Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


Public Types | Public Member Functions | Static Public Member Functions

XalanSourceTreeDocument Class Reference

#include <XalanSourceTreeDocument.hpp>

Inherits XalanDocument.

Collaboration diagram for XalanSourceTreeDocument:
Collaboration graph
[legend]

List of all members.

Public Types

Public Member Functions

Static Public Member Functions


Detailed Description

Definition at line 75 of file XalanSourceTreeDocument.hpp.


Member Typedef Documentation

Definition at line 119 of file XalanSourceTreeDocument.hpp.

Definition at line 79 of file XalanSourceTreeDocument.hpp.

Definition at line 120 of file XalanSourceTreeDocument.hpp.

Definition at line 121 of file XalanSourceTreeDocument.hpp.

Definition at line 122 of file XalanSourceTreeDocument.hpp.

Definition at line 83 of file XalanSourceTreeDocument.hpp.

Definition at line 87 of file XalanSourceTreeDocument.hpp.


Member Enumeration Documentation

anonymous enum
Enumerator:
eDefaultAttributeAllocatorBlockSize 
eDefaultAttributeNSAllocatorBlockSize 
eDefaultCommentAllocatorBlockSize 
eDefaultElementAllocatorBlockSize 
eDefaultElementNSAllocatorBlockSize 
eDefaultPIAllocatorBlockSize 
eDefaultTextAllocatorBlockSize 
eDefaultTextIWSAllocatorBlockSize 
eDefaultNamesStringPoolBlockSize 
eDefaultNamesStringPoolBucketCount 
eDefaultNamesStringPoolBucketSize 
eDefaultValuesStringPoolBlockSize 
eDefaultValuesStringPoolBucketCount 
eDefaultValuesStringPoolBucketSize 

Definition at line 103 of file XalanSourceTreeDocument.hpp.


Constructor & Destructor Documentation

XalanSourceTreeDocument::XalanSourceTreeDocument ( MemoryManager &  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 ( MemoryManager &  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

void XalanSourceTreeDocument::appendChildNode ( XalanSourceTreeComment theChild  ) 
void XalanSourceTreeDocument::appendChildNode ( XalanSourceTreeElement theChild  ) 
void XalanSourceTreeDocument::appendChildNode ( XalanSourceTreeProcessingInstruction theChild  ) 
static XalanSourceTreeDocument* XalanSourceTreeDocument::create ( MemoryManager &  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]
XalanSourceTreeComment* XalanSourceTreeDocument::createCommentNode ( const XalanDOMChar *  data,
XalanDOMString::size_type  length,
XalanNode theParentNode = 0,
XalanNode thePreviousSibling = 0,
XalanNode theNextSibling = 0 
)
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 *  tagName,
const AttributeListType attrs,
const PrefixResolver thePrefixResolver,
XalanNode theParentNode = 0,
XalanNode thePreviousSibling = 0,
XalanNode theNextSibling = 0,
bool  fAddXMLNamespaceAttribute = false 
)
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 *  name,
const AttributeListType attrs,
XalanNode theParentNode = 0,
XalanNode thePreviousSibling = 0,
XalanNode theNextSibling = 0,
bool  fAddXMLNamespaceAttribute = false 
)
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 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.

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.

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

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 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]

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

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.

static bool XalanSourceTreeDocument::getPoolAllTextNodes (  )  [inline, static]

Definition at line 247 of file XalanSourceTreeDocument.hpp.

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
static void XalanSourceTreeDocument::initialize ( MemoryManager &  theManager  )  [static]

Perform static initialization.

See class XalanSourceTreeInit.

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.

static void XalanSourceTreeDocument::setPoolAllTextNodes ( bool  fPool  )  [inline, static]

Definition at line 253 of file XalanSourceTreeDocument.hpp.

static 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:

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