## Xalan-C++ API Documentation

### The Xalan C++ XSLT Processor Version 1.9

Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

# XalanSourceTreeDocument Class Reference

Inheritance diagram for XalanSourceTreeDocument:

[legend]
Collaboration diagram for XalanSourceTreeDocument:

[legend]
List of all members.

## Public Types

- typedef XalanSourceTreeElementA::AttributesCountType AttributesCountType
- typedef XalanArrayAllocator<
  XalanSourceTreeAttr * > AttributesArrayAllocatorType
- typedef XalanMap< const XalanDOMChar *,
  XalanSourceTreeElement * > ElementByIDMapType
- typedef XalanMap< XalanDOMString,
  XalanDOMString > UnparsedEntityURIMapType
- typedef XalanSourceTreeAttributeAllocator::size_type allocator_size_type
- typedef XalanDOMStringPool::block_size_type block_size_type
- typedef XalanDOMStringPool::bucket_count_type bucket_count_type
- typedef XalanDOMStringPool::bucket_size_type bucket_size_type
- enum {
  eDefaultAttributeAllocatorBlockSize = 100, eDefaultAttributeNSAllocatorBlockSize = 50, eDefaultCommentAllocatorBlockSize = 10, eDefaultElementAllocatorBlockSize = 100,
  eDefaultElementNSAllocatorBlockSize = 100, eDefaultPIAllocatorBlockSize = 10, eDefaultTextAllocatorBlockSize = 100, eDefaultTextIWSAllocatorBlockSize = 100,
  eDefaultNamesStringPoolBlockSize = XalanDOMStringPool::eDefaultBlockSize, eDefaultNamesStringPoolBucketCount = XalanDOMStringPool::eDefaultBucketCount, eDefaultNamesStringPoolBucketSize = XalanDOMStringPool::eDefaultBucketSize, eDefaultValuesStringPoolBlockSize = XalanDOMStringPool::eDefaultBlockSize,
  eDefaultValuesStringPoolBucketCount = 997, eDefaultValuesStringPoolBucketSize = XalanDOMStringPool::eDefaultBucketSize
  }

## Public Member Functions

- XalanSourceTreeDocument (MemoryManagerType &theManager, bool fPoolAllText=s_poolAllTextNodes, block_size_type theNamesStringPoolBlockSize=eDefaultNamesStringPoolBlockSize, bucket_count_type theNamesStringPoolBucketCount=eDefaultNamesStringPoolBucketCount, bucket_size_type theNamesStringPoolBucketSize=eDefaultNamesStringPoolBucketSize, block_size_type theValuesStringPoolBlockSize=eDefaultValuesStringPoolBlockSize, bucket_count_type theValuesStringPoolBucketCount=eDefaultValuesStringPoolBucketCount, bucket_size_type theValuesStringPoolBucketSize=eDefaultValuesStringPoolBucketSize)
    Constructor for XalanSourceTreeDocument.
- XalanSourceTreeDocument (MemoryManagerType &theManager, allocator_size_type theAttributeBlockSize, allocator_size_type theAttributeNSBlockSize, allocator_size_type theCommentBlockSize, allocator_size_type theElementBlockSize, allocator_size_type theElementNSBlockSize, allocator_size_type thePIBlockSize, allocator_size_type theTextBlockSize, allocator_size_type theTextIWSBlockSize, bool fPoolAllText=s_poolAllTextNodes)
    Constructor for XalanSourceTreeDocument.
- virtual ~XalanSourceTreeDocument ()
- virtual const XalanDOMString & getNodeName () const
- virtual const XalanDOMString & getNodeValue () const
    Gets the value of this node, depending on its type.
- virtual NodeType getNodeType () const
    An enum value representing the type of the underlying object.
- virtual XalanNode * getParentNode () const
    Gets the parent of this node.
- virtual const XalanNodeList * getChildNodes () const
    Gets a `NodeList` that contains all children of this node.
- virtual XalanNode * getFirstChild () const
    Gets the first child of this node.
- virtual XalanNode * getLastChild () const
    Gets the last child of this node.
- virtual XalanNode * getPreviousSibling () const
    Gets the node immediately preceding this node.
- virtual XalanNode * getNextSibling () const
    Gets the node immediately following this node.
- virtual const XalanNamedNodeMap * getAttributes () const
    Gets a `NamedNodeMap` containing the attributes of this node (if it is an `Element`) or `null` otherwise.
- virtual XalanDocument * getOwnerDocument () const
    Gets the `Document` object associated with this node.
- virtual XalanSourceTreeDocument * cloneNode (bool deep) const
    Returns a duplicate of this node.
- virtual XalanNode * insertBefore (XalanNode *newChild, XalanNode *refChild)
    Inserts the node `newChild` before the existing child node `refChild`.
- virtual XalanNode * replaceChild (XalanNode *newChild, XalanNode *oldChild)
    Replaces the child node `oldChild` with `newChild` in the list of children, and returns the `oldChild` node.
- virtual XalanNode * removeChild (XalanNode *oldChild)
    Removes the child node indicated by `oldChild` from the list of children, and returns it.
- virtual XalanNode * appendChild (XalanNode *newChild)
    Adds the node `newChild` to the end of the list of children of this node.
