|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.saxonica.pull.TreeWalker
public class TreeWalker
This implementation of the Saxon pull interface starts from any NodeInfo, and returns the events corresponding to that node and its descendants (including their attributes and namespaces). This works with any tree model: alternative implementations may be available that take advantage of particular implementations of the tree model.
Field Summary |
---|
Fields inherited from interface net.sf.saxon.pull.PullProvider |
---|
ATOMIC_VALUE, ATTRIBUTE, COMMENT, END_DOCUMENT, END_ELEMENT, END_OF_INPUT, NAMESPACE, PROCESSING_INSTRUCTION, START_DOCUMENT, START_ELEMENT, START_OF_INPUT, TEXT |
Method Summary | |
---|---|
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 |
getColumnNumber()
Return the character position where the current document event ends. |
int |
getFingerprint()
Get the fingerprint of the name of the element. |
int |
getLineNumber()
Return the line number where the current document event ends. |
int |
getNameCode()
Get the nameCode identifying the name of the current node. |
NamePool |
getNamePool()
Get the namePool used to lookup all name codes and namespace codes |
NamespaceBinding[] |
getNamespaceDeclarations()
Get the namespace declarations associated with the current element. |
PipelineConfiguration |
getPipelineConfiguration()
Get configuration information. |
String |
getPublicId()
Return the public identifier for the current document event. |
SchemaType |
getSchemaType()
Get the type annotation of the current attribute or element node, or atomic value. |
SourceLocator |
getSourceLocator()
Get the location of the current event. |
CharSequence |
getStringValue()
Get the string value of the current attribute, text node, processing-instruction, or atomic value. |
String |
getSystemId()
Return the system identifier for the current document event. |
List |
getUnparsedEntities()
Get a list of unparsed entities. |
static PullProvider |
makeTreeWalker(NodeInfo startNode)
Factory method to get a tree walker starting an a given node |
int |
next()
Get the next event |
void |
setPipelineConfiguration(PipelineConfiguration pipe)
Set configuration information. |
int |
skipToMatchingEnd()
Skip the current subtree. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static PullProvider makeTreeWalker(NodeInfo startNode)
startNode
- the start node
public void setPipelineConfiguration(PipelineConfiguration pipe)
setPipelineConfiguration
in interface PullProvider
pipe
- the pipeline configurationpublic PipelineConfiguration getPipelineConfiguration()
getPipelineConfiguration
in interface PullProvider
public int next() throws XPathException
next
in interface PullProvider
PullProvider.END_OF_INPUT
is returned if there are no more events to return.
XPathException
- if a dynamic error occurspublic int current()
current
in interface 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
in interface PullProvider
XPathException
- if a dynamic error occurspublic NamespaceBinding[] 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
in interface PullProvider
XPathException
- if a dynamic error occurspublic int skipToMatchingEnd() throws XPathException
skipToMatchingEnd
in interface PullProvider
XPathException
- if a dynamic error occurspublic 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
in interface PullProvider
public NamePool getNamePool()
public int getNameCode()
PullProvider.START_ELEMENT
, PullProvider.PROCESSING_INSTRUCTION
,
PullProvider.ATTRIBUTE
, or PullProvider.NAMESPACE
events. With some PullProvider implementations,
including 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
in interface 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
in interface PullProvider
public CharSequence getStringValue() throws XPathException
PullProvider.START_ELEMENT
, PullProvider.TEXT
,
PullProvider.PROCESSING_INSTRUCTION
, or PullProvider.ATOMIC_VALUE
, the result is undefined.
getStringValue
in interface PullProvider
XPathException
- if a dynamic error occurspublic SchemaType getSchemaType()
getSchemaType
in interface PullProvider
public AtomicValue getAtomicValue()
getAtomicValue
in interface PullProvider
public SourceLocator getSourceLocator()
getSourceLocator
in interface PullProvider
public String getPublicId()
The return value is the public identifier of the document entity or of the external parsed entity in which the markup that triggered the event appears.
getPublicId
in interface SourceLocator
getSystemId()
public String getSystemId()
The return value is the system identifier of the document entity or of the external parsed entity in which the markup that triggered the event appears.
If the system identifier is a URL, the parser must resolve it fully before passing it to the application.
getSystemId
in interface SourceLocator
getPublicId()
public int getLineNumber()
Warning: The return value from the method is intended only as an approximation for the sake of error reporting; it is not intended to provide sufficient information to edit the character content of the original XML document.
The return value is an approximation of the line number in the document entity or external parsed entity where the markup that triggered the event appears.
getLineNumber
in interface SourceLocator
getColumnNumber()
public int getColumnNumber()
Warning: The return value from the method is intended only as an approximation for the sake of error reporting; it is not intended to provide sufficient information to edit the character content of the original XML document.
The return value is an approximation of the column number in the document entity or external parsed entity where the markup that triggered the event appears.
getColumnNumber
in interface SourceLocator
getLineNumber()
public List getUnparsedEntities()
getUnparsedEntities
in interface PullProvider
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |