org.apache.xalan.xsltc.dom
Class AdaptiveResultTreeImpl
java.lang.Object
org.apache.xml.serializer.EmptySerializer
org.apache.xalan.xsltc.dom.SimpleResultTreeImpl
org.apache.xalan.xsltc.dom.AdaptiveResultTreeImpl
- All Implemented Interfaces:
- ContentHandler, DeclHandler, DOM, DOMSerializer, DTM, ErrorHandler, ExtendedContentHandler, ExtendedLexicalHandler, LexicalHandler, SerializationHandler, Serializer, XSLOutputAttributes
- public class AdaptiveResultTreeImpl
- extends SimpleResultTreeImpl
AdaptiveResultTreeImpl is a adaptive DOM model for result tree fragments (RTF). It is
used in the case where the RTF is likely to be pure text yet it can still be a DOM tree.
It is designed for RTFs which have <xsl:call-template> or <xsl:apply-templates> in
the contents. Example:
<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 is likely to be a single
Text node. But it can also be a DOM tree. This kind of RTF cannot be modelled by
SimpleResultTreeImpl.
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.
Fields inherited from interface org.apache.xml.dtm.DTM |
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 |
Method Summary |
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.
|
Methods inherited from class org.apache.xml.serializer.EmptySerializer |
addAttribute, addAttributes, asContentHandler, asDOMSerializer, attributeDecl, close, elementDecl, endCDATA, endDTD, endEntity, endPrefixMapping, entityReference, error, externalEntityDecl, fatalError, flushPending, getDoctypePublic, getDoctypeSystem, getEncoding, getIndent, getIndentAmount, getMediaType, getNamespaceMappings, getNamespaceURI, getNamespaceURIFromPrefix, getOmitXMLDeclaration, getOutputFormat, getOutputStream, getPrefix, getStandalone, getTransformer, getVersion, getWriter, ignorableWhitespace, internalEntityDecl, reset, serialize, setCdataSectionElements, setCdataSectionElements, setContentHandler, setDoctype, setDoctypePublic, setDoctypeSystem, setDocumentLocator, setEncoding, setIndent, setIndentAmount, setMediaType, setNamespaceMappings, setOmitXMLDeclaration, setOutputFormat, setOutputStream, setSourceLocator, setStandalone, setTransformer, setVersion, setWriter, skippedEntity, startCDATA, startDTD, startEntity, startPrefixMapping, startPrefixMapping, warning |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
AdaptiveResultTreeImpl
public AdaptiveResultTreeImpl(XSLTCDTMManager dtmManager,
int documentID,
DTMWSFilter wsfilter,
int initSize,
boolean buildIdIndex)
getNestedDOM
public DOM getNestedDOM()
getDocument
public int getDocument()
- Description copied from interface:
DTM
- Given a DTM which contains only a single document,
find the Node Handle of the Document node. Note
that if the DTM is configured so it can contain multiple
documents, this call will return the Document currently
under construction -- but may return null if it's between
documents. Generally, you should use getOwnerDocument(nodeHandle)
or getDocumentRoot(nodeHandle) instead.
- Specified by:
getDocument
in interface DOM
- Overrides:
getDocument
in class SimpleResultTreeImpl
getStringValue
public java.lang.String getStringValue()
- Specified by:
getStringValue
in interface DOM
- Overrides:
getStringValue
in class SimpleResultTreeImpl
getIterator
public DTMAxisIterator getIterator()
- Description copied from interface:
DOM
- returns singleton iterator containg the document root
- Specified by:
getIterator
in interface DOM
- Overrides:
getIterator
in class SimpleResultTreeImpl
getChildren
public DTMAxisIterator getChildren(int node)
- Specified by:
getChildren
in interface DOM
- Overrides:
getChildren
in class SimpleResultTreeImpl
getTypedChildren
public DTMAxisIterator getTypedChildren(int type)
- Specified by:
getTypedChildren
in interface DOM
- Overrides:
getTypedChildren
in class SimpleResultTreeImpl
getAxisIterator
public DTMAxisIterator getAxisIterator(int axis)
- Description copied from interface:
DTM
- This is a shortcut to the iterators that implement
XPath axes.
Returns a bare-bones iterator that must be initialized
with a start node (using iterator.setStartNode()).
- Specified by:
getAxisIterator
in interface DOM
- Overrides:
getAxisIterator
in class SimpleResultTreeImpl
getTypedAxisIterator
public DTMAxisIterator getTypedAxisIterator(int axis,
int type)
- Description copied from interface:
DTM
- Get an iterator that can navigate over an XPath Axis, predicated by
the extended type ID.
- Specified by:
getTypedAxisIterator
in interface DOM
- Overrides:
getTypedAxisIterator
in class SimpleResultTreeImpl
getNthDescendant
public DTMAxisIterator getNthDescendant(int node,
int n,
boolean includeself)
- Specified by:
getNthDescendant
in interface DOM
- Overrides:
getNthDescendant
in class SimpleResultTreeImpl
getNamespaceAxisIterator
public DTMAxisIterator getNamespaceAxisIterator(int axis,
int ns)
- Specified by:
getNamespaceAxisIterator
in interface DOM
- Overrides:
getNamespaceAxisIterator
in class SimpleResultTreeImpl
getNodeValueIterator
public DTMAxisIterator getNodeValueIterator(DTMAxisIterator iter,
int returnType,
java.lang.String value,
boolean op)
- Specified by:
getNodeValueIterator
in interface DOM
- Overrides:
getNodeValueIterator
in class SimpleResultTreeImpl
orderNodes
public DTMAxisIterator orderNodes(DTMAxisIterator source,
int node)
- Specified by:
orderNodes
in interface DOM
- Overrides:
orderNodes
in class SimpleResultTreeImpl
getNodeName
public java.lang.String getNodeName(int node)
- Description copied from interface:
DTM
- Given a node handle, return its DOM-style node name. This will
include names such as #text or #document.
- Specified by:
getNodeName
in interface DOM
- Overrides:
getNodeName
in class SimpleResultTreeImpl
getNodeNameX
public java.lang.String getNodeNameX(int node)
- Description copied from interface:
DTM
- Given a node handle, return the XPath node name. This should be
the name as described by the XPath data model, NOT the DOM-style
name.
- Specified by:
getNodeNameX
in interface DOM
- Overrides:
getNodeNameX
in class SimpleResultTreeImpl
getNamespaceName
public java.lang.String getNamespaceName(int node)
- Specified by:
getNamespaceName
in interface DOM
- Overrides:
getNamespaceName
in class SimpleResultTreeImpl
getExpandedTypeID
public int getExpandedTypeID(int nodeHandle)
- Description copied from interface:
DTM
- Given a node handle, return an ID that represents the node's expanded name.
- Specified by:
getExpandedTypeID
in interface DOM
- Overrides:
getExpandedTypeID
in class SimpleResultTreeImpl
getNamespaceType
public int getNamespaceType(int node)
- Specified by:
getNamespaceType
in interface DOM
- Overrides:
getNamespaceType
in class SimpleResultTreeImpl
getParent
public int getParent(int nodeHandle)
- Description copied from interface:
DTM
- Given a node handle, find its parent node.
- Specified by:
getParent
in interface DOM
- Overrides:
getParent
in class SimpleResultTreeImpl
getAttributeNode
public int getAttributeNode(int gType,
int element)
- Specified by:
getAttributeNode
in interface DOM
- Overrides:
getAttributeNode
in class SimpleResultTreeImpl
getStringValueX
public java.lang.String getStringValueX(int nodeHandle)
- Specified by:
getStringValueX
in interface DOM
- Overrides:
getStringValueX
in class SimpleResultTreeImpl
copy
public void copy(int node,
SerializationHandler handler)
throws TransletException
- Specified by:
copy
in interface DOM
- Overrides:
copy
in class SimpleResultTreeImpl
- Throws:
TransletException
copy
public void copy(DTMAxisIterator nodes,
SerializationHandler handler)
throws TransletException
- Specified by:
copy
in interface DOM
- Overrides:
copy
in class SimpleResultTreeImpl
- Throws:
TransletException
shallowCopy
public java.lang.String shallowCopy(int node,
SerializationHandler handler)
throws TransletException
- Specified by:
shallowCopy
in interface DOM
- Overrides:
shallowCopy
in class SimpleResultTreeImpl
- Throws:
TransletException
lessThan
public boolean lessThan(int node1,
int node2)
- Specified by:
lessThan
in interface DOM
- Overrides:
lessThan
in class SimpleResultTreeImpl
characters
public void characters(int node,
SerializationHandler handler)
throws TransletException
- Dispatch the character content of a node to an output handler.
The escape setting should be taken care of when outputting to
a handler.
- Specified by:
characters
in interface DOM
- Overrides:
characters
in class SimpleResultTreeImpl
- Throws:
TransletException
makeNode
public Node makeNode(int index)
- Specified by:
makeNode
in interface DOM
- Overrides:
makeNode
in class SimpleResultTreeImpl
makeNode
public Node makeNode(DTMAxisIterator iter)
- Specified by:
makeNode
in interface DOM
- Overrides:
makeNode
in class SimpleResultTreeImpl
makeNodeList
public NodeList makeNodeList(int index)
- Specified by:
makeNodeList
in interface DOM
- Overrides:
makeNodeList
in class SimpleResultTreeImpl
makeNodeList
public NodeList makeNodeList(DTMAxisIterator iter)
- Specified by:
makeNodeList
in interface DOM
- Overrides:
makeNodeList
in class SimpleResultTreeImpl
getLanguage
public java.lang.String getLanguage(int node)
- Specified by:
getLanguage
in interface DOM
- Overrides:
getLanguage
in class SimpleResultTreeImpl
getSize
public int getSize()
- Specified by:
getSize
in interface DOM
- Overrides:
getSize
in class SimpleResultTreeImpl
getDocumentURI
public java.lang.String getDocumentURI(int node)
- Specified by:
getDocumentURI
in interface DOM
- Overrides:
getDocumentURI
in class SimpleResultTreeImpl
setFilter
public void setFilter(StripFilter filter)
- Specified by:
setFilter
in interface DOM
- Overrides:
setFilter
in class SimpleResultTreeImpl
setupMapping
public void setupMapping(java.lang.String[] names,
java.lang.String[] uris,
int[] types,
java.lang.String[] namespaces)
- Specified by:
setupMapping
in interface DOM
- Overrides:
setupMapping
in class SimpleResultTreeImpl
isElement
public boolean isElement(int node)
- Specified by:
isElement
in interface DOM
- Overrides:
isElement
in class SimpleResultTreeImpl
isAttribute
public boolean isAttribute(int node)
- Specified by:
isAttribute
in interface DOM
- Overrides:
isAttribute
in class SimpleResultTreeImpl
lookupNamespace
public java.lang.String lookupNamespace(int node,
java.lang.String prefix)
throws TransletException
- Specified by:
lookupNamespace
in interface DOM
- Overrides:
lookupNamespace
in class SimpleResultTreeImpl
- Throws:
TransletException
getNodeIdent
public final int getNodeIdent(int nodehandle)
- Return the node identity from a node handle.
- Specified by:
getNodeIdent
in interface DOM
- Overrides:
getNodeIdent
in class SimpleResultTreeImpl
getNodeHandle
public final int getNodeHandle(int nodeId)
- Return the node handle from a node identity.
- Specified by:
getNodeHandle
in interface DOM
- Overrides:
getNodeHandle
in class SimpleResultTreeImpl
getResultTreeFrag
public DOM getResultTreeFrag(int initialSize,
int rtfType)
- Specified by:
getResultTreeFrag
in interface DOM
- Overrides:
getResultTreeFrag
in class SimpleResultTreeImpl
getOutputDomBuilder
public SerializationHandler getOutputDomBuilder()
- Specified by:
getOutputDomBuilder
in interface DOM
- Overrides:
getOutputDomBuilder
in class SimpleResultTreeImpl
getNSType
public int getNSType(int node)
- Specified by:
getNSType
in interface DOM
- Overrides:
getNSType
in class SimpleResultTreeImpl
getUnparsedEntityURI
public java.lang.String getUnparsedEntityURI(java.lang.String name)
- Description copied from interface:
DTM
- 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]). It returns the empty string if
there is no such entity.
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.)
- Specified by:
getUnparsedEntityURI
in interface DOM
- Overrides:
getUnparsedEntityURI
in class SimpleResultTreeImpl
getElementsWithIDs
public Hashtable getElementsWithIDs()
- Specified by:
getElementsWithIDs
in interface DOM
- Overrides:
getElementsWithIDs
in class SimpleResultTreeImpl
startDocument
public void startDocument()
throws SAXException
- Description copied from class:
SimpleResultTreeImpl
- We only need to override the endDocument, characters, and
setEscaping interfaces. A simple RTF does not have element
nodes. We do not need to touch startElement and endElement.
- Specified by:
startDocument
in interface ContentHandler
- Overrides:
startDocument
in class SimpleResultTreeImpl
- Throws:
SAXException
endDocument
public void endDocument()
throws SAXException
- Description copied from interface:
ContentHandler
- Receive notification of the end of a document.
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.
- Specified by:
endDocument
in interface ContentHandler
- Overrides:
endDocument
in class SimpleResultTreeImpl
- Throws:
SAXException
characters
public void characters(java.lang.String str)
throws SAXException
- Description copied from interface:
ExtendedContentHandler
- This method is used to notify of a character event, but passing the data
as a character String rather than the standard character array.
- Specified by:
characters
in interface ExtendedContentHandler
- Overrides:
characters
in class SimpleResultTreeImpl
- Throws:
SAXException
characters
public void characters(char[] ch,
int offset,
int length)
throws SAXException
- Description copied from interface:
ContentHandler
- Receive notification of character data.
The 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).
- Specified by:
characters
in interface ContentHandler
- Overrides:
characters
in class SimpleResultTreeImpl
- Throws:
SAXException
setEscaping
public boolean setEscaping(boolean escape)
throws SAXException
- Description copied from interface:
SerializationHandler
- Turns special character escaping on/off.
Note that characters will
never, even if this option is set to 'true', be escaped within
CDATA sections in output XML documents.
- Specified by:
setEscaping
in interface SerializationHandler
- Overrides:
setEscaping
in class SimpleResultTreeImpl
- Throws:
SAXException
startElement
public void startElement(java.lang.String elementName)
throws SAXException
- Description copied from interface:
ExtendedContentHandler
- This method is used to notify of the start of an element
- Specified by:
startElement
in interface ExtendedContentHandler
- Overrides:
startElement
in class EmptySerializer
- Throws:
SAXException
- See Also:
ExtendedContentHandler.startElement(java.lang.String)
startElement
public void startElement(java.lang.String uri,
java.lang.String localName,
java.lang.String qName)
throws SAXException
- Description copied from interface:
ExtendedContentHandler
- This method is used to notify that an element is starting.
This method is just like the standard SAX method
startElement(uri,localName,qname,atts)
but without the attributes.
- Specified by:
startElement
in interface ExtendedContentHandler
- Overrides:
startElement
in class EmptySerializer
- Throws:
SAXException
- See Also:
ExtendedContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String)
startElement
public void startElement(java.lang.String uri,
java.lang.String localName,
java.lang.String qName,
Attributes attributes)
throws SAXException
- Description copied from interface:
ContentHandler
- Receive notification of the beginning of an element.
The 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:
- the Namespace URI;
- the local name; and
- the qualified (prefixed) name.
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:
- the Namespace URI and local name are required when
the namespaces property is true (the default), and are
optional when the namespaces property is false (if one is
specified, both must be);
- the qualified name is required when the namespace-prefixes property
is true, and is optional when the namespace-prefixes property
is false (the default).
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.
- Specified by:
startElement
in interface ContentHandler
- Overrides:
startElement
in class EmptySerializer
- Throws:
SAXException
- See Also:
ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)
endElement
public void endElement(java.lang.String elementName)
throws SAXException
- Description copied from interface:
ExtendedContentHandler
- This method is used to notify that an element has ended. Unlike the
standard SAX method
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.
- Specified by:
endElement
in interface ExtendedContentHandler
- Overrides:
endElement
in class EmptySerializer
- Throws:
SAXException
- See Also:
ExtendedContentHandler.endElement(java.lang.String)
endElement
public void endElement(java.lang.String uri,
java.lang.String localName,
java.lang.String qName)
throws SAXException
- Description copied from interface:
ContentHandler
- Receive notification of the end of an element.
The 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.
- Specified by:
endElement
in interface ContentHandler
- Overrides:
endElement
in class EmptySerializer
- Throws:
SAXException
- See Also:
ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)
addUniqueAttribute
public void addUniqueAttribute(java.lang.String qName,
java.lang.String value,
int flags)
throws SAXException
- Description copied from interface:
ExtendedContentHandler
- Add a unique attribute to the current element.
The attribute is guaranteed to be unique here. The serializer can write
it out immediately without saving it in a table first. The integer
flag contains information about the attribute, which helps the serializer
to decide whether a particular processing is needed.
- Specified by:
addUniqueAttribute
in interface ExtendedContentHandler
- Overrides:
addUniqueAttribute
in class EmptySerializer
- Throws:
SAXException
- See Also:
ExtendedContentHandler.addUniqueAttribute(java.lang.String, java.lang.String, int)
addAttribute
public void addAttribute(java.lang.String name,
java.lang.String value)
- Description copied from interface:
ExtendedContentHandler
- Add an attribute to the current element. The namespace URI of the
attribute will be calculated from the prefix of qName. The local name
will be derived from qName and the type will be assumed to be "CDATA".
- Specified by:
addAttribute
in interface ExtendedContentHandler
- Overrides:
addAttribute
in class EmptySerializer
- See Also:
ExtendedContentHandler.addAttribute(java.lang.String, java.lang.String)
namespaceAfterStartElement
public void namespaceAfterStartElement(java.lang.String prefix,
java.lang.String uri)
throws SAXException
- Description copied from interface:
ExtendedContentHandler
- This method is used to notify that a prefix mapping is to start, but
after an element is started. The SAX method call
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")
- Specified by:
namespaceAfterStartElement
in interface ExtendedContentHandler
- Overrides:
namespaceAfterStartElement
in class EmptySerializer
- Throws:
SAXException
- See Also:
ExtendedContentHandler.namespaceAfterStartElement(java.lang.String, java.lang.String)
comment
public void comment(java.lang.String comment)
throws SAXException
- Description copied from interface:
ExtendedLexicalHandler
- This method is used to notify of a comment
- Specified by:
comment
in interface ExtendedLexicalHandler
- Overrides:
comment
in class EmptySerializer
- Throws:
SAXException
- See Also:
ExtendedLexicalHandler.comment(java.lang.String)
comment
public void comment(char[] chars,
int offset,
int length)
throws SAXException
- Description copied from interface:
LexicalHandler
- Report an XML comment anywhere in the document.
This 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).
- Specified by:
comment
in interface LexicalHandler
- Overrides:
comment
in class EmptySerializer
- Throws:
SAXException
- See Also:
LexicalHandler.comment(char[], int, int)
processingInstruction
public void processingInstruction(java.lang.String target,
java.lang.String data)
throws SAXException
- Description copied from interface:
ContentHandler
- Receive notification of a processing instruction.
The 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.
- Specified by:
processingInstruction
in interface ContentHandler
- Overrides:
processingInstruction
in class EmptySerializer
- Throws:
SAXException
- See Also:
ContentHandler.processingInstruction(java.lang.String, java.lang.String)
setFeature
public void setFeature(java.lang.String featureId,
boolean state)
- Implementation of the DTM interfaces
- Specified by:
setFeature
in interface DTM
- Overrides:
setFeature
in class SimpleResultTreeImpl
setProperty
public void setProperty(java.lang.String property,
java.lang.Object value)
- Description copied from interface:
DTM
- Set a run time property for this DTM instance.
- Specified by:
setProperty
in interface DTM
- Overrides:
setProperty
in class SimpleResultTreeImpl
getAxisTraverser
public DTMAxisTraverser getAxisTraverser(int axis)
- Description copied from interface:
DTM
- This returns a stateless "traverser", that can navigate over an
XPath axis, though not in document order.
- Specified by:
getAxisTraverser
in interface DTM
- Overrides:
getAxisTraverser
in class SimpleResultTreeImpl
hasChildNodes
public boolean hasChildNodes(int nodeHandle)
- Description copied from interface:
DTM
- Given a node handle, test if it has child nodes.
%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.
- Specified by:
hasChildNodes
in interface DTM
- Overrides:
hasChildNodes
in class SimpleResultTreeImpl
getFirstChild
public int getFirstChild(int nodeHandle)
- Description copied from interface:
DTM
- Given a node handle, get the handle of the node's first child.
- Specified by:
getFirstChild
in interface DTM
- Overrides:
getFirstChild
in class SimpleResultTreeImpl
getLastChild
public int getLastChild(int nodeHandle)
- Description copied from interface:
DTM
- Given a node handle, get the handle of the node's last child.
- Specified by:
getLastChild
in interface DTM
- Overrides:
getLastChild
in class SimpleResultTreeImpl
getAttributeNode
public int getAttributeNode(int elementHandle,
java.lang.String namespaceURI,
java.lang.String name)
- Description copied from interface:
DTM
- 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.
- Specified by:
getAttributeNode
in interface DTM
- Overrides:
getAttributeNode
in class SimpleResultTreeImpl
getFirstAttribute
public int getFirstAttribute(int nodeHandle)
- Description copied from interface:
DTM
- Given a node handle, get the index of the node's first attribute.
- Specified by:
getFirstAttribute
in interface DTM
- Overrides:
getFirstAttribute
in class SimpleResultTreeImpl
getFirstNamespaceNode
public int getFirstNamespaceNode(int nodeHandle,
boolean inScope)
- Description copied from interface:
DTM
- Given a node handle, get the index of the node's first namespace node.
- Specified by:
getFirstNamespaceNode
in interface DTM
- Overrides:
getFirstNamespaceNode
in class SimpleResultTreeImpl
getNextSibling
public int getNextSibling(int nodeHandle)
- Description copied from interface:
DTM
- Given a node handle, advance to its next sibling.
- Specified by:
getNextSibling
in interface DTM
- Overrides:
getNextSibling
in class SimpleResultTreeImpl
getPreviousSibling
public int getPreviousSibling(int nodeHandle)
- Description copied from interface:
DTM
- Given a node handle, find its preceeding sibling.
WARNING: DTM implementations may be asymmetric; in some,
this operation has been resolved by search, and is relatively expensive.
- Specified by:
getPreviousSibling
in interface DTM
- Overrides:
getPreviousSibling
in class SimpleResultTreeImpl
getNextAttribute
public int getNextAttribute(int nodeHandle)
- Description copied from interface:
DTM
- Given a node handle, advance to the next attribute. If an
element, we advance to its first attribute; if an attr, we advance to
the next attr of the same element.
- Specified by:
getNextAttribute
in interface DTM
- Overrides:
getNextAttribute
in class SimpleResultTreeImpl
getNextNamespaceNode
public int getNextNamespaceNode(int baseHandle,
int namespaceHandle,
boolean inScope)
- Description copied from interface:
DTM
- Given a namespace handle, advance to the next namespace in the same scope
(local or local-plus-inherited, as selected by getFirstNamespaceNode)
- Specified by:
getNextNamespaceNode
in interface DTM
- Overrides:
getNextNamespaceNode
in class SimpleResultTreeImpl
getOwnerDocument
public int getOwnerDocument(int nodeHandle)
- Description copied from interface:
DTM
- Given a node handle, find the owning document node. This version mimics
the behavior of the DOM call by the same name.
- Specified by:
getOwnerDocument
in interface DTM
- Overrides:
getOwnerDocument
in class SimpleResultTreeImpl
getDocumentRoot
public int getDocumentRoot(int nodeHandle)
- Description copied from interface:
DTM
- Given a node handle, find the owning document node.
- Specified by:
getDocumentRoot
in interface DTM
- Overrides:
getDocumentRoot
in class SimpleResultTreeImpl
getStringValue
public XMLString getStringValue(int nodeHandle)
- Description copied from interface:
DTM
- 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).
- Specified by:
getStringValue
in interface DTM
- Overrides:
getStringValue
in class SimpleResultTreeImpl
getStringValueChunkCount
public int getStringValueChunkCount(int nodeHandle)
- Description copied from interface:
DTM
- Get number of character array chunks in
the string-value of a node.
(see http://www.w3.org/TR/xpath#data-model
for the definition of a node's string-value).
Note that a single text node may have multiple text chunks.
- Specified by:
getStringValueChunkCount
in interface DTM
- Overrides:
getStringValueChunkCount
in class SimpleResultTreeImpl
getStringValueChunk
public char[] getStringValueChunk(int nodeHandle,
int chunkIndex,
int[] startAndLen)
- Description copied from interface:
DTM
- Get a character array chunk in the string-value of a node.
(see http://www.w3.org/TR/xpath#data-model
for the definition of a node's string-value).
Note that a single text node may have multiple text chunks.
- Specified by:
getStringValueChunk
in interface DTM
- Overrides:
getStringValueChunk
in class SimpleResultTreeImpl
getExpandedTypeID
public int getExpandedTypeID(java.lang.String namespace,
java.lang.String localName,
int type)
- Description copied from interface:
DTM
- Given an expanded name, return an ID. If the expanded-name does not
exist in the internal tables, the entry will be created, and the ID will
be returned. Any additional nodes that are created that have this
expanded name will use this ID.
- Specified by:
getExpandedTypeID
in interface DTM
- Overrides:
getExpandedTypeID
in class SimpleResultTreeImpl
getLocalNameFromExpandedNameID
public java.lang.String getLocalNameFromExpandedNameID(int ExpandedNameID)
- Description copied from interface:
DTM
- Given an expanded-name ID, return the local name part.
- Specified by:
getLocalNameFromExpandedNameID
in interface DTM
- Overrides:
getLocalNameFromExpandedNameID
in class SimpleResultTreeImpl
getNamespaceFromExpandedNameID
public java.lang.String getNamespaceFromExpandedNameID(int ExpandedNameID)
- Description copied from interface:
DTM
- Given an expanded-name ID, return the namespace URI part.
- Specified by:
getNamespaceFromExpandedNameID
in interface DTM
- Overrides:
getNamespaceFromExpandedNameID
in class SimpleResultTreeImpl
getLocalName
public java.lang.String getLocalName(int nodeHandle)
- Description copied from interface:
DTM
- Given a node handle, return its DOM-style localname.
(As defined in Namespaces, this is the portion of the name after the
prefix, if present, or the whole node name if no prefix exists)
- Specified by:
getLocalName
in interface DTM
- Overrides:
getLocalName
in class SimpleResultTreeImpl
getPrefix
public java.lang.String getPrefix(int nodeHandle)
- Description copied from interface:
DTM
- Given a namespace handle, return the prefix that the namespace decl is
mapping.
Given a node handle, return the prefix used to map to the namespace.
(As defined in Namespaces, this is the portion of the name before any
colon character).
- Specified by:
getPrefix
in interface DTM
- Overrides:
getPrefix
in class SimpleResultTreeImpl
getNamespaceURI
public java.lang.String getNamespaceURI(int nodeHandle)
- Description copied from interface:
DTM
- 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.)
- Specified by:
getNamespaceURI
in interface DTM
- Overrides:
getNamespaceURI
in class SimpleResultTreeImpl
getNodeValue
public java.lang.String getNodeValue(int nodeHandle)
- Description copied from interface:
DTM
- Given a node handle, return its node value. This is mostly
as defined by the DOM, but may ignore some conveniences.
- Specified by:
getNodeValue
in interface DTM
- Overrides:
getNodeValue
in class SimpleResultTreeImpl
getNodeType
public short getNodeType(int nodeHandle)
- Description copied from interface:
DTM
- Given a node handle, return its DOM-style node type.
%REVIEW% Generally, returning short is false economy. Return int?
- Specified by:
getNodeType
in interface DTM
- Overrides:
getNodeType
in class SimpleResultTreeImpl
getLevel
public short getLevel(int nodeHandle)
- Description copied from interface:
DTM
- Get the depth level of this node in the tree (equals 1 for
a parentless node).
- Specified by:
getLevel
in interface DTM
- Overrides:
getLevel
in class SimpleResultTreeImpl
isSupported
public boolean isSupported(java.lang.String feature,
java.lang.String version)
- Description copied from interface:
DTM
- Tests whether DTM DOM implementation implements a specific feature and
that feature is supported by this node.
- Specified by:
isSupported
in interface DTM
- Overrides:
isSupported
in class SimpleResultTreeImpl
getDocumentBaseURI
public java.lang.String getDocumentBaseURI()
- Description copied from interface:
DTM
- Return the base URI of the document entity. If it is not known
(because the document was parsed from a socket connection or from
standard input, for example), the value of this property is unknown.
- Specified by:
getDocumentBaseURI
in interface DTM
- Overrides:
getDocumentBaseURI
in class SimpleResultTreeImpl
setDocumentBaseURI
public void setDocumentBaseURI(java.lang.String baseURI)
- Description copied from interface:
DTM
- Set the base URI of the document entity.
- Specified by:
setDocumentBaseURI
in interface DTM
- Overrides:
setDocumentBaseURI
in class SimpleResultTreeImpl
getDocumentSystemIdentifier
public java.lang.String getDocumentSystemIdentifier(int nodeHandle)
- Description copied from interface:
DTM
- Return the system identifier of the document entity. If
it is not known, the value of this property is null.
- Specified by:
getDocumentSystemIdentifier
in interface DTM
- Overrides:
getDocumentSystemIdentifier
in class SimpleResultTreeImpl
getDocumentEncoding
public java.lang.String getDocumentEncoding(int nodeHandle)
- Description copied from interface:
DTM
- Return the name of the character encoding scheme
in which the document entity is expressed.
- Specified by:
getDocumentEncoding
in interface DTM
- Overrides:
getDocumentEncoding
in class SimpleResultTreeImpl
getDocumentStandalone
public java.lang.String getDocumentStandalone(int nodeHandle)
- Description copied from interface:
DTM
- Return an indication of the standalone status of the document,
either "yes" or "no". This property is derived from the optional
standalone document declaration in the XML declaration at the
beginning of the document entity, and has no value if there is no
standalone document declaration.
- Specified by:
getDocumentStandalone
in interface DTM
- Overrides:
getDocumentStandalone
in class SimpleResultTreeImpl
getDocumentVersion
public java.lang.String getDocumentVersion(int documentHandle)
- Description copied from interface:
DTM
- Return a string representing the XML version of the document. This
property is derived from the XML declaration optionally present at the
beginning of the document entity, and has no value if there is no XML
declaration.
- Specified by:
getDocumentVersion
in interface DTM
- Overrides:
getDocumentVersion
in class SimpleResultTreeImpl
getDocumentAllDeclarationsProcessed
public boolean getDocumentAllDeclarationsProcessed()
- Description copied from interface:
DTM
- Return an indication of
whether the processor has read the complete DTD. Its value is a
boolean. If it is false, then certain properties (indicated in their
descriptions below) may be unknown. If it is true, those properties
are never unknown.
- Specified by:
getDocumentAllDeclarationsProcessed
in interface DTM
- Overrides:
getDocumentAllDeclarationsProcessed
in class SimpleResultTreeImpl
getDocumentTypeDeclarationSystemIdentifier
public java.lang.String getDocumentTypeDeclarationSystemIdentifier()
- Description copied from interface:
DTM
- A document type declaration information item has the following properties:
1. [system identifier] The system identifier of the external subset, if
it exists. Otherwise this property has no value.
- Specified by:
getDocumentTypeDeclarationSystemIdentifier
in interface DTM
- Overrides:
getDocumentTypeDeclarationSystemIdentifier
in class SimpleResultTreeImpl
getDocumentTypeDeclarationPublicIdentifier
public java.lang.String getDocumentTypeDeclarationPublicIdentifier()
- Description copied from interface:
DTM
- Return the public identifier of the external subset,
normalized as described in 4.2.2 External Entities [XML]. If there is
no external subset or if it has no public identifier, this property
has no value.
- Specified by:
getDocumentTypeDeclarationPublicIdentifier
in interface DTM
- Overrides:
getDocumentTypeDeclarationPublicIdentifier
in class SimpleResultTreeImpl
getElementById
public int getElementById(java.lang.String elementId)
- Description copied from interface:
DTM
- Returns the
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.
- Specified by:
getElementById
in interface DTM
- Overrides:
getElementById
in class SimpleResultTreeImpl
supportsPreStripping
public boolean supportsPreStripping()
- Description copied from interface:
DTM
- Return true if the xsl:strip-space or xsl:preserve-space was processed
during construction of the document contained in this DTM.
NEEDSDOC ($objectName$) @return
- Specified by:
supportsPreStripping
in interface DTM
- Overrides:
supportsPreStripping
in class SimpleResultTreeImpl
isNodeAfter
public boolean isNodeAfter(int firstNodeHandle,
int secondNodeHandle)
- Description copied from interface:
DTM
- Figure out whether nodeHandle2 should be considered as being later
in the document than nodeHandle1, in Document Order as defined
by the XPath model. This may not agree with the ordering defined
by other XML applications.
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)?
- Specified by:
isNodeAfter
in interface DTM
- Overrides:
isNodeAfter
in class SimpleResultTreeImpl
isCharacterElementContentWhitespace
public boolean isCharacterElementContentWhitespace(int nodeHandle)
- Description copied from interface:
DTM
- 2. [element content whitespace] A boolean indicating whether a
text node represents white space appearing within element content
(see [XML], 2.10 "White Space Handling"). Note that validating
XML processors are required by XML 1.0 to provide this
information... but that DOM Level 2 did not support it, since it
depends on knowledge of the DTD which DOM2 could not guarantee
would be available.
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
- Specified by:
isCharacterElementContentWhitespace
in interface DTM
- Overrides:
isCharacterElementContentWhitespace
in class SimpleResultTreeImpl
isDocumentAllDeclarationsProcessed
public boolean isDocumentAllDeclarationsProcessed(int documentHandle)
- Description copied from interface:
DTM
- 10. [all declarations processed] This property is not strictly speaking
part of the infoset of the document. Rather it is an indication of
whether the processor has read the complete DTD. Its value is a
boolean. If it is false, then certain properties (indicated in their
descriptions below) may be unknown. If it is true, those properties
are never unknown.
- Specified by:
isDocumentAllDeclarationsProcessed
in interface DTM
- Overrides:
isDocumentAllDeclarationsProcessed
in class SimpleResultTreeImpl
isAttributeSpecified
public boolean isAttributeSpecified(int attributeHandle)
- Description copied from interface:
DTM
- 5. [specified] A flag indicating whether this attribute was actually
specified in the start-tag of its element, or was defaulted from the
DTD (or schema).
- Specified by:
isAttributeSpecified
in interface DTM
- Overrides:
isAttributeSpecified
in class SimpleResultTreeImpl
dispatchCharactersEvents
public void dispatchCharactersEvents(int nodeHandle,
ContentHandler ch,
boolean normalize)
throws SAXException
- Description copied from interface:
DTM
- 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). Multiple calls to the
ContentHandler's characters methods may well occur for a single call to
this method.
- Specified by:
dispatchCharactersEvents
in interface DTM
- Overrides:
dispatchCharactersEvents
in class SimpleResultTreeImpl
- Throws:
SAXException
dispatchToEvents
public void dispatchToEvents(int nodeHandle,
ContentHandler ch)
throws SAXException
- Description copied from interface:
DTM
- Directly create SAX parser events representing the XML content of
a DTM subtree. This is a "serialize" operation.
- Specified by:
dispatchToEvents
in interface DTM
- Overrides:
dispatchToEvents
in class SimpleResultTreeImpl
- Throws:
SAXException
getNode
public Node getNode(int nodeHandle)
- Description copied from interface:
DTM
- Return an DOM node for the given node.
- Specified by:
getNode
in interface DTM
- Overrides:
getNode
in class SimpleResultTreeImpl
needsTwoThreads
public boolean needsTwoThreads()
- Specified by:
needsTwoThreads
in interface DTM
- Overrides:
needsTwoThreads
in class SimpleResultTreeImpl
getContentHandler
public ContentHandler getContentHandler()
- Description copied from interface:
DTM
- Return this DTM's content handler, if it has one.
- Specified by:
getContentHandler
in interface DTM
- Overrides:
getContentHandler
in class SimpleResultTreeImpl
getLexicalHandler
public LexicalHandler getLexicalHandler()
- Description copied from interface:
DTM
- Return this DTM's lexical handler, if it has one.
%REVIEW% Should this return null if constrution already done/begun?
- Specified by:
getLexicalHandler
in interface DTM
- Overrides:
getLexicalHandler
in class SimpleResultTreeImpl
getEntityResolver
public EntityResolver getEntityResolver()
- Description copied from interface:
DTM
- Return this DTM's EntityResolver, if it has one.
- Specified by:
getEntityResolver
in interface DTM
- Overrides:
getEntityResolver
in class SimpleResultTreeImpl
getDTDHandler
public DTDHandler getDTDHandler()
- Description copied from interface:
DTM
- Return this DTM's DTDHandler, if it has one.
- Specified by:
getDTDHandler
in interface DTM
- Overrides:
getDTDHandler
in class SimpleResultTreeImpl
getErrorHandler
public ErrorHandler getErrorHandler()
- Description copied from interface:
DTM
- Return this DTM's ErrorHandler, if it has one.
- Specified by:
getErrorHandler
in interface DTM
- Overrides:
getErrorHandler
in class SimpleResultTreeImpl
getDeclHandler
public DeclHandler getDeclHandler()
- Description copied from interface:
DTM
- Return this DTM's DeclHandler, if it has one.
- Specified by:
getDeclHandler
in interface DTM
- Overrides:
getDeclHandler
in class SimpleResultTreeImpl
appendChild
public void appendChild(int newChild,
boolean clone,
boolean cloneDepth)
- Description copied from interface:
DTM
- Append a child to "the end of the document". Please note that
the node is always cloned in a base DTM, since our basic behavior
is immutable so nodes can't be removed from their previous
location.
%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).
- Specified by:
appendChild
in interface DTM
- Overrides:
appendChild
in class SimpleResultTreeImpl
appendTextChild
public void appendTextChild(java.lang.String str)
- Description copied from interface:
DTM
- Append a text node child that will be constructed from a string,
to the end of the document. Behavior is otherwise like appendChild().
- Specified by:
appendTextChild
in interface DTM
- Overrides:
appendTextChild
in class SimpleResultTreeImpl
getSourceLocatorFor
public SourceLocator getSourceLocatorFor(int node)
- Description copied from interface:
DTM
- Get the location of a node in the source document.
- Specified by:
getSourceLocatorFor
in interface DTM
- Overrides:
getSourceLocatorFor
in class SimpleResultTreeImpl
documentRegistration
public void documentRegistration()
- Description copied from interface:
DTM
- As the DTM is registered with the DTMManager, this method
will be called. This will give the DTM implementation a
chance to initialize any subsystems that are required to
build the DTM
- Specified by:
documentRegistration
in interface DTM
- Overrides:
documentRegistration
in class SimpleResultTreeImpl
documentRelease
public void documentRelease()
- Description copied from interface:
DTM
- As documents are released from the DTMManager, the DTM implementation
will be notified of the event. This will allow the DTM implementation
to shutdown any subsystem activity that may of been assoiated with
the active DTM Implementation.
- Specified by:
documentRelease
in interface DTM
- Overrides:
documentRelease
in class SimpleResultTreeImpl
Copyright © 2004 Apache XML Project. All Rights Reserved.