- virtual bool hasChildNodes () const
    This is a convenience method to allow easy determination of whether a node has any children.
- virtual void setNodeValue (const XalanDOMString &nodeValue)
    Sets the value of the node.
- virtual void normalize ()
    Puts all `Text` nodes in the full depth of the sub-tree underneath this `Node`, including attribute nodes, into a "normal" form where only markup (e.g., tags, comments, processing instructions, CDATA sections, and entity references) separates `Text` nodes, i.e., there are no adjacent `Text` nodes.
- virtual bool isSupported (const XalanDOMString &feature, const XalanDOMString &version) const
    Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.
- virtual const XalanDOMString & getNamespaceURI () const
    Get the namespace URI of this node, or `null` if it is unspecified.
- virtual const XalanDOMString & getPrefix () const
    Get the namespace prefix of this node, or `null` if it is unspecified.
- virtual const XalanDOMString & getLocalName () const
    Returns the local part of the qualified name of this node.
- virtual void setPrefix (const XalanDOMString &prefix)
    Set the namespace prefix of this node.
- virtual bool isIndexed () const
    Determine if the document is node-order indexed.
- virtual IndexType getIndex () const
    Get the node's index.
- virtual XalanElement * createElement (const XalanDOMString &tagName)
    Creates an element of the type specified.
- virtual XalanDocumentFragment * createDocumentFragment ()
    Creates an empty DocumentFragment object.
- virtual XalanText * createTextNode (const XalanDOMString &data)
    Creates a Text node given the specified string.
- virtual XalanComment * createComment (const XalanDOMString &data)
    Creates a Comment node given the specified string.
- virtual XalanCDATASection * createCDATASection (const XalanDOMString &data)
    Creates a CDATASection node whose value is the specified string.
- virtual XalanProcessingInstruction * createProcessingInstruction (const XalanDOMString &target, const XalanDOMString &data)
    Creates a ProcessingInstruction node given the specified name and data strings.
- virtual XalanAttr * createAttribute (const XalanDOMString &name)
    Creates an Attr of the given name.
- virtual XalanEntityReference * createEntityReference (const XalanDOMString &name)
    Creates an EntityReference object.
- virtual XalanDocumentType * getDoctype () const
    Get Document Type Declaration (see `DocumentType`) associated with this document.
- virtual XalanDOMImplementation * getImplementation () const
    Return the `DOMImplementation` object that handles this document.
- virtual XalanElement * getDocumentElement () const
    Return a reference to the root element of the document.
- virtual XalanNodeList * getElementsByTagName (const XalanDOMString &tagname) const
    Returns a `NodeList` of all the elements with a given tag name.
- virtual XalanNode * importNode (XalanNode *importedNode, bool deep)
    Imports a node from another document to this document.
- virtual XalanElement * createElementNS (const XalanDOMString &namespaceURI, const XalanDOMString &qualifiedName)
    Creates an element of the given qualified name and namespace URI.
- virtual XalanAttr * createAttributeNS (const XalanDOMString &namespaceURI, const XalanDOMString &qualifiedName)
    Creates an attribute of the given qualified name and namespace URI.
- virtual XalanNodeList * getElementsByTagNameNS (const XalanDOMString &namespaceURI, const XalanDOMString &localName) const
    Returns a `NodeList` of all the `Element`s with a given local name and namespace URI in the order in which they would be encountered in a preorder traversal of the `Document` tree.
- virtual XalanElement * getElementById (const XalanDOMString &elementId) const
    Returns the `Element` whose ID is given by `elementId`.
- XalanSourceTreeElement * createElementNode (const XalanDOMChar *name, const AttributeListType &attrs, XalanNode *theParentNode=0, XalanNode *thePreviousSibling=0, XalanNode *theNextSibling=0, bool fAddXMLNamespaceAttribute=false)
- XalanSourceTreeElement * createElementNode (const XalanDOMChar *uri, const XalanDOMChar *localname, const XalanDOMChar *qname, const AttributesType &attrs, XalanNode *theParentNode=0, XalanNode *thePreviousSibling=0, XalanNode *theNextSibling=0, bool fAddXMLNamespaceAttribute=false)
- XalanSourceTreeElement * createElementNode (const XalanDOMChar *tagName, const AttributeListType &attrs, const PrefixResolver &thePrefixResolver, XalanNode *theParentNode=0, XalanNode *thePreviousSibling=0, XalanNode *theNextSibling=0, bool fAddXMLNamespaceAttribute=false)
- XalanSourceTreeElement * createElementNode (const XalanDOMChar *name, const AttributesType &attrs, XalanNode *theParentNode=0, XalanNode *thePreviousSibling=0, XalanNode *theNextSibling=0, bool fAddXMLNamespaceAttribute=false)
- XalanSourceTreeComment * createCommentNode (const XalanDOMChar *data, XalanDOMString::size_type length, XalanNode *theParentNode=0, XalanNode *thePreviousSibling=0, XalanNode *theNextSibling=0)
- XalanSourceTreeProcessingInstruction * createProcessingInstructionNode (const XalanDOMChar *target, const XalanDOMChar *data, XalanNode *theParentNode=0, XalanNode *thePreviousSibling=0, XalanNode *theNextSibling=0)
- XalanSourceTreeText * createTextNode (const XalanDOMChar *chars, XalanDOMString::size_type length, XalanNode *theParentNode=0, XalanNode *thePreviousSibling=0, XalanNode *theNextSibling=0)
- XalanSourceTreeText * createTextIWSNode (const XalanDOMChar *chars, XalanDOMString::size_type length, XalanNode *theParentNode=0, XalanNode *thePreviousSibling=0, XalanNode *theNextSibling=0)
- void unparsedEntityDeclaration (const XalanDOMChar *name, const XalanDOMChar *publicId, const XalanDOMChar *systemId, const XalanDOMChar *notationName)
- const XalanDOMString & getUnparsedEntityURI (const XalanDOMString &theName) const
- void appendChildNode (XalanSourceTreeComment *theChild)
- void appendChildNode (XalanSourceTreeElement *theChild)
- void appendChildNode (XalanSourceTreeProcessingInstruction *theChild)

