Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


Public Member Functions | Protected Member Functions

XalanDocument Class Reference

#include <XalanDocument.hpp>

Inherits XalanNode.

Inherited by XalanSourceTreeDocument, XercesDocumentBridge, and XercesDocumentWrapper.

Collaboration diagram for XalanDocument:
Collaboration graph
[legend]

List of all members.

Public Member Functions

Protected Member Functions


Detailed Description

Definition at line 36 of file XalanDocument.hpp.


Constructor & Destructor Documentation

XalanDocument::XalanDocument (  ) 
virtual XalanDocument::~XalanDocument (  )  [virtual]
XalanDocument::XalanDocument ( const XalanDocument theSource  )  [protected]

Member Function Documentation

virtual const XalanNamedNodeMap* XalanDocument::getAttributes (  )  const [pure virtual]

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

Implements XalanNode.

Implemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

virtual const XalanNodeList* XalanDocument::getChildNodes (  )  const [pure virtual]

Gets a NodeList that contains all children of this node.

If there are no children, this is a NodeList containing no nodes.

Implements XalanNode.

Implemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

virtual XalanElement* XalanDocument::getDocumentElement (  )  const [pure virtual]

Return a reference to the root element of the document.

Implemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

virtual XalanElement* XalanDocument::getElementById ( const XalanDOMString elementId  )  const [pure 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.

Parameters:
elementId The unique id value for an element.
Returns:
The matching element.

Implemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

virtual XalanNode* XalanDocument::getFirstChild (  )  const [pure virtual]

Gets the first child of this node.

If there is no such node, this returns null.

Implements XalanNode.

Implemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

virtual IndexType XalanDocument::getIndex (  )  const [pure 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 XalanNode.

Implemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

virtual XalanNode* XalanDocument::getLastChild (  )  const [pure virtual]

Gets the last child of this node.

If there is no such node, this returns null.

Implements XalanNode.

Implemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

virtual const XalanDOMString& XalanDocument::getLocalName (  )  const [pure 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 XalanNode.

Implemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

virtual const XalanDOMString& XalanDocument::getNamespaceURI (  )  const [pure 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 XalanNode.

Implemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

virtual XalanNode* XalanDocument::getNextSibling (  )  const [pure virtual]

Gets the node immediately following this node.

If there is no such node, this returns null.

Implements XalanNode.

Implemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

virtual const XalanDOMString& XalanDocument::getNodeName (  )  const [pure virtual]

Gets the name of this node, depending on its type.

Implements XalanNode.

Implemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

virtual NodeType XalanDocument::getNodeType (  )  const [pure virtual]

An enum value representing the type of the underlying object.

Implements XalanNode.

Implemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

virtual const XalanDOMString& XalanDocument::getNodeValue (  )  const [pure virtual]

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

Implements XalanNode.

Implemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

virtual XalanDocument* XalanDocument::getOwnerDocument (  )  const [pure 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 XalanNode.

Implemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

virtual XalanNode* XalanDocument::getParentNode (  )  const [pure 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 XalanNode.

Implemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

virtual const XalanDOMString& XalanDocument::getPrefix (  )  const [pure virtual]

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

Implements XalanNode.

Implemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

virtual XalanNode* XalanDocument::getPreviousSibling (  )  const [pure virtual]

Gets the node immediately preceding this node.

If there is no such node, this returns null.

Implements XalanNode.

Implemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

virtual bool XalanDocument::isIndexed (  )  const [pure virtual]

Determine if the document is node-order indexed.

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

Implements XalanNode.

Implemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

XalanDocument& XalanDocument::operator= ( const XalanDocument theSource  )  [protected]
bool XalanDocument::operator== ( const XalanDocument theRHS  )  const [protected]

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

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.11
Copyright © 1999-2012 The Apache Software Foundation.
All Rights Reserved.

Apache Logo