org.apache.xml.dtm.ref
Class DTMDefaultBase

java.lang.Object
  org.apache.xml.dtm.ref.DTMDefaultBase

All Implemented Interfaces:

DTM

Direct Known Subclasses:

DTMDefaultBaseTraversers

public abstract class DTMDefaultBase

extends Object

implements DTM

The DTMDefaultBase class serves as a helper base for DTMs. It sets up structures for navigation and type, while leaving data management and construction to the derived classes.

Field Summary

(package private) static boolean	JJK_DEBUG
protected int	m_blocksize Size of blocks to allocate
protected String	m_documentBaseURI The base URI for this document.
protected SuballocatedIntVector	m_dtmIdent The document identity number(s).
protected int[][][]	m_elemIndexes These hold indexes to elements based on namespace and local name.
protected ExpandedNameTable	m_expandedNameTable The table for exandedNameID lookups.
protected SuballocatedIntVector	m_exptype The expanded names, one array element for each node.
protected SuballocatedIntVector	m_firstch First child values, one array element for each node.
protected boolean	m_indexing true if indexing is turned on.
protected int	m_initialblocksize The default initial block size of the node arrays
protected DTMManager	m_mgr The DTM manager who "owns" this DTM.
protected DTMManagerDefault	m_mgrDefault m_mgr cast to DTMManagerDefault, or null if it isn't an instance (Efficiency hook)
protected SuballocatedIntVector	m_namespaceDeclSetElements SuballocatedIntVector of elements at which corresponding namespaceDeclSets were defined
protected Vector	m_namespaceDeclSets Vector of SuballocatedIntVectors of NS decl sets
private Vector	m_namespaceLists Lazily created namespace lists.
protected SuballocatedIntVector	m_nextsib Next sibling values, one array element for each node.
protected SuballocatedIntVector	m_parent Previous sibling values, one array element for each node.
protected SuballocatedIntVector	m_prevsib Previous sibling values, one array element for each node.
protected BoolStack	m_shouldStripWhitespaceStack Stack of flags indicating whether to strip whitespace nodes
protected boolean	m_shouldStripWS Flag indicating whether to strip whitespace nodes
protected int	m_size The number of nodes, which is also used to determine the next node index.
protected DTMAxisTraverser[]	m_traversers Stateless axis traversers, lazely built.
protected DTMWSFilter	m_wsfilter The whitespace filter that enables elements to strip whitespace or not.
protected XMLStringFactory	m_xstrf The XMLString factory for creating XMLStrings.
protected static int	NOTPROCESSED The value to use when the information has not been built yet.

Fields inherited from interface org.apache.xml.dtm.DTM

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NAMESPACE_NODE, NOTATION_NODE, NTYPES, NULL, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Constructor Summary

DTMDefaultBase(DTMManager mgr, javax.xml.transform.Source source, int dtmIdentity, DTMWSFilter whiteSpaceFilter, XMLStringFactory xstringfactory, boolean doIndexing)
Construct a DTMDefaultBase object from a DOM node.

Method Summary