## Static Public Member Functions

- void initialize (MemoryManagerType &theManager)
    Perform static initialization.
- void terminate ()
    Perform static shut down.
- XalanSourceTreeDocument * create (MemoryManagerType &theManager, bool fPoolAllText=s_poolAllTextNodes, block_size_type theNamesStringPoolBlockSize=eDefaultNamesStringPoolBlockSize, bucket_count_type theNamesStringPoolBucketCount=eDefaultNamesStringPoolBucketCount, bucket_size_type theNamesStringPoolBucketSize=eDefaultNamesStringPoolBucketSize, block_size_type theValuesStringPoolBlockSize=eDefaultValuesStringPoolBlockSize, bucket_count_type theValuesStringPoolBucketCount=eDefaultValuesStringPoolBucketCount, bucket_size_type theValuesStringPoolBucketSize=eDefaultValuesStringPoolBucketSize)
- bool getPoolAllTextNodes ()
- void setPoolAllTextNodes (bool fPool)

## Member Typedef Documentation

typedef XalanSourceTreeAttributeAllocator::size_type XalanSourceTreeDocument::allocator_size_type

typedef XalanArrayAllocator<XalanSourceTreeAttr*> XalanSourceTreeDocument::AttributesArrayAllocatorType

typedef XalanSourceTreeElementA::AttributesCountType XalanSourceTreeDocument::AttributesCountType

typedef XalanDOMStringPool::block_size_type XalanSourceTreeDocument::block_size_type

typedef XalanDOMStringPool::bucket_count_type XalanSourceTreeDocument::bucket_count_type

typedef XalanDOMStringPool::bucket_size_type XalanSourceTreeDocument::bucket_size_type

typedef XalanMap< const XalanDOMChar*, XalanSourceTreeElement*> XalanSourceTreeDocument::ElementByIDMapType

typedef XalanMap< XalanDOMString, XalanDOMString> XalanSourceTreeDocument::UnparsedEntityURIMapType

## Member Enumeration Documentation

anonymous enum

Enumeration values:

  eDefaultAttributeAllocatorBlockSize |
  eDefaultAttributeNSAllocatorBlockSize |
  eDefaultCommentAllocatorBlockSize |
  eDefaultElementAllocatorBlockSize |
  eDefaultElementNSAllocatorBlockSize |
  eDefaultPIAllocatorBlockSize |
  eDefaultTextAllocatorBlockSize |
  eDefaultTextIWSAllocatorBlockSize |
  eDefaultNamesStringPoolBlockSize |
  eDefaultNamesStringPoolBucketCount |
  eDefaultNamesStringPoolBucketSize |
  eDefaultValuesStringPoolBlockSize |
  eDefaultValuesStringPoolBucketCount |
  eDefaultValuesStringPoolBucketSize |

## Constructor & Destructor Documentation

XalanSourceTreeDocument::XalanSourceTreeDocument | ( | MemoryManagerType & | theManager,
|  | bool | fPoolAllText = s_poolAllTextNodes,
|  | block_size_type | theNamesStringPoolBlockSize = eDefaultNamesStringPoolBlockSize,
|  | bucket_count_type | theNamesStringPoolBucketCount = eDefaultNamesStringPoolBucketCount,
|  | bucket_size_type | theNamesStringPoolBucketSize = eDefaultNamesStringPoolBucketSize,
|  | block_size_type | theValuesStringPoolBlockSize = eDefaultValuesStringPoolBlockSize,
|  | bucket_count_type | theValuesStringPoolBucketCount = eDefaultValuesStringPoolBucketCount,
|  | bucket_size_type | theValuesStringPoolBucketSize = eDefaultValuesStringPoolBucketSize
| ) |

Constructor for XalanSourceTreeDocument.

Parameters:

  fPoolAllText | If false, text node data that is not whitespace will not be pooled.
  theNamesStringPoolBlockSize | The block size for allocating strings in the name pool
  theNamesStringPoolBucketCount | The number of buckets for allocating strings in the name pool
  theNamesStringPoolBucketSize | The bucket size for allocating strings in the name pool
  theValuesStringPoolBlockSize | The block size for allocating strings in the values pool
  theValuesStringPoolBucketCount | The number of buckets for allocating strings in the values pool
  theValuesStringPoolBucketSize | The bucket size for allocating strings in the values pool

