Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

Public Types | Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
XalanSourceTreeElementA Class Reference
Inheritance diagram for XalanSourceTreeElementA:
XalanSourceTreeElement XalanNamedNodeMap XalanElement XalanNode XalanSourceTreeElementANS

Public Types

typedef unsigned long AttributesCountType
 
- Public Types inherited from XalanNode
enum  NodeType {
  UNKNOWN_NODE = 0, ELEMENT_NODE = 1, ATTRIBUTE_NODE = 2, TEXT_NODE = 3,
  CDATA_SECTION_NODE = 4, ENTITY_REFERENCE_NODE = 5, ENTITY_NODE = 6, PROCESSING_INSTRUCTION_NODE = 7,
  COMMENT_NODE = 8, DOCUMENT_NODE = 9, DOCUMENT_TYPE_NODE = 10, DOCUMENT_FRAGMENT_NODE = 11,
  NOTATION_NODE = 12
}
 
typedef unsigned long IndexType
 

Public Member Functions

 XalanSourceTreeElementA (MemoryManagerType &theManager, const XalanDOMString &theTagName, XalanSourceTreeDocument *theOwnerDocument, XalanSourceTreeAttr **theAttributes, AttributesCountType theAttributeCount, XalanNode *theParentNode=0, XalanNode *thePreviousSibling=0, XalanNode *theNextSibling=0, IndexType theIndex=0)
 Constructor. More...
 
virtual ~XalanSourceTreeElementA ()
 
virtual const XalanNamedNodeMapgetAttributes () const
 Gets a NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise. More...
 
virtual XalanSourceTreeElementAcloneNode (bool deep) const
 Returns a duplicate of this node. More...
 
virtual const XalanDOMStringgetNamespaceURI () const
 Get the namespace URI of this node, or null if it is unspecified. More...
 
virtual const XalanDOMStringgetPrefix () const
 Get the namespace prefix of this node, or null if it is unspecified. More...
 
virtual const XalanDOMStringgetLocalName () const
 Returns the local part of the qualified name of this node. More...
 
virtual const XalanDOMStringgetAttribute (const XalanDOMString &name) const
 Retrieves an attribute value by name. More...
 
virtual XalanAttrgetAttributeNode (const XalanDOMString &name) const
 Retrieves an DOM_Attr node by name. More...
 
virtual const XalanDOMStringgetAttributeNS (const XalanDOMString &namespaceURI, const XalanDOMString &localName) const
 Retrieves an attribute value by local name and namespace URI. More...
 
virtual XalanAttrgetAttributeNodeNS (const XalanDOMString &namespaceURI, const XalanDOMString &localName) const
 Retrieves an DOM_Attr node by local name and namespace URI. More...
 
AttributesCountType getAttributeCount () const
 
XalanSourceTreeAttrgetAttributeByIndex (AttributesCountType index) const
 
XalanSourceTreeElementAclone (bool deep) const
 
- Public Member Functions inherited from XalanSourceTreeElement
 XalanSourceTreeElement (MemoryManagerType &theManager, const XalanDOMString &theTagName, XalanSourceTreeDocument *theOwnerDocument, XalanNode *theParentNode=0, XalanNode *thePreviousSibling=0, XalanNode *theNextSibling=0, IndexType theIndex=0)
 Constructor. More...
 
virtual ~XalanSourceTreeElement ()
 
MemoryManagerTypegetMemoryManager ()
 
virtual const XalanDOMStringgetNodeName () const
 Gets the name of this node. More...
 
virtual const XalanDOMStringgetNodeValue () const
 Gets the value of this node, depending on its type. More...
 
virtual NodeType getNodeType () const
 An enum value representing the type of the underlying object. More...
 
virtual XalanNodegetParentNode () const
 Gets the parent of this node. More...
 
virtual const XalanNodeListgetChildNodes () const
 Gets a NodeList that contains all children of this node. More...
 
virtual XalanNodegetFirstChild () const
 Gets the first child of this node. More...
 
virtual XalanNodegetLastChild () const
 Gets the last child of this node. More...
 
virtual XalanNodegetPreviousSibling () const
 Gets the node immediately preceding this node. More...
 
virtual XalanNodegetNextSibling () const
 Gets the node immediately following this node. More...
 
virtual XalanDocumentgetOwnerDocument () const
 Gets the DOM_Document object associated with this node. More...
 
virtual const XalanDOMStringgetTagName () const
 The name of the element. More...
 
virtual XalanNodeListgetElementsByTagName (const XalanDOMString &name) const
 Returns a NodeList of all descendant elements with a given tag name, in the order in which they would be encountered in a preorder traversal of the DOM_Element tree. More...
 
XalanSourceTreeDocumentgetDocument () const
 
void setParent (XalanSourceTreeElement *theParent)
 
