xalanc::XercesDocumentBridge Class Reference

This class is deprecated. More...

#include <xalanc/XercesParserLiaison/Deprecated/XercesDocumentBridge.hpp>

Inheritance diagram for xalanc::XercesDocumentBridge:

Collaboration diagram for xalanc::XercesDocumentBridge:

Classes
class	BuildBridgeTreeWalker

Public Types
typedef XalanDeque< XercesBridgeNavigator >	NavigatorBridgeVectorType
typedef XalanDeque< XalanNode * >	NodeVectorType
Public Types inherited from xalanc::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
	XercesDocumentBridge (const DOM_Document_Type &theXercesDocument, bool threadSafe=true, bool buildBridge=true)
	Constructor for XercesDocumentBridge. More...
virtual	~XercesDocumentBridge ()
virtual const XalanDOMString &	getNodeName () const
	Gets the name of this node, depending on its type. More...
virtual const XalanDOMString &	getNodeValue () 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 XalanNode *	getParentNode () const
	Gets the parent of this node. More...
virtual const XalanNodeList *	getChildNodes () const
	Gets a NodeList that contains all children of this node. More...
virtual XalanNode *	getFirstChild () const
	Gets the first child of this node. More...
virtual XalanNode *	getLastChild () const
	Gets the last child of this node. More...
virtual XalanNode *	getPreviousSibling () const
	Gets the node immediately preceding this node. More...
virtual XalanNode *	getNextSibling () const
	Gets the node immediately following this node. More...
virtual const XalanNamedNodeMap *	getAttributes () const
	Gets a NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise. More...
virtual XalanDocument *	getOwnerDocument () const
	Gets the Document object associated with this node. More...
virtual XercesDocumentBridge *	cloneNode (bool deep) const
virtual XalanNode *	insertBefore (XalanNode *newChild, XalanNode *refChild)
virtual XalanNode *	replaceChild (XalanNode *newChild, XalanNode *oldChild)
virtual XalanNode *	removeChild (XalanNode *oldChild)
virtual XalanNode *	appendChild (XalanNode *newChild)
virtual bool	hasChildNodes () const
virtual void	setNodeValue (const XalanDOMString &nodeValue)
virtual void	normalize ()
virtual bool	isSupported (const XalanDOMString &feature, const XalanDOMString &version) const
virtual const XalanDOMString &	getNamespaceURI () const
	Get the namespace URI of this node, or null if it is unspecified. More...
virtual const XalanDOMString &	getPrefix () const
	Get the namespace prefix of this node, or null if it is unspecified. More...
virtual const XalanDOMString &	getLocalName () const
	Returns the local part of the qualified name of this node. More...
virtual void	setPrefix (const XalanDOMString &prefix)
virtual bool	isIndexed () const
	Determine if the document is node-order indexed. More...
virtual IndexType	getIndex () const
	Get the node's index. More...
virtual XalanElement *	createElement (const XalanDOMString &tagName)
virtual XalanDocumentFragment *	createDocumentFragment ()
virtual XalanText *	createTextNode (const XalanDOMString &data)
virtual XalanComment *	createComment (const XalanDOMString &data)
virtual XalanCDATASection *	createCDATASection (const XalanDOMString &data)
virtual XalanProcessingInstruction *	createProcessingInstruction (const XalanDOMString &target, const XalanDOMString &data)
virtual XalanAttr *	createAttribute (const XalanDOMString &name)
virtual XalanEntityReference *	createEntityReference (const XalanDOMString &name)
virtual XalanDocumentType *	getDoctype () const
virtual XalanDOMImplementation *	getImplementation () const
virtual XalanElement *	getDocumentElement () const
	Return a reference to the root element of the document. More...
