public class VirtualTreeWalker extends java.lang.Object implements PullProvider, NamespaceDeclarations
The tree is physically constructed if operations are requested that depend on the identity of the nodes in the tree, or that navigate within the tree. Operations such as copying or atomizing the tree can be done directly, without building it in memory. (Note however that if such operations are done more than once, the underlying instructions may be evaluated repeatedly.)
ATOMIC_VALUE, ATTRIBUTE, COMMENT, END_DOCUMENT, END_ELEMENT, END_OF_INPUT, NAMESPACE, PROCESSING_INSTRUCTION, START_DOCUMENT, START_ELEMENT, START_OF_INPUT, TEXT
?????? |
---|
VirtualTreeWalker(ParentNodeConstructor instruction,
XPathContext context)
Create a VirtualTreeWalker to navigate the tree constructed by evaluating a given instruction
in a given dyamic context
|
?????? | ????? |
---|---|
void |
close()
Close the event reader.
|
int |
current()
Get the event most recently returned by next(), or by other calls that change
the position, for example getStringValue() and skipToMatchingEnd().
|
AtomicValue |
getAtomicValue()
Get an atomic value.
|
AttributeCollection |
getAttributes()
Get the attributes associated with the current element.
|
int |
getFingerprint()
Get the fingerprint of the name of the element.
|
int |
getNameCode()
Get the nameCode identifying the name of the current node.
|
NamePool |
getNamePool()
Get the namepool
|
int |
getNamespaceCode(int index)
Get the n'th declaration in the list in the form of a namespace code.
|
int[] |
getNamespaceCodes(int[] buffer)
Get all the namespace codes, as an array.
|
NamespaceDeclarations |
getNamespaceDeclarations()
Get the namespace declarations associated with the current element.
|
int |
getNumberOfNamespaces()
Get the number of declarations (and undeclarations) in this list.
|
PipelineConfiguration |
getPipelineConfiguration()
Get configuration information.
|
java.lang.String |
getPrefix(int index)
Get the prefix of the n'th declaration (or undeclaration) in the list,
counting from zero.
|
javax.xml.transform.SourceLocator |
getSourceLocator()
Get the location of the current event.
|
java.lang.CharSequence |
getStringValue()
Get the string value of the current element, text node, processing-instruction,
or top-level attribute or namespace node, or atomic value.
|
int |
getTypeAnnotation()
Get the type annotation of the current attribute or element node, or atomic value.
|
java.util.List |
getUnparsedEntities()
Get a list of unparsed entities.
|
java.lang.String |
getURI(int index)
Get the namespace URI of the n'th declaration (or undeclaration) in the list,
counting from zero.
|
int |
next()
Get the next event
|
void |
setNameCode(int nameCode)
Set the initial nameCode
|
void |
setPipelineConfiguration(PipelineConfiguration pipe)
Set configuration information.
|
int |
skipToMatchingEnd()
Skip the current subtree.
|
public VirtualTreeWalker(ParentNodeConstructor instruction, XPathContext context)
instruction
- the instruction (this will always be an instruction that creates element or
document nodes)context
- the dynamic evaluation contextpublic void setPipelineConfiguration(PipelineConfiguration pipe)
setPipelineConfiguration
???? PullProvider
pipe
- the pipeline configurationpublic PipelineConfiguration getPipelineConfiguration()
getPipelineConfiguration
???? PullProvider
public NamePool getNamePool()
public int next() throws XPathException
next
???? PullProvider
PullProvider.END_OF_INPUT
is returned at the end of the sequence.XPathException
public int current()
current
???? PullProvider
public AttributeCollection getAttributes() throws XPathException
Attributes may be read before or after reading the namespaces of an element, but must not be read after the first child node has been read, or after calling one of the methods skipToEnd(), getStringValue(), or getTypedValue().
getAttributes
???? PullProvider
XPathException
public NamespaceDeclarations getNamespaceDeclarations() throws XPathException
It is permissible for this method to return namespace declarations that are redundant.
The NamespaceDeclarations object is guaranteed to remain unchanged until the next START_ELEMENT event, but may then be overwritten. The object should not be modified by the client.
Namespaces may be read before or after reading the attributes of an element, but must not be read after the first child node has been read, or after calling one of the methods skipToEnd(), getStringValue(), or getTypedValue().
*getNamespaceDeclarations
???? PullProvider
XPathException
public int skipToMatchingEnd() throws XPathException
skipToMatchingEnd
???? PullProvider
java.lang.IllegalStateException
- if the method is called at any time other than
immediately after a START_DOCUMENT or START_ELEMENT event.XPathException
public void close()
PullProvider.END_OF_INPUT
has
been reported, but it is recommended to close it if reading terminates
prematurely. Once an event reader has been closed, the effect of further
calls on next() is undefined.close
???? PullProvider
public void setNameCode(int nameCode)
nameCode
- the nameCode of the node at the root of the tree being walkedpublic int getNameCode()
PullProvider.START_ELEMENT
, PullProvider.END_ELEMENT
, PullProvider.PROCESSING_INSTRUCTION
,
PullProvider.ATTRIBUTE
, or PullProvider.NAMESPACE
events. With some PullProvider implementations,
but not this one, it can also be used after PullProvider.END_ELEMENT
.
If called at other times, the result is undefined and may result in an IllegalStateException.
If called when the current node is an unnamed namespace node (a node representing the default namespace)
the returned value is -1.getNameCode
???? PullProvider
public int getFingerprint()
PullProvider.START_ELEMENT
, PullProvider.END_ELEMENT
, PullProvider.PROCESSING_INSTRUCTION
,
PullProvider.ATTRIBUTE
, or PullProvider.NAMESPACE
events.
If called at other times, the result is undefined and may result in an IllegalStateException.
If called when the current node is an unnamed namespace node (a node representing the default namespace)
the returned value is -1.getFingerprint
???? PullProvider
public java.lang.CharSequence getStringValue() throws XPathException
In other situations the result is undefined and may result in an IllegalStateException.
If the most recent event was a PullProvider.START_ELEMENT
, this method causes the content
of the element to be read. The current event on completion of this method will be the
corresponding PullProvider.END_ELEMENT
. The next call of next() will return the event following
the END_ELEMENT event.
getStringValue
???? PullProvider
XPathException
public AtomicValue getAtomicValue()
getAtomicValue
???? PullProvider
public int getTypeAnnotation()
getTypeAnnotation
???? PullProvider
SchemaType
by access to the Configuration.public javax.xml.transform.SourceLocator getSourceLocator()
getSourceLocator
???? PullProvider
public int getNumberOfNamespaces()
getNumberOfNamespaces
???? NamespaceDeclarations
public java.lang.String getPrefix(int index)
getPrefix
???? NamespaceDeclarations
index
- the index identifying which declaration is required.java.lang.IndexOutOfBoundsException
- if the index is out of range.public java.lang.String getURI(int index)
getURI
???? NamespaceDeclarations
index
- the index identifying which declaration is required.java.lang.IndexOutOfBoundsException
- if the index is out of range.public int getNamespaceCode(int index)
getNamespaceCode
???? NamespaceDeclarations
index
- the index identifying which declaration is required.java.lang.IndexOutOfBoundsException
- if the index is out of range.NamePool.getPrefixFromNamespaceCode(int)
,
NamePool.getURIFromNamespaceCode(int)
public int[] getNamespaceCodes(int[] buffer)
getNamespaceCodes
???? NamespaceDeclarations
buffer
- a sacrificial array that the method is free to use to contain the result.
May be null.public java.util.List getUnparsedEntities()
getUnparsedEntities
???? PullProvider