void setParent (XalanSourceTreeDocumentFragment *theParent)
 
void setPreviousSibling (XalanSourceTreeComment *thePreviousSibling)
 
void setPreviousSibling (XalanSourceTreeElement *thePreviousSibling)
 
void setPreviousSibling (XalanSourceTreeProcessingInstruction *thePreviousSibling)
 
void setPreviousSibling (XalanSourceTreeText *thePreviousSibling)
 
void appendSiblingNode (XalanSourceTreeComment *theSibling)
 
void appendSiblingNode (XalanSourceTreeElement *theSibling)
 
void appendSiblingNode (XalanSourceTreeProcessingInstruction *theSibling)
 
void appendSiblingNode (XalanSourceTreeText *theSibling)
 
void appendChildNode (XalanSourceTreeComment *theChild)
 
void appendChildNode (XalanSourceTreeElement *theChild)
 
void appendChildNode (XalanSourceTreeProcessingInstruction *theChild)
 
void appendChildNode (XalanSourceTreeText *theChild)
 
void setIndex (IndexType theIndex)
 
void clearChildren ()
 Removes all of the children. More...
 
virtual XalanNodeinsertBefore (XalanNode *newChild, XalanNode *refChild)
 Inserts the node newChild before the existing child node refChild. More...
 
virtual XalanNodereplaceChild (XalanNode *newChild, XalanNode *oldChild)
 Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node. More...
 
virtual XalanNoderemoveChild (XalanNode *oldChild)
 Removes the child node indicated by oldChild from the list of children, and returns it. More...
 
virtual XalanNodeappendChild (XalanNode *newChild)
 Adds the node newChild to the end of the list of children of this node. More...
 
virtual bool hasChildNodes () const
 This is a convenience method to allow easy determination of whether a node has any children. More...
 
virtual void setNodeValue (const XalanDOMString &nodeValue)
 Sets the value of the node. More...
 
virtual void setAttribute (const XalanDOMString &name, const XalanDOMString &value)
 Adds a new attribute. More...
 
virtual XalanAttrsetAttributeNode (XalanAttr *newAttr)
 Adds a new attribute. More...
 
virtual void normalize ()
 Puts all DOM_Text nodes in the full depth of the sub-tree underneath this DOM_Node, including attribute nodes, into a "normal" form where only markup (e.g., tags, comments, processing instructions, CDATA sections, and entity references) separates DOM_Text nodes, i.e., there are no adjacent DOM_Text nodes. More...
 
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. More...
 
virtual void setPrefix (const XalanDOMString &prefix)
 Set the namespace prefix of this node. More...
 
virtual bool isIndexed () const
 Determine if the document is node-order indexed. More...
 
virtual IndexType getIndex () const
 Get the node's index. More...
 
virtual void setAttributeNS (const XalanDOMString &namespaceURI, const XalanDOMString &qualifiedName, const XalanDOMString &value)
 Adds a new attribute. More...
 
virtual void removeAttributeNS (const XalanDOMString &namespaceURI, const XalanDOMString &localName)
 Removes an attribute by local name and namespace URI. More...
 
virtual XalanAttrsetAttributeNodeNS (XalanAttr *newAttr)
 Adds a new attribute. More...
 
virtual XalanNodeListgetElementsByTagNameNS (const XalanDOMString &namespaceURI, const XalanDOMString &localName) const
 Returns a DOM_NodeList of all the DOM_Elements with a given local name and namespace URI in the order in which they would be encountered in a preorder traversal of the DOM_Document tree, starting from this node. More...
 
virtual XalanAttrremoveAttributeNode (XalanAttr *oldAttr)
 Removes the specified attribute node. More...
 
virtual void removeAttribute (const XalanDOMString &name)
 Removes an attribute by name. More...
 
- Public Member Functions inherited from XalanElement
 XalanElement ()
 
virtual ~XalanElement ()
 
- Public Member Functions inherited from XalanNode
 XalanNode ()
 
virtual ~XalanNode ()
 

Protected Member Functions

 XalanSourceTreeElementA (MemoryManagerType &theManager, const XalanSourceTreeElementA &theSource, bool deep=false)
 
- Protected Member Functions inherited from XalanSourceTreeElement
 XalanSourceTreeElement (MemoryManagerType &theManager, const XalanSourceTreeElement &theSource, bool deep=false)
 
- Protected Member Functions inherited from XalanElement
 XalanElement (const XalanElement &theSource)
 
XalanElementoperator= (const XalanElement &theSource)
 
bool operator== (const XalanElement &theRHS) const
 
- Protected Member Functions inherited from XalanNode
 XalanNode (const XalanNode &theSource)
 
XalanNodeoperator= (const XalanNode &theSource)
 
bool operator== (const XalanNode &theRHS) const
 

