com.filenet.wcm.toolkit.server.util.xml
Class WcmDocumentImpl

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.util.xml.WcmDocumentImpl
Direct Known Subclasses:
WcmXMLObject, WcmXMLPropDescs, XMLPropertiesFilter

public class WcmDocumentImpl
extends java.lang.Object

Perform DOM manipulations of FileNet-specific XML.


Field Summary
static java.lang.String ELEM_OBJECTSET
          The XML nodes that are created and handled by this class
protected  org.w3c.dom.Document thisDoc
          The Document object this class refers to
 
Constructor Summary
WcmDocumentImpl(org.w3c.dom.Document newDocumentXML)
          Constructor takes the Document object to implement
 
Method Summary
 org.w3c.dom.Element createCDATAChildElement(org.w3c.dom.Element oRoot, java.lang.String sTagName, java.lang.String sValue)
          Create a child CDATA element
 org.w3c.dom.Element createChildElement(org.w3c.dom.Element oRootElement, java.lang.String sTagName)
          Create a child element
 org.w3c.dom.Element createChildElement(org.w3c.dom.Element oRoot, java.lang.String sTagName, java.lang.String sValue)
          Create a child element
protected  org.w3c.dom.Element createNamespace()
          private helper function to create the namespace Element required by WcmXPathUtil
static WcmDocumentImpl getDocumentImpl(org.w3c.dom.Document newDocumentXML)
          Get method creates this object using the given Document.
 org.w3c.dom.Element getElement(org.w3c.dom.Node startingNode, java.lang.String XPathStr)
          Returns the Element refered by the XPathStr
 org.w3c.dom.Element getElement(java.lang.String XPathStr)
          Returns the Element refered by the XPathStr
 java.lang.String getElementText(java.lang.String XPathStr)
          Returns the text of the Element refered by the XPathStr
 org.w3c.dom.NodeList getNodeList(java.lang.String XPathStr)
          Returns the NodeList refered by the XPathStr
 org.w3c.dom.Document getThis()
          Returns the Document object
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ELEM_OBJECTSET

public static final java.lang.String ELEM_OBJECTSET
The XML nodes that are created and handled by this class

See Also:
Constant Field Values

thisDoc

protected org.w3c.dom.Document thisDoc
The Document object this class refers to

Constructor Detail

WcmDocumentImpl

public WcmDocumentImpl(org.w3c.dom.Document newDocumentXML)
Constructor takes the Document object to implement

Parameters:
newDocumentXML - The new Document object
Method Detail

getDocumentImpl

public static WcmDocumentImpl getDocumentImpl(org.w3c.dom.Document newDocumentXML)
Get method creates this object using the given Document.

Parameters:
newDocumentXML - The Document to implement
Returns:
WcmDocumentImpl The new object

getThis

public org.w3c.dom.Document getThis()
Returns the Document object

Returns:
the Document object

createChildElement

public org.w3c.dom.Element createChildElement(org.w3c.dom.Element oRoot,
                                              java.lang.String sTagName,
                                              java.lang.String sValue)
Create a child element

Parameters:
oRoot - The parent of the new child
sTagName - The tag name for the new child
sValue - The value to put into the child Element
Returns:
The child Element that was created

createCDATAChildElement

public org.w3c.dom.Element createCDATAChildElement(org.w3c.dom.Element oRoot,
                                                   java.lang.String sTagName,
                                                   java.lang.String sValue)
Create a child CDATA element

Parameters:
oRoot - The parent of the new child
sTagName - The tag name for the new child
sValue - The value to put into the child Element
Returns:
The child Element that was created

createChildElement

public org.w3c.dom.Element createChildElement(org.w3c.dom.Element oRootElement,
                                              java.lang.String sTagName)
Create a child element

Parameters:
oRootElement - The parent of the new child
sTagName - The tag name for the new child
Returns:
The child Element that was created

createNamespace

protected org.w3c.dom.Element createNamespace()
private helper function to create the namespace Element required by WcmXPathUtil

Returns:
The namespace

getElementText

public java.lang.String getElementText(java.lang.String XPathStr)
                                throws java.lang.Exception
Returns the text of the Element refered by the XPathStr

Parameters:
XPathStr - Specifies the XPath string
Returns:
String Contents of the Element refered to by the XPathStr
Throws:
java.lang.Exception

getElement

public org.w3c.dom.Element getElement(java.lang.String XPathStr)
                               throws java.lang.Exception
Returns the Element refered by the XPathStr

Parameters:
XPathStr - Specifies the XPath string
Returns:
The Element refered to by the XPathStr
Throws:
java.lang.Exception

getElement

public org.w3c.dom.Element getElement(org.w3c.dom.Node startingNode,
                                      java.lang.String XPathStr)
                               throws java.lang.Exception
Returns the Element refered by the XPathStr

Parameters:
startingNode - Specifies the starting node
XPathStr - Specifies the XPath string
Returns:
The Element refered to by the XPathStr
Throws:
java.lang.Exception

getNodeList

public org.w3c.dom.NodeList getNodeList(java.lang.String XPathStr)
                                 throws java.lang.Exception
Returns the NodeList refered by the XPathStr

Parameters:
XPathStr - Specifies the XPath string
Returns:
The NodeList refered to by the XPathStr
Throws:
java.lang.Exception


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.