XalanSourceTreeDocument::XalanSourceTreeDocument | ( | MemoryManagerType & | theManager,
|  | allocator_size_type | theAttributeBlockSize,
|  | allocator_size_type | theAttributeNSBlockSize,
|  | allocator_size_type | theCommentBlockSize,
|  | allocator_size_type | theElementBlockSize,
|  | allocator_size_type | theElementNSBlockSize,
|  | allocator_size_type | thePIBlockSize,
|  | allocator_size_type | theTextBlockSize,
|  | allocator_size_type | theTextIWSBlockSize,
|  | bool | fPoolAllText = s_poolAllTextNodes
| ) |

Constructor for XalanSourceTreeDocument.

Parameters:

  theAttributeBlockSize | The block size for allocating attribute nodes
  theAttributeNSBlockSize | The block size for allocating attribute NS nodes
  theCommentBlockSize | The block size for allocating comment nodes
  theElementBlockSize | The block size for allocating element nodes
  theElementNSBlockSize | The block size for allocating element nodes
  theTextBlockSize | The block size for allocating text nodes,
  theTextIWSBlockSize | The block size for allocating text IWS nodes,
  fPoolAllText | If false, text node data that is not whitespace will not be pooled.

virtual XalanSourceTreeDocument::~XalanSourceTreeDocument | ( |  | ) | `[virtual]`

## Member Function Documentation

virtual XalanNode* XalanSourceTreeDocument::appendChild | ( | XalanNode * | newChild | ) | `[virtual]`

Adds the node `newChild` to the end of the list of children of this node.

If the `newChild` is already in the tree, it is first removed.

Parameters:

  newChild | The node to add.If it is a `DocumentFragment` object, the entire contents of the document fragment are moved into the child list of this node

Returns:
  The node added.

Implements XalanDocument.

void XalanSourceTreeDocument::appendChildNode | ( | XalanSourceTreeProcessingInstruction * | theChild | ) |

void XalanSourceTreeDocument::appendChildNode | ( | XalanSourceTreeElement * | theChild | ) |

void XalanSourceTreeDocument::appendChildNode | ( | XalanSourceTreeComment * | theChild | ) |

virtual XalanSourceTreeDocument* XalanSourceTreeDocument::cloneNode | ( | bool | deep | ) | const`[virtual]`

Returns a duplicate of this node.

This function serves as a generic copy constructor for nodes.

The duplicate node has no parent ( `parentNode` returns `null`.).
Cloning an `Element` copies all attributes and their values, including those generated by the XML processor to represent defaulted attributes, but this method does not copy any text it contains unless it is a deep clone, since the text is contained in a child `Text` node. Cloning any other type of node simply returns a copy of this node.

Parameters:

  deep | If `true`, recursively clone the subtree under the specified node; if `false`, clone only the node itself (and its attributes, if it is an `Element`).

Returns:
  The duplicate node.

Implements XalanDocument.

XalanSourceTreeDocument* XalanSourceTreeDocument::create | ( | MemoryManagerType & | theManager,
|  | bool | fPoolAllText = s_poolAllTextNodes,
|  | block_size_type | theNamesStringPoolBlockSize = eDefaultNamesStringPoolBlockSize,
|  | bucket_count_type | theNamesStringPoolBucketCount = eDefaultNamesStringPoolBucketCount,
|  | bucket_size_type | theNamesStringPoolBucketSize = eDefaultNamesStringPoolBucketSize,
|  | block_size_type | theValuesStringPoolBlockSize = eDefaultValuesStringPoolBlockSize,
|  | bucket_count_type | theValuesStringPoolBucketCount = eDefaultValuesStringPoolBucketCount,
|  | bucket_size_type | theValuesStringPoolBucketSize = eDefaultValuesStringPoolBucketSize
| ) | `[static]`

virtual XalanAttr* XalanSourceTreeDocument::createAttribute | ( | const XalanDOMString & | name | ) | `[virtual]`

Creates an Attr of the given name.

Note that the `Attr` instance can then be attached to an Element using the `DOMElement::setAttribute()` method.

Parameters:

  name | The name of the attribute.

Returns:
  A new `Attr` object with the `nodeName` attribute set to `name`, and `localName`, `prefix`, and `namespaceURI` set to `null`.

Exceptions:

  DOMException | INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.

Implements XalanDocument.

virtual XalanAttr* XalanSourceTreeDocument::createAttributeNS | ( | const XalanDOMString & | namespaceURI,
|  | const XalanDOMString & | qualifiedName
| ) | `[virtual]`

Creates an attribute of the given qualified name and namespace URI.

"Experimental - subject to change"

Parameters:

  namespaceURI | The namespace URI of the attribute to create.
  qualifiedName | The qualified name of the attribute to instantiate.

Returns:
  A new `Attr` object.

