org.apache.xml.dtm.ref
public abstract class DTMDefaultBase extends Object implements DTM
DTMDefaultBase
class serves as a helper base for DTMs.
It sets up structures for navigation and type, while leaving data
management and construction to the derived classes.
Field Summary | |
---|---|
static int | DEFAULT_BLOCKSIZE The default block size of the node arrays |
static int | DEFAULT_NUMBLOCKS The number of blocks for the node arrays |
static int | DEFAULT_NUMBLOCKS_SMALL The number of blocks used for small documents & RTFs |
DTMManager | m_mgr
The DTM manager who "owns" this DTM. |
static int | ROOTNODE The identity of the root node. |
Constructor Summary | |
---|---|
DTMDefaultBase(DTMManager mgr, Source source, int dtmIdentity, DTMWSFilter whiteSpaceFilter, XMLStringFactory xstringfactory, boolean doIndexing)
Construct a DTMDefaultBase object using the default block size.
| |
DTMDefaultBase(DTMManager mgr, Source source, int dtmIdentity, DTMWSFilter whiteSpaceFilter, XMLStringFactory xstringfactory, boolean doIndexing, int blocksize, boolean usePrevsib, boolean newNameTable)
Construct a DTMDefaultBase object from a DOM node.
|
Method Summary | |
---|---|
void | appendChild(int newChild, boolean clone, boolean cloneDepth)
Append a child to the end of the document. |
void | appendTextChild(String str)
Append a text node child that will be constructed from a string,
to the end of the document.
|
abstract 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). |
abstract 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 | dumpDTM(OutputStream os)
Diagnostics function to dump the DTM. |
String | dumpNode(int nodeHandle)
Diagnostics function to dump a single node.
|
abstract int | getAttributeNode(int nodeHandle, String namespaceURI, String name)
Retrieves an attribute node by by qualified name and namespace URI.
|
int | getDocument()
Find the Document node handle for the document currently under construction.
|
boolean | getDocumentAllDeclarationsProcessed()
Return an indication of
whether the processor has read the complete DTD. |
String | getDocumentBaseURI()
Return the base URI of the document entity. |
String | getDocumentEncoding(int nodeHandle)
Return the name of the character encoding scheme
in which the document entity is expressed.
|
int | getDocumentRoot(int nodeHandle)
Given a node handle, find the owning document node. |
String | getDocumentStandalone(int nodeHandle)
Return an indication of the standalone status of the document,
either "yes" or "no". |
String | getDocumentSystemIdentifier(int nodeHandle)
Return the system identifier of the document entity. |
abstract String | getDocumentTypeDeclarationPublicIdentifier()
Return the public identifier of the external subset,
normalized as described in 4.2.2 External Entities [XML]. |
abstract String | getDocumentTypeDeclarationSystemIdentifier()
A document type declaration information item has the following properties:
1. [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. |
SuballocatedIntVector | getDTMIDs() Query which DTMIDs this DTM is currently using within the DTMManager.
|
abstract int | getElementById(String elementId)
Returns the Element whose ID is given by
elementId . |
int | getExpandedTypeID(int nodeHandle)
Given a node handle, return an ID that represents the node's expanded name.
|
int | getExpandedTypeID(String namespace, String localName, int type)
Given an expanded name, return an ID. |
int | getFirstAttribute(int nodeHandle)
Given a node handle, get the index of the node's first attribute.
|
int | getFirstChild(int nodeHandle)
Given a node handle, get the handle of the node's first child.
|
int | getFirstNamespaceNode(int nodeHandle, boolean inScope)
Given a node handle, get the index of the node's first child.
|
int | getLastChild(int nodeHandle)
Given a node handle, advance to its last child.
|
short | getLevel(int nodeHandle)
Get the depth level of this node in the tree (equals 1 for
a parentless node).
|
abstract String | getLocalName(int nodeHandle)
Given a node handle, return its XPath-style localname.
|
String | getLocalNameFromExpandedNameID(int expandedNameID)
Given an expanded-name ID, return the local name part.
|
DTMManager | getManager() Query which DTMManager this DTM is currently being handled by.
|
String | getNamespaceFromExpandedNameID(int expandedNameID)
Given an expanded-name ID, return the namespace URI part.
|
int | getNamespaceType(int nodeHandle)
Returns the namespace type of a specific node |
abstract String | getNamespaceURI(int nodeHandle)
Given a node handle, return its DOM-style namespace URI
(As defined in Namespaces, this is the declared URI which this node's
prefix -- or default in lieu thereof -- was mapped to.)
|
int | getNextAttribute(int nodeHandle)
Given a node handle, advance to the next attribute.
|
int | getNextNamespaceNode(int baseHandle, int nodeHandle, boolean inScope)
Given a namespace handle, advance to the next namespace.
|
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.
|
int | getNodeHandle(int nodeId)
Get the handle of this node in the tree
|
int | getNodeIdent(int nodeHandle)
Get the identity of this node in the tree
|
abstract String | getNodeName(int nodeHandle)
Given a node handle, return its DOM-style node name. |
String | getNodeNameX(int nodeHandle)
Given a node handle, return the XPath node name. |
short | getNodeType(int nodeHandle)
Given a node handle, return its DOM-style node type.
|
abstract String | getNodeValue(int nodeHandle)
Given a node handle, return its node value. |
int | getOwnerDocument(int nodeHandle)
Given a node handle, find the owning document node. |
int | getParent(int nodeHandle)
Given a node handle, find its parent node.
|
abstract String | getPrefix(int nodeHandle)
Given a namespace handle, return the prefix that the namespace decl is
mapping.
|
int | getPreviousSibling(int nodeHandle)
Given a node handle, find its preceeding sibling.
|
abstract XMLString | getStringValue(int nodeHandle)
Get the string-value of a node as a String object
(see http://www.w3.org/TR/xpath#data-model
for the definition of a node's string-value).
|
char[] | getStringValueChunk(int nodeHandle, int chunkIndex, int[] startAndLen)
Get a character array chunk in the string-value of a node.
(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).
|
int | getTypedFirstChild(int nodeHandle, int nodeType)
Given a node handle, get the handle of the node's first child.
|
int | getTypedNextSibling(int nodeHandle, int nodeType)
Given a node handle, advance to its next sibling.
|
abstract String | getUnparsedEntityURI(String name)
The getUnparsedEntityURI function returns the URI of the unparsed
entity with the specified name in the same document as the context
node (see [3.3 Unparsed Entities]). |
boolean | hasChildNodes(int nodeHandle)
Given a node handle, test if it has child nodes.
|
abstract boolean | isAttributeSpecified(int attributeHandle)
5. [specified] A flag indicating whether this attribute was actually
specified in the start-tag of its element, or was defaulted from the
DTD.
|
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.
|
int | makeNodeHandle(int nodeIdentity) Given a node identity, return a node handle. |
int | makeNodeIdentity(int nodeHandle) Given a node handle, return a node identity. |
void | migrateTo(DTMManager mgr)
Migrate a DTM built with an old DTMManager to a new DTMManager.
|
void | setDocumentBaseURI(String baseURI)
Set the base URI of the document entity.
|
void | setFeature(String featureId, boolean state)
Set an implementation dependent feature.
|
boolean | supportsPreStripping()
Return true if the xsl:strip-space or xsl:preserve-space was processed
during construction of the DTM document.
|
Parameters: mgr The DTMManager who owns this DTM. source The object that is used to specify the construction source. dtmIdentity The DTM identity ID for this DTM. whiteSpaceFilter The white space filter for this DTM, which may be null. xstringfactory The factory to use for creating XMLStrings. doIndexing true if the caller considers it worth it to use indexing schemes.
Parameters: mgr The DTMManager who owns this DTM. source The object that is used to specify the construction source. dtmIdentity The DTM identity ID for this DTM. whiteSpaceFilter The white space filter for this DTM, which may be null. xstringfactory The factory to use for creating XMLStrings. doIndexing true if the caller considers it worth it to use indexing schemes. blocksize The block size of the DTM. usePrevsib true if we want to build the previous sibling node array. newNameTable true if we want to use a new ExpandedNameTable for this DTM.
%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 reverence to a string.
Parameters: nodeHandle The node ID. ch A non-null reference to a ContentHandler. normalize true if the content should be normalized according to the rules for the XPath normalize-space function.
Throws: org.xml.sax.SAXException
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.
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.
UNKNOWN: internal
Parameters: nodeHandle the id of the node.
Returns: int Node handle of owning document, or the nodeHandle if it 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: an IntVector, or null if this is a "stand-alone" DTM.
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.
Parameters: nodeHandle The handle to the node in question.
Returns: the expanded-name id of the node.
Parameters: type The simple type, i.e. one of ELEMENT, ATTRIBUTE, etc. namespace The namespace URI, which may be null, may be an empty string (which will be the same as null), or may be a namespace URI. localName The local name string, which must be a valid NCName.
Returns: the expanded-name id of the node.
Parameters: nodeHandle int Handle of the 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
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: a DTMManager, or null if this is a "stand-alone" DTM.
Parameters: expandedNameID an ID that represents an expanded-name.
Returns: String URI value of this node's namespace, or null if no namespace was resolved.
Parameters: nodeHandle the id of the node.
Returns: the ID of the namespace.
%REVIEW% Null or ""? -sb
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: baseHandle handle to original node from where the first namespace was relative to (needed to return nodes in document order). nodeHandle A namespace handle for which we will find the next node. inScope true if all namespaces that are in scope should be processed, otherwise just process the nodes in the given element handle.
Returns: handle of next namespace, or DTM.NULL to indicate none exists.
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: nodeId The node identity.
Returns: the node handle
UNKNOWN: internal
Parameters: nodeHandle The node handle.
Returns: the node identity
UNKNOWN: internal
Parameters: nodeHandle the id of the node.
Returns: String Name of this node, which may be an empty string. %REVIEW% Document when empty string is possible... %REVIEW-COMMENT% It should never be empty, should it?
Parameters: nodeHandle the id of the node.
Returns: String Name of this node, which may be an empty string.
%REVIEW% Generally, returning short is false economy. Return int? %REVIEW% Make assumption that node has already arrived. Is OK?
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.
%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 -1 if the node was a Docment
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-COMMENT% I think so... not totally sure. -sb
Parameters: nodeHandle the id of the node.
Returns: String prefix of this node's name, or "" if no explicit namespace prefix was given.
Parameters: nodeHandle the id of the node.
Returns: int Node-number of the previous sib, or DTM.NULL to indicate none exists.
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: nodeHandle int Handle of the node.
Returns: int DTM node-number of first child, 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.
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 in question.
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 false.
Parameters: nodeHandle1 Node handle to perform position comparison on. nodeHandle2 Second Node handle to perform position comparison on .
Returns: true if node1 comes before node2, otherwise return false.
You can think of this as
(node1.documentOrderPosition <= node2.documentOrderPosition)
.
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: nodeIdentity Internal offset to this node's records.
Returns: NodeHandle (external representation of node)
Parameters: nodeHandle (external representation of node)
Returns: nodeIdentity Internal offset to this node's records.
Parameters: mgr 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.
Returns: true if this DTM supports prestripping.