public class AdaptiveResultTreeImpl extends SimpleResultTreeImpl
<xsl:variable name = "x">
<xsl:call-template name = "test">
<xsl:with-param name="a" select="."/>
</xsl:call-template>
</xsl:variable>
In this example the result produced by
AdaptiveResultTreeImpl can be considered as a smart switcher between SimpleResultTreeImpl
and SAXImpl. It treats the RTF as simple Text and uses the SimpleResultTreeImpl model
at the beginning. However, if it receives a call which indicates that this is a DOM tree
(e.g. startElement), it will automatically transform itself into a wrapper around a
SAXImpl. In this way we can have a light-weight model when the result only contains
simple text, while at the same time it still works when the RTF is a DOM tree.
All methods in this class are overridden to delegate the action to the wrapped SAXImpl object
if it is non-null, or delegate the action to the SimpleResultTreeImpl if there is no
wrapped SAXImpl.
%REVISIT% Can we combine this class with SimpleResultTreeImpl? I think it is possible, but
it will make SimpleResultTreeImpl more expensive. I will use two separate classes at
this time.
SimpleResultTreeImpl.SimpleIterator, SimpleResultTreeImpl.SingletonIteratorNUMBER_OF_NODES, RTF_ROOT, RTF_TEXTADAPTIVE_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 |
|---|
AdaptiveResultTreeImpl(XSLTCDTMManager dtmManager,
int documentID,
DTMWSFilter wsfilter,
int initSize,
boolean buildIdIndex) |
| Modifier and Type | Method and Description |
|---|---|
void |
addAttribute(java.lang.String name,
java.lang.String value)
Add an attribute to the current element.
|
void |
addUniqueAttribute(java.lang.String qName,
java.lang.String value,
int flags)
Add a unique attribute to the current element.
|
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)
Receive notification of character data.
|
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 |
comment(char[] chars,
int offset,
int length)
Report an XML comment anywhere in the document.
|
void |
comment(java.lang.String comment)
This method is used to notify of a comment
|
void |
copy(DTMAxisIterator nodes,
SerializationHandler handler) |
void |
copy(int node,
SerializationHandler handler) |
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 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()
Receive notification of the end of a document.
|
void |
endElement(java.lang.String elementName)
This method is used to notify that an element has ended.
|
void |
endElement(java.lang.String uri,
java.lang.String localName,
java.lang.String qName)
Receive notification of the end of an element.
|
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) |
ContentHandler |
getContentHandler()
Return this DTM's content handler, if it has one.
|
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.
|
DTDHandler |
getDTDHandler()
Return this DTM's DTDHandler, if it has one.
|
int |
getElementById(java.lang.String elementId)
Returns the
Element whose ID is given by
elementId. |
Hashtable |
getElementsWithIDs() |
EntityResolver |
getEntityResolver()
Return this DTM's EntityResolver, if it has one.
|
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).
|
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.)
|
DOM |
getNestedDOM() |
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.
|
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) |
int |
getSize() |
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) |
Node |
makeNode(DTMAxisIterator iter) |
Node |
makeNode(int index) |
NodeList |
makeNodeList(DTMAxisIterator iter) |
NodeList |
makeNodeList(int index) |
void |
namespaceAfterStartElement(java.lang.String prefix,
java.lang.String uri)
This method is used to notify that a prefix mapping is to start, but
after an element is started.
|
boolean |
needsTwoThreads() |
DTMAxisIterator |
orderNodes(DTMAxisIterator source,
int node) |
void |
processingInstruction(java.lang.String target,
java.lang.String data)
Receive notification of a processing instruction.
|
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)
Implementation of the DTM interfaces
|
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.
|
void |
startElement(java.lang.String elementName)
This method is used to notify of the start of an element
|
void |
startElement(java.lang.String uri,
java.lang.String localName,
java.lang.String qName)
This method is used to notify that an element is starting.
|
void |
startElement(java.lang.String uri,
java.lang.String localName,
java.lang.String qName,
Attributes attributes)
Receive notification of the beginning of an element.
|
boolean |
supportsPreStripping()
Return true if the xsl:strip-space or xsl:preserve-space was processed
during construction of the document contained in this DTM.
|
getDTMManager, getResultTreeFrag, migrateToaddAttribute, addAttribute, addAttributes, addXSLAttribute, asContentHandler, asDOM3Serializer, asDOMSerializer, attributeDecl, characters, close, elementDecl, endCDATA, endDTD, 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, notationDecl, 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, startEntity, startPrefixMapping, startPrefixMapping, unparsedEntityDecl, warningpublic AdaptiveResultTreeImpl(XSLTCDTMManager dtmManager, int documentID, DTMWSFilter wsfilter, int initSize, boolean buildIdIndex)
public DOM getNestedDOM()
public int getDocument()
DTMgetDocument in interface DOMgetDocument in interface DTMgetDocument in class SimpleResultTreeImplpublic java.lang.String getStringValue()
getStringValue in interface DOMgetStringValue in class SimpleResultTreeImplpublic DTMAxisIterator getIterator()
DOMgetIterator in interface DOMgetIterator in class SimpleResultTreeImplpublic DTMAxisIterator getChildren(int node)
getChildren in interface DOMgetChildren in class SimpleResultTreeImplpublic DTMAxisIterator getTypedChildren(int type)
getTypedChildren in interface DOMgetTypedChildren in class SimpleResultTreeImplpublic DTMAxisIterator getAxisIterator(int axis)
DTMgetAxisIterator in interface DOMgetAxisIterator in interface DTMgetAxisIterator in class SimpleResultTreeImplaxis - One of Axes.ANCESTORORSELF, etc.public DTMAxisIterator getTypedAxisIterator(int axis, int type)
DTMgetTypedAxisIterator in interface DOMgetTypedAxisIterator in interface DTMgetTypedAxisIterator in class SimpleResultTreeImpltype - An extended type ID.public DTMAxisIterator getNthDescendant(int node, int n, boolean includeself)
getNthDescendant in interface DOMgetNthDescendant in class SimpleResultTreeImplpublic DTMAxisIterator getNamespaceAxisIterator(int axis, int ns)
getNamespaceAxisIterator in interface DOMgetNamespaceAxisIterator in class SimpleResultTreeImplpublic DTMAxisIterator getNodeValueIterator(DTMAxisIterator iter, int returnType, java.lang.String value, boolean op)
getNodeValueIterator in interface DOMgetNodeValueIterator in class SimpleResultTreeImplpublic DTMAxisIterator orderNodes(DTMAxisIterator source, int node)
orderNodes in interface DOMorderNodes in class SimpleResultTreeImplpublic java.lang.String getNodeName(int node)
DTMgetNodeName in interface DOMgetNodeName in interface DTMgetNodeName in class SimpleResultTreeImplnode - the id of the node.public java.lang.String getNodeNameX(int node)
DTMgetNodeNameX in interface DOMgetNodeNameX in interface DTMgetNodeNameX in class SimpleResultTreeImplnode - the id of the node.public java.lang.String getNamespaceName(int node)
getNamespaceName in interface DOMgetNamespaceName in class SimpleResultTreeImplpublic int getExpandedTypeID(int nodeHandle)
DTMgetExpandedTypeID in interface DOMgetExpandedTypeID in interface DTMgetExpandedTypeID in class SimpleResultTreeImplnodeHandle - The handle to the node in question.public int getNamespaceType(int node)
getNamespaceType in interface DOMgetNamespaceType in class SimpleResultTreeImplpublic int getParent(int nodeHandle)
DTMpublic int getAttributeNode(int gType,
int element)
getAttributeNode in interface DOMgetAttributeNode in class SimpleResultTreeImplpublic java.lang.String getStringValueX(int nodeHandle)
getStringValueX in interface DOMgetStringValueX in class SimpleResultTreeImplpublic void copy(int node,
SerializationHandler handler)
throws TransletException
copy in interface DOMcopy in class SimpleResultTreeImplTransletExceptionpublic void copy(DTMAxisIterator nodes, SerializationHandler handler) throws TransletException
copy in interface DOMcopy in class SimpleResultTreeImplTransletExceptionpublic java.lang.String shallowCopy(int node,
SerializationHandler handler)
throws TransletException
shallowCopy in interface DOMshallowCopy in class SimpleResultTreeImplTransletExceptionpublic boolean lessThan(int node1,
int node2)
lessThan in interface DOMlessThan in class SimpleResultTreeImplpublic void characters(int node,
SerializationHandler handler)
throws TransletException
characters in interface DOMcharacters in class SimpleResultTreeImplTransletExceptionpublic Node makeNode(int index)
makeNode in interface DOMmakeNode in class SimpleResultTreeImplpublic Node makeNode(DTMAxisIterator iter)
makeNode in interface DOMmakeNode in class SimpleResultTreeImplpublic NodeList makeNodeList(int index)
makeNodeList in interface DOMmakeNodeList in class SimpleResultTreeImplpublic NodeList makeNodeList(DTMAxisIterator iter)
makeNodeList in interface DOMmakeNodeList in class SimpleResultTreeImplpublic java.lang.String getLanguage(int node)
getLanguage in interface DOMgetLanguage in class SimpleResultTreeImplpublic int getSize()
getSize in interface DOMgetSize in class SimpleResultTreeImplpublic java.lang.String getDocumentURI(int node)
getDocumentURI in interface DOMgetDocumentURI in class SimpleResultTreeImplpublic void setFilter(StripFilter filter)
setFilter in interface DOMsetFilter in class SimpleResultTreeImplpublic void setupMapping(java.lang.String[] names,
java.lang.String[] uris,
int[] types,
java.lang.String[] namespaces)
setupMapping in interface DOMsetupMapping in class SimpleResultTreeImplpublic boolean isElement(int node)
isElement in interface DOMisElement in class SimpleResultTreeImplpublic boolean isAttribute(int node)
isAttribute in interface DOMisAttribute in class SimpleResultTreeImplpublic java.lang.String lookupNamespace(int node,
java.lang.String prefix)
throws TransletException
lookupNamespace in interface DOMlookupNamespace in class SimpleResultTreeImplTransletExceptionpublic final int getNodeIdent(int nodehandle)
getNodeIdent in interface DOMgetNodeIdent in class SimpleResultTreeImplpublic final int getNodeHandle(int nodeId)
getNodeHandle in interface DOMgetNodeHandle in class SimpleResultTreeImplpublic DOM getResultTreeFrag(int initialSize, int rtfType)
getResultTreeFrag in interface DOMgetResultTreeFrag in class SimpleResultTreeImplpublic SerializationHandler getOutputDomBuilder()
getOutputDomBuilder in interface DOMgetOutputDomBuilder in class SimpleResultTreeImplpublic int getNSType(int node)
getNSType in interface DOMgetNSType in class SimpleResultTreeImplpublic 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 DTMgetUnparsedEntityURI in class SimpleResultTreeImplname - A string containing the Entity Name of the unparsed
entity.public Hashtable getElementsWithIDs()
getElementsWithIDs in interface DOMgetElementsWithIDs in class SimpleResultTreeImplpublic void startDocument()
throws SAXException
SimpleResultTreeImplstartDocument in interface ContentHandlerstartDocument in class SimpleResultTreeImplSAXException - any SAX exception, possibly
wrapping another exceptionContentHandler.startDocument()public void endDocument()
throws SAXException
ContentHandlerThere is an apparent contradiction between the
documentation for this method and the documentation for ErrorHandler.fatalError(org.xml.sax.SAXParseException). Until this ambiguity is
resolved in a future major release, clients should make no
assumptions about whether endDocument() will or will not be
invoked when the parser has reported a fatalError() or thrown
an exception.
The SAX parser will invoke this method only once, and it will be the last method invoked during the parse. The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of input.
endDocument in interface ContentHandlerendDocument in class SimpleResultTreeImplSAXException - any SAX exception, possibly
wrapping another exceptionContentHandler.endDocument()public void characters(java.lang.String str)
throws SAXException
ExtendedContentHandlercharacters in interface ExtendedContentHandlercharacters in class SimpleResultTreeImplstr - the character dataSAXExceptionExtendedContentHandler.characters(java.lang.String)public void characters(char[] ch,
int offset,
int length)
throws SAXException
ContentHandlerThe Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity so that the Locator provides useful information.
The application must not attempt to read from the array outside of the specified range.
Individual characters may consist of more than one Java
char value. There are two important cases where this
happens, because characters can't be represented in just sixteen bits.
In one case, characters are represented in a Surrogate Pair,
using two special Unicode values. Such characters are in the so-called
"Astral Planes", with a code point above U+FFFF. A second case involves
composite characters, such as a base character combining with one or
more accent characters.
Your code should not assume that algorithms using
char-at-a-time idioms will be working in character
units; in some cases they will split characters. This is relevant
wherever XML permits arbitrary characters, such as attribute values,
processing instruction data, and comments as well as in data reported
from this method. It's also generally relevant whenever Java code
manipulates internationalized text; the issue isn't unique to XML.
Note that some parsers will report whitespace in element
content using the ignorableWhitespace
method rather than this one (validating parsers must
do so).
characters in interface ContentHandlercharacters in class SimpleResultTreeImplch - the characters from the XML documentoffset - the start position in the arraylength - the number of characters to read from the arraySAXException - any SAX exception, possibly
wrapping another exceptionContentHandler.characters(char[], int, int)public boolean setEscaping(boolean escape)
throws SAXException
SerializationHandlersetEscaping in interface SerializationHandlersetEscaping in class SimpleResultTreeImplescape - true if escaping is to be set on.SAXExceptionSerializationHandler.setEscaping(boolean)public void startElement(java.lang.String elementName)
throws SAXException
ExtendedContentHandlerstartElement in interface ExtendedContentHandlerstartElement in class EmptySerializerelementName - the fully qualified name of the elementSAXExceptionExtendedContentHandler.startElement(java.lang.String)public void startElement(java.lang.String uri,
java.lang.String localName,
java.lang.String qName)
throws SAXException
ExtendedContentHandlerstartElement(uri,localName,qname,atts)but without the attributes.
startElement in interface ExtendedContentHandlerstartElement in class EmptySerializeruri - the namespace URI of the elementlocalName - the local name (without prefix) of the elementqName - the qualified name of the elementSAXExceptionExtendedContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String)public void startElement(java.lang.String uri,
java.lang.String localName,
java.lang.String qName,
Attributes attributes)
throws SAXException
ContentHandlerThe Parser will invoke this method at the beginning of every
element in the XML document; there will be a corresponding
endElement event for every startElement event
(even when the element is empty). All of the element's content will be
reported, in order, before the corresponding endElement
event.
This event allows up to three name components for each element:
Any or all of these may be provided, depending on the values of the http://xml.org/sax/features/namespaces and the http://xml.org/sax/features/namespace-prefixes properties:
Note that the attribute list provided will contain only
attributes with explicit values (specified or defaulted):
#IMPLIED attributes will be omitted. The attribute list
will contain attributes used for Namespace declarations
(xmlns* attributes) only if the
http://xml.org/sax/features/namespace-prefixes
property is true (it is false by default, and support for a
true value is optional).
Like characters(), attribute values may have
characters that need more than one char value.
startElement in interface ContentHandlerstartElement in class EmptySerializeruri - the Namespace URI, or the empty string if the
element has no Namespace URI or if Namespace
processing is not being performedlocalName - the local name (without prefix), or the
empty string if Namespace processing is not being
performedqName - the qualified name (with prefix), or the
empty string if qualified names are not availableattributes - the attributes attached to the element. If
there are no attributes, it shall be an empty
Attributes object. The value of this object after
startElement returns is undefinedSAXException - any SAX exception, possibly
wrapping another exceptionContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)public void endElement(java.lang.String elementName)
throws SAXException
ExtendedContentHandlerendElement(namespaceURI,localName,qName)only the last parameter is passed. If needed the serializer can derive the localName from the qualified name and derive the namespaceURI from its implementation.
endElement in interface ExtendedContentHandlerendElement in class EmptySerializerelementName - the fully qualified element name.SAXExceptionExtendedContentHandler.endElement(java.lang.String)public void endElement(java.lang.String uri,
java.lang.String localName,
java.lang.String qName)
throws SAXException
ContentHandlerThe SAX parser will invoke this method at the end of every
element in the XML document; there will be a corresponding
startElement event for every endElement
event (even when the element is empty).
For information on the names, see startElement.
endElement in interface ContentHandlerendElement in class EmptySerializeruri - the Namespace URI, or the empty string if the
element has no Namespace URI or if Namespace
processing is not being performedlocalName - the local name (without prefix), or the
empty string if Namespace processing is not being
performedqName - the qualified XML name (with prefix), or the
empty string if qualified names are not availableSAXException - any SAX exception, possibly
wrapping another exceptionContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)public void addUniqueAttribute(java.lang.String qName,
java.lang.String value,
int flags)
throws SAXException
ExtendedContentHandleraddUniqueAttribute in interface ExtendedContentHandleraddUniqueAttribute in class EmptySerializerqName - the fully qualified attribute name.value - the attribute valueflags - a bitwise flagSAXExceptionExtendedContentHandler.addUniqueAttribute(java.lang.String, java.lang.String, int)public void addAttribute(java.lang.String name,
java.lang.String value)
ExtendedContentHandleraddAttribute in interface ExtendedContentHandleraddAttribute in class EmptySerializerExtendedContentHandler.addAttribute(java.lang.String, java.lang.String)public void namespaceAfterStartElement(java.lang.String prefix,
java.lang.String uri)
throws SAXException
ExtendedContentHandlerstartPrefixMapping(prefix,uri)is used just before an element starts and applies to the element to come, not to the current element. This method applies to the current element. For example one could make the calls in this order:
startElement("prfx8:elem9")
namespaceAfterStartElement("http://namespace8","prfx8")
namespaceAfterStartElement in interface ExtendedContentHandlernamespaceAfterStartElement in class EmptySerializerprefix - the namespace URI being declareduri - the prefix that maps to the given namespaceSAXExceptionExtendedContentHandler.namespaceAfterStartElement(java.lang.String, java.lang.String)public void comment(java.lang.String comment)
throws SAXException
ExtendedLexicalHandlercomment in interface ExtendedLexicalHandlercomment in class EmptySerializercomment - the comment, but unlike the SAX comment() method this
method takes a String rather than a character array.SAXExceptionExtendedLexicalHandler.comment(java.lang.String)public void comment(char[] chars,
int offset,
int length)
throws SAXException
LexicalHandlerThis callback will be used for comments inside or outside the document element, including comments in the external DTD subset (if read). Comments in the DTD must be properly nested inside start/endDTD and start/endEntity events (if used).
comment in interface LexicalHandlercomment in class EmptySerializerchars - An array holding the characters in the comment.offset - The starting position in the array.length - The number of characters to use from the array.SAXException - The application may raise an exception.LexicalHandler.comment(char[], int, int)public void processingInstruction(java.lang.String target,
java.lang.String data)
throws SAXException
ContentHandlerThe Parser will invoke this method once for each processing instruction found: note that processing instructions may occur before or after the main document element.
A SAX parser must never report an XML declaration (XML 1.0, section 2.8) or a text declaration (XML 1.0, section 4.3.1) using this method.
Like characters(), processing instruction
data may have characters that need more than one char
value.
processingInstruction in interface ContentHandlerprocessingInstruction in class EmptySerializertarget - the processing instruction targetdata - the processing instruction data, or null if
none was supplied. The data does not include any
whitespace separating it from the targetSAXException - any SAX exception, possibly
wrapping another exceptionContentHandler.processingInstruction(java.lang.String, java.lang.String)public void setFeature(java.lang.String featureId,
boolean state)
setFeature in interface DTMsetFeature in class SimpleResultTreeImplfeatureId - 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 DTMsetProperty in class SimpleResultTreeImplproperty - a String valuevalue - an Object valuepublic DTMAxisTraverser getAxisTraverser(int axis)
DTMgetAxisTraverser in interface DTMgetAxisTraverser in class SimpleResultTreeImplaxis - 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 DTMhasChildNodes in class SimpleResultTreeImplnodeHandle - int Handle of the node.public int getFirstChild(int nodeHandle)
DTMgetFirstChild in interface DTMgetFirstChild in class SimpleResultTreeImplnodeHandle - int Handle of the node.public int getLastChild(int nodeHandle)
DTMgetLastChild in interface DTMgetLastChild in class SimpleResultTreeImplnodeHandle - int Handle of the node.public int getAttributeNode(int elementHandle,
java.lang.String namespaceURI,
java.lang.String name)
DTMgetAttributeNode in interface DTMgetAttributeNode in class SimpleResultTreeImplelementHandle - 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 DTMgetFirstAttribute in class SimpleResultTreeImplnodeHandle - int Handle of the node.public int getFirstNamespaceNode(int nodeHandle,
boolean inScope)
DTMgetFirstNamespaceNode in interface DTMgetFirstNamespaceNode in class SimpleResultTreeImplnodeHandle - 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 DTMgetNextSibling in class SimpleResultTreeImplnodeHandle - int Handle of the node.public int getPreviousSibling(int nodeHandle)
DTMgetPreviousSibling in interface DTMgetPreviousSibling in class SimpleResultTreeImplnodeHandle - the id of the node.public int getNextAttribute(int nodeHandle)
DTMgetNextAttribute in interface DTMgetNextAttribute in class SimpleResultTreeImplnodeHandle - int Handle of the node.public int getNextNamespaceNode(int baseHandle,
int namespaceHandle,
boolean inScope)
DTMgetNextNamespaceNode in interface DTMgetNextNamespaceNode in class SimpleResultTreeImplbaseHandle - 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 DTMgetOwnerDocument in class SimpleResultTreeImplnodeHandle - the id of the node.DTM.getDocumentRoot(int nodeHandle)public int getDocumentRoot(int nodeHandle)
DTMgetDocumentRoot in interface DTMgetDocumentRoot in class SimpleResultTreeImplnodeHandle - the id of the node.DTM.getOwnerDocument(int nodeHandle)public XMLString getStringValue(int nodeHandle)
DTMgetStringValue in interface DTMgetStringValue in class SimpleResultTreeImplnodeHandle - The node ID.public int getStringValueChunkCount(int nodeHandle)
DTMgetStringValueChunkCount in interface DTMgetStringValueChunkCount in class SimpleResultTreeImplnodeHandle - The node ID.public char[] getStringValueChunk(int nodeHandle,
int chunkIndex,
int[] startAndLen)
DTMgetStringValueChunk in interface DTMgetStringValueChunk in class SimpleResultTreeImplnodeHandle - 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 DTMgetExpandedTypeID in class SimpleResultTreeImplpublic java.lang.String getLocalNameFromExpandedNameID(int ExpandedNameID)
DTMgetLocalNameFromExpandedNameID in interface DTMgetLocalNameFromExpandedNameID in class SimpleResultTreeImplExpandedNameID - an ID that represents an expanded-name.public java.lang.String getNamespaceFromExpandedNameID(int ExpandedNameID)
DTMgetNamespaceFromExpandedNameID in interface DTMgetNamespaceFromExpandedNameID in class SimpleResultTreeImplExpandedNameID - an ID that represents an expanded-name.public java.lang.String getLocalName(int nodeHandle)
DTMgetLocalName in interface DTMgetLocalName in class SimpleResultTreeImplnodeHandle - the id of the node.public java.lang.String getPrefix(int nodeHandle)
DTM%REVIEW% Are you sure you want "" for no prefix?
getPrefix in interface DTMgetPrefix in class SimpleResultTreeImplnodeHandle - the id of the node.public java.lang.String getNamespaceURI(int nodeHandle)
DTMgetNamespaceURI in interface DTMgetNamespaceURI in class SimpleResultTreeImplnodeHandle - the id of the node.public java.lang.String getNodeValue(int nodeHandle)
DTMgetNodeValue in interface DTMgetNodeValue in class SimpleResultTreeImplnodeHandle - The node id.public short getNodeType(int nodeHandle)
DTM%REVIEW% Generally, returning short is false economy. Return int?
getNodeType in interface DTMgetNodeType in class SimpleResultTreeImplnodeHandle - The node id.public short getLevel(int nodeHandle)
DTMgetLevel in interface DTMgetLevel in class SimpleResultTreeImplnodeHandle - The node id.public boolean isSupported(java.lang.String feature,
java.lang.String version)
DTMisSupported in interface DTMisSupported in class SimpleResultTreeImplfeature - 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 DTMgetDocumentBaseURI in class SimpleResultTreeImplpublic void setDocumentBaseURI(java.lang.String baseURI)
DTMsetDocumentBaseURI in interface DTMsetDocumentBaseURI in class SimpleResultTreeImplbaseURI - the document base URI String object or null if unknown.public java.lang.String getDocumentSystemIdentifier(int nodeHandle)
DTMgetDocumentSystemIdentifier in interface DTMgetDocumentSystemIdentifier in class SimpleResultTreeImplnodeHandle - The node id, which can be any valid node handle.public java.lang.String getDocumentEncoding(int nodeHandle)
DTMgetDocumentEncoding in interface DTMgetDocumentEncoding in class SimpleResultTreeImplnodeHandle - The node id, which can be any valid node handle.public java.lang.String getDocumentStandalone(int nodeHandle)
DTMgetDocumentStandalone in interface DTMgetDocumentStandalone in class SimpleResultTreeImplnodeHandle - The node id, which can be any valid node handle.public java.lang.String getDocumentVersion(int documentHandle)
DTMgetDocumentVersion in interface DTMgetDocumentVersion in class SimpleResultTreeImpldocumentHandle - the document handlepublic boolean getDocumentAllDeclarationsProcessed()
DTMgetDocumentAllDeclarationsProcessed in interface DTMgetDocumentAllDeclarationsProcessed in class SimpleResultTreeImpltrue if all declarations were processed;
false otherwise.public java.lang.String getDocumentTypeDeclarationSystemIdentifier()
DTMgetDocumentTypeDeclarationSystemIdentifier in interface DTMgetDocumentTypeDeclarationSystemIdentifier in class SimpleResultTreeImplpublic java.lang.String getDocumentTypeDeclarationPublicIdentifier()
DTMgetDocumentTypeDeclarationPublicIdentifier in interface DTMgetDocumentTypeDeclarationPublicIdentifier in class SimpleResultTreeImplpublic 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 DTMgetElementById in class SimpleResultTreeImplelementId - The unique id value for an element.public boolean supportsPreStripping()
DTMsupportsPreStripping in interface DTMsupportsPreStripping in class SimpleResultTreeImplpublic 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 DTMisNodeAfter in class SimpleResultTreeImplfirstNodeHandle - 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 DTMisCharacterElementContentWhitespace in class SimpleResultTreeImplnodeHandle - the node ID.true if the node definitely represents whitespace in
element content; false otherwise.public boolean isDocumentAllDeclarationsProcessed(int documentHandle)
DTMisDocumentAllDeclarationsProcessed in interface DTMisDocumentAllDeclarationsProcessed in class SimpleResultTreeImpldocumentHandle - A node handle that must identify a document.true if all declarations were processed;
false otherwise.public boolean isAttributeSpecified(int attributeHandle)
DTMisAttributeSpecified in interface DTMisAttributeSpecified in class SimpleResultTreeImplattributeHandle - 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,
ContentHandler ch,
boolean normalize)
throws SAXException
DTMdispatchCharactersEvents in interface DTMdispatchCharactersEvents in class SimpleResultTreeImplnodeHandle - 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.SAXExceptionpublic void dispatchToEvents(int nodeHandle,
ContentHandler ch)
throws SAXException
DTMdispatchToEvents in interface DTMdispatchToEvents in class SimpleResultTreeImplnodeHandle - The node ID.ch - A non-null reference to a ContentHandler.SAXExceptionpublic Node getNode(int nodeHandle)
DTMgetNode in interface DTMgetNode in class SimpleResultTreeImplnodeHandle - The node ID.public boolean needsTwoThreads()
needsTwoThreads in interface DTMneedsTwoThreads in class SimpleResultTreeImplpublic ContentHandler getContentHandler()
DTMgetContentHandler in interface DTMgetContentHandler in class SimpleResultTreeImplpublic LexicalHandler getLexicalHandler()
DTMgetLexicalHandler in interface DTMgetLexicalHandler in class SimpleResultTreeImplpublic EntityResolver getEntityResolver()
DTMgetEntityResolver in interface DTMgetEntityResolver in class SimpleResultTreeImplpublic DTDHandler getDTDHandler()
DTMgetDTDHandler in interface DTMgetDTDHandler in class SimpleResultTreeImplpublic ErrorHandler getErrorHandler()
DTMgetErrorHandler in interface DTMgetErrorHandler in class SimpleResultTreeImplpublic DeclHandler getDeclHandler()
DTMgetDeclHandler in interface DTMgetDeclHandler in class SimpleResultTreeImplpublic 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 DTMappendChild in class SimpleResultTreeImplnewChild - 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 DTMappendTextChild in class SimpleResultTreeImplstr - Non-null reference to a string.public SourceLocator getSourceLocatorFor(int node)
DTMgetSourceLocatorFor in interface DTMgetSourceLocatorFor in class SimpleResultTreeImplnode - an int valueSourceLocator value or null if no location
is availablepublic void documentRegistration()
DTMdocumentRegistration in interface DTMdocumentRegistration in class SimpleResultTreeImplpublic void documentRelease()
DTMdocumentRelease in interface DTMdocumentRelease in class SimpleResultTreeImplCopyright © 2014 Apache XML Project. All Rights Reserved.