DTM is an XML document model expressed as a table
rather than an object tree. It attempts to provide an interface to
a parse tree that has very little object creation. (DTM
implementations may also support incremental construction of the
model, but that's hidden from the DTM API.)
Nodes in the DTM are identified by integer "handles". A handle must be unique within a process, and carries both node identification and document identification. It must be possible to compare two handles (and thus their nodes) for identity with "==".
Namespace URLs, local-names, and expanded-names can all be represented by and tested as integer ID values. An expanded name represents (and may or may not directly contain) a combination of the URL ID, and the local-name ID. Note that the namespace URL id can be 0, which should have the meaning that the namespace is null. For consistancy, zero should not be used for a local-name index.
Text content of a node is represented by an index and length, permitting efficient storage such as a shared FastStringBuffer.
The model of the tree, as well as the general navigation model, is that of XPath 1.0, for the moment. The model will eventually be adapted to match the XPath 2.0 data model, XML Schema, and InfoSet.
DTM does _not_ directly support the W3C's Document Object Model. However, it attempts to come close enough that an implementation of DTM can be created that wraps a DOM and vice versa.
Note
The DTM API is still Subject To Change. This wouldn't affect most users, but might require updating some extensions.
The largest change being contemplated is a reconsideration of the Node Handle representation. We are still not entirely sure that an integer packed with two numeric subfields is really the best solution. It has been suggested that we move up to a Long, to permit more nodes per document without having to reduce the number of slots in the DTMManager. There's even been a proposal that we replace these integers with "cursor" objects containing the internal node id and a pointer to the actual DTM object; this might reduce the need to continuously consult the DTMManager to retrieve the latter, and might provide a useful "hook" back into normal Java heap management. But changing this datatype would have huge impact on Xalan's internals -- especially given Java's lack of C-style typedefs -- so we won't cut over unless we're convinced the new solution really would be an improvement!
| Modifier and Type | Field and Description |
|---|---|
| public static final short | ATTRIBUTE_NODE
The node is an |
| public static final short | CDATA_SECTION_NODE
The node is a |
| public static final short | COMMENT_NODE
The node is a |
| public static final short | DOCUMENT_FRAGMENT_NODE
The node is a |
| public static final short | DOCUMENT_NODE
The node is a |
| public static final short | DOCUMENT_TYPE_NODE
The node is a |
| public static final short | ELEMENT_NODE
The node is an |
| public static final short | ENTITY_NODE
The node is an |
| public static final short | ENTITY_REFERENCE_NODE
The node is an |
| public static final short | NAMESPACE_NODE
The node is a |
| public static final short | NOTATION_NODE
The node is a |
| public static final short | NTYPES
The number of valid nodetypes. |
| public static final int | NULL
Null node handles are represented by this value. |
| public static final short | PROCESSING_INSTRUCTION_NODE
The node is a |
| public static final short | ROOT_NODE
The node is a |
| public static final short | TEXT_NODE
The node is a |
| Modifier and Type | Method and Description |
|---|---|
| public void | appendChild(int
Must be a valid new node handle. newChild, boolean true if the child should be cloned into the document. clone, boolean if the clone argument is true, specifies that the
clone should include all it's children. cloneDepth)Append a child to "the end of the document". |
| public void | appendTextChild(String
Non-null reference to a string. str)Append a text node child that will be constructed from a string, to the end of the document. |
| public void | dispatchCharactersEvents(int
The node ID. nodeHandle, ContentHandler A non-null reference to a ContentHandler. ch, boolean true if the content should be normalized according to
the rules for the XPath
normalize-space
function. 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). |
| public void | dispatchToEvents(int
The node ID. nodeHandle, ContentHandler A non-null reference to a ContentHandler. ch)Directly create SAX parser events representing the XML content of a DTM subtree. |
| public void | |
| public void | documentRelease()
As documents are released from the DTMManager, the DTM implementation will be notified of the event. |
| public int | Returns: The attribute node handle with the specified name (nodeName) or DTM.NULL if there is no such
attribute.Handle of the node upon which to look up this attribute. elementHandle, String The namespace URI of the attribute to
retrieve, or null. namespaceURI, String The local name of the attribute to
retrieve. name)Retrieves an attribute node by local name and namespace URI %TBD% Note that we currently have no way to support the DOM's old getAttribute() call, which accesses only the qname. |
| public DTMAxisIterator | Returns: A DTMAxisIterator, or null if the givin axis isn't supported.One of Axes.ANCESTORORSELF, etc. axis)This is a shortcut to the iterators that implement XPath axes. |
| public DTMAxisTraverser | Returns: A DTMAxisIterator, or null if the givin axis isn't supported.One of Axes.ANCESTORORSELF, etc. axis)This returns a stateless "traverser", that can navigate over an XPath axis, though not in document order. |
| public ContentHandler | Returns: null if this model doesn't respond to SAX events.Return this DTM's content handler, if it has one. |
| public DeclHandler | Returns: null if this model doesn't respond to SAX Decl events.Return this DTM's DeclHandler, if it has one. |
| public int | Returns: int Node handle of document, or DTM.NULL if a shared DTM can not tell us which Document is currently active.Given a DTM which contains only a single document, find the Node Handle of the Document node. |
| public boolean | Returns: true if all declarations were processed;
false otherwise.Return an indication of whether the processor has read the complete DTD. |
| public String | Returns: the document base URI String object or null if unknown.Return the base URI of the document entity. |
| public String | Returns: the document encoding String object.The node id, which can be any valid node handle. nodeHandle)Return the name of the character encoding scheme in which the document entity is expressed. |
| public int | Returns: int Node handle of owning document, or the node itself if it was a Document. (Note difference from DOM, where getOwnerDocument returns null for the Document node.)the id of the node. nodeHandle)Given a node handle, find the owning document node. |
| public String | Returns: the document standalone String object, either "yes", "no", or null.The node id, which can be any valid node handle. nodeHandle)Return an indication of the standalone status of the document, either "yes" or "no". |
| public String | Returns: the system identifier String object or null if unknown.The node id, which can be any valid node handle. nodeHandle)Return the system identifier of the document entity. |
| public String | Returns: the public identifier String object, or null if there is none.Return the public identifier of the external subset, normalized as described in 4.2.2 External Entities [XML]. |
| public String | Returns: the system identifier String object, or null if there is none.A document type declaration information item has the following properties: 1. |
| public String | Returns: the document version String objectthe document handle documentHandle)Return a string representing the XML version of the document. |
| public DTDHandler | Returns: null if this model doesn't respond to SAX dtd events.Return this DTM's DTDHandler, if it has one. |
| public int | Returns: The handle of the matching element.The unique elementId)id value for an element.Returns the |
| public EntityResolver | Returns: null if this model doesn't respond to SAX entity ref events.Return this DTM's EntityResolver, if it has one. |
| public ErrorHandler | Returns: null if this model doesn't respond to SAX error events.Return this DTM's ErrorHandler, if it has one. |
| public int | Returns: the expanded-name id of the node.The handle to the node in question. nodeHandle)Given a node handle, return an ID that represents the node's expanded name. |
| public int | Returns: the expanded-name id of the node.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. |
| public int | Returns: Handle of first attribute, or DTM.NULL to indicate none exists.int Handle of the node. nodeHandle)Given a node handle, get the index of the node's first attribute. |
| public int | Returns: int DTM node-number of first child, or DTM.NULL to indicate none exists.int Handle of the node. nodeHandle)Given a node handle, get the handle of the node's first child. |
| public int | Returns: handle of first namespace, or DTM.NULL to indicate none exists.handle to node, which should probably be an element
node, but need not be. nodeHandle, boolean true if all namespaces in scope should be
returned, false if only the node's own
namespace declarations should be returned. inScope)Given a node handle, get the index of the node's first namespace node. |
| public int | Returns: int Node-number of last child, or DTM.NULL to indicate none exists.int Handle of the node. nodeHandle)Given a node handle, get the handle of the node's last child. |
| public short | Returns: the number of ancestors, plus oneThe node id. nodeHandle)Get the depth level of this node in the tree (equals 1 for a parentless node). |
| public LexicalHandler | Returns: null if this model doesn't respond to lexical SAX events.Return this DTM's lexical handler, if it has one. |
| public String | Returns: String Local name of this node.the id of the node. nodeHandle)Given a node handle, return its DOM-style localname. |
| public String | Returns: String Local name of this node.an ID that represents an expanded-name. ExpandedNameID)Given an expanded-name ID, return the local name part. |
| public String | Returns: String URI value of this node's namespace, or null if no namespace was resolved.an ID that represents an expanded-name. ExpandedNameID)Given an expanded-name ID, return the namespace URI part. |
| public String | Returns: String URI value of this node's namespace, or null if no namespace was resolved.the id of the node. 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.) |
| public int | Returns: int DTM node-number of the resolved attr, or DTM.NULL to indicate none exists.int Handle of the node. nodeHandle)Given a node handle, advance to the next attribute. |
| public int | Returns: handle of next namespace, or DTM.NULL to indicate none exists.handle to original node from where the first child
was relative to (needed to return nodes in document order). baseHandle, int handle to node which must be of type
NAMESPACE_NODE.
NEEDSDOC @param inScope namespaceHandle, boolean inScope)Given a namespace handle, advance to the next namespace in the same scope (local or local-plus-inherited, as selected by getFirstNamespaceNode) |
| public int | Returns: int Node-number of next sibling, or DTM.NULL to indicate none exists.int Handle of the node. nodeHandle)Given a node handle, advance to its next sibling. |
| public Node | Returns: A node representation of the DTM node.The node ID. nodeHandle)Return an DOM node for the given node. |
| public String | Returns: String Name of this node, which may be an empty string. %REVIEW% Document when empty string is possible...the id of the node. nodeHandle)Given a node handle, return its DOM-style node name. |
| public String | Returns: String Name of this node.the id of the node. nodeHandle)Given a node handle, return the XPath node name. |
| public short | Returns: int Node type, as per the DOM's Node._NODE constants.The node id. nodeHandle)Given a node handle, return its DOM-style node type. |
| public String | Returns: String Value of this node, or null if not meaningful for this node type.The node id. nodeHandle)Given a node handle, return its node value. |
| public int | Returns: int Node handle of owning document, or DTM.NULL if the node was a Document.the id of the node. nodeHandle)Given a node handle, find the owning document node. |
| public int | Returns: int Node handle of parent, or DTM.NULL to indicate none exists.the id of the node. nodeHandle)Given a node handle, find its parent node. |
| public String | Returns: String prefix of this node's name, or "" if no explicit namespace prefix was given.the id of the node. nodeHandle)Given a namespace handle, return the prefix that the namespace decl is mapping. |
| public int | Returns: int Node-number of the previous sib, or DTM.NULL to indicate none exists.the id of the node. nodeHandle)Given a node handle, find its preceeding sibling. |
| public SourceLocator | Returns: aSourceLocator value or null if no location
is availablean node)int valueGet the location of a node in the source document. |
| public XMLString | Returns: A string object that represents the string-value of the given node.The node ID. 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). |
| public char[] | Returns: The character array buffer within which the chunk occurs, setting startAndLen's contents as a side-effect.The node ID. nodeHandle, int Which chunk to get. chunkIndex, int[] A two-integer array which, upon return, WILL
BE FILLED with values representing the chunk's start position
within the returned character buffer and the length of the chunk. startAndLen)Get a character array chunk in the string-value of a node. |
| public int | Returns: number of character array chunks in the string-value of a node.The node ID. nodeHandle)Get number of character array chunks in the string-value of a node. |
| public DTMAxisIterator | Returns: A DTMAxisIterator, or null if the givin axis isn't supported.An extended type ID. type)Get an iterator that can navigate over an XPath Axis, predicated by the extended type ID. |
| public String | Returns: String containing the URI of the Unparsed Entity, or an empty string if no such entity exists.A string containing the Entity Name of the unparsed
entity. 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]). |
| public boolean | Returns: int true if the given node has child nodes.int Handle of the node. nodeHandle)Given a node handle, test if it has child nodes. |
| public boolean | Returns: true if the attribute was specified;
false if it was defaulted or the handle doesn't
refer to an attribute node.The attribute handle attributeHandle)5. |
| public boolean | Returns: true if the node definitely represents whitespace in
element content; false otherwise.the node ID. nodeHandle)2. |
| public boolean | Returns: true if all declarations were processed;
false otherwise.A node handle that must identify a document. documentHandle)10. |
| public boolean | Returns: false if secondNode comes before firstNode, otherwise return true. You can think of this as(firstNode.documentOrderPosition <= secondNode.documentOrderPosition).DOM Node to perform position comparison on. firstNodeHandle, int DOM Node to perform position comparison on. secondNodeHandle)Figure out whether nodeHandle2 should be considered as being later in the document than nodeHandle1, in Document Order as defined by the XPath model. |
| public boolean | Returns: Returnstrue if the specified feature is
supported on this node, false otherwise.The name of the feature to test. feature, String This is the version number of the feature to test.
If the version is not
specified, supporting any version of the feature will cause the
method to return version)true.Tests whether DTM DOM implementation implements a specific feature and that feature is supported by this node. |
| public void | migrateTo(DTMManager
the DTMManager manager)Migrate a DTM built with an old DTMManager to a new DTMManager. |
| public boolean | needsTwoThreads()
Returns: true iff we're building this model incrementally (eg we're partnered with a CoroutineParser) and thus require that the transformation and the parse run simultaneously. |
| public void | setDocumentBaseURI(String
the document base URI String object or null if unknown. baseURI)Set the base URI of the document entity. |
| public void | setFeature(String
A feature URL. featureId, boolean true if this feature should be on, false otherwise. state)Set an implementation dependent feature. |
| public void | setProperty(String
a property, Object String valuean value)Object valueSet a run time property for this DTM instance. |
| public boolean | supportsPreStripping()
Return true if the xsl:strip-space or xsl:preserve-space was processed during construction of the document contained in this DTM. |
| ATTRIBUTE_NODE | back to summary |
|---|---|
| public static final short ATTRIBUTE_NODE The node is an | |
| CDATA_SECTION_NODE | back to summary |
|---|---|
| public static final short CDATA_SECTION_NODE The node is a | |
| COMMENT_NODE | back to summary |
|---|---|
| public static final short COMMENT_NODE The node is a | |
| DOCUMENT_FRAGMENT_NODE | back to summary |
|---|---|
| public static final short DOCUMENT_FRAGMENT_NODE The node is a | |
| DOCUMENT_NODE | back to summary |
|---|---|
| public static final short DOCUMENT_NODE The node is a | |
| DOCUMENT_TYPE_NODE | back to summary |
|---|---|
| public static final short DOCUMENT_TYPE_NODE The node is a | |
| ELEMENT_NODE | back to summary |
|---|---|
| public static final short ELEMENT_NODE The node is an | |
| ENTITY_NODE | back to summary |
|---|---|
| public static final short ENTITY_NODE The node is an | |
| ENTITY_REFERENCE_NODE | back to summary |
|---|---|
| public static final short ENTITY_REFERENCE_NODE The node is an | |
| NAMESPACE_NODE | back to summary |
|---|---|
| public static final short NAMESPACE_NODE The node is a | |
| NOTATION_NODE | back to summary |
|---|---|
| public static final short NOTATION_NODE The node is a | |
| NTYPES | back to summary |
|---|---|
| public static final short NTYPES The number of valid nodetypes. | |
| NULL | back to summary |
|---|---|
| public static final int NULL Null node handles are represented by this value. | |
| PROCESSING_INSTRUCTION_NODE | back to summary |
|---|---|
| public static final short PROCESSING_INSTRUCTION_NODE The node is a | |
| ROOT_NODE | back to summary |
|---|---|
| public static final short ROOT_NODE The node is a | |
| TEXT_NODE | back to summary |
|---|---|
| public static final short TEXT_NODE The node is a | |
| appendChild | back to summary |
|---|---|
| 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 in a base DTM, since our basic behavior is immutable so nodes can't be removed from their previous location. %REVIEW% DTM maintains an insertion cursor which performs a depth-first tree walk as nodes come in, and this operation is really equivalent to: insertionCursor.appendChild(document.importNode(newChild))) where the insert point is the last element that was appended (or the last one popped back to by an end-element operation).
| |
| appendTextChild | back to summary |
|---|---|
| public void appendTextChild(String str) Append a text node child that will be constructed from a string, to the end of the document. Behavior is otherwise like appendChild().
| |
| dispatchCharactersEvents | back to summary |
|---|---|
| public void dispatchCharactersEvents(int nodeHandle, ContentHandler ch, boolean normalize) throws 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.
| |
| dispatchToEvents | back to summary |
|---|---|
| public void dispatchToEvents(int nodeHandle, ContentHandler ch) throws SAXException Directly create SAX parser events representing the XML content of a DTM subtree. This is a "serialize" operation.
| |
| documentRegistration | back to summary |
|---|---|
| public void documentRegistration() As the DTM is registered with the DTMManager, this method will be called. This will give the DTM implementation a chance to initialize any subsystems that are required to build the DTM | |
| documentRelease | back to summary |
|---|---|
| public void documentRelease() As documents are released from the DTMManager, the DTM implementation will be notified of the event. This will allow the DTM implementation to shutdown any subsystem activity that may of been assoiated with the active DTM Implementation. | |
| getAttributeNode | back to summary |
|---|---|
| public int getAttributeNode(int elementHandle, String namespaceURI, String name) Retrieves an attribute node by local name and namespace URI %TBD% Note that we currently have no way to support the DOM's old getAttribute() call, which accesses only the qname.
| |
| getAxisIterator | back to summary |
|---|---|
| public DTMAxisIterator getAxisIterator(final int axis) This is a shortcut to the iterators that implement XPath axes. Returns a bare-bones iterator that must be initialized with a start node (using iterator.setStartNode()).
| |
| getAxisTraverser | back to summary |
|---|---|
| public DTMAxisTraverser getAxisTraverser(final int axis) This returns a stateless "traverser", that can navigate over an XPath axis, though not in document order.
| |
| getContentHandler | back to summary |
|---|---|
| public ContentHandler getContentHandler() Return this DTM's content handler, if it has one.
| |
| getDeclHandler | back to summary |
|---|---|
| public DeclHandler getDeclHandler() Return this DTM's DeclHandler, if it has one.
| |
| getDocument | back to summary |
|---|---|
| public int getDocument() Given a DTM which contains only a single document, find the Node Handle of the Document node. Note that if the DTM is configured so it can contain multiple documents, this call will return the Document currently under construction -- but may return null if it's between documents. Generally, you should use getOwnerDocument(nodeHandle) or getDocumentRoot(nodeHandle) instead.
| |
| getDocumentAllDeclarationsProcessed | back to summary |
|---|---|
| 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.
| |
| getDocumentBaseURI | back to summary |
|---|---|
| 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.
| |
| getDocumentEncoding | back to summary |
|---|---|
| public String getDocumentEncoding(int nodeHandle) Return the name of the character encoding scheme in which the document entity is expressed.
| |
| getDocumentRoot | back to summary |
|---|---|
| public int getDocumentRoot(int nodeHandle) Given a node handle, find the owning document node.
| |
| getDocumentStandalone | back to summary |
|---|---|
| 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.
| |
| getDocumentSystemIdentifier | back to summary |
|---|---|
| public String getDocumentSystemIdentifier(int nodeHandle) Return the system identifier of the document entity. If it is not known, the value of this property is null.
| |
| getDocumentTypeDeclarationPublicIdentifier | back to summary |
|---|---|
| public 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.
| |
| getDocumentTypeDeclarationSystemIdentifier | back to summary |
|---|---|
| public 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.
| |
| getDocumentVersion | back to summary |
|---|---|
| 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.
| |
| getDTDHandler | back to summary |
|---|---|
| public DTDHandler getDTDHandler() Return this DTM's DTDHandler, if it has one.
| |
| getElementById | back to summary |
|---|---|
| public int getElementById(String elementId) Returns the %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.
| |
| getEntityResolver | back to summary |
|---|---|
| public EntityResolver getEntityResolver() Return this DTM's EntityResolver, if it has one.
| |
| getErrorHandler | back to summary |
|---|---|
| public ErrorHandler getErrorHandler() Return this DTM's ErrorHandler, if it has one.
| |
| getExpandedTypeID | back to summary |
|---|---|
| public int getExpandedTypeID(int nodeHandle) Given a node handle, return an ID that represents the node's expanded name.
| |
| getExpandedTypeID | back to summary |
|---|---|
| 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. NEEDSDOC @param namespace NEEDSDOC @param localName NEEDSDOC @param type
| |
| getFirstAttribute | back to summary |
|---|---|
| public int getFirstAttribute(int nodeHandle) Given a node handle, get the index of the node's first attribute.
| |
| getFirstChild | back to summary |
|---|---|
| public int getFirstChild(int nodeHandle) Given a node handle, get the handle of the node's first child.
| |
| getFirstNamespaceNode | back to summary |
|---|---|
| public int getFirstNamespaceNode(int nodeHandle, boolean inScope) Given a node handle, get the index of the node's first namespace node.
| |
| getLastChild | back to summary |
|---|---|
| public int getLastChild(int nodeHandle) Given a node handle, get the handle of the node's last child.
| |
| getLevel | back to summary |
|---|---|
| public short getLevel(int nodeHandle) Get the depth level of this node in the tree (equals 1 for a parentless node).
| |
| getLexicalHandler | back to summary |
|---|---|
| public LexicalHandler getLexicalHandler() Return this DTM's lexical handler, if it has one. %REVIEW% Should this return null if constrution already done/begun?
| |
| getLocalName | back to summary |
|---|---|
| public String getLocalName(int nodeHandle) Given a node handle, return its DOM-style localname. (As defined in Namespaces, this is the portion of the name after the prefix, if present, or the whole node name if no prefix exists)
| |
| getLocalNameFromExpandedNameID | back to summary |
|---|---|
| public String getLocalNameFromExpandedNameID(int ExpandedNameID) Given an expanded-name ID, return the local name part.
| |
| getNamespaceFromExpandedNameID | back to summary |
|---|---|
| public String getNamespaceFromExpandedNameID(int ExpandedNameID) Given an expanded-name ID, return the namespace URI part.
| |
| getNamespaceURI | back to summary |
|---|---|
| public 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.)
| |
| getNextAttribute | back to summary |
|---|---|
| public int getNextAttribute(int nodeHandle) Given a node handle, advance to the next attribute. If an element, we advance to its first attribute; if an attr, we advance to the next attr of the same element.
| |
| getNextNamespaceNode | back to summary |
|---|---|
| public int getNextNamespaceNode(int baseHandle, int namespaceHandle, boolean inScope) Given a namespace handle, advance to the next namespace in the same scope (local or local-plus-inherited, as selected by getFirstNamespaceNode)
| |
| getNextSibling | back to summary |
|---|---|
| public int getNextSibling(int nodeHandle) Given a node handle, advance to its next sibling.
| |
| getNode | back to summary |
|---|---|
| public Node getNode(int nodeHandle) Return an DOM node for the given node.
| |
| getNodeName | back to summary |
|---|---|
| public String getNodeName(int nodeHandle) Given a node handle, return its DOM-style node name. This will include names such as #text or #document.
| |
| getNodeNameX | back to summary |
|---|---|
| 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.
| |
| getNodeType | back to summary |
|---|---|
| public short getNodeType(int nodeHandle) Given a node handle, return its DOM-style node type. %REVIEW% Generally, returning short is false economy. Return int?
| |
| getNodeValue | back to summary |
|---|---|
| public 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.
| |
| getOwnerDocument | back to summary |
|---|---|
| public int getOwnerDocument(int nodeHandle) Given a node handle, find the owning document node. This version mimics the behavior of the DOM call by the same name.
| |
| getParent | back to summary |
|---|---|
| public int getParent(int nodeHandle) Given a node handle, find its parent node.
| |
| getPrefix | back to summary |
|---|---|
| public 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. (As defined in Namespaces, this is the portion of the name before any colon character). %REVIEW% Are you sure you want "" for no prefix?
| |
| getPreviousSibling | back to summary |
|---|---|
| public int getPreviousSibling(int nodeHandle) Given a node handle, find its preceeding sibling. Warning DTM implementations may be asymmetric; in some, this operation has been resolved by search, and is relatively expensive.
| |
| getSourceLocatorFor | back to summary |
|---|---|
| public SourceLocator getSourceLocatorFor(int node) Get the location of a node in the source document.
| |
| getStringValue | back to summary |
|---|---|
| public 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).
| |
| getStringValueChunk | back to summary |
|---|---|
| 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.
| |
| getStringValueChunkCount | back to summary |
|---|---|
| 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.
| |
| getTypedAxisIterator | back to summary |
|---|---|
| public DTMAxisIterator getTypedAxisIterator(final int axis, final int type) Get an iterator that can navigate over an XPath Axis, predicated by the extended type ID.
| |
| getUnparsedEntityURI | back to summary |
|---|---|
| public 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. %REVIEW% 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.) %REVIEW% 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.) | |
| hasChildNodes | back to summary |
|---|---|
| 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.
| |
| isAttributeSpecified | back to summary |
|---|---|
| public 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 (or schema).
| |
| isCharacterElementContentWhitespace | back to summary |
|---|---|
| public boolean isCharacterElementContentWhitespace(int nodeHandle) 2. [element content whitespace] A boolean indicating whether a text node represents 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... but that DOM Level 2 did not support it, since it depends on knowledge of the DTD which DOM2 could not guarantee would be available. If there is no declaration for the containing element, an XML processor must assume that the whitespace could be meaningful and return false. 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 indeterminate for white space characters and should probably be reported as false. It is always false for text nodes that contain anything other than (or in addition to) white space. Note too that it always returns false for non-Text nodes. %REVIEW% Joe wants to rename this isWhitespaceInElementContent() for clarity
| |
| isDocumentAllDeclarationsProcessed | back to summary |
|---|---|
| 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.
| |
| isNodeAfter | back to summary |
|---|---|
| public boolean isNodeAfter(int firstNodeHandle, int secondNodeHandle) 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 true. %REVIEW% Make sure this does the right thing with attribute nodes!!! %REVIEW% Consider renaming for clarity. Perhaps isDocumentOrder(a,b)?
| |
| isSupported | back to summary |
|---|---|
| public boolean isSupported(String feature, String version) Tests whether DTM DOM implementation implements a specific feature and that feature is supported by this node.
| |
| migrateTo | back to summary |
|---|---|
| public void migrateTo(DTMManager manager) Migrate a DTM built with an old DTMManager to a new DTMManager. After the migration, the new DTMManager will treat the DTM as one that is built by itself. This is used to support DTM sharing between multiple transformations.
| |
| needsTwoThreads | back to summary |
|---|---|
public boolean needsTwoThreads()
| |
| setDocumentBaseURI | back to summary |
|---|---|
| public void setDocumentBaseURI(String baseURI) Set the base URI of the document entity.
| |
| setFeature | back to summary |
|---|---|
| public void setFeature(String featureId, boolean state) Set an implementation dependent feature. %REVIEW% Do we really expect to set features on DTMs?
| |
| setProperty | back to summary |
|---|---|
| public void setProperty(String property, Object value) Set a run time property for this DTM instance. | |
| supportsPreStripping | back to summary |
|---|---|
| public boolean supportsPreStripping() Return true if the xsl:strip-space or xsl:preserve-space was processed during construction of the document contained in this DTM. NEEDSDOC ($objectName$) @return | |