net.sf.saxon.pull
Class PullFromIterator
java.lang.Object
net.sf.saxon.pull.PullFromIterator
- PullProvider
public class PullFromIterator
extends java.lang.Object
This class delivers any XPath sequence through the pull interface. Atomic values
in the sequence are supplied unchanged, as are top-level text, comment, attribute,
namespace, and processing-instruction nodes. Elements and documents appearing in
the input sequence are supplied as a sequence of events that walks recursively
down the subtree rooted at that node. The input is supplied in the form of a
SequenceIterator.
ATOMIC_VALUE , ATTRIBUTE , COMMENT , END_DOCUMENT , END_ELEMENT , END_OF_INPUT , NAMESPACE , PROCESSING_INSTRUCTION , START_DOCUMENT , START_ELEMENT , START_OF_INPUT , TEXT |
PullFromIterator
public PullFromIterator(SequenceIterator base)
Create a PullProvider that wraps a supplied SequenceIterator
base
- the sequence iterator to be wrapped
close
public void close()
Close the event reader. This indicates that no further events are required.
It is not necessary to close an event reader after
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
current
public int current()
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.
- current in interface PullProvider
getAtomicValue
public AtomicValue getAtomicValue()
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.
- getAtomicValue in interface PullProvider
getAttributes
public AttributeCollection getAttributes()
throws XPathException
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().
- getAttributes in interface PullProvider
- an AttributeCollection representing the attributes of the element
that has just been notified.
getFingerprint
public int getFingerprint()
- getFingerprint in interface PullProvider
- the fingerprint. The fingerprint can be used to obtain the local name
and namespace URI from the name pool.
getNameCode
public int getNameCode()
- getNameCode in interface PullProvider
- the nameCode. The nameCode can be used to obtain the prefix, local name,
and namespace URI from the name pool.
getNamespaceDeclarations
public NamespaceDeclarations getNamespaceDeclarations()
throws XPathException
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().*
- getNamespaceDeclarations in interface PullProvider
getSourceLocator
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. 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.
- getSourceLocator in interface PullProvider
getStringValue
public CharSequence getStringValue()
throws XPathException
Get the string value of the current element, text node, processing-instruction,
or top-level attribute or namespace node, or atomic value.
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 in interface PullProvider
- the String Value of the node in question, defined according to the rules in the
XPath data model.
getTypeAnnotation
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,
ATTRIBUTE, or ATOMIC_VALUE.
- getTypeAnnotation in interface PullProvider
- the type annotation. This code is the fingerprint of a type name, which may be
resolved to a
SchemaType
by access to the Configuration.
getUnparsedEntities
public List getUnparsedEntities()
Get a list of unparsed entities.
- getUnparsedEntities in interface PullProvider
- a list of unparsed entities, or null if the information is not available, or
an empty list if there are no unparsed entities.
skipToMatchingEnd
public int skipToMatchingEnd()
throws XPathException
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.
- skipToMatchingEnd in interface PullProvider