Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


Classes | Public Types | Public Member Functions | Friends

XercesDocumentBridge Class Reference

This class is deprecated. More...

#include <XercesDocumentBridge.hpp>

Inherits XalanDocument.

Collaboration diagram for XercesDocumentBridge:
Collaboration graph
[legend]

List of all members.

Classes

Public Types

Public Member Functions

Friends


Detailed Description

This class is deprecated.

Deprecated:
This class is part of the deprecated Xerces DOM bridge.

Definition at line 92 of file XercesDocumentBridge.hpp.


Member Typedef Documentation

Definition at line 334 of file XercesDocumentBridge.hpp.

Definition at line 335 of file XercesDocumentBridge.hpp.


Constructor & Destructor Documentation

XercesDocumentBridge::XercesDocumentBridge ( const DOM_Document_Type theXercesDocument,
bool  threadSafe = true,
bool  buildBridge = true 
)

Constructor for XercesDocumentBridge.

If the document will be shared amongst multiple threads of execution, the parameter buildBridge must be true. Otherwise, the bridge nodes will be built on demand, a process which is not synchronized. This could cause serious problems if multiple threads tried to visit an unbuilt node at the same time.

Parameters:
theXercesDocument The Xerces document to bridge
threadSafe If true, the tree can safely be shared amongst multiple threads. (Also implies buildBridge == true)
buildBridge If true, all of the bridge nodes will be built during construction.
virtual XercesDocumentBridge::~XercesDocumentBridge (  )  [virtual]

Member Function Documentation

virtual XalanNode* XercesDocumentBridge::appendChild ( XalanNode newChild  )  [virtual]
void XercesDocumentBridge::buildBridgeNodes (  ) 

Build the entire bridge structure.

This should be done before any processing begins, if the tree will be shared amongst multiple threads.

virtual XercesDocumentBridge* XercesDocumentBridge::cloneNode ( bool  deep  )  const [virtual]
virtual XalanAttr* XercesDocumentBridge::createAttribute ( const XalanDOMString name  )  [virtual]
virtual XalanAttr* XercesDocumentBridge::createAttributeNS ( const XalanDOMString namespaceURI,
const XalanDOMString qualifiedName 
) [virtual]
virtual XalanCDATASection* XercesDocumentBridge::createCDATASection ( const XalanDOMString data  )  [virtual]
virtual XalanComment* XercesDocumentBridge::createComment ( const XalanDOMString data  )  [virtual]
virtual XalanDocumentFragment* XercesDocumentBridge::createDocumentFragment (  )  [virtual]
virtual XalanElement* XercesDocumentBridge::createElement ( const XalanDOMString tagName  )  [virtual]
virtual XalanElement* XercesDocumentBridge::createElementNS ( const XalanDOMString namespaceURI,
const XalanDOMString qualifiedName 
) [virtual]
virtual XalanEntityReference* XercesDocumentBridge::createEntityReference ( const XalanDOMString name  )  [virtual]
virtual XalanProcessingInstruction* XercesDocumentBridge::createProcessingInstruction ( const XalanDOMString target,
const XalanDOMString data 
) [virtual]
virtual XalanText* XercesDocumentBridge::createTextNode ( const XalanDOMString data  )  [virtual]
void XercesDocumentBridge::destroyBridge (  ) 

Destroy the entire bridge structure that connects the Xerces document to this XercesDocumentBridge instance.

This will invalidate any pointers to any nodes in the document (except, of course, the document itself).

virtual const XalanNamedNodeMap* XercesDocumentBridge::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* XercesDocumentBridge::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.

Implements XalanDocument.

virtual XalanDocumentType* XercesDocumentBridge::getDoctype (  )  const [virtual]
virtual XalanElement* XercesDocumentBridge::getDocumentElement (  )  const [virtual]

Return a reference to the root element of the document.

Implements XalanDocument.

virtual XalanElement* XercesDocumentBridge::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.

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

Implements XalanDocument.

virtual XalanNodeList* XercesDocumentBridge::getElementsByTagName ( const XalanDOMString tagname  )  const [virtual]
virtual XalanNodeList* XercesDocumentBridge::getElementsByTagNameNS ( const XalanDOMString namespaceURI,
const XalanDOMString localName 
) const [virtual]
virtual XalanNode* XercesDocumentBridge::getFirstChild (  )  const [virtual]

Gets the first child of this node.

If there is no such node, this returns null.

Implements XalanDocument.

