org.apache.xml.dtm.ref
public class DTMDocumentImpl extends Object implements DTM, ContentHandler, LexicalHandler
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 | |
---|---|
DTMDocumentImpl(DTMManager mgr, int documentNumber, DTMWSFilter whiteSpaceFilter, XMLStringFactory xstringfactory)
Construct a DTM.
|
Method Summary | |
---|---|
void | appendChild(int newChild, boolean clone, boolean cloneDepth)
Append a child to the end of the child list of the current node. |
void | appendTextChild(String str)
Append a text node child that will be constructed from a string,
to the end of the document.
|
void | characters(char[] ch, int start, int length) |
void | comment(char[] ch, int start, int length) |
void | dispatchCharactersEvents(int nodeHandle, 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). |
void | dispatchToEvents(int nodeHandle, ContentHandler ch)
Directly create SAX parser events from a subtree.
|
void | documentRegistration()
A dummy routine to satisify the abstract interface. |
void | documentRelease()
A dummy routine to satisify the abstract interface. |
void | endCDATA() |
void | endDocument() |
void | endDTD() |
void | endElement(String namespaceURI, String localName, String qName) |
void | endEntity(String name) |
void | endPrefixMapping(String prefix) |
int | getAttributeNode(int nodeHandle, String namespaceURI, String name)
Retrieves an attribute node by by qualified name and namespace URI.
|
DTMAxisIterator | getAxisIterator(int axis)
This is a shortcut to the iterators that implement the
supported XPath axes (only namespace::) is not supported.
|
DTMAxisTraverser | getAxisTraverser(int axis)
This returns a stateless "traverser", that can navigate over an
XPath axis, though not in document order.
|
ContentHandler | getContentHandler() getContentHandler returns "our SAX builder" -- the thing that
someone else should send SAX events to in order to extend this
DTM model.
|
DeclHandler | getDeclHandler()
Return this DTM's DeclHandler.
|
int | getDocument()
Given a node handle, find the owning document node.
|
boolean | getDocumentAllDeclarationsProcessed()
Return an indication of
whether the processor has read the complete DTD. |
String | getDocumentBaseURI()
Return the base URI of the document entity. |
String | getDocumentEncoding(int nodeHandle)
Return the name of the character encoding scheme
in which the document entity is expressed.
|
int | getDocumentRoot()
Returns the root element of the document. |
int | getDocumentRoot(int nodeHandle)
Given a node handle, find the owning document node. |
String | getDocumentStandalone(int nodeHandle)
Return an indication of the standalone status of the document,
either "yes" or "no". |
String | getDocumentSystemIdentifier(int nodeHandle)
Return the system identifier of the document entity. |
String | getDocumentTypeDeclarationPublicIdentifier()
Return the public identifier of the external subset,
normalized as described in 4.2.2 External Entities [XML]. |
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. |
String | getDocumentVersion(int documentHandle)
Return a string representing the XML version of the document. |
DTDHandler | getDTDHandler()
Return this DTM's DTDHandler.
|
int | getElementById(String elementId)
Returns the Element whose ID is given by
elementId . |
EntityResolver | getEntityResolver()
Return this DTM's EntityResolver.
|
ErrorHandler | getErrorHandler()
Return this DTM's ErrorHandler.
|
int | getExpandedTypeID(int nodeHandle)
Given a node handle, return an ID that represents the node's expanded name.
|
int | getExpandedTypeID(String namespace, String localName, int type)
Given an expanded name, return an ID. |
int | getFirstAttribute(int nodeHandle)
Given a node handle, get the index of the node's first attribute.
|
int | getFirstChild(int nodeHandle)
Given a node handle, get the handle of the node's first child.
|
int | getFirstNamespaceNode(int nodeHandle, boolean inScope)
Given a node handle, get the index of the node's first child.
|
int | getLastChild(int nodeHandle)
Given a node handle, advance to its last child.
|
short | getLevel(int nodeHandle)
Get the depth level of this node in the tree (equals 1 for
a parentless node).
|
LexicalHandler | getLexicalHandler()
Return this DTM's lexical handler.
|
String | getLocalName(int nodeHandle)
Given a node handle, return its DOM-style localname.
|
String | getLocalNameFromExpandedNameID(int ExpandedNameID)
Given an expanded-name ID, return the local name part.
|
DTMStringPool | getLocalNameTable()
Get a reference pointer to the element name symbol table.
|
String | getNamespaceFromExpandedNameID(int ExpandedNameID)
Given an expanded-name ID, return the namespace URI part.
|
String | getNamespaceURI(int nodeHandle)
Given a node handle, return its DOM-style namespace URI
(As defined in Namespaces, this is the declared URI which this node's
prefix -- or default in lieu thereof -- was mapped to.)
|
int | getNextAttribute(int nodeHandle)
Given a node handle, advance to the next attribute. |
int | getNextDescendant(int subtreeRootHandle, int nodeHandle)
Given a node handle, advance to its next descendant.
|
int | getNextFollowing(int axisContextHandle, int nodeHandle)
Given a node handle, advance to the next node on the following axis.
|
int | getNextNamespaceNode(int baseHandle, int namespaceHandle, boolean inScope)
Given a namespace handle, advance to the next namespace.
|
int | getNextPreceding(int axisContextHandle, int nodeHandle)
Given a node handle, advance to the next node on the preceding axis.
|
int | getNextSibling(int nodeHandle)
Given a node handle, advance to its next sibling.
|
Node | getNode(int nodeHandle)
Return an DOM node for the given node.
|
String | getNodeName(int nodeHandle)
Given a node handle, return its DOM-style node name. |
String | getNodeNameX(int nodeHandle)
Given a node handle, return the XPath node name. |
short | getNodeType(int nodeHandle)
Given a node handle, return its DOM-style node type.
|
String | getNodeValue(int nodeHandle)
Given a node handle, return its node value. |
DTMStringPool | getNsNameTable()
Get a reference pointer to the namespace URI symbol table.
|
int | getOwnerDocument(int nodeHandle)
Given a node handle, find the owning document node. |
int | getParent(int nodeHandle)
Given a node handle, find its parent node.
|
String | getPrefix(int nodeHandle)
Given a namespace handle, return the prefix that the namespace decl is
mapping.
|
DTMStringPool | getPrefixNameTable()
Get a reference pointer to the prefix name symbol table.
|
int | getPreviousSibling(int nodeHandle)
Given a node handle, find its preceeding sibling.
|
SourceLocator | getSourceLocatorFor(int node)
Source information is not handled yet, so return
null here.
|
XMLString | getStringValue(int nodeHandle)
Get the string-value of a node as a String object
(see http://www.w3.org/TR/xpath#data-model
for the definition of a node's string-value).
|
char[] | getStringValueChunk(int nodeHandle, int chunkIndex, int[] startAndLen)
Get a character array chunk in the string-value of a node.
(see http://www.w3.org/TR/xpath#data-model
for the definition of a node's string-value).
|
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).
|
DTMAxisIterator | getTypedAxisIterator(int axis, int type)
Get an iterator that can navigate over an XPath Axis, predicated by
the extended type ID.
|
String | getUnparsedEntityURI(String name)
The getUnparsedEntityURI function returns the URI of the unparsed
entity with the specified name in the same document as the context
node (see [3.3 Unparsed Entities]). |
boolean | hasChildNodes(int nodeHandle) Given a node handle, test if it has child nodes.
|
void | ignorableWhitespace(char[] ch, int start, int length) |
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.
|
boolean | isCharacterElementContentWhitespace(int nodeHandle)
2. [element content whitespace] A boolean indicating whether the
character is white space appearing within element content (see [XML],
2.10 "White Space Handling"). |
boolean | isDocumentAllDeclarationsProcessed(int documentHandle)
10. [all declarations processed] This property is not strictly speaking
part of the infoset of the document. |
boolean | isNodeAfter(int nodeHandle1, int nodeHandle2)
Figure out whether nodeHandle2 should be considered as being later
in the document than nodeHandle1, in Document Order as defined
by the XPath model. |
boolean | isSupported(String feature, String version)
Tests whether DTM DOM implementation implements a specific feature and
that feature is supported by this node.
|
void | migrateTo(DTMManager manager)
Migrate a DTM built with an old DTMManager to a new DTMManager.
|
boolean | needsTwoThreads() |
void | processingInstruction(String target, String data) |
void | setDocumentBaseURI(String baseURI)
Set the base URI of the document entity.
|
void | setDocumentLocator(Locator locator) |
void | setFeature(String featureId, boolean state)
Set an implementation dependent feature.
|
void | setIncrementalSAXSource(IncrementalSAXSource source) Bind a IncrementalSAXSource to this DTM. |
void | setLocalNameTable(DTMStringPool poolRef)
Set a reference pointer to the element name symbol table.
|
void | setNsNameTable(DTMStringPool poolRef)
Set a reference pointer to the namespace URI symbol table.
|
void | setPrefixNameTable(DTMStringPool poolRef)
Set a reference pointer to the prefix name symbol table.
|
void | setProperty(String property, Object value)
For the moment all the run time properties are ignored by this
class.
|
void | skippedEntity(String name) |
void | startCDATA() |
void | startDocument() |
void | startDTD(String name, String publicId, String systemId) |
void | startElement(String namespaceURI, String localName, String qName, Attributes atts) |
void | startEntity(String name) |
void | startPrefixMapping(String prefix, String uri) |
boolean | supportsPreStripping()
Return true if the xsl:strip-space or xsl:preserve-space was processed
during construction of the DTM document.
|
Parameters: documentNumber the ID number assigned to this document. It will be shifted up into the high bits and returned as part of all node ID numbers, so those IDs indicate which document they came from as well as a location within the document. It is the DTMManager's responsibility to assign a unique number to each 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. clone true if the child should be cloned into the document. cloneDepth if the clone argument is true, specifies that the clone should include all it's children.
%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.
Parameters: nodeHandle The node ID. ch A non-null reference to a ContentHandler.
Throws: org.xml.sax.SAXException
Parameters: nodeHandle The node ID. ch A non-null reference to a ContentHandler.
Throws: org.xml.sax.SAXException
Parameters: nodeHandle int Handle of the node upon which to look up this attribute. namespaceURI The namespace URI of the attribute to retrieve, or null. name The local name of the attribute to retrieve.
Returns: The attribute node handle with the specified name (
nodeName
) or DTM.NULL
if there is no such
attribute.
Parameters: axis One of Axes.ANCESTORORSELF, etc.
Returns: A DTMAxisIterator, or null if the given axis isn't supported.
Parameters: axis One of Axes.ANCESTORORSELF, etc.
Returns: A DTMAxisIterator, or null if the given axis isn't supported.
Returns: 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 receive the SAX stream via it for incremental build purposes...
Returns: null if this model doesn't respond to SAX Decl events.
Returns: int Node handle of document, which should always be valid.
Returns: true
if all declarations were processed {};
false
otherwise.
Returns: the document base URI String object or null if unknown.
Parameters: nodeHandle The node id, which can be any valid node handle.
Returns: the document encoding String object.
Returns: nodeHandle to the Document Root.
%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.
Returns: int Node handle of owning document, or NULL if the nodeHandle is a document.
Parameters: nodeHandle The node id, which can be any valid node handle.
Returns: the document standalone String object, either "yes", "no", or null.
Parameters: nodeHandle The node id, which can be any valid node handle.
Returns: the system identifier String object or null if unknown.
Returns: the public identifier String object, or null if there is none.
Returns: the system identifier String object, or null if there is none.
Parameters: documentHandle the document handle
Returns: the document version String object
Returns: null if this model doesn't respond to SAX dtd events.
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.
Returns: The handle of the matching element.
Returns: null if this model doesn't respond to SAX entity ref events.
Returns: null if this model doesn't respond to SAX error events.
Parameters: nodeHandle The handle to the node in question.
Returns: the expanded-name id of the node.
Returns: the expanded-name id of the node.
Parameters: nodeHandle int Handle of the Element node.
Returns: Handle of first attribute, or DTM.NULL to indicate none exists.
Parameters: nodeHandle int Handle of the node.
Returns: int DTM node-number of first child, or DTM.NULL to indicate none exists.
Parameters: nodeHandle handle to node, which should probably be an element node, but need not be. inScope true if all namespaces in scope should be returned, false if only the namespace declarations should be returned.
Returns: handle of first namespace, or DTM.NULL to indicate none exists.
Parameters: nodeHandle int Handle of the node.
Returns: int Node-number of last child, or DTM.NULL to indicate none exists.
Parameters: nodeHandle The node id.
Returns: the number of ancestors, plus one
UNKNOWN: internal
Returns: 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 receive the SAX stream via it for incremental build purposes...
Parameters: nodeHandle the id of the node.
Returns: String Local name of this node.
Parameters: ExpandedNameID an ID that represents an expanded-name.
Returns: String Local name of this node.
Returns: DTMStringPool reference to an instance of table.
Parameters: ExpandedNameID an ID that represents an expanded-name.
Returns: String URI value of this node's namespace, or null if no namespace was resolved.
Parameters: nodeHandle the id of the node.
Returns: String URI value of this node's namespace, or null if no namespace was resolved.
Parameters: nodeHandle int Handle of the node.
Returns: int DTM node-number of the resolved attr, or DTM.NULL to indicate none exists.
Parameters: subtreeRootHandle nodeHandle int Handle of the node.
Returns: handle of next descendant, or DTM.NULL to indicate none exists.
Parameters: axisContextHandle the start of the axis that is being traversed. nodeHandle
Returns: handle of next sibling, or DTM.NULL to indicate none exists.
Parameters: namespaceHandle handle to node which must be of type NAMESPACE_NODE.
Returns: handle of next namespace, or DTM.NULL to indicate none exists.
Parameters: axisContextHandle the start of the axis that is being traversed. nodeHandle the id of the node.
Returns: int Node-number of preceding sibling, or DTM.NULL to indicate none exists.
Parameters: nodeHandle int Handle of the node.
Returns: int Node-number of next sibling, or DTM.NULL to indicate none exists.
Parameters: nodeHandle The node ID.
Returns: A node representation of the DTM node.
Parameters: nodeHandle the id of the node.
Returns: String Name of this node, which may be an empty string. %REVIEW% Document when empty string is possible...
Parameters: nodeHandle the id of the node.
Returns: String Name of this node.
%REVIEW% Generally, returning short is false economy. Return int?
Parameters: nodeHandle The node id.
Returns: int Node type, as per the DOM's Node._NODE constants.
Parameters: nodeHandle The node id.
Returns: String Value of this node, or null if not meaningful for this node type.
Returns: DTMStringPool reference to an instance of table.
%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.
Returns: int Node handle of owning document, or NULL if the nodeHandle is a document.
Parameters: nodeHandle the id of the node.
Returns: int Node-number of parent, or DTM.NULL to indicate none exists.
%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.
Returns: String prefix of this node's name, or "" if no explicit namespace prefix was given.
Returns: DTMStringPool reference to an instance of table.
Parameters: nodeHandle the id of the node.
Returns: int Node-number of the previous sib, or DTM.NULL to indicate none exists.
null
here.
Parameters: node an int
value
Returns: null
Parameters: nodeHandle The node ID.
Returns: A string object that represents the string-value of the given node.
Parameters: nodeHandle The node ID. chunkIndex Which chunk to get. startAndLen An array of 2 where the start position and length of the chunk will be returned.
Returns: The character array reference where the chunk occurs.
Parameters: nodeHandle The node ID.
Returns: number of character array chunks in the string-value of a node.
Parameters: axis type An extended type ID.
Returns: A DTMAxisIterator, or null if the given axis isn't supported.
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 unparsed entity.
Returns: String containing the URI of the Unparsed Entity, or an empty string if no such entity exists.
%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.
Returns: int true if the given node has child nodes.
Parameters: attributeHandle the attribute handle
Returns: true
if the attribute was specified;
false
if it was defaulted.
Parameters: nodeHandle the node ID.
Returns: true
if the character data is whitespace;
false
otherwise.
Parameters: documentHandle A node handle that must identify a document.
Returns: true
if all declarations were processed;
false
otherwise.
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. nodeHandle2 DOM Node to perform position comparison on .
Returns: false if node2 comes before node1, otherwise return true.
You can think of this as
(node1.documentOrderPosition <= node2.documentOrderPosition)
.
Parameters: feature The name of the feature to test. version 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 true
.
Returns: Returns true
if the specified feature is
supported on this node, false
otherwise.
Parameters: manager the DTMManager
Returns: true iff we're building this model incrementally (eg we're partnered with a IncrementalSAXSource) and thus require that the transformation and the parse run simultaneously. Guidance to the DTMManager.
Parameters: baseURI the document base URI String object or null if unknown.
%REVIEW% Do we really expect to set features on DTMs?
Parameters: featureId A feature URL. state true if this feature should be on, false otherwise.
Parameters: source The IncrementalSAXSource that we want to recieve events from on demand.
Parameters: poolRef DTMStringPool reference to an instance of table.
Parameters: poolRef DTMStringPool reference to an instance of table.
Parameters: poolRef DTMStringPool reference to an instance of table.
Parameters: property a String
value value an Object
value
%REVEIW% Presumes a 1:1 mapping from DTM to Document, since we aren't saying which Document to query...?