Static Protected Member Functions

static XalanSourceTreeElementAcreate (MemoryManagerType &theManager, const XalanSourceTreeElementA &theSource, bool deep=false)
 

Additional Inherited Members

- Protected Attributes inherited from XalanSourceTreeElement
const XalanDOMStringm_tagName
 
- Static Protected Attributes inherited from XalanSourceTreeElement
static const XalanDOMString s_emptyString
 

Member Typedef Documentation

Constructor & Destructor Documentation

XalanSourceTreeElementA::XalanSourceTreeElementA ( MemoryManagerType theManager,
const XalanDOMString theTagName,
XalanSourceTreeDocument theOwnerDocument,
XalanSourceTreeAttr **  theAttributes,
AttributesCountType  theAttributeCount,
XalanNode theParentNode = 0,
XalanNode thePreviousSibling = 0,
XalanNode theNextSibling = 0,
IndexType  theIndex = 0 
)

Constructor.

Parameters
theTagNameThe tag name of the element
theOwnerDocumentThe document that owns the instance
theAttributesAn array of pointers to the attribute instances for the element
theAttributeCountThe number of attributes.
theParentNodeThe parent node, if any.
thePreviousSiblingThe previous sibling, if any.
theNextSiblingThe next sibling, if any.
theIndexThe document-order index of the node.
virtual XalanSourceTreeElementA::~XalanSourceTreeElementA ( )
virtual
XalanSourceTreeElementA::XalanSourceTreeElementA ( MemoryManagerType theManager,
const XalanSourceTreeElementA theSource,
bool  deep = false 
)
protected

Member Function Documentation

XalanSourceTreeElementA* XalanSourceTreeElementA::clone ( bool  deep) const
virtual XalanSourceTreeElementA* XalanSourceTreeElementA::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
deepIf 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 XalanSourceTreeElement.

Reimplemented in XalanSourceTreeElementANS.

static XalanSourceTreeElementA* XalanSourceTreeElementA::create ( MemoryManagerType theManager,
const XalanSourceTreeElementA theSource,
bool  deep = false 
)
staticprotected
virtual const XalanDOMString& XalanSourceTreeElementA::getAttribute ( const XalanDOMString name) const
virtual

Retrieves an attribute value by name.

Parameters
nameThe name of the attribute to retrieve.
Returns
The DOM_Attr value as a string, or the empty string if that attribute does not have a specified or default value.

Implements XalanSourceTreeElement.

XalanSourceTreeAttr* XalanSourceTreeElementA::getAttributeByIndex ( AttributesCountType  index) const
AttributesCountType XalanSourceTreeElementA::getAttributeCount ( ) const
virtual XalanAttr* XalanSourceTreeElementA::getAttributeNode ( const XalanDOMString name) const
virtual

Retrieves an DOM_Attr node by name.

Parameters
nameThe name (nodeName) of the attribute to retrieve.
Returns
The DOM_Attr node with the specified name (nodeName) or null if there is no such attribute.

Implements XalanSourceTreeElement.

virtual XalanAttr* XalanSourceTreeElementA::getAttributeNodeNS ( const XalanDOMString namespaceURI,
const XalanDOMString localName 
) const
virtual

Retrieves an DOM_Attr node by local name and namespace URI.

Parameters
namespaceURIThe namespace URI of the attribute to retrieve.
localNameThe local name of the attribute to retrieve.
Returns
The DOM_Attr node with the specified attribute local name and namespace URI or null if there is no such attribute.

Implements XalanSourceTreeElement.

virtual const XalanDOMString& XalanSourceTreeElementA::getAttributeNS ( const XalanDOMString namespaceURI,
const XalanDOMString localName 
) const
virtual

Retrieves an attribute value by local name and namespace URI.

Parameters
namespaceURIThe namespace URI of the attribute to retrieve.
localNameThe local name of the attribute to retrieve.
Returns
The DOM_Attr value as a string, or an empty string if that attribute does not have a specified or default value.

Implements XalanSourceTreeElement.

virtual const XalanNamedNodeMap* XalanSourceTreeElementA::getAttributes ( ) const
virtual

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

Implements XalanSourceTreeElement.

virtual const XalanDOMString& XalanSourceTreeElementA::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 DOM_Document interface, it is null.

Implements XalanSourceTreeElement.

Reimplemented in XalanSourceTreeElementANS.

virtual const XalanDOMString& XalanSourceTreeElementA::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 XalanSourceTreeElement.

Reimplemented in XalanSourceTreeElementANS.

virtual const XalanDOMString& XalanSourceTreeElementA::getPrefix ( ) const
virtual

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

Implements XalanSourceTreeElement.

Reimplemented in XalanSourceTreeElementANS.


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.

dot

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

Apache Logo