virtual XalanDOMImplementation* XercesDocumentBridge::getImplementation (  )  const [virtual]
virtual IndexType XercesDocumentBridge::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* XercesDocumentBridge::getLastChild (  )  const [virtual]

Gets the last child of this node.

If there is no such node, this returns null.

Implements XalanDocument.

virtual const XalanDOMString& XercesDocumentBridge::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& XercesDocumentBridge::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* XercesDocumentBridge::getNextSibling (  )  const [virtual]

Gets the node immediately following this node.

If there is no such node, this returns null.

Implements XalanDocument.

virtual const XalanDOMString& XercesDocumentBridge::getNodeName (  )  const [virtual]

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

Implements XalanDocument.

virtual NodeType XercesDocumentBridge::getNodeType (  )  const [virtual]

An enum value representing the type of the underlying object.

Implements XalanDocument.

virtual const XalanDOMString& XercesDocumentBridge::getNodeValue (  )  const [virtual]

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

Implements XalanDocument.

virtual XalanDocument* XercesDocumentBridge::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* XercesDocumentBridge::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.

const XalanDOMString& XercesDocumentBridge::getPooledString ( const XalanDOMString theString  )  const

Get a pooled string.

If the string is not in the pool, add it.

Parameters:
theString The string to pool.
Returns:
A const reference to the pooled string.
const XalanDOMString& XercesDocumentBridge::getPooledString ( const XalanDOMChar *  theString,
XalanDOMString::size_type  theLength 
) const

Get a pooled string.

If the string is not in the pool, add it.

Parameters:
theString The string to pool.
theLength The length of the string. If XalanDOMString::npos, the string is assumed to be null-terminated.
Returns:
A const reference to the pooled string.
virtual const XalanDOMString& XercesDocumentBridge::getPrefix (  )  const [virtual]

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

Implements XalanDocument.

virtual XalanNode* XercesDocumentBridge::getPreviousSibling (  )  const [virtual]

Gets the node immediately preceding this node.

If there is no such node, this returns null.

Implements XalanDocument.

DOM_Document_Type XercesDocumentBridge::getXercesDocument (  )  const [inline]

Get the Xerces DOM_Document that this XercesDocument represents.

Returns:
the Xerces DOM_Document instance.

Definition at line 320 of file XercesDocumentBridge.hpp.

virtual bool XercesDocumentBridge::hasChildNodes (  )  const [virtual]
virtual XalanNode* XercesDocumentBridge::importNode ( XalanNode importedNode,
bool  deep 
) [virtual]
virtual XalanNode* XercesDocumentBridge::insertBefore ( XalanNode newChild,
XalanNode refChild 
) [virtual]
virtual bool XercesDocumentBridge::isIndexed (  )  const [virtual]

Determine if the document is node-order indexed.

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

Implements XalanDocument.

virtual bool XercesDocumentBridge::isSupported ( const XalanDOMString feature,
const XalanDOMString version 
) const [virtual]
DOM_NodeType XercesDocumentBridge::mapNode ( const XalanNode theXalanNode  )  const
XalanElement* XercesDocumentBridge::mapNode ( const DOM_ElementType theXercesNode  )  const
XalanNode* XercesDocumentBridge::mapNode ( const DOM_NodeType theXercesNode  )  const
DOM_AttrType XercesDocumentBridge::mapNode ( const XalanAttr theXalanNode  )  const
XalanAttr* XercesDocumentBridge::mapNode ( const DOM_AttrType theXercesNode  )  const
NodeImplType* XercesDocumentBridge::mapNodeToImpl ( const XalanNode theXalanNode  )  const
virtual void XercesDocumentBridge::normalize (  )  [virtual]
void XercesDocumentBridge::rebuildBridge (  ) 

Rebuild the entire bridge structure that connects the Xerces document to this XercesDocumentBridge instance.

This destroys the bridge before rebuilding.

virtual XalanNode* XercesDocumentBridge::removeChild ( XalanNode oldChild  )  [virtual]
virtual XalanNode* XercesDocumentBridge::replaceChild ( XalanNode newChild,
XalanNode oldChild 
) [virtual]
virtual void XercesDocumentBridge::setNodeValue ( const XalanDOMString nodeValue  )  [virtual]
virtual void XercesDocumentBridge::setPrefix ( const XalanDOMString prefix  )  [virtual]

Friends And Related Function Documentation

friend class BuildBridgeTreeWalker [friend]

Definition at line 523 of file XercesDocumentBridge.hpp.

friend class XercesBridgeNavigator [friend]

Definition at line 96 of file XercesDocumentBridge.hpp.


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