Exceptions:

  DOMException

  INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character.
  NAMESPACE_ERR: Raised if the `qualifiedName` is malformed, if the `qualifiedName` has a prefix and the `namespaceURI` is `null` or an empty string, if the `qualifiedName` has a prefix that is "xml" and the `namespaceURI` is different from "http://www.w3.org/XML/1998/namespace", if the `qualifiedName` has a prefix that is "xmlns" and the `namespaceURI` is different from "http://www.w3.org/2000/xmlns/", or if the `qualifiedName` is "xmlns" and the `namespaceURI` is different from "http://www.w3.org/2000/xmlns/".

Implements XalanDocument.

virtual XalanCDATASection* XalanSourceTreeDocument::createCDATASection | ( | const XalanDOMString & | data | ) | `[virtual]`

Creates a CDATASection node whose value is the specified string.

Parameters:

  data | The data for the `CDATASection` contents.

Returns:
  A `CDATASection` object.

Exceptions:

  DOMException | NOT_SUPPORTED_ERR: Raised if this document is an HTML document.

Implements XalanDocument.

virtual XalanComment* XalanSourceTreeDocument::createComment | ( | const XalanDOMString & | data | ) | `[virtual]`

Creates a Comment node given the specified string.

Parameters:

  data | The data for the comment.

Returns:
  A `Comment` that references the newly created comment node.

Implements XalanDocument.

XalanSourceTreeComment* XalanSourceTreeDocument::createCommentNode | ( | const XalanDOMChar * | data,
|  | XalanDOMString::size_type | length,
|  | XalanNode * | theParentNode = 0,
|  | XalanNode * | thePreviousSibling = 0,
|  | XalanNode * | theNextSibling = 0
| ) |

virtual XalanDocumentFragment* XalanSourceTreeDocument::createDocumentFragment | ( |  | ) | `[virtual]`

Creates an empty DocumentFragment object.

Returns:
  A `DocumentFragment` that references the newly created document fragment.

Implements XalanDocument.

virtual XalanElement* XalanSourceTreeDocument::createElement | ( | const XalanDOMString & | tagName | ) | `[virtual]`

Creates an element of the type specified.

Note that the instance returned implements the Element interface, so attributes can be specified directly on the returned object.

Parameters:

  tagName | The name of the element type to instantiate.

Returns:
  A `Element` that reference the new element.

Implements XalanDocument.

XalanSourceTreeElement* XalanSourceTreeDocument::createElementNode | ( | const XalanDOMChar * | name,
|  | const AttributesType & | attrs,
|  | XalanNode * | theParentNode = 0,
|  | XalanNode * | thePreviousSibling = 0,
|  | XalanNode * | theNextSibling = 0,
|  | bool | fAddXMLNamespaceAttribute = false
| ) |

XalanSourceTreeElement* XalanSourceTreeDocument::createElementNode | ( | const XalanDOMChar * | tagName,
|  | const AttributeListType & | attrs,
|  | const PrefixResolver & | thePrefixResolver,
|  | XalanNode * | theParentNode = 0,
|  | XalanNode * | thePreviousSibling = 0,
|  | XalanNode * | theNextSibling = 0,
|  | bool | fAddXMLNamespaceAttribute = false
| ) |

XalanSourceTreeElement* XalanSourceTreeDocument::createElementNode | ( | const XalanDOMChar * | uri,
|  | const XalanDOMChar * | localname,
|  | const XalanDOMChar * | qname,
|  | const AttributesType & | attrs,
|  | XalanNode * | theParentNode = 0,
|  | XalanNode * | thePreviousSibling = 0,
|  | XalanNode * | theNextSibling = 0,
|  | bool | fAddXMLNamespaceAttribute = false
| ) |

XalanSourceTreeElement* XalanSourceTreeDocument::createElementNode | ( | const XalanDOMChar * | name,
|  | const AttributeListType & | attrs,
|  | XalanNode * | theParentNode = 0,
|  | XalanNode * | thePreviousSibling = 0,
|  | XalanNode * | theNextSibling = 0,
|  | bool | fAddXMLNamespaceAttribute = false
| ) |

virtual XalanElement* XalanSourceTreeDocument::createElementNS | ( | const XalanDOMString & | namespaceURI,
|  | const XalanDOMString & | qualifiedName
| ) | `[virtual]`

Creates an element of the given qualified name and namespace URI.

"Experimental - subject to change"

Parameters:

  namespaceURI | The namespace URI of the element to create.
  qualifiedName | The qualified name of the element type to instantiate.

Returns:
  A new `Element` object.

Exceptions:

  DOMException | INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character. NAMESPACE_ERR: Raised if the `qualifiedName` is malformed, if the `qualifiedName` has a prefix and the `namespaceURI` is `null` or an empty string, or if the `qualifiedName` has a prefix that is "xml" and the `namespaceURI` is different from "http://www.w3.org/XML/1998/namespace".

Implements XalanDocument.

virtual XalanEntityReference* XalanSourceTreeDocument::createEntityReference | ( | const XalanDOMString & | name | ) | `[virtual]`

Creates an EntityReference object.

Parameters:

  name | The name of the entity to reference.

Returns:
  A `EntityReference` that references the newly created EntityReference node.

Exceptions:

  DOMException | INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.

Implements XalanDocument.

virtual XalanProcessingInstruction* XalanSourceTreeDocument::createProcessingInstruction | ( | const XalanDOMString & | target,
|  | const XalanDOMString & | data
| ) | `[virtual]`