virtual XalanNodeList *	getElementsByTagName (const XalanDOMString &tagname) const
virtual XalanNode *	importNode (XalanNode *importedNode, bool deep)
virtual XalanElement *	createElementNS (const XalanDOMString &namespaceURI, const XalanDOMString &qualifiedName)
virtual XalanAttr *	createAttributeNS (const XalanDOMString &namespaceURI, const XalanDOMString &qualifiedName)
virtual XalanNodeList *	getElementsByTagNameNS (const XalanDOMString &namespaceURI, const XalanDOMString &localName) const
virtual XalanElement *	getElementById (const XalanDOMString &elementId) const
	Returns the Element whose ID is given by elementId. More...
void	destroyBridge ()
	Destroy the entire bridge structure that connects the Xerces document to this XercesDocumentBridge instance. More...
void	rebuildBridge ()
	Rebuild the entire bridge structure that connects the Xerces document to this XercesDocumentBridge instance. More...
XalanNode *	mapNode (const DOM_NodeType &theXercesNode) const
XalanAttr *	mapNode (const DOM_AttrType &theXercesNode) const
XalanElement *	mapNode (const DOM_ElementType &theXercesNode) const
DOM_NodeType	mapNode (const XalanNode *theXalanNode) const
DOM_AttrType	mapNode (const XalanAttr *theXalanNode) const
NodeImplType *	mapNodeToImpl (const XalanNode *theXalanNode) const
DOM_Document_Type	getXercesDocument () const
	Get the Xerces DOM_Document that this XercesDocument represents. More...
void	buildBridgeNodes ()
	Build the entire bridge structure. More...
const XalanDOMString &	getPooledString (const XalanDOMString &theString) const
	Get a pooled string. More...
const XalanDOMString &	getPooledString (const XalanDOMChar *theString, XalanDOMString::size_type theLength) const
	Get a pooled string. More...
Public Member Functions inherited from xalanc::XalanDocument
	XalanDocument ()
virtual	~XalanDocument ()
Public Member Functions inherited from xalanc::XalanNode
	XalanNode ()
virtual	~XalanNode ()

Friends
class	XercesBridgeNavigator
class	BuildBridgeTreeWalker

Additional Inherited Members
Protected Member Functions inherited from xalanc::XalanDocument
	XalanDocument (const XalanDocument &theSource)
XalanDocument &	operator= (const XalanDocument &theSource)
bool	operator== (const XalanDocument &theRHS) const
Protected Member Functions inherited from xalanc::XalanNode
	XalanNode (const XalanNode &theSource)
XalanNode &	operator= (const XalanNode &theSource)
bool	operator== (const XalanNode &theRHS) const

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

NavigatorBridgeVectorType

typedef XalanDeque<XercesBridgeNavigator> xalanc::XercesDocumentBridge::NavigatorBridgeVectorType

Definition at line 330 of file XercesDocumentBridge.hpp.

NodeVectorType

typedef XalanDeque<XalanNode*> xalanc::XercesDocumentBridge::NodeVectorType

Definition at line 331 of file XercesDocumentBridge.hpp.

Constructor & Destructor Documentation

XercesDocumentBridge()

xalanc::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.

~XercesDocumentBridge()

virtual xalanc::XercesDocumentBridge::~XercesDocumentBridge ( )

virtual

Member Function Documentation

appendChild()

virtual XalanNode* xalanc::XercesDocumentBridge::appendChild ( XalanNode *  newChild )

virtual

buildBridgeNodes()

void xalanc::XercesDocumentBridge::buildBridgeNodes

(

)

Build the entire bridge structure.

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

cloneNode()

virtual XercesDocumentBridge* xalanc::XercesDocumentBridge::cloneNode ( bool  deep ) const

virtual

createAttribute()

virtual XalanAttr* xalanc::XercesDocumentBridge::createAttribute ( const XalanDOMString &  name )

virtual

createAttributeNS()

virtual XalanAttr* xalanc::XercesDocumentBridge::createAttributeNS ( const XalanDOMString &  namespaceURI, const XalanDOMString &  qualifiedName  )

virtual

createCDATASection()

