| java.lang.Object
 org.apache.xml.dtm.ref.DTMDocumentImpl
| DTMDocumentImpl | | public class DTMDocumentImpl implements DTM,org.xml.sax.ContentHandler,org.xml.sax.ext.LexicalHandler(Code) | | This is the implementation of the DTM document interface. It receives
requests from an XML content handler similar to that of an XML DOM or SAX parser
to store information from the xml document in an array based
dtm table structure. This informtion is used later for document navigation,
query, and SAX event dispatch functions. The DTM can also be used directly as a
document composition model for an application. The requests received are:
- initiating DTM to set the doc handle
- resetting DTM for data structure reuse
- hinting the end of document to adjust the end of data structure pointers
- createnodes (element, comment, text, attribute, ....)
- hinting the end of an element to patch parent and siblings
-
- setting application provided symbol name stringpool data structures
State: In progress!!
%REVIEW% I _think_ the SAX convention is that "no namespace" is expressed
as "" rather than as null (which is the DOM's convention). What should
DTM expect? What should it do with the other?
Origin: the implemention is a composite logic based on the DTM of XalanJ1 and
DocImpl, DocumentImpl, ElementImpl, TextImpl, etc. of XalanJ2
|
| Constructor Summary | |
| public | DTMDocumentImpl(DTMManager mgr, int documentNumber, DTMWSFilter whiteSpaceFilter, XMLStringFactory xstringfactory)
Construct a DTM.
Parameters:
documentNumber - the ID number assigned to this document.It will be shifted up into the high bits and returned as part ofall node ID numbers, so those IDs indicate which document theycame from as well as a location within the document. |
| Method Summary | |
| void | appendAttribute(int namespaceIndex, int localNameIndex, int prefixIndex, boolean isID, int m_char_current_start, int contentLength)
Append an Attribute child at the current insertion
point. | | public void | appendChild(int newChild, boolean clone, boolean cloneDepth)
Append a child to the end of the child list of the current node. | | void | appendComment(int m_char_current_start, int contentLength)
Append a comment child at the current insertion point. | | void | appendEndDocument()
All appends to this document have finished; do whatever final
cleanup is needed. | | void | appendEndElement()
Terminate the element currently acting as an insertion point. | | void | appendNSDeclaration(int prefixIndex, int namespaceIndex, boolean isID)
Append a Namespace Declaration child at the current insertion point.
Assumes that the symbols (namespace URI and prefix) have already been
added to the pools
prefixIndex: Index within the prefix string pool namespaceIndex: Index within the namespaceURI string pool isID: If someone really insists on writing a bad DTD, it istheoretically possible for a namespace declaration to also be declaredas being a node ID. | | void | appendStartDocument()
Starting a new document. | | void | appendStartElement(int namespaceIndex, int localNameIndex, int prefixIndex)
Append an Element child at the current insertion point. | | public void | appendTextChild(String str)
Append a text node child that will be constructed from a string,
to the end of the document. | | void | appendTextChild(int m_char_current_start, int contentLength)
Append a text child at the current insertion point. | | public void | characters(char[] ch, int start, int length)
| | public void | comment(char[] ch, int start, int length)
| | public 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). | | public void | dispatchToEvents(int nodeHandle, org.xml.sax.ContentHandler ch)
Directly create SAX parser events from a subtree. | | public void | documentRegistration()
A dummy routine to satisify the abstract interface. | | public void | documentRelease()
A dummy routine to satisify the abstract interface. | | public void | endCDATA()
| | public void | endDTD()
| | public void | endDocument()
| | public void | endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName)
| | public void | endEntity(java.lang.String name)
| | public void | endPrefixMapping(java.lang.String prefix)
| | public int | getAttributeNode(int nodeHandle, String namespaceURI, String name)
Retrieves an attribute node by by qualified name and namespace URI.
Parameters:
nodeHandle - int Handle of the node upon which to look up this attribute.
Parameters:
namespaceURI - The namespace URI of the attribute toretrieve, or null.
Parameters:
name - The local name of the attribute toretrieve. | | public DTMAxisIterator | getAxisIterator(int axis)
This is a shortcut to the iterators that implement the
supported XPath axes (only namespace::) is not supported.
Returns a bare-bones iterator that must be initialized
with a start node (using iterator.setStartNode()).
Parameters:
axis - One of Axes.ANCESTORORSELF, etc. | | public DTMAxisTraverser | getAxisTraverser(int axis)
This returns a stateless "traverser", that can navigate over an
XPath axis, though not in document order.
Parameters:
axis - One of Axes.ANCESTORORSELF, etc. | | FastStringBuffer | getContentBuffer()
| | public org.xml.sax.ContentHandler | getContentHandler()
getContentHandler returns "our SAX builder" -- the thing that
someone else should send SAX events to in order to extend this
DTM model. | | public org.xml.sax.DTDHandler | getDTDHandler()
Return this DTM's DTDHandler. | | public org.xml.sax.ext.DeclHandler | getDeclHandler()
Return this DTM's DeclHandler. | | public int | getDocument()
Given a node handle, find the owning document node. | | public boolean | getDocumentAllDeclarationsProcessed()
Return an indication of
whether the processor has read the complete DTD. | | public String | getDocumentBaseURI()
Return the base URI of the document entity. | | public String | getDocumentEncoding(int nodeHandle)
Return the name of the character encoding scheme
in which the document entity is expressed.
Parameters:
nodeHandle - The node id, which can be any valid node handle. | | public int | getDocumentRoot()
Returns the root element of the document. | | public int | getDocumentRoot(int nodeHandle)
Given a node handle, find the owning document node. | | public String | getDocumentStandalone(int nodeHandle)
Return an indication of the standalone status of the document,
either "yes" or "no". | | public String | getDocumentSystemIdentifier(int nodeHandle)
Return the system identifier of the document entity. | | public String | getDocumentTypeDeclarationPublicIdentifier()
Return the public identifier of the external subset,
normalized as described in 4.2.2 External Entities [XML]. | | public String | getDocumentTypeDeclarationSystemIdentifier()
A document type declaration information item has the following properties:
1. | | public String | getDocumentVersion(int documentHandle)
Return a string representing the XML version of the document. | | public int | getElementById(String elementId)
Returns the Element whose ID is given by
elementId. | | public org.xml.sax.EntityResolver | getEntityResolver()
Return this DTM's EntityResolver. | | public org.xml.sax.ErrorHandler | getErrorHandler()
Return this DTM's ErrorHandler. | | public int | getExpandedTypeID(int nodeHandle)
Given a node handle, return an ID that represents the node's expanded name.
Parameters:
nodeHandle - The handle to the node in question. | | public int | getExpandedTypeID(String namespace, String localName, int type)
Given an expanded name, return an ID. | | public int | getFirstAttribute(int nodeHandle)
Given a node handle, get the index of the node's first attribute.
Parameters:
nodeHandle - int Handle of the Element node. | | 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.
Parameters:
nodeHandle - int Handle of the node. | | 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
Parameters:
nodeHandle - handle to node, which should probably be an elementnode, but need not be.
Parameters:
inScope - true if all namespaces in scope should be returned,false if only the namespace declarations should bereturned. | | 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.
Parameters:
nodeHandle - int Handle of the node. | | public short | getLevel(int nodeHandle)
Get the depth level of this node in the tree (equals 1 for
a parentless node).
Parameters:
nodeHandle - The node id. | | public LexicalHandler | getLexicalHandler()
Return this DTM's lexical handler. | | 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 any
colon character)
%REVIEW% What's the local name of something other than Element/Attr?
Should this be DOM-style (undefined unless namespaced), or other?
Parameters:
nodeHandle - the id of the node. | | public String | getLocalNameFromExpandedNameID(int ExpandedNameID)
Given an expanded-name ID, return the local name part.
Parameters:
ExpandedNameID - an ID that represents an expanded-name. | | public DTMStringPool | getLocalNameTable()
Get a reference pointer to the element name symbol table. | | public String | getNamespaceFromExpandedNameID(int ExpandedNameID)
Given an expanded-name ID, return the namespace URI part.
Parameters:
ExpandedNameID - an ID that represents an expanded-name. | | 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.)
Parameters:
nodeHandle - the id of the node. | | public int | getNextAttribute(int nodeHandle)
Given a node handle, advance to the next attribute. | | public int | getNextDescendant(int subtreeRootHandle, int nodeHandle)
Given a node handle, advance to its next descendant.
If not yet resolved, waits for more nodes to be added to the document and
tries again.
Parameters:
subtreeRootHandle -
Parameters:
nodeHandle - int Handle of the node. | | public int | getNextFollowing(int axisContextHandle, int nodeHandle)
Given a node handle, advance to the next node on the following axis. | | public int | getNextNamespaceNode(int baseHandle, int namespaceHandle, boolean inScope)
Given a namespace handle, advance to the next namespace.
%TBD% THIS METHOD DOES NOT MATCH THE CURRENT SIGNATURE IN
THE DTM INTERFACE. | | public int | getNextPreceding(int axisContextHandle, int nodeHandle)
Given a node handle, advance to the next node on the preceding axis.
Parameters:
axisContextHandle - the start of the axis that is being traversed.
Parameters:
nodeHandle - the id of the node. | | public int | getNextSibling(int nodeHandle)
Given a node handle, advance to its next sibling.
%TBD% This currently uses the DTM-internal definition of
sibling; eg, the last attr's next sib is the first
child. | | public org.w3c.dom.Node | getNode(int nodeHandle)
Return an DOM node for the given node.
Parameters:
nodeHandle - The node ID. | | public String | getNodeName(int nodeHandle)
Given a node handle, return its DOM-style node name. | | public String | getNodeNameX(int nodeHandle)
Given a node handle, return the XPath node name. | | public short | getNodeType(int nodeHandle)
Given a node handle, return its DOM-style node type.
%REVIEW% Generally, returning short is false economy. | | public String | getNodeValue(int nodeHandle)
Given a node handle, return its node value. | | public DTMStringPool | getNsNameTable()
Get a reference pointer to the namespace URI symbol table. | | public int | getOwnerDocument(int nodeHandle)
Given a node handle, find the owning document node. | | public int | getParent(int nodeHandle)
Given a node handle, find its parent node.
Parameters:
nodeHandle - the id of the node. | | 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.
%REVIEW% Are you sure you want "" for no prefix?
%REVIEW% Should this be DOM-style (undefined unless namespaced),
or other?
Parameters:
nodeHandle - the id of the node. | | public DTMStringPool | getPrefixNameTable()
Get a reference pointer to the prefix name symbol table. | | 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.
Parameters:
nodeHandle - the id of the node. | | public SourceLocator | getSourceLocatorFor(int node)
Source information is not handled yet, so return
null here. | | 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).
Parameters:
nodeHandle - The node ID. | | 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.
EXPLANATION: This method is an artifact of the fact that
the underlying m_chars object may not store characters in a
single contiguous array -- for example,the current
FastStringBuffer may split a single node's text across
multiple allocation units. | | 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.
EXPLANATION: This method is an artifact of the fact that the
underlying m_chars object may not store characters in a
single contiguous array -- for example,the current
FastStringBuffer may split a single node's text across
multiple allocation units. | | public DTMAxisIterator | getTypedAxisIterator(int axis, int type)
Get an iterator that can navigate over an XPath Axis, predicated by
the extended type ID.
Parameters:
axis -
Parameters:
type - An extended type ID. | | 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]). | | 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. | | public void | ignorableWhitespace(char[] ch, int start, int length)
| | final void | initDocument(int documentNumber)
Reset a dtm document to its initial (empty) state. | | public boolean | isAttributeSpecified(int attributeHandle)
5. | | public boolean | isCharacterElementContentWhitespace(int nodeHandle)
2. | | public boolean | isDocumentAllDeclarationsProcessed(int documentHandle)
10. | | 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. | | public boolean | isSupported(String feature, String version)
Tests whether DTM DOM implementation implements a specific feature and
that feature is supported by this node.
Parameters:
feature - The name of the feature to test.
Parameters:
version - This is the version number of the feature to test.If the version is notspecified, supporting any version of the feature will cause themethod to return true. | | public void | migrateTo(DTMManager manager)
Migrate a DTM built with an old DTMManager to a new DTMManager. | | public boolean | needsTwoThreads()
true iff we're building this model incrementally (egwe're partnered with a IncrementalSAXSource) and thus require that thetransformation and the parse run simultaneously. | | public void | processingInstruction(java.lang.String target, java.lang.String data)
| | void | setContentBuffer(FastStringBuffer buffer)
| | public void | setDocumentBaseURI(String baseURI)
Set the base URI of the document entity. | | public void | setDocumentLocator(Locator locator)
| | public void | setFeature(String featureId, boolean state)
Set an implementation dependent feature. | | public void | setIncrementalSAXSource(IncrementalSAXSource source)
Bind a IncrementalSAXSource to this DTM. | | public void | setLocalNameTable(DTMStringPool poolRef)
Set a reference pointer to the element name symbol table. | | public void | setNsNameTable(DTMStringPool poolRef)
Set a reference pointer to the namespace URI symbol table. | | public void | setPrefixNameTable(DTMStringPool poolRef)
Set a reference pointer to the prefix name symbol table. | | public void | setProperty(String property, Object value)
For the moment all the run time properties are ignored by this
class. | | public void | skippedEntity(java.lang.String name)
| | public void | startCDATA()
| | public void | startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId)
| | public void | startDocument()
| | public void | startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, Attributes atts)
| | public void | startEntity(java.lang.String name)
| | public void | startPrefixMapping(java.lang.String prefix, java.lang.String uri)
| | public boolean | supportsPreStripping()
Return true if the xsl:strip-space or xsl:preserve-space was processed
during construction of the DTM document. |
| DOCHANDLE_MASK | | final protected static int DOCHANDLE_MASK(Code) | | |
| DOCHANDLE_SHIFT | | final protected static byte DOCHANDLE_SHIFT(Code) | | |
| NODEHANDLE_MASK | | final protected static int NODEHANDLE_MASK(Code) | | |
| currentParent | | int currentParent(Code) | | |
| m_currentNode | | protected int m_currentNode(Code) | | |
| m_docElement | | int m_docElement(Code) | | |
| m_docHandle | | int m_docHandle(Code) | | |
| m_documentBaseURI | | protected String m_documentBaseURI(Code) | | The document base URI.
|
| m_isError | | boolean m_isError(Code) | | |
| previousSibling | | int previousSibling(Code) | | |
| DTMDocumentImpl | | public DTMDocumentImpl(DTMManager mgr, int documentNumber, DTMWSFilter whiteSpaceFilter, XMLStringFactory xstringfactory)(Code) | | Construct a DTM.
Parameters:
documentNumber - the ID number assigned to this document.It will be shifted up into the high bits and returned as part ofall node ID numbers, so those IDs indicate which document theycame from as well as a location within the document. It is theDTMManager's responsibility to assign a unique number to eachdocument. |
| appendAttribute | | void appendAttribute(int namespaceIndex, int localNameIndex, int prefixIndex, boolean isID, int m_char_current_start, int contentLength)(Code) | | Append an Attribute child at the current insertion
point. Assumes that the symbols (namespace URI, local name, and
prefix) have already been added to the pools, and that the content has
already been appended to m_char. Note that the attribute's content has
been flattened into a single string; DTM does _NOT_ attempt to model
the details of entity references within attribute values.
Parameters:
namespaceIndex - int Index within the namespaceURI string pool
Parameters:
localNameIndex - int Index within the local name string pool
Parameters:
prefixIndex - int Index within the prefix string pool
Parameters:
isID - boolean True if this attribute was declared as an ID(for use in supporting getElementByID).
Parameters:
m_char_current_start - int Starting offset of node's content in m_char.
Parameters:
contentLength - int Length of node's content in m_char. |
| appendChild | | public void appendChild(int newChild, boolean clone, boolean cloneDepth)(Code) | | Append a child to the end of the child list of the current node. 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?
Parameters:
newChild - Must be a valid new node handle.
Parameters:
clone - true if the child should be cloned into the document.
Parameters:
cloneDepth - if the clone argument is true, specifies that theclone should include all it's children. |
| appendComment | | void appendComment(int m_char_current_start, int contentLength)(Code) | | Append a comment child at the current insertion point. Assumes that the
actual content of the comment has previously been appended to the m_char
buffer (shared with the builder).
Parameters:
m_char_current_start - int Starting offset of node's content in m_char.
Parameters:
contentLength - int Length of node's content in m_char. |
| appendEndDocument | | void appendEndDocument()(Code) | | All appends to this document have finished; do whatever final
cleanup is needed.
|
| appendEndElement | | void appendEndElement()(Code) | | Terminate the element currently acting as an insertion point. Subsequent
insertions will occur as the last child of this element's parent.
|
| appendNSDeclaration | | void appendNSDeclaration(int prefixIndex, int namespaceIndex, boolean isID)(Code) | | Append a Namespace Declaration child at the current insertion point.
Assumes that the symbols (namespace URI and prefix) have already been
added to the pools
prefixIndex: Index within the prefix string pool namespaceIndex: Index within the namespaceURI string pool isID: If someone really insists on writing a bad DTD, it istheoretically possible for a namespace declaration to also be declaredas being a node ID. I don't really want to support that stupidity,but I'm not sure we can refuse to accept it. |
| appendStartDocument | | void appendStartDocument()(Code) | | Starting a new document. Perform any resets/initialization
not already handled.
|
| appendStartElement | | void appendStartElement(int namespaceIndex, int localNameIndex, int prefixIndex)(Code) | | Append an Element child at the current insertion point. This
Element then _becomes_ the insertion point; subsequent appends
become its lastChild until an appendEndElement() call is made.
Assumes that the symbols (local name, namespace URI and prefix)
have already been added to the pools
Note that this _only_ handles the Element node itself. Attrs and
namespace nodes are unbundled in the ContentHandler layer
and appended separately.
namespaceIndex: Index within the namespaceURI string pool
Parameters:
localNameIndex - Index within the local name string pool prefixIndex: Index within the prefix string pool |
| appendTextChild | | public void appendTextChild(String str)(Code) | | 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?
Parameters:
str - Non-null reference to a string. |
| appendTextChild | | void appendTextChild(int m_char_current_start, int contentLength)(Code) | | Append a text child at the current insertion point. Assumes that the
actual content of the text has previously been appended to the m_char
buffer (shared with the builder).
Parameters:
m_char_current_start - int Starting offset of node's content in m_char.
Parameters:
contentLength - int Length of node's content in m_char. |
| dispatchCharactersEvents | | public void dispatchCharactersEvents(int nodeHandle, org.xml.sax.ContentHandler ch, boolean normalize) throws org.xml.sax.SAXException(Code) | | 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.
Parameters:
nodeHandle - The node ID.
Parameters:
ch - A non-null reference to a ContentHandler.
throws:
org.xml.sax.SAXException - |
| documentRegistration | | public void documentRegistration()(Code) | | 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.
|
| documentRelease | | public void documentRelease()(Code) | | 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
|
| getAttributeNode | | public int getAttributeNode(int nodeHandle, String namespaceURI, String name)(Code) | | Retrieves an attribute node by by qualified name and namespace URI.
Parameters:
nodeHandle - int Handle of the node upon which to look up this attribute.
Parameters:
namespaceURI - The namespace URI of the attribute toretrieve, or null.
Parameters:
name - The local name of the attribute toretrieve. The attribute node handle with the specified name (nodeName) or DTM.NULL if there is no suchattribute. |
| getAxisIterator | | public DTMAxisIterator getAxisIterator(int axis)(Code) | | This is a shortcut to the iterators that implement the
supported XPath axes (only namespace::) is not supported.
Returns a bare-bones iterator that must be initialized
with a start node (using iterator.setStartNode()).
Parameters:
axis - One of Axes.ANCESTORORSELF, etc. A DTMAxisIterator, or null if the given axis isn't supported. |
| getAxisTraverser | | public DTMAxisTraverser getAxisTraverser(int axis)(Code) | | This returns a stateless "traverser", that can navigate over an
XPath axis, though not in document order.
Parameters:
axis - One of Axes.ANCESTORORSELF, etc. A DTMAxisIterator, or null if the given axis isn't supported. |
| getContentBuffer | | FastStringBuffer getContentBuffer()(Code) | | Get a reference pointer to the content-text repository
FastStringBuffer reference to an instance of buffer |
| getContentHandler | | public org.xml.sax.ContentHandler getContentHandler()(Code) | | getContentHandler returns "our SAX builder" -- the thing that
someone else should send SAX events to in order to extend this
DTM model.
null if this model doesn't respond to SAX events,"this" if the DTM object has a built-in SAX ContentHandler,the IncrementalSAXSource if we're bound to one and should receivethe SAX stream via it for incremental build purposes... |
| getDTDHandler | | public org.xml.sax.DTDHandler getDTDHandler()(Code) | | Return this DTM's DTDHandler.
null if this model doesn't respond to SAX dtd events. |
| getDocument | | public int getDocument()(Code) | | Given a node handle, find the owning document node.
int Node handle of document, which should always be valid. |
| getDocumentAllDeclarationsProcessed | | public boolean getDocumentAllDeclarationsProcessed()(Code) | | 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.
true if all declarations were processed {};false otherwise. |
| getDocumentBaseURI | | public String getDocumentBaseURI()(Code) | | 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.
the document base URI String object or null if unknown. |
| getDocumentEncoding | | public String getDocumentEncoding(int nodeHandle)(Code) | | Return the name of the character encoding scheme
in which the document entity is expressed.
Parameters:
nodeHandle - The node id, which can be any valid node handle. the document encoding String object. |
| getDocumentRoot | | public int getDocumentRoot()(Code) | | Returns the root element of the document.
nodeHandle to the Document Root. |
| getDocumentRoot | | public int getDocumentRoot(int nodeHandle)(Code) | | Given a node handle, find the owning document node. This has the DTM
semantics; a Document node is its own owner.
%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.
Parameters:
nodeHandle - the id of the node. int Node handle of owning document, or NULL if the nodeHandle isa document. |
| getDocumentStandalone | | public String getDocumentStandalone(int nodeHandle)(Code) | | 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.
Parameters:
nodeHandle - The node id, which can be any valid node handle. the document standalone String object, either "yes", "no", or null. |
| getDocumentSystemIdentifier | | public String getDocumentSystemIdentifier(int nodeHandle)(Code) | | Return the system identifier of the document entity. If
it is not known, the value of this property is unknown.
Parameters:
nodeHandle - The node id, which can be any valid node handle. the system identifier String object or null if unknown. |
| getDocumentTypeDeclarationPublicIdentifier | | public String getDocumentTypeDeclarationPublicIdentifier()(Code) | | 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.
the public identifier String object, or null if there is none. |
| getDocumentTypeDeclarationSystemIdentifier | | public String getDocumentTypeDeclarationSystemIdentifier()(Code) | | 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.
the system identifier String object, or null if there is none. |
| getDocumentVersion | | public String getDocumentVersion(int documentHandle)(Code) | | 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.
Parameters:
documentHandle - the document handle the document version String object |
| getElementById | | public int getElementById(String elementId)(Code) | | 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.
Parameters:
elementId - The unique id value for an element. The handle of the matching element. |
| getEntityResolver | | public org.xml.sax.EntityResolver getEntityResolver()(Code) | | Return this DTM's EntityResolver.
null if this model doesn't respond to SAX entity ref events. |
| getErrorHandler | | public org.xml.sax.ErrorHandler getErrorHandler()(Code) | | Return this DTM's ErrorHandler.
null if this model doesn't respond to SAX error events. |
| getExpandedTypeID | | public int getExpandedTypeID(int nodeHandle)(Code) | | Given a node handle, return an ID that represents the node's expanded name.
Parameters:
nodeHandle - The handle to the node in question. the expanded-name id of the node. |
| getExpandedTypeID | | public int getExpandedTypeID(String namespace, String localName, int type)(Code) | | 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.
the expanded-name id of the node. |
| getFirstAttribute | | public int getFirstAttribute(int nodeHandle)(Code) | | Given a node handle, get the index of the node's first attribute.
Parameters:
nodeHandle - int Handle of the Element node. Handle of first attribute, or DTM.NULL to indicate none exists. |
| getFirstChild | | public int getFirstChild(int nodeHandle)(Code) | | 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.
Parameters:
nodeHandle - int Handle of the node. int DTM node-number of first child, or DTM.NULL to indicate none exists. |
| getFirstNamespaceNode | | public int getFirstNamespaceNode(int nodeHandle, boolean inScope)(Code) | | 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
Parameters:
nodeHandle - handle to node, which should probably be an elementnode, but need not be.
Parameters:
inScope - true if all namespaces in scope should be returned,false if only the namespace declarations should bereturned. handle of first namespace, or DTM.NULL to indicate none exists. |
| getLastChild | | public int getLastChild(int nodeHandle)(Code) | | 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.
Parameters:
nodeHandle - int Handle of the node. int Node-number of last child,or DTM.NULL to indicate none exists. |
| getLevel | | public short getLevel(int nodeHandle)(Code) | | Get the depth level of this node in the tree (equals 1 for
a parentless node).
Parameters:
nodeHandle - The node id. the number of ancestors, plus one |
| getLexicalHandler | | public LexicalHandler getLexicalHandler()(Code) | | Return this DTM's lexical handler.
%REVIEW% Should this return null if constrution already done/begun?
null if this model doesn't respond to lexical SAX events,"this" if the DTM object has a built-in SAX ContentHandler,the IncrementalSAXSource if we're bound to one and should receivethe SAX stream via it for incremental build purposes... |
| getLocalName | | public String getLocalName(int nodeHandle)(Code) | | Given a node handle, return its DOM-style localname.
(As defined in Namespaces, this is the portion of the name after any
colon character)
%REVIEW% What's the local name of something other than Element/Attr?
Should this be DOM-style (undefined unless namespaced), or other?
Parameters:
nodeHandle - the id of the node. String Local name of this node. |
| getLocalNameFromExpandedNameID | | public String getLocalNameFromExpandedNameID(int ExpandedNameID)(Code) | | Given an expanded-name ID, return the local name part.
Parameters:
ExpandedNameID - an ID that represents an expanded-name. String Local name of this node. |
| getLocalNameTable | | public DTMStringPool getLocalNameTable()(Code) | | Get a reference pointer to the element name symbol table.
DTMStringPool reference to an instance of table. |
| getNamespaceFromExpandedNameID | | public String getNamespaceFromExpandedNameID(int ExpandedNameID)(Code) | | Given an expanded-name ID, return the namespace URI part.
Parameters:
ExpandedNameID - an ID that represents an expanded-name. String URI value of this node's namespace, or null if nonamespace was resolved. |
| getNamespaceURI | | public String getNamespaceURI(int nodeHandle)(Code) | | 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.)
Parameters:
nodeHandle - the id of the node. String URI value of this node's namespace, or null if nonamespace was resolved. |
| getNextAttribute | | public int getNextAttribute(int nodeHandle)(Code) | | 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 on the same node.
Parameters:
nodeHandle - int Handle of the node. int DTM node-number of the resolved attr,or DTM.NULL to indicate none exists. |
| getNextDescendant | | public int getNextDescendant(int subtreeRootHandle, int nodeHandle)(Code) | | Given a node handle, advance to its next descendant.
If not yet resolved, waits for more nodes to be added to the document and
tries again.
Parameters:
subtreeRootHandle -
Parameters:
nodeHandle - int Handle of the node. handle of next descendant,or DTM.NULL to indicate none exists. |
| getNextFollowing | | public int getNextFollowing(int axisContextHandle, int nodeHandle)(Code) | | Given a node handle, advance to the next node on the following axis.
Parameters:
axisContextHandle - the start of the axis that is being traversed.
Parameters:
nodeHandle - handle of next sibling,or DTM.NULL to indicate none exists. |
| getNextNamespaceNode | | public int getNextNamespaceNode(int baseHandle, int namespaceHandle, boolean inScope)(Code) | | Given a namespace handle, advance to the next namespace.
%TBD% THIS METHOD DOES NOT MATCH THE CURRENT SIGNATURE IN
THE DTM INTERFACE. FIX IT, OR JUSTIFY CHANGING THE DTM
API.
Parameters:
namespaceHandle - handle to node which must be of type NAMESPACE_NODE. handle of next namespace, or DTM.NULL to indicate none exists. |
| getNextPreceding | | public int getNextPreceding(int axisContextHandle, int nodeHandle)(Code) | | Given a node handle, advance to the next node on the preceding axis.
Parameters:
axisContextHandle - the start of the axis that is being traversed.
Parameters:
nodeHandle - the id of the node. int Node-number of preceding sibling,or DTM.NULL to indicate none exists. |
| getNextSibling | | public int getNextSibling(int nodeHandle)(Code) | | Given a node handle, advance to its next sibling.
%TBD% This currently uses the DTM-internal definition of
sibling; eg, the last attr's next sib is the first
child. In the old DTM, the DOM proxy layer provided the
additional logic for the public view. If we're rewriting
for XPath emulation, that test must be done here.
%TBD% CODE INTERACTION WITH INCREMENTAL PARSE - If not yet
resolved, should wait for more nodes to be added to the document
and tries again.
Parameters:
nodeHandle - int Handle of the node. int Node-number of next sibling,or DTM.NULL to indicate none exists. |
| getNode | | public org.w3c.dom.Node getNode(int nodeHandle)(Code) | | Return an DOM node for the given node.
Parameters:
nodeHandle - The node ID. A node representation of the DTM node. |
| getNodeName | | public String getNodeName(int nodeHandle)(Code) | | Given a node handle, return its DOM-style node name. This will
include names such as #text or #document.
Parameters:
nodeHandle - the id of the node. String Name of this node, which may be an empty string.%REVIEW% Document when empty string is possible... |
| getNodeNameX | | public String getNodeNameX(int nodeHandle)(Code) | | 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.
Parameters:
nodeHandle - the id of the node. String Name of this node. |
| getNodeType | | public short getNodeType(int nodeHandle)(Code) | | Given a node handle, return its DOM-style node type.
%REVIEW% Generally, returning short is false economy. Return int?
Parameters:
nodeHandle - The node id. int Node type, as per the DOM's Node._NODE constants. |
| getNodeValue | | public String getNodeValue(int nodeHandle)(Code) | | Given a node handle, return its node value. This is mostly
as defined by the DOM, but may ignore some conveniences.
Parameters:
nodeHandle - The node id. String Value of this node, or null if notmeaningful for this node type. |
| getNsNameTable | | public DTMStringPool getNsNameTable()(Code) | | Get a reference pointer to the namespace URI symbol table.
DTMStringPool reference to an instance of table. |
| getOwnerDocument | | public int getOwnerDocument(int nodeHandle)(Code) | | 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.
Parameters:
nodeHandle - the id of the node. int Node handle of owning document, or NULL if the nodeHandle isa document. |
| getParent | | public int getParent(int nodeHandle)(Code) | | Given a node handle, find its parent node.
Parameters:
nodeHandle - the id of the node. int Node-number of parent,or DTM.NULL to indicate none exists. |
| getPrefix | | public String getPrefix(int nodeHandle)(Code) | | 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% Should this be DOM-style (undefined unless namespaced),
or other?
Parameters:
nodeHandle - the id of the node. String prefix of this node's name, or "" if no explicitnamespace prefix was given. |
| getPrefixNameTable | | public DTMStringPool getPrefixNameTable()(Code) | | Get a reference pointer to the prefix name symbol table.
DTMStringPool reference to an instance of table. |
| getPreviousSibling | | public int getPreviousSibling(int nodeHandle)(Code) | | Given a node handle, find its preceeding sibling.
WARNING: DTM is asymmetric; this operation is resolved by search, and is
relatively expensive.
Parameters:
nodeHandle - the id of the node. int Node-number of the previous sib,or DTM.NULL to indicate none exists. |
| getSourceLocatorFor | | public SourceLocator getSourceLocatorFor(int node)(Code) | | Source information is not handled yet, so return
null here.
Parameters:
node - an int value null |
| getStringValue | | public XMLString getStringValue(int nodeHandle)(Code) | | 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).
Parameters:
nodeHandle - The node ID. A string object that represents the string-value of the given node. |
| getStringValueChunk | | public char[] getStringValueChunk(int nodeHandle, int chunkIndex, int[] startAndLen)(Code) | | 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.
EXPLANATION: This method is an artifact of the fact that
the underlying m_chars object may not store characters in a
single contiguous array -- for example,the current
FastStringBuffer may split a single node's text across
multiple allocation units. This call retrieves a single
contiguous portion of the text -- as much as m-chars was
able to store in a single allocation unit. PLEASE NOTE
that this may not be the same granularityas the SAX
characters() events that caused the text node to be built
in the first place, since m_chars buffering may be on
different boundaries than the parser's buffers.
Parameters:
nodeHandle - The node ID.
Parameters:
chunkIndex - Which chunk to get.
Parameters:
startAndLen - An array of 2 where the start position and length ofthe chunk will be returned. The character array reference where the chunk occurs. |
| getStringValueChunkCount | | public int getStringValueChunkCount(int nodeHandle)(Code) | | 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.
EXPLANATION: This method is an artifact of the fact that the
underlying m_chars object may not store characters in a
single contiguous array -- for example,the current
FastStringBuffer may split a single node's text across
multiple allocation units. This call tells us how many
separate accesses will be required to retrieve the entire
content. PLEASE NOTE that this may not be the same as the
number of SAX characters() events that caused the text node
to be built in the first place, since m_chars buffering may
be on different boundaries than the parser's buffers.
Parameters:
nodeHandle - The node ID. number of character array chunks inthe string-value of a node. |
| getTypedAxisIterator | | public DTMAxisIterator getTypedAxisIterator(int axis, int type)(Code) | | Get an iterator that can navigate over an XPath Axis, predicated by
the extended type ID.
Parameters:
axis -
Parameters:
type - An extended type ID. A DTMAxisIterator, or null if the given axis isn't supported. |
| getUnparsedEntityURI | | public String getUnparsedEntityURI(String name)(Code) | | 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.)
Parameters:
name - A string containing the Entity Name of the unparsedentity. String containing the URI of the Unparsed Entity, or anempty string if no such entity exists. |
| hasChildNodes | | public boolean hasChildNodes(int nodeHandle)(Code) | | 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.
Parameters:
nodeHandle - int Handle of the node. int true if the given node has child nodes. |
| initDocument | | final void initDocument(int documentNumber)(Code) | | Reset a dtm document to its initial (empty) state.
The DTMManager will invoke this method when the dtm is created.
Parameters:
documentNumber - the handle for the DTM document. |
| isAttributeSpecified | | public boolean isAttributeSpecified(int attributeHandle)(Code) | | 5. [specified] A flag indicating whether this attribute was actually
specified in the start-tag of its element, or was defaulted from the
DTD.
Parameters:
attributeHandle - the attribute handle true if the attribute was specified;false if it was defaulted. |
| isCharacterElementContentWhitespace | | public boolean isCharacterElementContentWhitespace(int nodeHandle)(Code) | | 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.
Parameters:
nodeHandle - the node ID. true if the character data is whitespace;false otherwise. |
| isDocumentAllDeclarationsProcessed | | public boolean isDocumentAllDeclarationsProcessed(int documentHandle)(Code) | | 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.
Parameters:
documentHandle - A node handle that must identify a document. true if all declarations were processed;false otherwise. |
| isNodeAfter | | public boolean isNodeAfter(int nodeHandle1, int nodeHandle2)(Code) | | 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.
TODO: Make sure this does the right thing with attribute nodes!!!
Parameters:
nodeHandle1 - DOM Node to perform position comparison on.
Parameters:
nodeHandle2 - DOM Node to perform position comparison on . false if node2 comes before node1, otherwise return true.You can think of this as(node1.documentOrderPosition <= node2.documentOrderPosition). |
| isSupported | | public boolean isSupported(String feature, String version)(Code) | | Tests whether DTM DOM implementation implements a specific feature and
that feature is supported by this node.
Parameters:
feature - The name of the feature to test.
Parameters:
version - This is the version number of the feature to test.If the version is notspecified, supporting any version of the feature will cause themethod to return true. Returns true if the specified feature issupported on this node, false otherwise. |
| migrateTo | | public void migrateTo(DTMManager manager)(Code) | | 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.
Parameters:
manager - the DTMManager |
| needsTwoThreads | | public boolean needsTwoThreads()(Code) | | true iff we're building this model incrementally (egwe're partnered with a IncrementalSAXSource) and thus require that thetransformation and the parse run simultaneously. Guidance to theDTMManager. |
| setContentBuffer | | void setContentBuffer(FastStringBuffer buffer)(Code) | | Set a reference pointer to the content-text repository
Parameters:
buffer - FastStringBuffer reference to an instance ofbuffer |
| setDocumentBaseURI | | public void setDocumentBaseURI(String baseURI)(Code) | | Set the base URI of the document entity.
Parameters:
baseURI - the document base URI String object or null if unknown. |
| setDocumentLocator | | public void setDocumentLocator(Locator locator)(Code) | | |
| setFeature | | public void setFeature(String featureId, boolean state)(Code) | | Set an implementation dependent feature.
%REVIEW% Do we really expect to set features on DTMs?
Parameters:
featureId - A feature URL.
Parameters:
state - true if this feature should be on, false otherwise. |
| setIncrementalSAXSource | | public void setIncrementalSAXSource(IncrementalSAXSource source)(Code) | | Bind a IncrementalSAXSource to this DTM. If we discover we need nodes
that have not yet been built, we will ask this object to send us more
events, and it will manage interactions with its data sources.
Note that we do not actually build the IncrementalSAXSource, since we don't
know what source it's reading from, what thread that source will run in,
or when it will run.
Parameters:
source - The IncrementalSAXSource that we want to recieve events fromon demand. |
| setLocalNameTable | | public void setLocalNameTable(DTMStringPool poolRef)(Code) | | Set a reference pointer to the element name symbol table.
%REVIEW% Should this really be Public? Changing it while
DTM is in use would be a disaster.
Parameters:
poolRef - DTMStringPool reference to an instance of table. |
| setNsNameTable | | public void setNsNameTable(DTMStringPool poolRef)(Code) | | Set a reference pointer to the namespace URI symbol table.
%REVIEW% Should this really be Public? Changing it while
DTM is in use would be a disaster.
Parameters:
poolRef - DTMStringPool reference to an instance of table. |
| setPrefixNameTable | | public void setPrefixNameTable(DTMStringPool poolRef)(Code) | | Set a reference pointer to the prefix name symbol table.
%REVIEW% Should this really be Public? Changing it while
DTM is in use would be a disaster.
Parameters:
poolRef - DTMStringPool reference to an instance of table. |
| setProperty | | public void setProperty(String property, Object value)(Code) | | For the moment all the run time properties are ignored by this
class.
Parameters:
property - a String value
Parameters:
value - an Object value |
| supportsPreStripping | | public boolean supportsPreStripping()(Code) | | Return true if the xsl:strip-space or xsl:preserve-space was processed
during construction of the DTM document.
%REVEIW% Presumes a 1:1 mapping from DTM to Document, since
we aren't saying which Document to query...?
|
|
|