| java.lang.Object
 net.sf.saxon.pull.TreeWalker
| TreeWalker | | public class TreeWalker implements PullProvider,SourceLocator(Code) | | 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.
|
| Method Summary | |
| public void | close()
Close the event reader. | | public int | current()
Get the event most recently returned by next(), or by other calls that change
the position, for example getStringValue() and skipToMatchingEnd(). | | public AtomicValue | getAtomicValue()
Get an atomic value. | | public AttributeCollection | getAttributes()
Get the attributes associated with the current element. | | public int | getColumnNumber()
Return the character position where the current document event ends. | | public int | getFingerprint()
Get the fingerprint of the name of the element. | | public int | getLineNumber()
Return the line number where the current document event ends. | | public int | getNameCode()
Get the nameCode identifying the name of the current node. | | public NamePool | getNamePool()
| | public NamespaceDeclarations | getNamespaceDeclarations()
Get the namespace declarations associated with the current element. | | public PipelineConfiguration | getPipelineConfiguration()
Get configuration information. | | public String | getPublicId()
Return the public identifier for the current document event. | | public SourceLocator | getSourceLocator()
Get the location of the current event.
For an event stream representing a real document, the location information
should identify the location in the lexical XML source. | | public CharSequence | getStringValue()
Get the string value of the current attribute, text node, processing-instruction,
or atomic value.
This method cannot be used to obtain the string value of an element, or of a namespace
node. | | public String | getSystemId()
Return the system identifier for the current document event. | | public int | getTypeAnnotation()
Get the type annotation of the current attribute or element node, or atomic value.
The result of this method is undefined unless the most recent event was START_ELEMENT,
START_CONTENT, ATTRIBUTE, or ATOMIC_VALUE.
the type code. | | public static PullProvider | makeTreeWalker(NodeInfo startNode)
| | public int | next()
Get the next event
an integer code indicating the type of event. | | public void | setPipelineConfiguration(PipelineConfiguration pipe)
Set configuration information. | | public int | skipToMatchingEnd()
Skip the current subtree. |
| close | | public void close()(Code) | | Close the event reader. This indicates that no further events are required.
It is not necessary to close an event reader after
TreeWalker.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.
|
| current | | public int current()(Code) | | Get the event most recently returned by next(), or by other calls that change
the position, for example getStringValue() and skipToMatchingEnd(). This
method does not change the position of the PullProvider.
the current event |
| getAtomicValue | | public AtomicValue getAtomicValue()(Code) | | Get an atomic value. This call may be used only when the last event reported was
ATOMIC_VALUE. This indicates that the PullProvider is reading a sequence that contains
a free-standing atomic value; it is never used when reading the content of a node.
|
| getAttributes | | public AttributeCollection getAttributes() throws XPathException(Code) | | Get the attributes associated with the current element. This method must
be called only after a START_ELEMENT event has been notified. The contents
of the returned AttributeCollection are guaranteed to remain unchanged
until the next START_ELEMENT event, but may be modified thereafter. The object
should not be modified by the client.
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().
an AttributeCollection representing the attributes of the elementthat has just been notified. |
| getColumnNumber | | public int getColumnNumber()(Code) | | Return the character position where the current document event ends.
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.
The column number, or -1 if none is available.
See Also: TreeWalker.getLineNumber |
| getFingerprint | | public int getFingerprint()(Code) | | Get the fingerprint of the name of the element. This is similar to the nameCode, except that
it does not contain any information about the prefix: so two elements with the same fingerprint
have the same name, excluding prefix. This method
can be used after the
TreeWalker.START_ELEMENT ,
TreeWalker.END_ELEMENT ,
TreeWalker.PROCESSING_INSTRUCTION ,
TreeWalker.ATTRIBUTE , or
TreeWalker.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.
the fingerprint. The fingerprint can be used to obtain the local nameand namespace URI from the name pool. |
| getLineNumber | | public int getLineNumber()(Code) | | Return the line number where the current document event ends.
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.
The line number, or -1 if none is available.
See Also: TreeWalker.getColumnNumber |
| getNameCode | | public int getNameCode()(Code) | | Get the nameCode identifying the name of the current node. This method
can be used after the
TreeWalker.START_ELEMENT ,
TreeWalker.PROCESSING_INSTRUCTION ,
TreeWalker.ATTRIBUTE , or
TreeWalker.NAMESPACE events. With some PullProvider implementations,
including this one, it can also be used after
TreeWalker.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.
the nameCode. The nameCode can be used to obtain the prefix, local name,and namespace URI from the name pool. |
| getNamePool | | public NamePool getNamePool()(Code) | | Get the namePool used to lookup all name codes and namespace codes
the namePool |
| getNamespaceDeclarations | | public NamespaceDeclarations getNamespaceDeclarations() throws XPathException(Code) | | Get the namespace declarations associated with the current element. This method must
be called only after a START_ELEMENT event has been notified. In the case of a top-level
START_ELEMENT event (that is, an element that either has no parent node, or whose parent
is not included in the sequence being read), the NamespaceDeclarations object returned
will contain a namespace declaration for each namespace that is in-scope for this element
node. In the case of a non-top-level element, the NamespaceDeclarations will contain
a set of namespace declarations and undeclarations, representing the differences between
this element and its parent.
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(). *
|
| getPublicId | | public String getPublicId()(Code) | | Return the public identifier for the current document event.
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.
A string containing the public identifier, ornull if none is available.
See Also: TreeWalker.getSystemId |
| getSourceLocator | | public SourceLocator getSourceLocator()(Code) | | Get the location of the current event.
For an event stream representing a real document, the location information
should identify the location in the lexical XML source. For a constructed document, it should
identify the location in the query or stylesheet that caused the node to be created.
A value of null can be returned if no location information is available.
|
| getSystemId | | public String getSystemId()(Code) | | Return the system identifier for the current document event.
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.
A string containing the system identifier, or nullif none is available.
See Also: TreeWalker.getPublicId |
| getTypeAnnotation | | public int getTypeAnnotation()(Code) | | Get the type annotation of the current attribute or element node, or atomic value.
The result of this method is undefined unless the most recent event was START_ELEMENT,
START_CONTENT, ATTRIBUTE, or ATOMIC_VALUE.
the type code. This code is the fingerprint of a type name, which may beresolved to a net.sf.saxon.type.SchemaType by access to the Configuration. |
| makeTreeWalker | | public static PullProvider makeTreeWalker(NodeInfo startNode)(Code) | | Factory method to get a tree walker starting an a given node
Parameters:
startNode - the start node a PullProvider that delivers events associated with the subtree starting at the given node |
| setPipelineConfiguration | | public void setPipelineConfiguration(PipelineConfiguration pipe)(Code) | | Set configuration information. This must only be called before any events
have been read.
|
| skipToMatchingEnd | | public int skipToMatchingEnd() throws XPathException(Code) | | Skip the current subtree. This method may be called only immediately after
a START_DOCUMENT or START_ELEMENT event. This call returns the matching
END_DOCUMENT or END_ELEMENT event; the next call on next() will return
the event following the END_DOCUMENT or END_ELEMENT.
|
|
|