virtual XalanCDATASection* xalanc::XercesDocumentBridge::createCDATASection ( const XalanDOMString &  data )

virtual

createComment()

virtual XalanComment* xalanc::XercesDocumentBridge::createComment ( const XalanDOMString &  data )

virtual

createDocumentFragment()

virtual XalanDocumentFragment* xalanc::XercesDocumentBridge::createDocumentFragment ( )

virtual

createElement()

virtual XalanElement* xalanc::XercesDocumentBridge::createElement ( const XalanDOMString &  tagName )

virtual

createElementNS()

virtual XalanElement* xalanc::XercesDocumentBridge::createElementNS ( const XalanDOMString &  namespaceURI, const XalanDOMString &  qualifiedName  )

virtual

createEntityReference()

virtual XalanEntityReference* xalanc::XercesDocumentBridge::createEntityReference ( const XalanDOMString &  name )

virtual

createProcessingInstruction()

virtual XalanProcessingInstruction* xalanc::XercesDocumentBridge::createProcessingInstruction ( const XalanDOMString &  target, const XalanDOMString &  data  )

virtual

createTextNode()

virtual XalanText* xalanc::XercesDocumentBridge::createTextNode ( const XalanDOMString &  data )

virtual

destroyBridge()

void xalanc::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).

getAttributes()

virtual const XalanNamedNodeMap* xalanc::XercesDocumentBridge::getAttributes ( ) const

virtual

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

Implements xalanc::XalanDocument.

getChildNodes()

virtual const XalanNodeList* xalanc::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 xalanc::XalanDocument.

getDoctype()

virtual XalanDocumentType* xalanc::XercesDocumentBridge::getDoctype ( ) const

virtual

getDocumentElement()

virtual XalanElement* xalanc::XercesDocumentBridge::getDocumentElement ( ) const

virtual

Return a reference to the root element of the document.

Implements xalanc::XalanDocument.

getElementById()

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

getElementsByTagName()

virtual XalanNodeList* xalanc::XercesDocumentBridge::getElementsByTagName ( const XalanDOMString &  tagname ) const

virtual

getElementsByTagNameNS()

virtual XalanNodeList* xalanc::XercesDocumentBridge::getElementsByTagNameNS ( const XalanDOMString &  namespaceURI, const XalanDOMString &  localName  ) const

virtual

getFirstChild()

virtual XalanNode* xalanc::XercesDocumentBridge::getFirstChild ( ) const

virtual

Gets the first child of this node.

If there is no such node, this returns null.

Implements xalanc::XalanDocument.

getImplementation()

virtual XalanDOMImplementation* xalanc::XercesDocumentBridge::getImplementation ( ) const

virtual

getIndex()

virtual IndexType xalanc::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 xalanc::XalanDocument.

getLastChild()

virtual XalanNode* xalanc::XercesDocumentBridge::getLastChild ( ) const

virtual

Gets the last child of this node.

If there is no such node, this returns null.

Implements xalanc::XalanDocument.

getLocalName()

virtual const XalanDOMString& xalanc::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 xalanc::XalanDocument.

getNamespaceURI()

virtual const XalanDOMString& xalanc::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 xalanc::XalanDocument.

getNextSibling()

virtual XalanNode* xalanc::XercesDocumentBridge::getNextSibling ( ) const

virtual

Gets the node immediately following this node.

If there is no such node, this returns null.

Implements xalanc::XalanDocument.

getNodeName()

virtual const XalanDOMString& xalanc::XercesDocumentBridge::getNodeName ( ) const

virtual

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

Implements xalanc::XalanDocument.

getNodeType()

virtual NodeType xalanc::XercesDocumentBridge::getNodeType ( ) const

virtual

An enum value representing the type of the underlying object.

Implements xalanc::XalanDocument.

getNodeValue()

virtual const XalanDOMString& xalanc::XercesDocumentBridge::getNodeValue ( ) const

virtual

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

Implements xalanc::XalanDocument.

getOwnerDocument()

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

