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.SingletonIterator
_dtmManager, _size, _textArray, NUMBER_OF_NODES, RTF_ROOT, RTF_TEXT
ERR
ADAPTIVE_RTF, FIRST_TYPE, NO_TYPE, NULL, RETURN_CURRENT, RETURN_PARENT, SIMPLE_RTF, TREE_RTF
ATTRIBUTE_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_NODE
HTML_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(String name,
String value)
Add an attribute to the current element.
|
void |
addUniqueAttribute(String qName,
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(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(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) |
void |
comment(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() |
void |
endElement(String elementName)
This method is used to notify that an element has ended.
|
void |
endElement(String uri,
String localName,
String qName) |
int |
getAttributeNode(int gType,
int element) |
int |
getAttributeNode(int elementHandle,
String namespaceURI,
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.
|
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.
|
String |
getDocumentTypeDeclarationPublicIdentifier()
Return the public identifier of the external subset,
normalized as described in 4.2.2 External Entities [XML].
|
String |
getDocumentTypeDeclarationSystemIdentifier()
A document type declaration information item has the following properties:
1.
|
String |
getDocumentURI(int node) |
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(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(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 namespace node.
|
DTMAxisIterator |
getIterator()
returns singleton iterator containg the document root
|
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.
|
String |
getLocalName(int nodeHandle)
Given a node handle, return its DOM-style localname.
|
String |
getLocalNameFromExpandedNameID(int ExpandedNameID)
Given an expanded-name ID, return the local name part.
|
DTMAxisIterator |
getNamespaceAxisIterator(int axis,
int ns) |
String |
getNamespaceFromExpandedNameID(int ExpandedNameID)
Given an expanded-name ID, return the namespace URI part.
|
String |
getNamespaceName(int node) |
int |
getNamespaceType(int node) |
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.
|
String |
getNodeName(int node)
Given a node handle, return its DOM-style node name.
|
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.
|
String |
getNodeValue(int nodeHandle)
Given a node handle, return its node value.
|
DTMAxisIterator |
getNodeValueIterator(DTMAxisIterator iter,
int returnType,
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.
|
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.
|
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.
|
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) |
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.
|
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(String feature,
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) |
String |
lookupNamespace(int node,
String prefix) |
Node |
makeNode(DTMAxisIterator iter) |
Node |
makeNode(int index) |
NodeList |
makeNodeList(DTMAxisIterator iter) |
NodeList |
makeNodeList(int index) |
void |
namespaceAfterStartElement(String prefix,
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(String target,
String data) |
void |
setDocumentBaseURI(String baseURI)
Set the base URI of the document entity.
|
boolean |
setEscaping(boolean escape)
Turns special character escaping on/off.
|
void |
setFeature(String featureId,
boolean state)
Implementation of the DTM interfaces
|
void |
setFilter(StripFilter filter) |
void |
setProperty(String property,
Object value)
Set a run time property for this DTM instance.
|
void |
setupMapping(String[] names,
String[] uris,
int[] types,
String[] namespaces) |
String |
shallowCopy(int node,
SerializationHandler handler) |
void |
startDocument()
We only need to override the endDocument, characters, and
setEscaping interfaces.
|
void |
startElement(String elementName)
This method is used to notify of the start of an element
|
void |
startElement(String uri,
String localName,
String qName)
This method is used to notify that an element is starting.
|
void |
startElement(String uri,
String localName,
String qName,
Attributes attributes) |
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, migrateTo
addAttribute, addAttribute, addAttributes, addXSLAttribute, asContentHandler, asDOM3Serializer, asDOMSerializer, attributeDecl, characters, close, couldThrowException, couldThrowIOException, couldThrowSAXException, couldThrowSAXException, couldThrowSAXException, 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, warning
public AdaptiveResultTreeImpl(XSLTCDTMManager dtmManager, int documentID, DTMWSFilter wsfilter, int initSize, boolean buildIdIndex)
public DOM getNestedDOM()
public int getDocument()
DTM
getDocument
in interface DOM
getDocument
in interface DTM
getDocument
in class SimpleResultTreeImpl
public String getStringValue()
getStringValue
in interface DOM
getStringValue
in class SimpleResultTreeImpl
public DTMAxisIterator getIterator()
DOM
getIterator
in interface DOM
getIterator
in class SimpleResultTreeImpl
public DTMAxisIterator getChildren(int node)
getChildren
in interface DOM
getChildren
in class SimpleResultTreeImpl
public DTMAxisIterator getTypedChildren(int type)
getTypedChildren
in interface DOM
getTypedChildren
in class SimpleResultTreeImpl
public DTMAxisIterator getAxisIterator(int axis)
DTM
getAxisIterator
in interface DOM
getAxisIterator
in interface DTM
getAxisIterator
in class SimpleResultTreeImpl
axis
- One of Axes.ANCESTORORSELF, etc.public DTMAxisIterator getTypedAxisIterator(int axis, int type)
DTM
getTypedAxisIterator
in interface DOM
getTypedAxisIterator
in interface DTM
getTypedAxisIterator
in class SimpleResultTreeImpl
type
- An extended type ID.public DTMAxisIterator getNthDescendant(int node, int n, boolean includeself)
getNthDescendant
in interface DOM
getNthDescendant
in class SimpleResultTreeImpl
public DTMAxisIterator getNamespaceAxisIterator(int axis, int ns)
getNamespaceAxisIterator
in interface DOM
getNamespaceAxisIterator
in class SimpleResultTreeImpl
public DTMAxisIterator getNodeValueIterator(DTMAxisIterator iter, int returnType, String value, boolean op)
getNodeValueIterator
in interface DOM
getNodeValueIterator
in class SimpleResultTreeImpl
public DTMAxisIterator orderNodes(DTMAxisIterator source, int node)
orderNodes
in interface DOM
orderNodes
in class SimpleResultTreeImpl
public String getNodeName(int node)
DTM
getNodeName
in interface DOM
getNodeName
in interface DTM
getNodeName
in class SimpleResultTreeImpl
node
- the id of the node.public String getNodeNameX(int node)
DTM
getNodeNameX
in interface DOM
getNodeNameX
in interface DTM
getNodeNameX
in class SimpleResultTreeImpl
node
- the id of the node.public String getNamespaceName(int node)
getNamespaceName
in interface DOM
getNamespaceName
in class SimpleResultTreeImpl
public int getExpandedTypeID(int nodeHandle)
DTM
getExpandedTypeID
in interface DOM
getExpandedTypeID
in interface DTM
getExpandedTypeID
in class SimpleResultTreeImpl
nodeHandle
- The handle to the node in question.public int getNamespaceType(int node)
getNamespaceType
in interface DOM
getNamespaceType
in class SimpleResultTreeImpl
public int getParent(int nodeHandle)
DTM
public int getAttributeNode(int gType, int element)
getAttributeNode
in interface DOM
getAttributeNode
in class SimpleResultTreeImpl
public String getStringValueX(int nodeHandle)
getStringValueX
in interface DOM
getStringValueX
in class SimpleResultTreeImpl
public void copy(int node, SerializationHandler handler) throws TransletException
copy
in interface DOM
copy
in class SimpleResultTreeImpl
TransletException
public void copy(DTMAxisIterator nodes, SerializationHandler handler) throws TransletException
copy
in interface DOM
copy
in class SimpleResultTreeImpl
TransletException
public String shallowCopy(int node, SerializationHandler handler) throws TransletException
shallowCopy
in interface DOM
shallowCopy
in class SimpleResultTreeImpl
TransletException
public boolean lessThan(int node1, int node2)
lessThan
in interface DOM
lessThan
in class SimpleResultTreeImpl
public void characters(int node, SerializationHandler handler) throws TransletException
characters
in interface DOM
characters
in class SimpleResultTreeImpl
TransletException
public Node makeNode(int index)
makeNode
in interface DOM
makeNode
in class SimpleResultTreeImpl
public Node makeNode(DTMAxisIterator iter)
makeNode
in interface DOM
makeNode
in class SimpleResultTreeImpl
public NodeList makeNodeList(int index)
makeNodeList
in interface DOM
makeNodeList
in class SimpleResultTreeImpl
public NodeList makeNodeList(DTMAxisIterator iter)
makeNodeList
in interface DOM
makeNodeList
in class SimpleResultTreeImpl
public String getLanguage(int node)
getLanguage
in interface DOM
getLanguage
in class SimpleResultTreeImpl
public int getSize()
getSize
in interface DOM
getSize
in class SimpleResultTreeImpl
public String getDocumentURI(int node)
getDocumentURI
in interface DOM
getDocumentURI
in class SimpleResultTreeImpl
public void setFilter(StripFilter filter)
setFilter
in interface DOM
setFilter
in class SimpleResultTreeImpl
public void setupMapping(String[] names, String[] uris, int[] types, String[] namespaces)
setupMapping
in interface DOM
setupMapping
in class SimpleResultTreeImpl
public boolean isElement(int node)
isElement
in interface DOM
isElement
in class SimpleResultTreeImpl
public boolean isAttribute(int node)
isAttribute
in interface DOM
isAttribute
in class SimpleResultTreeImpl
public String lookupNamespace(int node, String prefix) throws TransletException
lookupNamespace
in interface DOM
lookupNamespace
in class SimpleResultTreeImpl
TransletException
public final int getNodeIdent(int nodehandle)
getNodeIdent
in interface DOM
getNodeIdent
in class SimpleResultTreeImpl
public final int getNodeHandle(int nodeId)
getNodeHandle
in interface DOM
getNodeHandle
in class SimpleResultTreeImpl
public DOM getResultTreeFrag(int initialSize, int rtfType)
getResultTreeFrag
in interface DOM
getResultTreeFrag
in class SimpleResultTreeImpl
public SerializationHandler getOutputDomBuilder()
getOutputDomBuilder
in interface DOM
getOutputDomBuilder
in class SimpleResultTreeImpl
public int getNSType(int node)
getNSType
in interface DOM
getNSType
in class SimpleResultTreeImpl
public String getUnparsedEntityURI(String name)
DTM
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. %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 DOM
getUnparsedEntityURI
in interface DTM
getUnparsedEntityURI
in class SimpleResultTreeImpl
name
- A string containing the Entity Name of the unparsed
entity.public Hashtable getElementsWithIDs()
getElementsWithIDs
in interface DOM
getElementsWithIDs
in class SimpleResultTreeImpl
public void startDocument() throws SAXException
SimpleResultTreeImpl
startDocument
in interface ContentHandler
startDocument
in class SimpleResultTreeImpl
SAXException
ContentHandler.startDocument()
public void endDocument() throws SAXException
endDocument
in interface ContentHandler
endDocument
in class SimpleResultTreeImpl
SAXException
ContentHandler.endDocument()
public void characters(String str) throws SAXException
ExtendedContentHandler
characters
in interface ExtendedContentHandler
characters
in class SimpleResultTreeImpl
str
- the character dataSAXException
ExtendedContentHandler.characters(java.lang.String)
public void characters(char[] ch, int offset, int length) throws SAXException
characters
in interface ContentHandler
characters
in class SimpleResultTreeImpl
SAXException
ContentHandler.characters(char[], int, int)
public boolean setEscaping(boolean escape) throws SAXException
SerializationHandler
setEscaping
in interface SerializationHandler
setEscaping
in class SimpleResultTreeImpl
escape
- true if escaping is to be set on.SAXException
SerializationHandler.setEscaping(boolean)
public void startElement(String elementName) throws SAXException
ExtendedContentHandler
startElement
in interface ExtendedContentHandler
startElement
in class EmptySerializer
elementName
- the fully qualified name of the elementSAXException
ExtendedContentHandler.startElement(java.lang.String)
public void startElement(String uri, String localName, String qName) throws SAXException
ExtendedContentHandler
startElement(uri,localName,qname,atts)but without the attributes.
startElement
in interface ExtendedContentHandler
startElement
in class EmptySerializer
uri
- the namespace URI of the elementlocalName
- the local name (without prefix) of the elementqName
- the qualified name of the elementSAXException
ExtendedContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String)
public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException
startElement
in interface ContentHandler
startElement
in class EmptySerializer
SAXException
ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)
public void endElement(String elementName) throws SAXException
ExtendedContentHandler
endElement(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 ExtendedContentHandler
endElement
in class EmptySerializer
elementName
- the fully qualified element name.SAXException
ExtendedContentHandler.endElement(java.lang.String)
public void endElement(String uri, String localName, String qName) throws SAXException
endElement
in interface ContentHandler
endElement
in class EmptySerializer
SAXException
ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)
public void addUniqueAttribute(String qName, String value, int flags) throws SAXException
ExtendedContentHandler
addUniqueAttribute
in interface ExtendedContentHandler
addUniqueAttribute
in class EmptySerializer
qName
- the fully qualified attribute name.value
- the attribute valueflags
- a bitwise flagSAXException
ExtendedContentHandler.addUniqueAttribute(java.lang.String, java.lang.String, int)
public void addAttribute(String name, String value)
ExtendedContentHandler
addAttribute
in interface ExtendedContentHandler
addAttribute
in class EmptySerializer
ExtendedContentHandler.addAttribute(java.lang.String, java.lang.String)
public void namespaceAfterStartElement(String prefix, String uri) throws SAXException
ExtendedContentHandler
startPrefixMapping(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 ExtendedContentHandler
namespaceAfterStartElement
in class EmptySerializer
prefix
- the namespace URI being declareduri
- the prefix that maps to the given namespaceSAXException
ExtendedContentHandler.namespaceAfterStartElement(java.lang.String, java.lang.String)
public void comment(String comment) throws SAXException
ExtendedLexicalHandler
comment
in interface ExtendedLexicalHandler
comment
in class EmptySerializer
comment
- the comment, but unlike the SAX comment() method this
method takes a String rather than a character array.SAXException
ExtendedLexicalHandler.comment(java.lang.String)
public void comment(char[] chars, int offset, int length) throws SAXException
comment
in interface LexicalHandler
comment
in class EmptySerializer
SAXException
LexicalHandler.comment(char[], int, int)
public void processingInstruction(String target, String data) throws SAXException
processingInstruction
in interface ContentHandler
processingInstruction
in class EmptySerializer
SAXException
ContentHandler.processingInstruction(java.lang.String, java.lang.String)
public void setFeature(String featureId, boolean state)
setFeature
in interface DTM
setFeature
in class SimpleResultTreeImpl
featureId
- A feature URL.state
- true if this feature should be on, false otherwise.public void setProperty(String property, Object value)
DTM
setProperty
in interface DTM
setProperty
in class SimpleResultTreeImpl
property
- a String
valuevalue
- an Object
valuepublic DTMAxisTraverser getAxisTraverser(int axis)
DTM
getAxisTraverser
in interface DTM
getAxisTraverser
in class SimpleResultTreeImpl
axis
- 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 DTM
hasChildNodes
in class SimpleResultTreeImpl
nodeHandle
- int Handle of the node.public int getFirstChild(int nodeHandle)
DTM
getFirstChild
in interface DTM
getFirstChild
in class SimpleResultTreeImpl
nodeHandle
- int Handle of the node.public int getLastChild(int nodeHandle)
DTM
getLastChild
in interface DTM
getLastChild
in class SimpleResultTreeImpl
nodeHandle
- int Handle of the node.public int getAttributeNode(int elementHandle, String namespaceURI, String name)
DTM
getAttributeNode
in interface DTM
getAttributeNode
in class SimpleResultTreeImpl
elementHandle
- 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)
DTM
getFirstAttribute
in interface DTM
getFirstAttribute
in class SimpleResultTreeImpl
nodeHandle
- int Handle of the node.public int getFirstNamespaceNode(int nodeHandle, boolean inScope)
DTM
getFirstNamespaceNode
in interface DTM
getFirstNamespaceNode
in class SimpleResultTreeImpl
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 node's own
namespace declarations should be returned.public int getNextSibling(int nodeHandle)
DTM
getNextSibling
in interface DTM
getNextSibling
in class SimpleResultTreeImpl
nodeHandle
- int Handle of the node.public int getPreviousSibling(int nodeHandle)
DTM
getPreviousSibling
in interface DTM
getPreviousSibling
in class SimpleResultTreeImpl
nodeHandle
- the id of the node.public int getNextAttribute(int nodeHandle)
DTM
getNextAttribute
in interface DTM
getNextAttribute
in class SimpleResultTreeImpl
nodeHandle
- int Handle of the node.public int getNextNamespaceNode(int baseHandle, int namespaceHandle, boolean inScope)
DTM
getNextNamespaceNode
in interface DTM
getNextNamespaceNode
in class SimpleResultTreeImpl
baseHandle
- 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)
DTM
getOwnerDocument
in interface DTM
getOwnerDocument
in class SimpleResultTreeImpl
nodeHandle
- the id of the node.DTM.getDocumentRoot(int nodeHandle)
public int getDocumentRoot(int nodeHandle)
DTM
getDocumentRoot
in interface DTM
getDocumentRoot
in class SimpleResultTreeImpl
nodeHandle
- the id of the node.DTM.getOwnerDocument(int nodeHandle)
public XMLString getStringValue(int nodeHandle)
DTM
getStringValue
in interface DTM
getStringValue
in class SimpleResultTreeImpl
nodeHandle
- The node ID.public int getStringValueChunkCount(int nodeHandle)
DTM
getStringValueChunkCount
in interface DTM
getStringValueChunkCount
in class SimpleResultTreeImpl
nodeHandle
- The node ID.public char[] getStringValueChunk(int nodeHandle, int chunkIndex, int[] startAndLen)
DTM
getStringValueChunk
in interface DTM
getStringValueChunk
in class SimpleResultTreeImpl
nodeHandle
- 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(String namespace, String localName, int type)
DTM
getExpandedTypeID
in interface DTM
getExpandedTypeID
in class SimpleResultTreeImpl
public String getLocalNameFromExpandedNameID(int ExpandedNameID)
DTM
getLocalNameFromExpandedNameID
in interface DTM
getLocalNameFromExpandedNameID
in class SimpleResultTreeImpl
ExpandedNameID
- an ID that represents an expanded-name.public String getNamespaceFromExpandedNameID(int ExpandedNameID)
DTM
getNamespaceFromExpandedNameID
in interface DTM
getNamespaceFromExpandedNameID
in class SimpleResultTreeImpl
ExpandedNameID
- an ID that represents an expanded-name.public String getLocalName(int nodeHandle)
DTM
getLocalName
in interface DTM
getLocalName
in class SimpleResultTreeImpl
nodeHandle
- the id of the node.public String getPrefix(int nodeHandle)
DTM
%REVIEW% Are you sure you want "" for no prefix?
getPrefix
in interface DTM
getPrefix
in class SimpleResultTreeImpl
nodeHandle
- the id of the node.public String getNamespaceURI(int nodeHandle)
DTM
getNamespaceURI
in interface DTM
getNamespaceURI
in class SimpleResultTreeImpl
nodeHandle
- the id of the node.public String getNodeValue(int nodeHandle)
DTM
getNodeValue
in interface DTM
getNodeValue
in class SimpleResultTreeImpl
nodeHandle
- The node id.public short getNodeType(int nodeHandle)
DTM
%REVIEW% Generally, returning short is false economy. Return int?
getNodeType
in interface DTM
getNodeType
in class SimpleResultTreeImpl
nodeHandle
- The node id.public short getLevel(int nodeHandle)
DTM
getLevel
in interface DTM
getLevel
in class SimpleResultTreeImpl
nodeHandle
- The node id.public boolean isSupported(String feature, String version)
DTM
isSupported
in interface DTM
isSupported
in class SimpleResultTreeImpl
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
.true
if the specified feature is
supported on this node, false
otherwise.public String getDocumentBaseURI()
DTM
getDocumentBaseURI
in interface DTM
getDocumentBaseURI
in class SimpleResultTreeImpl
public void setDocumentBaseURI(String baseURI)
DTM
setDocumentBaseURI
in interface DTM
setDocumentBaseURI
in class SimpleResultTreeImpl
baseURI
- the document base URI String object or null if unknown.public String getDocumentSystemIdentifier(int nodeHandle)
DTM
getDocumentSystemIdentifier
in interface DTM
getDocumentSystemIdentifier
in class SimpleResultTreeImpl
nodeHandle
- The node id, which can be any valid node handle.public String getDocumentEncoding(int nodeHandle)
DTM
getDocumentEncoding
in interface DTM
getDocumentEncoding
in class SimpleResultTreeImpl
nodeHandle
- The node id, which can be any valid node handle.public String getDocumentStandalone(int nodeHandle)
DTM
getDocumentStandalone
in interface DTM
getDocumentStandalone
in class SimpleResultTreeImpl
nodeHandle
- The node id, which can be any valid node handle.public String getDocumentVersion(int documentHandle)
DTM
getDocumentVersion
in interface DTM
getDocumentVersion
in class SimpleResultTreeImpl
documentHandle
- the document handlepublic boolean getDocumentAllDeclarationsProcessed()
DTM
getDocumentAllDeclarationsProcessed
in interface DTM
getDocumentAllDeclarationsProcessed
in class SimpleResultTreeImpl
true
if all declarations were processed;
false
otherwise.public String getDocumentTypeDeclarationSystemIdentifier()
DTM
getDocumentTypeDeclarationSystemIdentifier
in interface DTM
getDocumentTypeDeclarationSystemIdentifier
in class SimpleResultTreeImpl
public String getDocumentTypeDeclarationPublicIdentifier()
DTM
getDocumentTypeDeclarationPublicIdentifier
in interface DTM
getDocumentTypeDeclarationPublicIdentifier
in class SimpleResultTreeImpl
public int getElementById(String elementId)
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.
getElementById
in interface DTM
getElementById
in class SimpleResultTreeImpl
elementId
- The unique id
value for an element.public boolean supportsPreStripping()
DTM
supportsPreStripping
in interface DTM
supportsPreStripping
in class SimpleResultTreeImpl
public boolean isNodeAfter(int firstNodeHandle, int secondNodeHandle)
DTM
There 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 DTM
isNodeAfter
in class SimpleResultTreeImpl
firstNodeHandle
- DOM Node to perform position comparison on.secondNodeHandle
- DOM Node to perform position comparison on.(firstNode.documentOrderPosition <= secondNode.documentOrderPosition)
.public boolean isCharacterElementContentWhitespace(int nodeHandle)
DTM
If 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 DTM
isCharacterElementContentWhitespace
in class SimpleResultTreeImpl
nodeHandle
- the node ID.true
if the node definitely represents whitespace in
element content; false
otherwise.public boolean isDocumentAllDeclarationsProcessed(int documentHandle)
DTM
isDocumentAllDeclarationsProcessed
in interface DTM
isDocumentAllDeclarationsProcessed
in class SimpleResultTreeImpl
documentHandle
- A node handle that must identify a document.true
if all declarations were processed;
false
otherwise.public boolean isAttributeSpecified(int attributeHandle)
DTM
isAttributeSpecified
in interface DTM
isAttributeSpecified
in class SimpleResultTreeImpl
attributeHandle
- 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
DTM
dispatchCharactersEvents
in interface DTM
dispatchCharactersEvents
in class SimpleResultTreeImpl
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.SAXException
public void dispatchToEvents(int nodeHandle, ContentHandler ch) throws SAXException
DTM
dispatchToEvents
in interface DTM
dispatchToEvents
in class SimpleResultTreeImpl
nodeHandle
- The node ID.ch
- A non-null reference to a ContentHandler.SAXException
public Node getNode(int nodeHandle)
DTM
getNode
in interface DTM
getNode
in class SimpleResultTreeImpl
nodeHandle
- The node ID.public boolean needsTwoThreads()
needsTwoThreads
in interface DTM
needsTwoThreads
in class SimpleResultTreeImpl
public ContentHandler getContentHandler()
DTM
getContentHandler
in interface DTM
getContentHandler
in class SimpleResultTreeImpl
public LexicalHandler getLexicalHandler()
DTM
getLexicalHandler
in interface DTM
getLexicalHandler
in class SimpleResultTreeImpl
public EntityResolver getEntityResolver()
DTM
getEntityResolver
in interface DTM
getEntityResolver
in class SimpleResultTreeImpl
public DTDHandler getDTDHandler()
DTM
getDTDHandler
in interface DTM
getDTDHandler
in class SimpleResultTreeImpl
public ErrorHandler getErrorHandler()
DTM
getErrorHandler
in interface DTM
getErrorHandler
in class SimpleResultTreeImpl
public DeclHandler getDeclHandler()
DTM
getDeclHandler
in interface DTM
getDeclHandler
in class SimpleResultTreeImpl
public 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 DTM
appendChild
in class SimpleResultTreeImpl
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.public void appendTextChild(String str)
DTM
appendTextChild
in interface DTM
appendTextChild
in class SimpleResultTreeImpl
str
- Non-null reference to a string.public SourceLocator getSourceLocatorFor(int node)
DTM
getSourceLocatorFor
in interface DTM
getSourceLocatorFor
in class SimpleResultTreeImpl
node
- an int
valueSourceLocator
value or null if no location
is availablepublic void documentRegistration()
DTM
documentRegistration
in interface DTM
documentRegistration
in class SimpleResultTreeImpl
public void documentRelease()
DTM
documentRelease
in interface DTM
documentRelease
in class SimpleResultTreeImpl
Copyright © 2017 JBoss by Red Hat. All rights reserved.