public class SimpleResultTreeImpl extends EmptySerializer implements DOM, DTM
A SimpleResultTreeImpl has only two nodes, i.e. the ROOT node and its Text child. All DOM interfaces are overridden with this in mind. For example, the getStringValue() interface returns the value of the Text node. This class receives the character data from the characters() interface.
This class implements DOM and SerializationHandler. It also implements the DTM interface for support in MultiDOM. The nested iterators (SimpleIterator and SingletonIterator) are used to support the nodeset() extension function.
| Modifier and Type | Class and Description |
|---|---|
class |
SimpleResultTreeImpl.SimpleIterator
The SimpleIterator is designed to support the nodeset() extension function.
|
class |
SimpleResultTreeImpl.SingletonIterator
The SingletonIterator is used for the self axis.
|
| Modifier and Type | Field and Description |
|---|---|
static int |
NUMBER_OF_NODES |
static int |
RTF_ROOT |
static int |
RTF_TEXT |
ADAPTIVE_RTF, FIRST_TYPE, NO_TYPE, NULL, RETURN_CURRENT, RETURN_PARENT, SIMPLE_RTF, TREE_RTFATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NAMESPACE_NODE, NOTATION_NODE, NTYPES, NULL, PROCESSING_INSTRUCTION_NODE, ROOT_NODE, TEXT_NODEHTML_ATTREMPTY, HTML_ATTRURL, NO_BAD_CHARS| Constructor and Description |
|---|
SimpleResultTreeImpl(XSLTCDTMManager dtmManager,
int documentID) |
| Modifier and Type | Method and Description |
|---|---|
void |
appendChild(int newChild,
boolean clone,
boolean cloneDepth)
Append a child to "the end of the document".
|
void |
appendTextChild(java.lang.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 offset,
int length) |
void |
characters(int node,
SerializationHandler handler)
Dispatch the character content of a node to an output handler.
|
void |
characters(java.lang.String str)
This method is used to notify of a character event, but passing the data
as a character String rather than the standard character array.
|
void |
copy(DTMAxisIterator nodes,
SerializationHandler handler) |
void |
copy(int node,
SerializationHandler handler) |
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).
|
void |
dispatchToEvents(int nodeHandle,
org.xml.sax.ContentHandler ch)
Directly create SAX parser events representing the XML content of
a DTM subtree.
|
void |
documentRegistration()
As the DTM is registered with the DTMManager, this method
will be called.
|
void |
documentRelease()
As documents are released from the DTMManager, the DTM implementation
will be notified of the event.
|
void |
endDocument() |
int |
getAttributeNode(int gType,
int element) |
int |
getAttributeNode(int elementHandle,
java.lang.String namespaceURI,
java.lang.String name)
Retrieves an attribute node by local name and namespace URI
%TBD% Note that we currently have no way to support
the DOM's old getAttribute() call, which accesses only the qname.
|
DTMAxisIterator |
getAxisIterator(int axis)
This is a shortcut to the iterators that implement
XPath axes.
|
DTMAxisTraverser |
getAxisTraverser(int axis)
This returns a stateless "traverser", that can navigate over an
XPath axis, though not in document order.
|
DTMAxisIterator |
getChildren(int node) |
org.xml.sax.ContentHandler |
getContentHandler()
Return this DTM's content handler, if it has one.
|
org.xml.sax.ext.DeclHandler |
getDeclHandler()
Return this DTM's DeclHandler, if it has one.
|
int |
getDocument()
Given a DTM which contains only a single document,
find the Node Handle of the Document node.
|
boolean |
getDocumentAllDeclarationsProcessed()
Return an indication of
whether the processor has read the complete DTD.
|
java.lang.String |
getDocumentBaseURI()
Return the base URI of the document entity.
|
java.lang.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.
|
java.lang.String |
getDocumentStandalone(int nodeHandle)
Return an indication of the standalone status of the document,
either "yes" or "no".
|
java.lang.String |
getDocumentSystemIdentifier(int nodeHandle)
Return the system identifier of the document entity.
|
java.lang.String |
getDocumentTypeDeclarationPublicIdentifier()
Return the public identifier of the external subset,
normalized as described in 4.2.2 External Entities [XML].
|
java.lang.String |
getDocumentTypeDeclarationSystemIdentifier()
A document type declaration information item has the following properties:
1.
|
java.lang.String |
getDocumentURI(int node) |
java.lang.String |
getDocumentVersion(int documentHandle)
Return a string representing the XML version of the document.
|
org.xml.sax.DTDHandler |
getDTDHandler()
Return this DTM's DTDHandler, if it has one.
|
DTMManagerDefault |
getDTMManager() |
int |
getElementById(java.lang.String elementId)
Returns the
Element whose ID is given by
elementId. |
Hashtable |
getElementsWithIDs() |
org.xml.sax.EntityResolver |
getEntityResolver()
Return this DTM's EntityResolver, if it has one.
|
org.xml.sax.ErrorHandler |
getErrorHandler()
Return this DTM's ErrorHandler, if it has one.
|
int |
getExpandedTypeID(int nodeHandle)
Given a node handle, return an ID that represents the node's expanded name.
|
int |
getExpandedTypeID(java.lang.String namespace,
java.lang.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 namespace node.
|
DTMAxisIterator |
getIterator()
returns singleton iterator containg the document root
|
java.lang.String |
getLanguage(int node) |
int |
getLastChild(int nodeHandle)
Given a node handle, get the handle of the node's last child.
|
short |
getLevel(int nodeHandle)
Get the depth level of this node in the tree (equals 1 for
a parentless node).
|
org.xml.sax.ext.LexicalHandler |
getLexicalHandler()
Return this DTM's lexical handler, if it has one.
|
java.lang.String |
getLocalName(int nodeHandle)
Given a node handle, return its DOM-style localname.
|
java.lang.String |
getLocalNameFromExpandedNameID(int ExpandedNameID)
Given an expanded-name ID, return the local name part.
|
DTMAxisIterator |
getNamespaceAxisIterator(int axis,
int ns) |
java.lang.String |
getNamespaceFromExpandedNameID(int ExpandedNameID)
Given an expanded-name ID, return the namespace URI part.
|
java.lang.String |
getNamespaceName(int node) |
int |
getNamespaceType(int node) |
java.lang.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 namespaceHandle,
boolean inScope)
Given a namespace handle, advance to the next namespace in the same scope
(local or local-plus-inherited, as selected by getFirstNamespaceNode)
|
int |
getNextSibling(int nodeHandle)
Given a node handle, advance to its next sibling.
|
org.w3c.dom.Node |
getNode(int nodeHandle)
Return an DOM node for the given node.
|
int |
getNodeHandle(int nodeId)
Return the node handle from a node identity.
|
int |
getNodeIdent(int nodehandle)
Return the node identity from a node handle.
|
java.lang.String |
getNodeName(int node)
Given a node handle, return its DOM-style node name.
|
java.lang.String |
getNodeNameX(int node)
Given a node handle, return the XPath node name.
|
short |
getNodeType(int nodeHandle)
Given a node handle, return its DOM-style node type.
|
java.lang.String |
getNodeValue(int nodeHandle)
Given a node handle, return its node value.
|
DTMAxisIterator |
getNodeValueIterator(DTMAxisIterator iter,
int returnType,
java.lang.String value,
boolean op) |
int |
getNSType(int node) |
DTMAxisIterator |
getNthDescendant(int node,
int n,
boolean includeself) |
SerializationHandler |
getOutputDomBuilder() |
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.
|
java.lang.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.
|
DOM |
getResultTreeFrag(int initialSize,
int rtfType) |
DOM |
getResultTreeFrag(int initialSize,
int rtfType,
boolean addToManager) |
int |
getSize() |
javax.xml.transform.SourceLocator |
getSourceLocatorFor(int node)
Get the location of a node in the source document.
|
java.lang.String |
getStringValue() |
XMLString |
getStringValue(int nodeHandle)
Get the string-value of a node as a String object
(see http://www.w3.org/TR/xpath#data-model
for the definition of a node's string-value).
|
char[] |
getStringValueChunk(int nodeHandle,
int chunkIndex,
int[] startAndLen)
Get a character array chunk in the string-value of a node.
|
int |
getStringValueChunkCount(int nodeHandle)
Get number of character array chunks in
the string-value of a node.
|
java.lang.String |
getStringValueX(int nodeHandle) |
DTMAxisIterator |
getTypedAxisIterator(int axis,
int type)
Get an iterator that can navigate over an XPath Axis, predicated by
the extended type ID.
|
DTMAxisIterator |
getTypedChildren(int type) |
java.lang.String |
getUnparsedEntityURI(java.lang.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.
|
boolean |
isAttribute(int node) |
boolean |
isAttributeSpecified(int attributeHandle)
5.
|
boolean |
isCharacterElementContentWhitespace(int nodeHandle)
2.
|
boolean |
isDocumentAllDeclarationsProcessed(int documentHandle)
10.
|
boolean |
isElement(int node) |
boolean |
isNodeAfter(int firstNodeHandle,
int secondNodeHandle)
Figure out whether nodeHandle2 should be considered as being later
in the document than nodeHandle1, in Document Order as defined
by the XPath model.
|
boolean |
isSupported(java.lang.String feature,
java.lang.String version)
Tests whether DTM DOM implementation implements a specific feature and
that feature is supported by this node.
|
boolean |
lessThan(int node1,
int node2) |
java.lang.String |
lookupNamespace(int node,
java.lang.String prefix) |
org.w3c.dom.Node |
makeNode(DTMAxisIterator iter) |
org.w3c.dom.Node |
makeNode(int index) |
org.w3c.dom.NodeList |
makeNodeList(DTMAxisIterator iter) |
org.w3c.dom.NodeList |
makeNodeList(int index) |
void |
migrateTo(DTMManager manager)
Migrate a DTM built with an old DTMManager to a new DTMManager.
|
boolean |
needsTwoThreads() |
DTMAxisIterator |
orderNodes(DTMAxisIterator source,
int node) |
void |
setDocumentBaseURI(java.lang.String baseURI)
Set the base URI of the document entity.
|
boolean |
setEscaping(boolean escape)
Turns special character escaping on/off.
|
void |
setFeature(java.lang.String featureId,
boolean state)
The DTM interfaces are not used in this class.
|
void |
setFilter(StripFilter filter) |
void |
setProperty(java.lang.String property,
java.lang.Object value)
Set a run time property for this DTM instance.
|
void |
setupMapping(java.lang.String[] names,
java.lang.String[] uris,
int[] types,
java.lang.String[] namespaces) |
java.lang.String |
shallowCopy(int node,
SerializationHandler handler) |
void |
startDocument()
We only need to override the endDocument, characters, and
setEscaping interfaces.
|
boolean |
supportsPreStripping()
Return true if the xsl:strip-space or xsl:preserve-space was processed
during construction of the document contained in this DTM.
|
addAttribute, addAttribute, addAttribute, addAttributes, addUniqueAttribute, addXSLAttribute, asContentHandler, asDOM3Serializer, asDOMSerializer, attributeDecl, characters, close, comment, comment, elementDecl, endCDATA, endDTD, endElement, endElement, endEntity, endPrefixMapping, entityReference, error, externalEntityDecl, fatalError, flushPending, getDoctypePublic, getDoctypeSystem, getEncoding, getIndent, getIndentAmount, getMediaType, getNamespaceMappings, getNamespaceURI, getNamespaceURIFromPrefix, getOmitXMLDeclaration, getOutputFormat, getOutputProperty, getOutputPropertyDefault, getOutputStream, getPrefix, getStandalone, getTransformer, getVersion, getWriter, ignorableWhitespace, internalEntityDecl, namespaceAfterStartElement, notationDecl, processingInstruction, reset, serialize, setCdataSectionElements, setCdataSectionElements, setContentHandler, setDoctype, setDoctypePublic, setDoctypeSystem, setDocumentLocator, setDTDEntityExpansion, setEncoding, setIndent, setIndentAmount, setMediaType, setNamespaceMappings, setOmitXMLDeclaration, setOutputFormat, setOutputProperty, setOutputPropertyDefault, setOutputStream, setSourceLocator, setStandalone, setTransformer, setVersion, setWriter, skippedEntity, startCDATA, startDTD, startElement, startElement, startElement, startEntity, startPrefixMapping, startPrefixMapping, unparsedEntityDecl, warningpublic static final int RTF_ROOT
public static final int RTF_TEXT
public static final int NUMBER_OF_NODES
public SimpleResultTreeImpl(XSLTCDTMManager dtmManager, int documentID)
public DTMManagerDefault getDTMManager()
public int getDocument()
DTMgetDocument in interface DOMgetDocument in interface DTMpublic java.lang.String getStringValue()
getStringValue in interface DOMpublic DTMAxisIterator getIterator()
DOMgetIterator in interface DOMpublic DTMAxisIterator getChildren(int node)
getChildren in interface DOMpublic DTMAxisIterator getTypedChildren(int type)
getTypedChildren in interface DOMpublic DTMAxisIterator getAxisIterator(int axis)
DTMgetAxisIterator in interface DOMgetAxisIterator in interface DTMaxis - One of Axes.ANCESTORORSELF, etc.public DTMAxisIterator getTypedAxisIterator(int axis, int type)
DTMgetTypedAxisIterator in interface DOMgetTypedAxisIterator in interface DTMtype - An extended type ID.public DTMAxisIterator getNthDescendant(int node, int n, boolean includeself)
getNthDescendant in interface DOMpublic DTMAxisIterator getNamespaceAxisIterator(int axis, int ns)
getNamespaceAxisIterator in interface DOMpublic DTMAxisIterator getNodeValueIterator(DTMAxisIterator iter, int returnType, java.lang.String value, boolean op)
getNodeValueIterator in interface DOMpublic DTMAxisIterator orderNodes(DTMAxisIterator source, int node)
orderNodes in interface DOMpublic java.lang.String getNodeName(int node)
DTMgetNodeName in interface DOMgetNodeName in interface DTMnode - the id of the node.public java.lang.String getNodeNameX(int node)
DTMgetNodeNameX in interface DOMgetNodeNameX in interface DTMnode - the id of the node.public java.lang.String getNamespaceName(int node)
getNamespaceName in interface DOMpublic int getExpandedTypeID(int nodeHandle)
DTMgetExpandedTypeID in interface DOMgetExpandedTypeID in interface DTMnodeHandle - The handle to the node in question.public int getNamespaceType(int node)
getNamespaceType in interface DOMpublic int getParent(int nodeHandle)
DTMpublic int getAttributeNode(int gType,
int element)
getAttributeNode in interface DOMpublic java.lang.String getStringValueX(int nodeHandle)
getStringValueX in interface DOMpublic void copy(int node,
SerializationHandler handler)
throws TransletException
copy in interface DOMTransletExceptionpublic void copy(DTMAxisIterator nodes, SerializationHandler handler) throws TransletException
copy in interface DOMTransletExceptionpublic java.lang.String shallowCopy(int node,
SerializationHandler handler)
throws TransletException
shallowCopy in interface DOMTransletExceptionpublic void characters(int node,
SerializationHandler handler)
throws TransletException
characters in interface DOMTransletExceptionpublic org.w3c.dom.Node makeNode(DTMAxisIterator iter)
public org.w3c.dom.NodeList makeNodeList(int index)
makeNodeList in interface DOMpublic org.w3c.dom.NodeList makeNodeList(DTMAxisIterator iter)
makeNodeList in interface DOMpublic java.lang.String getLanguage(int node)
getLanguage in interface DOMpublic java.lang.String getDocumentURI(int node)
getDocumentURI in interface DOMpublic void setFilter(StripFilter filter)
public void setupMapping(java.lang.String[] names,
java.lang.String[] uris,
int[] types,
java.lang.String[] namespaces)
setupMapping in interface DOMpublic boolean isAttribute(int node)
isAttribute in interface DOMpublic java.lang.String lookupNamespace(int node,
java.lang.String prefix)
throws TransletException
lookupNamespace in interface DOMTransletExceptionpublic int getNodeIdent(int nodehandle)
getNodeIdent in interface DOMpublic int getNodeHandle(int nodeId)
getNodeHandle in interface DOMpublic DOM getResultTreeFrag(int initialSize, int rtfType)
getResultTreeFrag in interface DOMpublic DOM getResultTreeFrag(int initialSize, int rtfType, boolean addToManager)
getResultTreeFrag in interface DOMpublic SerializationHandler getOutputDomBuilder()
getOutputDomBuilder in interface DOMpublic java.lang.String getUnparsedEntityURI(java.lang.String name)
DTMXML processors may choose to use the System Identifier (if one is provided) to resolve the entity, rather than the URI in the Public Identifier. The details are dependent on the processor, and we would have to support some form of plug-in resolver to handle this properly. Currently, we simply return the System Identifier if present, and hope that it a usable URI or that our caller can map it to one. %REVIEW% Resolve Public Identifiers... or consider changing function name.
If we find a relative URI reference, XML expects it to be resolved in terms of the base URI of the document. The DOM doesn't do that for us, and it isn't entirely clear whether that should be done here; currently that's pushed up to a higher level of our application. (Note that DOM Level 1 didn't store the document's base URI.) %REVIEW% Consider resolving Relative URIs.
(The DOM's statement that "An XML processor may choose to completely expand entities before the structure model is passed to the DOM" refers only to parsed entities, not unparsed, and hence doesn't affect this function.)
getUnparsedEntityURI in interface DOMgetUnparsedEntityURI in interface DTMname - A string containing the Entity Name of the unparsed
entity.public Hashtable getElementsWithIDs()
getElementsWithIDs in interface DOMpublic void startDocument()
throws org.xml.sax.SAXException
startDocument in interface org.xml.sax.ContentHandlerstartDocument in class EmptySerializerorg.xml.sax.SAXExceptionContentHandler.startDocument()public void endDocument()
throws org.xml.sax.SAXException
endDocument in interface org.xml.sax.ContentHandlerendDocument in class EmptySerializerorg.xml.sax.SAXExceptionContentHandler.endDocument()public void characters(java.lang.String str)
throws org.xml.sax.SAXException
ExtendedContentHandlercharacters in interface ExtendedContentHandlercharacters in class EmptySerializerstr - the character dataorg.xml.sax.SAXExceptionExtendedContentHandler.characters(java.lang.String)public void characters(char[] ch,
int offset,
int length)
throws org.xml.sax.SAXException
characters in interface org.xml.sax.ContentHandlercharacters in class EmptySerializerorg.xml.sax.SAXExceptionContentHandler.characters(char[], int, int)public boolean setEscaping(boolean escape)
throws org.xml.sax.SAXException
SerializationHandlersetEscaping in interface SerializationHandlersetEscaping in class EmptySerializerescape - true if escaping is to be set on.org.xml.sax.SAXExceptionSerializationHandler.setEscaping(boolean)public void setFeature(java.lang.String featureId,
boolean state)
setFeature in interface DTMfeatureId - A feature URL.state - true if this feature should be on, false otherwise.public void setProperty(java.lang.String property,
java.lang.Object value)
DTMsetProperty in interface DTMproperty - a String valuevalue - an Object valuepublic DTMAxisTraverser getAxisTraverser(int axis)
DTMgetAxisTraverser in interface DTMaxis - One of Axes.ANCESTORORSELF, etc.public boolean hasChildNodes(int nodeHandle)
DTM%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.
hasChildNodes in interface DTMnodeHandle - int Handle of the node.public int getFirstChild(int nodeHandle)
DTMgetFirstChild in interface DTMnodeHandle - int Handle of the node.public int getLastChild(int nodeHandle)
DTMgetLastChild in interface DTMnodeHandle - int Handle of the node.public int getAttributeNode(int elementHandle,
java.lang.String namespaceURI,
java.lang.String name)
DTMgetAttributeNode in interface DTMelementHandle - 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.nodeName) or DTM.NULL if there is no such
attribute.public int getFirstAttribute(int nodeHandle)
DTMgetFirstAttribute in interface DTMnodeHandle - int Handle of the node.public int getFirstNamespaceNode(int nodeHandle,
boolean inScope)
DTMgetFirstNamespaceNode in interface DTMnodeHandle - 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 node's own
namespace declarations should be returned.public int getNextSibling(int nodeHandle)
DTMgetNextSibling in interface DTMnodeHandle - int Handle of the node.public int getPreviousSibling(int nodeHandle)
DTMgetPreviousSibling in interface DTMnodeHandle - the id of the node.public int getNextAttribute(int nodeHandle)
DTMgetNextAttribute in interface DTMnodeHandle - int Handle of the node.public int getNextNamespaceNode(int baseHandle,
int namespaceHandle,
boolean inScope)
DTMgetNextNamespaceNode in interface DTMbaseHandle - handle to original node from where the first child
was relative to (needed to return nodes in document order).namespaceHandle - handle to node which must be of type
NAMESPACE_NODE.
NEEDSDOC @param inScopepublic int getOwnerDocument(int nodeHandle)
DTMgetOwnerDocument in interface DTMnodeHandle - the id of the node.DTM.getDocumentRoot(int nodeHandle)public int getDocumentRoot(int nodeHandle)
DTMgetDocumentRoot in interface DTMnodeHandle - the id of the node.DTM.getOwnerDocument(int nodeHandle)public XMLString getStringValue(int nodeHandle)
DTMgetStringValue in interface DTMnodeHandle - The node ID.public int getStringValueChunkCount(int nodeHandle)
DTMgetStringValueChunkCount in interface DTMnodeHandle - The node ID.public char[] getStringValueChunk(int nodeHandle,
int chunkIndex,
int[] startAndLen)
DTMgetStringValueChunk in interface DTMnodeHandle - The node ID.chunkIndex - Which chunk to get.startAndLen - A two-integer array which, upon return, WILL
BE FILLED with values representing the chunk's start position
within the returned character buffer and the length of the chunk.public int getExpandedTypeID(java.lang.String namespace,
java.lang.String localName,
int type)
DTMgetExpandedTypeID in interface DTMpublic java.lang.String getLocalNameFromExpandedNameID(int ExpandedNameID)
DTMgetLocalNameFromExpandedNameID in interface DTMExpandedNameID - an ID that represents an expanded-name.public java.lang.String getNamespaceFromExpandedNameID(int ExpandedNameID)
DTMgetNamespaceFromExpandedNameID in interface DTMExpandedNameID - an ID that represents an expanded-name.public java.lang.String getLocalName(int nodeHandle)
DTMgetLocalName in interface DTMnodeHandle - the id of the node.public java.lang.String getPrefix(int nodeHandle)
DTM%REVIEW% Are you sure you want "" for no prefix?
public java.lang.String getNamespaceURI(int nodeHandle)
DTMgetNamespaceURI in interface DTMnodeHandle - the id of the node.public java.lang.String getNodeValue(int nodeHandle)
DTMgetNodeValue in interface DTMnodeHandle - The node id.public short getNodeType(int nodeHandle)
DTM%REVIEW% Generally, returning short is false economy. Return int?
getNodeType in interface DTMnodeHandle - The node id.public short getLevel(int nodeHandle)
DTMpublic boolean isSupported(java.lang.String feature,
java.lang.String version)
DTMisSupported in interface DTMfeature - 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.true if the specified feature is
supported on this node, false otherwise.public java.lang.String getDocumentBaseURI()
DTMgetDocumentBaseURI in interface DTMpublic void setDocumentBaseURI(java.lang.String baseURI)
DTMsetDocumentBaseURI in interface DTMbaseURI - the document base URI String object or null if unknown.public java.lang.String getDocumentSystemIdentifier(int nodeHandle)
DTMgetDocumentSystemIdentifier in interface DTMnodeHandle - The node id, which can be any valid node handle.public java.lang.String getDocumentEncoding(int nodeHandle)
DTMgetDocumentEncoding in interface DTMnodeHandle - The node id, which can be any valid node handle.public java.lang.String getDocumentStandalone(int nodeHandle)
DTMgetDocumentStandalone in interface DTMnodeHandle - The node id, which can be any valid node handle.public java.lang.String getDocumentVersion(int documentHandle)
DTMgetDocumentVersion in interface DTMdocumentHandle - the document handlepublic boolean getDocumentAllDeclarationsProcessed()
DTMgetDocumentAllDeclarationsProcessed in interface DTMtrue if all declarations were processed;
false otherwise.public java.lang.String getDocumentTypeDeclarationSystemIdentifier()
DTMgetDocumentTypeDeclarationSystemIdentifier in interface DTMpublic java.lang.String getDocumentTypeDeclarationPublicIdentifier()
DTMgetDocumentTypeDeclarationPublicIdentifier in interface DTMpublic int getElementById(java.lang.String elementId)
DTMElement 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.
getElementById in interface DTMelementId - The unique id value for an element.public boolean supportsPreStripping()
DTMsupportsPreStripping in interface DTMpublic boolean isNodeAfter(int firstNodeHandle,
int secondNodeHandle)
DTMThere are some cases where ordering isn't defined, and neither are the results of this function -- though we'll generally return true.
%REVIEW% Make sure this does the right thing with attribute nodes!!!
%REVIEW% Consider renaming for clarity. Perhaps isDocumentOrder(a,b)?
isNodeAfter in interface DTMfirstNodeHandle - DOM Node to perform position comparison on.secondNodeHandle - DOM Node to perform position comparison on.(firstNode.documentOrderPosition <= secondNode.documentOrderPosition).public boolean isCharacterElementContentWhitespace(int nodeHandle)
DTMIf there is no declaration for the containing element, an XML processor must assume that the whitespace could be meaningful and return false. If no declaration has been read, but the [all declarations processed] property of the document information item is false (so there may be an unread declaration), then the value of this property is indeterminate for white space characters and should probably be reported as false. It is always false for text nodes that contain anything other than (or in addition to) white space.
Note too that it always returns false for non-Text nodes.
%REVIEW% Joe wants to rename this isWhitespaceInElementContent() for clarity
isCharacterElementContentWhitespace in interface DTMnodeHandle - the node ID.true if the node definitely represents whitespace in
element content; false otherwise.public boolean isDocumentAllDeclarationsProcessed(int documentHandle)
DTMisDocumentAllDeclarationsProcessed in interface DTMdocumentHandle - A node handle that must identify a document.true if all declarations were processed;
false otherwise.public boolean isAttributeSpecified(int attributeHandle)
DTMisAttributeSpecified in interface DTMattributeHandle - The attribute handletrue if the attribute was specified;
false if it was defaulted or the handle doesn't
refer to an attribute node.public void dispatchCharactersEvents(int nodeHandle,
org.xml.sax.ContentHandler ch,
boolean normalize)
throws org.xml.sax.SAXException
DTMdispatchCharactersEvents in interface DTMnodeHandle - 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.org.xml.sax.SAXExceptionpublic void dispatchToEvents(int nodeHandle,
org.xml.sax.ContentHandler ch)
throws org.xml.sax.SAXException
DTMdispatchToEvents in interface DTMnodeHandle - The node ID.ch - A non-null reference to a ContentHandler.org.xml.sax.SAXExceptionpublic org.w3c.dom.Node getNode(int nodeHandle)
DTMpublic boolean needsTwoThreads()
needsTwoThreads in interface DTMpublic org.xml.sax.ContentHandler getContentHandler()
DTMgetContentHandler in interface DTMpublic org.xml.sax.ext.LexicalHandler getLexicalHandler()
DTMgetLexicalHandler in interface DTMpublic org.xml.sax.EntityResolver getEntityResolver()
DTMgetEntityResolver in interface DTMpublic org.xml.sax.DTDHandler getDTDHandler()
DTMgetDTDHandler in interface DTMpublic org.xml.sax.ErrorHandler getErrorHandler()
DTMgetErrorHandler in interface DTMpublic org.xml.sax.ext.DeclHandler getDeclHandler()
DTMgetDeclHandler in interface DTMpublic void appendChild(int newChild,
boolean clone,
boolean cloneDepth)
DTM%REVIEW% DTM maintains an insertion cursor which performs a depth-first tree walk as nodes come in, and this operation is really equivalent to: insertionCursor.appendChild(document.importNode(newChild))) where the insert point is the last element that was appended (or the last one popped back to by an end-element operation).
appendChild in interface DTMnewChild - 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.public void appendTextChild(java.lang.String str)
DTMappendTextChild in interface DTMstr - Non-null reference to a string.public javax.xml.transform.SourceLocator getSourceLocatorFor(int node)
DTMgetSourceLocatorFor in interface DTMnode - an int valueSourceLocator value or null if no location
is availablepublic void documentRegistration()
DTMdocumentRegistration in interface DTMpublic void documentRelease()
DTMdocumentRelease in interface DTMpublic void migrateTo(DTMManager manager)
DTMCopyright © 2023 Apache XML Project. All Rights Reserved.