net.sf.saxon.pull
public class TreeWalker extends Object implements PullProvider, SourceLocator
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
|
NamespaceDeclarations | 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.
|
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.
|
int | getTypeAnnotation()
Get the type annotation of the current attribute or element node, or atomic value.
|
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. |
Returns: the current event
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().
Returns: an AttributeCollection representing the attributes of the element that has just been notified.
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.
Returns: The column number, or -1 if none is available.
See Also: TreeWalker
Returns: the fingerprint. The fingerprint can be used to obtain the local name and namespace URI from the name pool.
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.
Returns: The line number, or -1 if none is available.
See Also: TreeWalker
Returns: the nameCode. The nameCode can be used to obtain the prefix, local name, and namespace URI from the name pool.
Returns: the namePool
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().
*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.
Returns: A string containing the public identifier, or null if none is available.
See Also: TreeWalker
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.
Returns: A string containing the system identifier, or null if none is available.
See Also: TreeWalker
Returns: the type code. This code is the fingerprint of a type name, which may be resolved to a SchemaType by access to the Configuration.
Parameters: startNode the start node
Returns: a PullProvider that delivers events associated with the subtree starting at the given node
Returns: an integer code indicating the type of event. The code TreeWalker is returned if there are no more events to return.