Creates a ProcessingInstruction node given the specified name and data strings.

Parameters:

  target | The target part of the processing instruction.
  data | The data for the node.

Returns:
  A `ProcessingInstruction` that references the newly created PI node.

Exceptions:

  DOMException | INVALID_CHARACTER_ERR: Raised if an illegal character is specified.

Implements XalanDocument.

XalanSourceTreeProcessingInstruction* XalanSourceTreeDocument::createProcessingInstructionNode | ( | const XalanDOMChar * | target,
|  | const XalanDOMChar * | data,
|  | XalanNode * | theParentNode = 0,
|  | XalanNode * | thePreviousSibling = 0,
|  | XalanNode * | theNextSibling = 0
| ) |

XalanSourceTreeText* XalanSourceTreeDocument::createTextIWSNode | ( | const XalanDOMChar * | chars,
|  | XalanDOMString::size_type | length,
|  | XalanNode * | theParentNode = 0,
|  | XalanNode * | thePreviousSibling = 0,
|  | XalanNode * | theNextSibling = 0
| ) |

XalanSourceTreeText* XalanSourceTreeDocument::createTextNode | ( | const XalanDOMChar * | chars,
|  | XalanDOMString::size_type | length,
|  | XalanNode * | theParentNode = 0,
|  | XalanNode * | thePreviousSibling = 0,
|  | XalanNode * | theNextSibling = 0
| ) |

virtual XalanText* XalanSourceTreeDocument::createTextNode | ( | const XalanDOMString & | data | ) | `[virtual]`

Creates a Text node given the specified string.

Parameters:

  data | The data for the node.

Returns:
  A `Text` object that references the newly created text node.

Implements XalanDocument.

virtual const XalanNamedNodeMap* XalanSourceTreeDocument::getAttributes | ( |  | ) | const`[virtual]`

| Gets a `NamedNodeMap` containing the attributes of this node (if it is an `Element`) or `null` otherwise. Implements XalanDocument.

virtual const XalanNodeList* XalanSourceTreeDocument::getChildNodes | ( |  | ) | const`[virtual]`

Gets a `NodeList` that contains all children of this node.

If there are no children, this is a `NodeList` containing no nodes. The content of the returned `NodeList` is "live" in the sense that, for instance, changes to the children of the node object that it was created from are immediately reflected in the nodes returned by the `NodeList` accessors; it is not a static snapshot of the content of the node. This is true for every `NodeList`, including the ones returned by the `getElementsByTagName` method.

Implements XalanDocument.

virtual XalanDocumentType* XalanSourceTreeDocument::getDoctype | ( |  | ) | const`[virtual]`

| Get Document Type Declaration (see `DocumentType`) associated with this document. For documents without a document type declaration this returns `null` reference object. The DOM Level 1 does not support editing the Document Type Declaration, therefore `docType` cannot be altered in any way. Implements XalanDocument.

virtual XalanElement* XalanSourceTreeDocument::getDocumentElement | ( |  | ) | const`[virtual]`

| Return a reference to the root element of the document. Implements XalanDocument.

virtual XalanElement* XalanSourceTreeDocument::getElementById | ( | const XalanDOMString & | elementId | ) | const`[virtual]`

Returns the `Element` whose ID is given by `elementId`.

If no such element exists, returns `null`. Behavior is not defined if more than one element has this `ID`.

Note: The DOM implementation must have information that says which attributes are of type ID. Attributes with the name "ID" are not of type ID unless so defined. Implementations that do not know whether attributes are of type ID or not are expected to return `null`.

"Experimental - subject to change"

Parameters:

  elementId | The unique `id` value for an element.

Returns:
  The matching element.

Implements XalanDocument.

virtual XalanNodeList* XalanSourceTreeDocument::getElementsByTagName | ( | const XalanDOMString & | tagname | ) | const`[virtual]`

Returns a `NodeList` of all the elements with a given tag name.

The returned node list is "live", in that changes to the document tree made after a nodelist was initially returned will be immediately reflected in the node list.

The elements in the node list are ordered in the same order in which they would be encountered in a preorder traversal of the `Document` tree.

Parameters:

  tagname | The name of the tag to match on. The special value "*" matches all tags.

Returns:
  A reference to a NodeList containing all the matched `Element`s.

Implements XalanDocument.

virtual XalanNodeList* XalanSourceTreeDocument::getElementsByTagNameNS | ( | const XalanDOMString & | namespaceURI,
|  | const XalanDOMString & | localName
| ) | const`[virtual]`

Returns a `NodeList` of all the `Element`s with a given local name and namespace URI in the order in which they would be encountered in a preorder traversal of the `Document` tree.

"Experimental - subject to change"

Parameters:

  namespaceURI | The namespace URI of the elements to match on. The special value "*" matches all namespaces.
  localName | The local name of the elements to match on. The special value "*" matches all local names.

Returns:
  A new `NodeList` object containing all the matched `Element`s.

Implements XalanDocument.

virtual XalanNode* XalanSourceTreeDocument::getFirstChild | ( |  | ) | const`[virtual]`

| Gets the first child of this node. If there is no such node, this returns `null`. Implements XalanDocument.