getParentNode()

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

getPooledString() [1/2]

const XalanDOMString& xalanc::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.

getPooledString() [2/2]

const XalanDOMString& xalanc::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.

getPrefix()

virtual const XalanDOMString& xalanc::XercesDocumentBridge::getPrefix ( ) const

virtual

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

Implements xalanc::XalanDocument.

getPreviousSibling()

virtual XalanNode* xalanc::XercesDocumentBridge::getPreviousSibling ( ) const

virtual

Gets the node immediately preceding this node.

If there is no such node, this returns null.

Implements xalanc::XalanDocument.

getXercesDocument()

DOM_Document_Type xalanc::XercesDocumentBridge::getXercesDocument ( ) const

inline

Get the Xerces DOM_Document that this XercesDocument represents.

Returns

the Xerces DOM_Document instance.

Definition at line 316 of file XercesDocumentBridge.hpp.

hasChildNodes()

virtual bool xalanc::XercesDocumentBridge::hasChildNodes ( ) const

virtual

importNode()

virtual XalanNode* xalanc::XercesDocumentBridge::importNode ( XalanNode *  importedNode, bool  deep  )

virtual

insertBefore()

virtual XalanNode* xalanc::XercesDocumentBridge::insertBefore ( XalanNode *  newChild, XalanNode *  refChild  )

virtual

isIndexed()

virtual bool xalanc::XercesDocumentBridge::isIndexed ( ) const

virtual

Determine if the document is node-order indexed.

Returns

true if the document is indexed, otherwise false.

Implements xalanc::XalanDocument.

isSupported()

virtual bool xalanc::XercesDocumentBridge::isSupported ( const XalanDOMString &  feature, const XalanDOMString &  version  ) const

virtual

mapNode() [1/5]

XalanAttr* xalanc::XercesDocumentBridge::mapNode

(

const DOM_AttrType &

theXercesNode

)

const

mapNode() [2/5]

XalanElement* xalanc::XercesDocumentBridge::mapNode

(

const DOM_ElementType &

theXercesNode

)

const

mapNode() [3/5]

XalanNode* xalanc::XercesDocumentBridge::mapNode

(

const DOM_NodeType &

theXercesNode

)

const

mapNode() [4/5]

DOM_AttrType xalanc::XercesDocumentBridge::mapNode

(

const XalanAttr *

theXalanNode

)

const

mapNode() [5/5]

DOM_NodeType xalanc::XercesDocumentBridge::mapNode

(

const XalanNode *

theXalanNode

)

const

mapNodeToImpl()

NodeImplType* xalanc::XercesDocumentBridge::mapNodeToImpl

(

const XalanNode *

theXalanNode

)

const

normalize()

virtual void xalanc::XercesDocumentBridge::normalize ( )

virtual

rebuildBridge()

void xalanc::XercesDocumentBridge::rebuildBridge

(

)

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

This destroys the bridge before rebuilding.

removeChild()

virtual XalanNode* xalanc::XercesDocumentBridge::removeChild ( XalanNode *  oldChild )

virtual

replaceChild()

virtual XalanNode* xalanc::XercesDocumentBridge::replaceChild ( XalanNode *  newChild, XalanNode *  oldChild  )

virtual

setNodeValue()

virtual void xalanc::XercesDocumentBridge::setNodeValue ( const XalanDOMString &  nodeValue )

virtual

setPrefix()

virtual void xalanc::XercesDocumentBridge::setPrefix ( const XalanDOMString &  prefix )

virtual

Friends And Related Function Documentation

BuildBridgeTreeWalker

friend class BuildBridgeTreeWalker

friend

Definition at line 519 of file XercesDocumentBridge.hpp.

XercesBridgeNavigator

friend class XercesBridgeNavigator

friend

Definition at line 96 of file XercesDocumentBridge.hpp.

---

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

• xalanc/XercesParserLiaison/Deprecated/XercesDocumentBridge.hpp