protected int	_exptype(int identity) Get the expanded type ID for the given node identity.
protected int	_firstch(int identity) Get the first child for the given node identity.
protected int	_level(int identity) Get the level in the tree for the given node identity.
protected int	_nextsib(int identity) Get the next sibling for the given node identity.
protected int	_parent(int identity) Get the parent for the given node identity.
protected int	_prevsib(int identity) Get the previous sibling for the given node identity.
protected short	_type(int identity) Get the simple type ID for the given node identity.
void	appendChild(int newChild, boolean clone, boolean cloneDepth) Append a child to the end of the document.
void	appendTextChild(String str) Append a text node child that will be constructed from a string, to the end of the document.
protected void	declareNamespaceInContext(int elementNodeIndex, int namespaceNodeIndex) Build table of namespace declaration locations during DTM construction.
abstract void	dispatchCharactersEvents(int nodeHandle, org.xml.sax.ContentHandler ch, boolean normalize) Directly call the characters method on the passed ContentHandler for the string-value of the given node (see http://www.w3.org/TR/xpath#data-model for the definition of a node's string-value).
abstract void	dispatchToEvents(int nodeHandle, org.xml.sax.ContentHandler ch) Directly create SAX parser events from a subtree.
void	documentRegistration() A dummy routine to satisify the abstract interface.
void	documentRelease() A dummy routine to satisify the abstract interface.
void	dumpDTM(OutputStream os) Diagnostics function to dump the DTM.
String	dumpNode(int nodeHandle) Diagnostics function to dump a single node.
protected void	ensureSizeOfIndex(int namespaceID, int LocalNameID) Ensure that the size of the element indexes can hold the information.
protected void	error(String msg) Simple error for asserts and the like.
(package private) int	findElementFromIndex(int nsIndex, int lnIndex, int firstPotential) Find the first matching element from the index at or after the given node.
protected int	findGTE(int[] list, int start, int len, int value) Find the first index that occurs in the list that is greater than or equal to the given value.
protected int	findInSortedSuballocatedIntVector(SuballocatedIntVector vector, int lookfor) Subroutine: Locate the specified node within m_namespaceDeclSetElements, or the last element which preceeds it in document order %REVIEW% Inlne this into findNamespaceContext?
protected SuballocatedIntVector	findNamespaceContext(int elementNodeIndex) Retrieve list of namespace declaration locations active at this node.
abstract int	getAttributeNode(int nodeHandle, String namespaceURI, String name) Retrieves an attribute node by by qualified name and namespace URI.
int	getDocument() Find the Document node handle for the document currently under construction.
boolean	getDocumentAllDeclarationsProcessed() Return an indication of whether the processor has read the complete DTD.
String	getDocumentBaseURI() Return the base URI of the document entity.
String	getDocumentEncoding(int nodeHandle) Return the name of the character encoding scheme in which the document entity is expressed.
int	getDocumentRoot(int nodeHandle) Given a node handle, find the owning document node.
String	getDocumentStandalone(int nodeHandle) Return an indication of the standalone status of the document, either "yes" or "no".
String	getDocumentSystemIdentifier(int nodeHandle) Return the system identifier of the document entity.
abstract String	getDocumentTypeDeclarationPublicIdentifier() Return the public identifier of the external subset, normalized as described in 4.2.2 External Entities [XML].
abstract String	getDocumentTypeDeclarationSystemIdentifier() A document type declaration information item has the following properties: 1.
String	getDocumentVersion(int documentHandle) Return a string representing the XML version of the document.
SuballocatedIntVector	getDTMIDs() Query which DTMIDs this DTM is currently using within the DTMManager.
abstract int	getElementById(String elementId) Returns the Element whose ID is given by elementId.
int	getExpandedTypeID(int nodeHandle) Given a node handle, return an ID that represents the node's expanded name.
int	getExpandedTypeID(String namespace, String localName, int type) Given an expanded name, return an ID.
int	getFirstAttribute(int nodeHandle) Given a node handle, get the index of the node's first attribute.
int	getFirstChild(int nodeHandle) Given a node handle, get the handle of the node's first child.
int	getFirstNamespaceNode(int nodeHandle, boolean inScope) Given a node handle, get the index of the node's first child.
int	getLastChild(int nodeHandle) Given a node handle, advance to its last child.
short	getLevel(int nodeHandle) Get the depth level of this node in the tree (equals 1 for a parentless node).
abstract String	getLocalName(int nodeHandle) Given a node handle, return its XPath-style localname.
String	getLocalNameFromExpandedNameID(int expandedNameID) Given an expanded-name ID, return the local name part.
DTMManager	getManager() Query which DTMManager this DTM is currently being handled by.
String	getNamespaceFromExpandedNameID(int expandedNameID) Given an expanded-name ID, return the namespace URI part.
int	getNamespaceType(int nodeHandle) Returns the namespace type of a specific node
abstract String	getNamespaceURI(int nodeHandle) Given a node handle, return its DOM-style namespace URI (As defined in Namespaces, this is the declared URI which this node's prefix -- or default in lieu thereof -- was mapped to.)
int	getNextAttribute(int nodeHandle) Given a node handle, advance to the next attribute.
int	getNextNamespaceNode(int baseHandle, int nodeHandle, boolean inScope) Given a namespace handle, advance to the next namespace.
protected abstract int	getNextNodeIdentity(int identity) Get the next node identity value in the list, and call the iterator if it hasn't been added yet.
int	getNextSibling(int nodeHandle) Given a node handle, advance to its next sibling.
org.w3c.dom.Node	getNode(int nodeHandle) Return an DOM node for the given node.
abstract String	getNodeName(int nodeHandle) Given a node handle, return its DOM-style node name.
String	getNodeNameX(int nodeHandle) Given a node handle, return the XPath node name.
short	getNodeType(int nodeHandle) Given a node handle, return its DOM-style node type.
abstract String	getNodeValue(int nodeHandle) Given a node handle, return its node value.
protected abstract int	getNumberOfNodes() Get the number of nodes that have been added.
int	getOwnerDocument(int nodeHandle) Given a node handle, find the owning document node.
int	getParent(int nodeHandle) Given a node handle, find its parent node.
abstract String	getPrefix(int nodeHandle) Given a namespace handle, return the prefix that the namespace decl is mapping.
int	getPreviousSibling(int nodeHandle) Given a node handle, find its preceeding sibling.
protected boolean	getShouldStripWhitespace() Find out whether or not to strip whispace nodes.
abstract XMLString	getStringValue(int nodeHandle) Get the string-value of a node as a String object (see http://www.w3.org/TR/xpath#data-model for the definition of a node's string-value).
char[]	getStringValueChunk(int nodeHandle, int chunkIndex, int[] startAndLen) Get a character array chunk in the string-value of a node.
int	getStringValueChunkCount(int nodeHandle) Get number of character array chunks in the string-value of a node.
abstract String	getUnparsedEntityURI(String name) The getUnparsedEntityURI function returns the URI of the unparsed entity with the specified name in the same document as the context node (see [3.3 Unparsed Entities]).
boolean	hasChildNodes(int nodeHandle) Given a node handle, test if it has child nodes.
protected void	indexNode(int expandedTypeID, int identity) Add a node to the element indexes.
abstract boolean	isAttributeSpecified(int attributeHandle) 5.
boolean	isCharacterElementContentWhitespace(int nodeHandle) 2.
boolean	isDocumentAllDeclarationsProcessed(int documentHandle) 10.
boolean	isNodeAfter(int nodeHandle1, int nodeHandle2) Figure out whether nodeHandle2 should be considered as being later in the document than nodeHandle1, in Document Order as defined by the XPath model.
boolean	isSupported(String feature, String version) Tests whether DTM DOM implementation implements a specific feature and that feature is supported by this node.
protected int	makeNodeHandle(int nodeIdentity) Given a node identity, return a node handle.
protected int	makeNodeIdentity(int nodeHandle) Given a node handle, return a node identity.
protected abstract boolean	nextNode() This method should try and build one or more nodes in the table.
protected void	popShouldStripWhitespace() Set whether to strip whitespaces at this point by popping out m_shouldStripWhitespaceStack.
protected void	pushShouldStripWhitespace(boolean shouldStrip) Set whether to strip whitespaces and push in current value of m_shouldStripWS in m_shouldStripWhitespaceStack.
void	setDocumentBaseURI(String baseURI) Set the base URI of the document entity.
void	setFeature(String featureId, boolean state) Set an implementation dependent feature.
protected void	setShouldStripWhitespace(boolean shouldStrip) Set whether to strip whitespaces and set the top of the stack to the current value of m_shouldStripWS.
boolean	supportsPreStripping() Return true if the xsl:strip-space or xsl:preserve-space was processed during construction of the DTM document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.xml.dtm.DTM

getAxisIterator, getAxisTraverser, getContentHandler, getDeclHandler, getDTDHandler, getEntityResolver, getErrorHandler, getLexicalHandler, getSourceLocatorFor, getTypedAxisIterator, needsTwoThreads, setProperty

Field Detail

JJK_DEBUG

static boolean JJK_DEBUG

m_size

protected int m_size

The number of nodes, which is also used to determine the next node index.

m_exptype

protected SuballocatedIntVector m_exptype

The expanded names, one array element for each node.

m_firstch

protected SuballocatedIntVector m_firstch

First child values, one array element for each node.

m_nextsib

protected SuballocatedIntVector m_nextsib

Next sibling values, one array element for each node.

m_prevsib

protected SuballocatedIntVector m_prevsib

Previous sibling values, one array element for each node.

m_parent

protected SuballocatedIntVector m_parent

Previous sibling values, one array element for each node.

m_namespaceDeclSets

protected Vector m_namespaceDeclSets

Vector of SuballocatedIntVectors of NS decl sets

m_namespaceDeclSetElements

protected SuballocatedIntVector m_namespaceDeclSetElements

SuballocatedIntVector of elements at which corresponding namespaceDeclSets were defined

m_elemIndexes

protected int[][][] m_elemIndexes

These hold indexes to elements based on namespace and local name. The base lookup is the the namespace. The second lookup is the local name, and the last array contains the the first free element at the start, and the list of element handles following.

m_initialblocksize

protected int m_initialblocksize

The default initial block size of the node arrays

m_blocksize

protected int m_blocksize

Size of blocks to allocate

NOTPROCESSED

protected static final int NOTPROCESSED

The value to use when the information has not been built yet.

See Also:

Constant Field Values

m_mgr

protected DTMManager m_mgr

The DTM manager who "owns" this DTM.

m_mgrDefault

protected DTMManagerDefault m_mgrDefault

m_mgr cast to DTMManagerDefault, or null if it isn't an instance (Efficiency hook)

m_dtmIdent

protected SuballocatedIntVector m_dtmIdent

The document identity number(s). If we have overflowed the addressing range of the first that was assigned to us, we may add others.

m_documentBaseURI

protected String m_documentBaseURI

The base URI for this document.

m_wsfilter

protected DTMWSFilter m_wsfilter

The whitespace filter that enables elements to strip whitespace or not.

m_shouldStripWS

protected boolean m_shouldStripWS

Flag indicating whether to strip whitespace nodes

m_shouldStripWhitespaceStack

protected BoolStack m_shouldStripWhitespaceStack

Stack of flags indicating whether to strip whitespace nodes

m_xstrf

protected XMLStringFactory m_xstrf

The XMLString factory for creating XMLStrings.

m_expandedNameTable

protected ExpandedNameTable m_expandedNameTable

The table for exandedNameID lookups. This may or may not be the same table as is contained in the DTMManagerDefault.

m_indexing

protected boolean m_indexing

true if indexing is turned on.

m_traversers

protected DTMAxisTraverser[] m_traversers

Stateless axis traversers, lazely built.

m_namespaceLists

private Vector m_namespaceLists

Lazily created namespace lists.

Constructor Detail

DTMDefaultBase

public DTMDefaultBase(DTMManager mgr,
                      javax.xml.transform.Source source,
                      int dtmIdentity,
                      DTMWSFilter whiteSpaceFilter,
                      XMLStringFactory xstringfactory,
                      boolean doIndexing)

Construct a DTMDefaultBase object from a DOM node.

Parameters:

mgr - The DTMManager who owns this DTM.

source - The object that is used to specify the construction source.

dtmIdentity - The DTM identity ID for this DTM.

whiteSpaceFilter - The white space filter for this DTM, which may be null.

xstringfactory - The factory to use for creating XMLStrings.

doIndexing - true if the caller considers it worth it to use indexing schemes.

Method Detail

ensureSizeOfIndex

protected void ensureSizeOfIndex(int namespaceID,
                                 int LocalNameID)

Ensure that the size of the element indexes can hold the information.

Parameters:

namespaceID - Namespace ID index.

LocalNameID - Local name ID.

indexNode

protected void indexNode(int expandedTypeID,
                         int identity)

Add a node to the element indexes. The node will not be added unless it's an element.

Parameters:

expandedTypeID - The expanded type ID of the node.

identity - The node identity index.

findGTE

protected int findGTE(int[] list,
                      int start,
                      int len,
                      int value)

Find the first index that occurs in the list that is greater than or equal to the given value.

Parameters:

list - A list of integers.

start - The start index to begin the search.

len - The number of items to search.

value - Find the slot that has a value that is greater than or identical to this argument.

Returns:

The index in the list of the slot that is higher or identical to the identity argument, or -1 if no node is higher or equal.

findElementFromIndex

int findElementFromIndex(int nsIndex,
                         int lnIndex,
                         int firstPotential)

Find the first matching element from the index at or after the given node.

Parameters:

nsIndex - The namespace index lookup.

lnIndex - The local name index lookup.

firstPotential - The first potential match that is worth looking at.

Returns:

The first node that is greater than or equal to the firstPotential argument, or DTM.NOTPROCESSED if not found.

getNextNodeIdentity

protected abstract int getNextNodeIdentity(int identity)

Get the next node identity value in the list, and call the iterator if it hasn't been added yet.

Parameters:

identity - The node identity (index).

Returns:

identity+1, or DTM.NULL.

nextNode

protected abstract boolean nextNode()

This method should try and build one or more nodes in the table.

Returns:

The true if a next node is found or false if there are no more nodes.

getNumberOfNodes

protected abstract int getNumberOfNodes()

Get the number of nodes that have been added.

Returns:

the number of nodes that have been mapped.

_type

protected short _type(int identity)

Get the simple type ID for the given node identity.

Parameters:

identity - The node identity.

Returns:

The simple type ID, or DTM.NULL.

_exptype

protected int _exptype(int identity)

Get the expanded type ID for the given node identity.

Parameters:

identity - The node identity.

Returns:

The expanded type ID, or DTM.NULL.

_level

protected int _level(int identity)

Get the level in the tree for the given node identity.

Parameters:

identity - The node identity.

Returns:

The tree level, or DTM.NULL.

_firstch

protected int _firstch(int identity)

Get the first child for the given node identity.

Parameters:

identity - The node identity.

Returns:

The first child identity, or DTM.NULL.

_nextsib

protected int _nextsib(int identity)

Get the next sibling for the given node identity.

Parameters:

identity - The node identity.

Returns:

The next sibling identity, or DTM.NULL.

_prevsib

protected int _prevsib(int identity)

Get the previous sibling for the given node identity.

Parameters:

identity - The node identity.

Returns:

The previous sibling identity, or DTM.NULL.

_parent

protected int _parent(int identity)

Get the parent for the given node identity.

Parameters:

identity - The node identity.

Returns:

The parent identity, or DTM.NULL.

dumpDTM

public void dumpDTM(OutputStream os)

Diagnostics function to dump the DTM.

dumpNode

public String dumpNode(int nodeHandle)

Diagnostics function to dump a single node. %REVIEW% KNOWN GLITCH: If you pass it a node index rather than a node handle, it works just fine... but the displayed identity number before the colon is different, which complicates comparing it with nodes printed the other way. We could always OR the DTM ID into the value, to suppress that distinction... %REVIEW% This might want to be moved up to DTMDefaultBase, or possibly DTM itself, since it's a useful diagnostic and uses only DTM's public APIs.

setFeature

public void setFeature(String featureId,
                       boolean state)

Set an implementation dependent feature.

%REVIEW% Do we really expect to set features on DTMs?

Specified by:

setFeature in interface DTM

Parameters:

featureId - A feature URL.

state - true if this feature should be on, false otherwise.

hasChildNodes

public boolean hasChildNodes(int nodeHandle)

Given a node handle, test if it has child nodes.

%REVIEW% This is obviously useful at the DOM layer, where it would permit testing this without having to create a proxy node. It's less useful in the DTM API, where (dtm.getFirstChild(nodeHandle)!=DTM.NULL) is just as fast and almost as self-evident. But it's a convenience, and eases porting of DOM code to DTM.

Specified by:

hasChildNodes in interface DTM

Parameters:

nodeHandle - int Handle of the node.

Returns:

int true if the given node has child nodes.

makeNodeHandle

protected final int makeNodeHandle(int nodeIdentity)

Given a node identity, return a node handle. If extended addressing has been used (multiple DTM IDs), we need to map the high bits of the identity into the proper DTM ID. This has been made FINAL to facilitate inlining, since we do not expect any subclass of DTMDefaultBase to ever change the algorithm. (I don't really like doing so, and would love to have an excuse not to...) %REVIEW% Is it worth trying to specialcase small documents? %REVIEW% Should this be exposed at the package/public layers?

Parameters:

nodeIdentity - Internal offset to this node's records.

Returns:

NodeHandle (external representation of node)

makeNodeIdentity

protected final int makeNodeIdentity(int nodeHandle)

Given a node handle, return a node identity. If extended addressing has been used (multiple DTM IDs), we need to map the high bits of the identity into the proper DTM ID and thence find the proper offset to add to the low bits of the identity This has been made FINAL to facilitate inlining, since we do not expect any subclass of DTMDefaultBase to ever change the algorithm. (I don't really like doing so, and would love to have an excuse not to...) %OPT% Performance is critical for this operation. %REVIEW% Should this be exposed at the package/public layers?

Returns:

nodeIdentity Internal offset to this node's records.

getFirstChild

public int getFirstChild(int nodeHandle)

Given a node handle, get the handle of the node's first child. If not yet resolved, waits for more nodes to be added to the document and tries again.

Specified by:

getFirstChild in interface DTM

Parameters:

nodeHandle - int Handle of the node.

Returns:

int DTM node-number of first child, or DTM.NULL to indicate none exists.

getLastChild

public int getLastChild(int nodeHandle)

Given a node handle, advance to its last child. If not yet resolved, waits for more nodes to be added to the document and tries again.

Specified by:

getLastChild in interface DTM

Parameters:

nodeHandle - int Handle of the node.

Returns:

int Node-number of last child, or DTM.NULL to indicate none exists.

getAttributeNode

public abstract int getAttributeNode(int nodeHandle,
                                     String namespaceURI,
                                     String name)

Retrieves an attribute node by by qualified name and namespace URI.

Specified by:

getAttributeNode in interface DTM

Parameters:

nodeHandle - int Handle of the node upon which to look up this attribute..

namespaceURI - The namespace URI of the attribute to retrieve, or null.

name - The local name of the attribute to retrieve.

Returns:

The attribute node handle with the specified name ( nodeName) or DTM.NULL if there is no such attribute.

getFirstAttribute

public int getFirstAttribute(int nodeHandle)

Given a node handle, get the index of the node's first attribute.

Specified by:

getFirstAttribute in interface DTM

Parameters:

nodeHandle - int Handle of the node.

Returns:

Handle of first attribute, or DTM.NULL to indicate none exists.

getNextSibling

public int getNextSibling(int nodeHandle)

Given a node handle, advance to its next sibling. If not yet resolved, waits for more nodes to be added to the document and tries again.

Specified by:

getNextSibling in interface DTM

Parameters:

nodeHandle - int Handle of the node.

Returns:

int Node-number of next sibling, or DTM.NULL to indicate none exists.

getPreviousSibling

public int getPreviousSibling(int nodeHandle)

Given a node handle, find its preceeding sibling. WARNING: DTM is asymmetric; this operation is resolved by search, and is relatively expensive.

Specified by:

getPreviousSibling in interface DTM

Parameters:

nodeHandle - the id of the node.

Returns:

int Node-number of the previous sib, or DTM.NULL to indicate none exists.

getNextAttribute

public int getNextAttribute(int nodeHandle)

Given a node handle, advance to the next attribute. If an attr, we advance to the next attr on the same node. If not an attribute, we return NULL.

Specified by:

getNextAttribute in interface DTM

Parameters:

nodeHandle - int Handle of the node.

Returns:

int DTM node-number of the resolved attr, or DTM.NULL to indicate none exists.

declareNamespaceInContext

protected void declareNamespaceInContext(int elementNodeIndex,
                                         int namespaceNodeIndex)

Build table of namespace declaration locations during DTM construction. Table is a Vector of SuballocatedIntVectors containing the namespace node HANDLES declared at that ID, plus an SuballocatedIntVector of the element node INDEXES at which these declarations appeared. NOTE: Since this occurs during model build, nodes will be encountered in doucment order and thus the table will be ordered by element, permitting binary-search as a possible retrieval optimization. %REVIEW% Directly managed arrays rather than vectors? %REVIEW% Handles or IDs? Given usage, I think handles.

findNamespaceContext

protected SuballocatedIntVector findNamespaceContext(int elementNodeIndex)

Retrieve list of namespace declaration locations active at this node. List is an SuballocatedIntVector whose entries are the namespace node HANDLES declared at that ID. %REVIEW% Directly managed arrays rather than vectors? %REVIEW% Handles or IDs? Given usage, I think handles.

findInSortedSuballocatedIntVector

protected int findInSortedSuballocatedIntVector(SuballocatedIntVector vector,
                                                int lookfor)

Subroutine: Locate the specified node within m_namespaceDeclSetElements, or the last element which preceeds it in document order %REVIEW% Inlne this into findNamespaceContext? Create SortedSuballocatedIntVector type?

Returns:

If positive or zero, the index of the found item. If negative, index of the point at which it would have appeared, encoded as -1-index and hence reconvertable by subtracting it from -1. (Encoding because I don't want to recompare the strings but don't want to burn bytes on a datatype to hold a flagged value.)

getFirstNamespaceNode

public int getFirstNamespaceNode(int nodeHandle,
                                 boolean inScope)

Given a node handle, get the index of the node's first child. If not yet resolved, waits for more nodes to be added to the document and tries again

Specified by:

getFirstNamespaceNode in interface DTM

Parameters:

nodeHandle - handle to node, which should probably be an element node, but need not be.

inScope - true if all namespaces in scope should be returned, false if only the namespace declarations should be returned.

Returns:

handle of first namespace, or DTM.NULL to indicate none exists.

getNextNamespaceNode

public int getNextNamespaceNode(int baseHandle,
                                int nodeHandle,
                                boolean inScope)

Given a namespace handle, advance to the next namespace.

Specified by:

getNextNamespaceNode in interface DTM

Parameters:

baseHandle - handle to original node from where the first namespace was relative to (needed to return nodes in document order).

nodeHandle - A namespace handle for which we will find the next node.

inScope - true if all namespaces that are in scope should be processed, otherwise just process the nodes in the given element handle.

Returns:

handle of next namespace, or DTM.NULL to indicate none exists.

getParent

public int getParent(int nodeHandle)

Given a node handle, find its parent node.

Specified by:

getParent in interface DTM

Parameters:

nodeHandle - the id of the node.

Returns:

int Node-number of parent, or DTM.NULL to indicate none exists.

getDocument

public int getDocument()

Find the Document node handle for the document currently under construction. PLEASE NOTE that most people should use getOwnerDocument(nodeHandle) instead; this version of the operation is primarily intended for use during negotiation with the DTM Manager.

Specified by:

getDocument in interface DTM

Returns:

int Node handle of document, which should always be valid.

getOwnerDocument

public int getOwnerDocument(int nodeHandle)

Given a node handle, find the owning document node. This has the exact same semantics as the DOM Document method of the same name, in that if the nodeHandle is a document node, it will return NULL.

%REVIEW% Since this is DOM-specific, it may belong at the DOM binding layer. Included here as a convenience function and to aid porting of DOM code to DTM.

Specified by:

getOwnerDocument in interface DTM

Parameters:

nodeHandle - the id of the node.

Returns:

int Node handle of owning document, or -1 if the node was a Docment

See Also:

DTM.getDocumentRoot(int nodeHandle)

getDocumentRoot

public int getDocumentRoot(int nodeHandle)

Given a node handle, find the owning document node. Unlike the DOM, this considers the owningDocument of a Document to be itself.

Specified by:

getDocumentRoot in interface DTM

Parameters:

nodeHandle - the id of the node.

Returns:

int Node handle of owning document, or the nodeHandle if it is a Document.

See Also:

DTM.getOwnerDocument(int nodeHandle)

getStringValue

public abstract XMLString getStringValue(int nodeHandle)

Get the string-value of a node as a String object (see http://www.w3.org/TR/xpath#data-model for the definition of a node's string-value).

Specified by:

getStringValue in interface DTM

Parameters:

nodeHandle - The node ID.

Returns:

A string object that represents the string-value of the given node.

getStringValueChunkCount

public int getStringValueChunkCount(int nodeHandle)

Get number of character array chunks in the string-value of a node. (see http://www.w3.org/TR/xpath#data-model for the definition of a node's string-value). Note that a single text node may have multiple text chunks.

Specified by:

getStringValueChunkCount in interface DTM

Parameters:

nodeHandle - The node ID.

Returns:

number of character array chunks in the string-value of a node.

getStringValueChunk

public char[] getStringValueChunk(int nodeHandle,
                                  int chunkIndex,
                                  int[] startAndLen)

Get a character array chunk in the string-value of a node. (see http://www.w3.org/TR/xpath#data-model for the definition of a node's string-value). Note that a single text node may have multiple text chunks.

Specified by:

getStringValueChunk in interface DTM

Parameters:

nodeHandle - The node ID.

chunkIndex - Which chunk to get.

startAndLen - An array of 2 where the start position and length of the chunk will be returned.

Returns:

The character array reference where the chunk occurs.

getExpandedTypeID

public int getExpandedTypeID(int nodeHandle)

Given a node handle, return an ID that represents the node's expanded name.

Specified by:

getExpandedTypeID in interface DTM

Parameters:

nodeHandle - The handle to the node in question.

Returns:

the expanded-name id of the node.

getExpandedTypeID

public int getExpandedTypeID(String namespace,
                             String localName,
                             int type)

Given an expanded name, return an ID. If the expanded-name does not exist in the internal tables, the entry will be created, and the ID will be returned. Any additional nodes that are created that have this expanded name will use this ID.

Specified by:

getExpandedTypeID in interface DTM

Parameters:

type - The simple type, i.e. one of ELEMENT, ATTRIBUTE, etc.

namespace - The namespace URI, which may be null, may be an empty string (which will be the same as null), or may be a namespace URI.

localName - The local name string, which must be a valid NCName.

Returns:

the expanded-name id of the node.

getLocalNameFromExpandedNameID

public String getLocalNameFromExpandedNameID(int expandedNameID)

Given an expanded-name ID, return the local name part.

Specified by:

getLocalNameFromExpandedNameID in interface DTM

Parameters:

expandedNameID - an ID that represents an expanded-name.

Returns:

String Local name of this node.

getNamespaceFromExpandedNameID

public String getNamespaceFromExpandedNameID(int expandedNameID)

Given an expanded-name ID, return the namespace URI part.

Specified by:

getNamespaceFromExpandedNameID in interface DTM

Parameters:

expandedNameID - an ID that represents an expanded-name.

Returns:

String URI value of this node's namespace, or null if no namespace was resolved.

getNamespaceType

public int getNamespaceType(int nodeHandle)

Returns the namespace type of a specific node

Parameters:

nodeHandle - the id of the node.

Returns:

the ID of the namespace.

getNodeName

public abstract String getNodeName(int nodeHandle)

Given a node handle, return its DOM-style node name. This will include names such as #text or #document.

Specified by:

getNodeName in interface DTM

Parameters:

nodeHandle - the id of the node.

Returns:

String Name of this node, which may be an empty string. %REVIEW% Document when empty string is possible... %REVIEW-COMMENT% It should never be empty, should it?

getNodeNameX

public String getNodeNameX(int nodeHandle)

Given a node handle, return the XPath node name. This should be the name as described by the XPath data model, NOT the DOM-style name.

Specified by:

getNodeNameX in interface DTM

Parameters:

nodeHandle - the id of the node.

Returns:

String Name of this node, which may be an empty string.

getLocalName

public abstract String getLocalName(int nodeHandle)

Given a node handle, return its XPath-style localname. (As defined in Namespaces, this is the portion of the name after any colon character).

Specified by:

getLocalName in interface DTM

Parameters:

nodeHandle - the id of the node.

Returns:

String Local name of this node.

getPrefix

public abstract String getPrefix(int nodeHandle)

Given a namespace handle, return the prefix that the namespace decl is mapping. Given a node handle, return the prefix used to map to the namespace.

%REVIEW% Are you sure you want "" for no prefix?

%REVIEW-COMMENT% I think so... not totally sure. -sb

Specified by:

getPrefix in interface DTM

Parameters:

nodeHandle - the id of the node.

Returns:

String prefix of this node's name, or "" if no explicit namespace prefix was given.

getNamespaceURI

public abstract String getNamespaceURI(int nodeHandle)

Given a node handle, return its DOM-style namespace URI (As defined in Namespaces, this is the declared URI which this node's prefix -- or default in lieu thereof -- was mapped to.)

%REVIEW% Null or ""? -sb

Specified by:

getNamespaceURI in interface DTM

Parameters:

nodeHandle - the id of the node.

Returns:

String URI value of this node's namespace, or null if no namespace was resolved.

getNodeValue

public abstract String getNodeValue(int nodeHandle)

Given a node handle, return its node value. This is mostly as defined by the DOM, but may ignore some conveniences.

Specified by:

getNodeValue in interface DTM

Parameters:

nodeHandle - The node id.

Returns:

String Value of this node, or null if not meaningful for this node type.

getNodeType

public short getNodeType(int nodeHandle)

Given a node handle, return its DOM-style node type.

%REVIEW% Generally, returning short is false economy. Return int? %REVIEW% Make assumption that node has already arrived. Is OK?

Specified by:

getNodeType in interface DTM

Parameters:

nodeHandle - The node id.

Returns:

int Node type, as per the DOM's Node._NODE constants.

getLevel

public short getLevel(int nodeHandle)

Get the depth level of this node in the tree (equals 1 for a parentless node).

Specified by:

getLevel in interface DTM

Parameters:

nodeHandle - The node id.

Returns:

the number of ancestors, plus one

isSupported

public boolean isSupported(String feature,
                           String version)

Tests whether DTM DOM implementation implements a specific feature and that feature is supported by this node.

Specified by:

isSupported in interface DTM

Parameters:

feature - The name of the feature to test.

version - The version string of the feature requested, may be null.

Returns:

Returns true if the specified feature is supported on this node, false otherwise.

getDocumentBaseURI

public String getDocumentBaseURI()

Return the base URI of the document entity. If it is not known (because the document was parsed from a socket connection or from standard input, for example), the value of this property is unknown.

Specified by:

getDocumentBaseURI in interface DTM

Returns:

the document base URI String object or null if unknown.

setDocumentBaseURI

public void setDocumentBaseURI(String baseURI)

Set the base URI of the document entity.

Specified by:

setDocumentBaseURI in interface DTM

Parameters:

baseURI - the document base URI String object or null if unknown.

getDocumentSystemIdentifier

public String getDocumentSystemIdentifier(int nodeHandle)

Return the system identifier of the document entity. If it is not known, the value of this property is unknown.

Specified by:

getDocumentSystemIdentifier in interface DTM

Parameters:

nodeHandle - The node id, which can be any valid node handle.

Returns:

the system identifier String object or null if unknown.

getDocumentEncoding

public String getDocumentEncoding(int nodeHandle)

Return the name of the character encoding scheme in which the document entity is expressed.

Specified by:

getDocumentEncoding in interface DTM

Parameters:

nodeHandle - The node id, which can be any valid node handle.

Returns:

the document encoding String object.

getDocumentStandalone

public String getDocumentStandalone(int nodeHandle)

Return an indication of the standalone status of the document, either "yes" or "no". This property is derived from the optional standalone document declaration in the XML declaration at the beginning of the document entity, and has no value if there is no standalone document declaration.

Specified by:

getDocumentStandalone in interface DTM

Parameters:

nodeHandle - The node id, which can be any valid node handle.

Returns:

the document standalone String object, either "yes", "no", or null.

getDocumentVersion

public String getDocumentVersion(int documentHandle)

Return a string representing the XML version of the document. This property is derived from the XML declaration optionally present at the beginning of the document entity, and has no value if there is no XML declaration.

Specified by:

getDocumentVersion in interface DTM

Parameters:

documentHandle - The document handle

Returns:

the document version String object.

getDocumentAllDeclarationsProcessed

public boolean getDocumentAllDeclarationsProcessed()

Return an indication of whether the processor has read the complete DTD. Its value is a boolean. If it is false, then certain properties (indicated in their descriptions below) may be unknown. If it is true, those properties are never unknown.

Specified by:

getDocumentAllDeclarationsProcessed in interface DTM

Returns:

true if all declarations were processed; false otherwise.

getDocumentTypeDeclarationSystemIdentifier

public abstract String getDocumentTypeDeclarationSystemIdentifier()

A document type declaration information item has the following properties: 1. [system identifier] The system identifier of the external subset, if it exists. Otherwise this property has no value.

Specified by:

getDocumentTypeDeclarationSystemIdentifier in interface DTM

Returns:

the system identifier String object, or null if there is none.

getDocumentTypeDeclarationPublicIdentifier

public abstract String getDocumentTypeDeclarationPublicIdentifier()

Return the public identifier of the external subset, normalized as described in 4.2.2 External Entities [XML]. If there is no external subset or if it has no public identifier, this property has no value.

Specified by:

getDocumentTypeDeclarationPublicIdentifier in interface DTM

Returns:

the public identifier String object, or null if there is none.

getElementById

public abstract int getElementById(String elementId)

Returns the Element whose ID is given by elementId. If no such element exists, returns DTM.NULL. Behavior is not defined if more than one element has this ID. Attributes (including those with the name "ID") are not of type ID unless so defined by DTD/Schema information available to the DTM implementation. Implementations that do not know whether attributes are of type ID or not are expected to return DTM.NULL.

%REVIEW% Presumably IDs are still scoped to a single document, and this operation searches only within a single document, right? Wouldn't want collisions between DTMs in the same process.

Specified by:

getElementById in interface DTM

Parameters:

elementId - The unique id value for an element.

Returns:

The handle of the matching element.

getUnparsedEntityURI

public abstract String getUnparsedEntityURI(String name)

The getUnparsedEntityURI function returns the URI of the unparsed entity with the specified name in the same document as the context node (see [3.3 Unparsed Entities]). It returns the empty string if there is no such entity.

XML processors may choose to use the System Identifier (if one is provided) to resolve the entity, rather than the URI in the Public Identifier. The details are dependent on the processor, and we would have to support some form of plug-in resolver to handle this properly. Currently, we simply return the System Identifier if present, and hope that it a usable URI or that our caller can map it to one. TODO: Resolve Public Identifiers... or consider changing function name.

If we find a relative URI reference, XML expects it to be resolved in terms of the base URI of the document. The DOM doesn't do that for us, and it isn't entirely clear whether that should be done here; currently that's pushed up to a higher level of our application. (Note that DOM Level 1 didn't store the document's base URI.) TODO: Consider resolving Relative URIs.

(The DOM's statement that "An XML processor may choose to completely expand entities before the structure model is passed to the DOM" refers only to parsed entities, not unparsed, and hence doesn't affect this function.)

Specified by:

getUnparsedEntityURI in interface DTM

Parameters:

name - A string containing the Entity Name of the unparsed entity.

Returns:

String containing the URI of the Unparsed Entity, or an empty string if no such entity exists.

supportsPreStripping

public boolean supportsPreStripping()

Return true if the xsl:strip-space or xsl:preserve-space was processed during construction of the DTM document.

Specified by:

supportsPreStripping in interface DTM

Returns:

true if this DTM supports prestripping.

isNodeAfter

public boolean isNodeAfter(int nodeHandle1,
                           int nodeHandle2)

Figure out whether nodeHandle2 should be considered as being later in the document than nodeHandle1, in Document Order as defined by the XPath model. This may not agree with the ordering defined by other XML applications.

There are some cases where ordering isn't defined, and neither are the results of this function -- though we'll generally return false.

Specified by:

isNodeAfter in interface DTM

Parameters:

nodeHandle1 - Node handle to perform position comparison on.

nodeHandle2 - Second Node handle to perform position comparison on .

Returns:

true if node1 comes before node2, otherwise return false. You can think of this as (node1.documentOrderPosition <= node2.documentOrderPosition).

isCharacterElementContentWhitespace

public boolean isCharacterElementContentWhitespace(int nodeHandle)

2. [element content whitespace] A boolean indicating whether the character is white space appearing within element content (see [XML], 2.10 "White Space Handling"). Note that validating XML processors are required by XML 1.0 to provide this information. If there is no declaration for the containing element, this property has no value for white space characters. If no declaration has been read, but the [all declarations processed] property of the document information item is false (so there may be an unread declaration), then the value of this property is unknown for white space characters. It is always false for characters that are not white space.

Specified by:

isCharacterElementContentWhitespace in interface DTM

Parameters:

nodeHandle - the node ID.

Returns:

true if the character data is whitespace; false otherwise.

isDocumentAllDeclarationsProcessed

public boolean isDocumentAllDeclarationsProcessed(int documentHandle)

10. [all declarations processed] This property is not strictly speaking part of the infoset of the document. Rather it is an indication of whether the processor has read the complete DTD. Its value is a boolean. If it is false, then certain properties (indicated in their descriptions below) may be unknown. If it is true, those properties are never unknown.

Specified by:

isDocumentAllDeclarationsProcessed in interface DTM

Parameters:

documentHandle - A node handle that must identify a document.

Returns:

true if all declarations were processed; false otherwise.

isAttributeSpecified

public abstract boolean isAttributeSpecified(int attributeHandle)

5. [specified] A flag indicating whether this attribute was actually specified in the start-tag of its element, or was defaulted from the DTD.

Specified by:

isAttributeSpecified in interface DTM

Parameters:

attributeHandle - The attribute handle in question.

Returns:

true if the attribute was specified; false if it was defaulted.

dispatchCharactersEvents

public abstract void dispatchCharactersEvents(int nodeHandle,
                                              org.xml.sax.ContentHandler ch,
                                              boolean normalize)
                                       throws org.xml.sax.SAXException

Directly call the characters method on the passed ContentHandler for the string-value of the given node (see http://www.w3.org/TR/xpath#data-model for the definition of a node's string-value). Multiple calls to the ContentHandler's characters methods may well occur for a single call to this method.

Specified by:

dispatchCharactersEvents in interface DTM

Parameters:

nodeHandle - The node ID.

ch - A non-null reference to a ContentHandler.

normalize - true if the content should be normalized according to the rules for the XPath normalize-space function.

Throws:

org.xml.sax.SAXException

dispatchToEvents

public abstract void dispatchToEvents(int nodeHandle,
                                      org.xml.sax.ContentHandler ch)
                               throws org.xml.sax.SAXException

Directly create SAX parser events from a subtree.

Specified by:

dispatchToEvents in interface DTM

Parameters:

nodeHandle - The node ID.

ch - A non-null reference to a ContentHandler.

Throws:

org.xml.sax.SAXException

getNode

public org.w3c.dom.Node getNode(int nodeHandle)

Return an DOM node for the given node.

Specified by:

getNode in interface DTM

Parameters:

nodeHandle - The node ID.

Returns:

A node representation of the DTM node.

appendChild

public void appendChild(int newChild,
                        boolean clone,
                        boolean cloneDepth)

Append a child to the end of the document. Please note that the node is always cloned if it is owned by another document.

%REVIEW% "End of the document" needs to be defined more clearly. Does it become the last child of the Document? Of the root element?

Specified by:

appendChild in interface DTM

Parameters:

newChild - Must be a valid new node handle.

clone - true if the child should be cloned into the document.

cloneDepth - if the clone argument is true, specifies that the clone should include all it's children.

appendTextChild

public void appendTextChild(String str)

Append a text node child that will be constructed from a string, to the end of the document.

%REVIEW% "End of the document" needs to be defined more clearly. Does it become the last child of the Document? Of the root element?

Specified by:

appendTextChild in interface DTM

Parameters:

str - Non-null reverence to a string.

error

protected void error(String msg)

Simple error for asserts and the like.

Parameters:

msg - Error message to report.

getShouldStripWhitespace

protected boolean getShouldStripWhitespace()

Find out whether or not to strip whispace nodes.

Returns:

whether or not to strip whispace nodes.

pushShouldStripWhitespace

protected void pushShouldStripWhitespace(boolean shouldStrip)

Set whether to strip whitespaces and push in current value of m_shouldStripWS in m_shouldStripWhitespaceStack.

Parameters:

shouldStrip - Flag indicating whether to strip whitespace nodes

popShouldStripWhitespace

protected void popShouldStripWhitespace()

Set whether to strip whitespaces at this point by popping out m_shouldStripWhitespaceStack.

setShouldStripWhitespace

protected void setShouldStripWhitespace(boolean shouldStrip)

Set whether to strip whitespaces and set the top of the stack to the current value of m_shouldStripWS.

Parameters:

shouldStrip - Flag indicating whether to strip whitespace nodes

documentRegistration

public void documentRegistration()

A dummy routine to satisify the abstract interface. If the DTM implememtation that extends the default base requires notification of registration, they can override this method.

Specified by:

documentRegistration in interface DTM

documentRelease

public void documentRelease()

A dummy routine to satisify the abstract interface. If the DTM implememtation that extends the default base requires notification when the document is being released, they can override this method

Specified by:

documentRelease in interface DTM

getManager

public DTMManager getManager()

Query which DTMManager this DTM is currently being handled by. %REVEW% Should this become part of the base DTM API?

Returns:

a DTMManager, or null if this is a "stand-alone" DTM.

getDTMIDs

public SuballocatedIntVector getDTMIDs()

Query which DTMIDs this DTM is currently using within the DTMManager. %REVEW% Should this become part of the base DTM API?

Returns:

an IntVector, or null if this is a "stand-alone" DTM.