virtual XalanDOMImplementation* XalanSourceTreeDocument::getImplementation | ( |  | ) | const`[virtual]`

| Return the `DOMImplementation` object that handles this document. Implements XalanDocument.

virtual IndexType XalanSourceTreeDocument::getIndex | ( |  | ) | const`[virtual]`

Get the node's index.

Valid only if isIndexed() reports that the document is node-order indexed.

Returns:
  The index value, or 0 if the node is not indexed.

Implements XalanDocument.

virtual XalanNode* XalanSourceTreeDocument::getLastChild | ( |  | ) | const`[virtual]`

| Gets the last child of this node. If there is no such node, this returns `null`. Implements XalanDocument.

virtual const XalanDOMString& XalanSourceTreeDocument::getLocalName | ( |  | ) | const`[virtual]`

| Returns the local part of the qualified name of this node. For nodes created with a DOM Level 1 method, such as `createElement` from the `Document` interface, it is null. Implements XalanDocument.

virtual const XalanDOMString& XalanSourceTreeDocument::getNamespaceURI | ( |  | ) | const`[virtual]`

Get the namespace URI of this node, or `null` if it is unspecified.

This is not a computed value that is the result of a namespace lookup based on an examination of the namespace declarations in scope. It is merely the namespace URI given at creation time.

For nodes of any type other than `ELEMENT_NODE` and `ATTRIBUTE_NODE` and nodes created with a DOM Level 1 method, such as `createElement` from the `Document` interface, this is always `null`.

Implements XalanDocument.

virtual XalanNode* XalanSourceTreeDocument::getNextSibling | ( |  | ) | const`[virtual]`

| Gets the node immediately following this node. If there is no such node, this returns `null`. Implements XalanDocument.

virtual const XalanDOMString& XalanSourceTreeDocument::getNodeName | ( |  | ) | const`[virtual]`

| Implements XalanDocument.

virtual NodeType XalanSourceTreeDocument::getNodeType | ( |  | ) | const`[virtual]`

| An enum value representing the type of the underlying object. Implements XalanDocument.

virtual const XalanDOMString& XalanSourceTreeDocument::getNodeValue | ( |  | ) | const`[virtual]`

| Gets the value of this node, depending on its type. Implements XalanDocument.

virtual XalanDocument* XalanSourceTreeDocument::getOwnerDocument | ( |  | ) | const`[virtual]`

| Gets the `Document` object associated with this node. This is also the `Document` object used to create new nodes. When this node is a `Document` or a `DocumentType` which is not used with any `Document` yet, this is `null`. Implements XalanDocument.

virtual XalanNode* XalanSourceTreeDocument::getParentNode | ( |  | ) | const`[virtual]`

| Gets the parent of this node. All nodes, except `Document`, `DocumentFragment`, and `Attr` may have a parent. However, if a node has just been created and not yet added to the tree, or if it has been removed from the tree, a `null` Node is returned. Implements XalanDocument.

bool XalanSourceTreeDocument::getPoolAllTextNodes | ( |  | ) | `[static]`

virtual const XalanDOMString& XalanSourceTreeDocument::getPrefix | ( |  | ) | const`[virtual]`

| Get the namespace prefix of this node, or `null` if it is unspecified. Implements XalanDocument.

virtual XalanNode* XalanSourceTreeDocument::getPreviousSibling | ( |  | ) | const`[virtual]`

| Gets the node immediately preceding this node. If there is no such node, this returns `null`. Implements XalanDocument.

const XalanDOMString& XalanSourceTreeDocument::getUnparsedEntityURI | ( | const XalanDOMString & | theName | ) | const

virtual bool XalanSourceTreeDocument::hasChildNodes | ( |  | ) | const`[virtual]`

This is a convenience method to allow easy determination of whether a node has any children.

Returns:
  `true` if the node has any children, `false` if the node has no children.

Implements XalanDocument.

virtual XalanNode* XalanSourceTreeDocument::importNode | ( | XalanNode * | importedNode,
|  | bool | deep
| ) | `[virtual]`

Imports a node from another document to this document.

The returned node has no parent (`parentNode` is `null`). The source node is not altered or removed from the original document; this method creates a new copy of the source node.
For all nodes, importing a node creates a node object owned by the importing document, with attribute values identical to the source node's `nodeName` and `nodeType`, plus the attributes related to namespaces (prefix and namespaces URI).

"Experimental - subject to change"

Parameters:

  importedNode | The node to import.
  deep | If `true`, recursively import the subtree under the specified node; if `false`, import only the node itself, as explained above. This does not apply to `Attr`, `EntityReference`, and `Notation` nodes.

Returns:
  The imported node that belongs to this `Document`.

Exceptions:

  DOMException | NOT_SUPPORTED_ERR: Raised if the type of node being imported is not supported.

Implements XalanDocument.

void XalanSourceTreeDocument::initialize | ( | MemoryManagerType & | theManager | ) | `[static]`

| Perform static initialization. See class XalanSourceTreeInit.

virtual XalanNode* XalanSourceTreeDocument::insertBefore | ( | XalanNode * | newChild,
|  | XalanNode * | refChild
| ) | `[virtual]`

Inserts the node `newChild` before the existing child node `refChild`.

If `refChild` is `null`, insert `newChild` at the end of the list of children.
If `newChild` is a `DocumentFragment` object, all of its children are inserted, in the same order, before `refChild`. If the `newChild` is already in the tree, it is first removed. Note that a `Node` that has never been assigned to refer to an actual node is == null.

Parameters:

  newChild | The node to insert.
  refChild | The reference node, i.e., the node before which the new node must be inserted.

Returns:
  The node being inserted.

Implements XalanDocument.

virtual bool XalanSourceTreeDocument::isIndexed | ( |  | ) | const`[virtual]`

Determine if the document is node-order indexed.

Returns:
  true if the document is indexed, otherwise false.

Implements XalanDocument.

virtual bool XalanSourceTreeDocument::isSupported | ( | const XalanDOMString & | feature,
|  | const XalanDOMString & | version
| ) | const`[virtual]`

Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.

Parameters:

  feature | The string of the feature to test. This is the same name as what can be passed to the method `hasFeature` on `DOMImplementation`.
  version | This is the version number of the feature to test. In Level 2, version 1, this is the string "2.0". If the version is not specified, supporting any version of the feature will cause the method to return `true`.

Returns:
  Returns `true` if the specified feature is supported on this node, `false` otherwise.

Implements XalanDocument.

virtual void XalanSourceTreeDocument::normalize | ( |  | ) | `[virtual]`

Puts all `Text` nodes in the full depth of the sub-tree underneath this `Node`, including attribute nodes, into a "normal" form where only markup (e.g., tags, comments, processing instructions, CDATA sections, and entity references) separates `Text` nodes, i.e., there are no adjacent `Text` nodes.

This can be used to ensure that the DOM view of a document is the same as if it were saved and re-loaded, and is useful when operations (such as XPointer lookups) that depend on a particular document tree structure are to be used.

Note: In cases where the document contains `CDATASections`, the normalize operation alone may not be sufficient, since XPointers do not differentiate between `Text` nodes and `CDATASection` nodes.

Implements XalanDocument.

virtual XalanNode* XalanSourceTreeDocument::removeChild | ( | XalanNode * | oldChild | ) | `[virtual]`

Removes the child node indicated by `oldChild` from the list of children, and returns it.

Parameters:

  oldChild | The node being removed.

Returns:
  The node removed.

Implements XalanDocument.

virtual XalanNode* XalanSourceTreeDocument::replaceChild | ( | XalanNode * | newChild,
|  | XalanNode * | oldChild
| ) | `[virtual]`

Replaces the child node `oldChild` with `newChild` in the list of children, and returns the `oldChild` node.

If `newChild` is a `DocumentFragment` object, `oldChild` is replaced by all of the `DocumentFragment` children, which are inserted in the same order.

If the `newChild` is already in the tree, it is first removed.

Parameters:

  newChild | The new node to put in the child list.
  oldChild | The node being replaced in the list.

Returns:
  The node replaced.

Implements XalanDocument.

virtual void XalanSourceTreeDocument::setNodeValue | ( | const XalanDOMString & | nodeValue | ) | `[virtual]`

Sets the value of the node.

Any node which can have a nodeValue (

See also:
  getNodeValue) will also accept requests to set it to a string. The exact response to this varies from node to node -- Attribute, for example, stores its values in its children and has to replace them with a new Text holding the replacement value.

For most types of Node, value is null and attempting to set it will throw DOMException(NO_MODIFICATION_ALLOWED_ERR). This will also be thrown if the node is read-only.

Implements XalanDocument.

void XalanSourceTreeDocument::setPoolAllTextNodes | ( | bool | fPool | ) | `[static]`

virtual void XalanSourceTreeDocument::setPrefix | ( | const XalanDOMString & | prefix | ) | `[virtual]`

Set the namespace prefix of this node.

Note that setting this attribute, when permitted, changes the `nodeName` attribute, which holds the qualified name, as well as the `tagName` and `name` attributes of the `Element` and `Attr` interfaces, when applicable.

Note also that changing the prefix of an attribute, that is known to have a default value, does not make a new attribute with the default value and the original prefix appear, since the `namespaceURI` and `localName` do not change.

Parameters:

  prefix | The prefix of this node.

Exceptions:

  DOMException

  INVALID_CHARACTER_ERR: Raised if the specified prefix contains an illegal character.
  NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
  NAMESPACE_ERR: Raised if the specified `prefix` is malformed, if the specified prefix is "xml" and the `namespaceURI` of this node is different from "http://www.w3.org/XML/1998/namespace", if specified prefix is "xmlns" and the `namespaceURI` is neither `null` nor an empty string, or if the `localName` is `null`.

Implements XalanDocument.

void XalanSourceTreeDocument::terminate | ( |  | ) | `[static]`

| Perform static shut down. See class XalanSourceTreeInit.

void XalanSourceTreeDocument::unparsedEntityDeclaration | ( | const XalanDOMChar * | name,
|  | const XalanDOMChar * | publicId,
|  | const XalanDOMChar * | systemId,
|  | const XalanDOMChar * | notationName
| ) |

The documentation for this class was generated from the following file:

- XalanSourceTreeDocument.hpp

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Xalan-C++ XSLT Processor Version 1.9 Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.