|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.saxonica.pull.PullFromIterator
public class PullFromIterator
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.
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 |
Constructor Summary | |
---|---|
PullFromIterator(SequenceIterator base)
Create a PullProvider that wraps a supplied SequenceIterator |
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 |
getFingerprint()
Get the fingerprint of the name of the element. |
int |
getNameCode()
Get the nameCode identifying the name of the current node. |
NamespaceBinding[] |
getNamespaceDeclarations()
Get the namespace declarations associated with the current element. |
PipelineConfiguration |
getPipelineConfiguration()
Get configuration information. |
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 element, text node, processing-instruction, or top-level attribute or namespace node, or atomic value. |
List |
getUnparsedEntities()
Get a list of unparsed entities. |
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 |
Constructor Detail |
---|
public PullFromIterator(SequenceIterator base)
base
- the sequence iterator to be wrappedMethod Detail |
---|
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 at the end of the sequence.
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 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
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
XPathException
- if a dynamic error occurspublic AtomicValue getAtomicValue()
getAtomicValue
in interface PullProvider
public SchemaType getSchemaType()
getSchemaType
in interface PullProvider
public SourceLocator getSourceLocator()
getSourceLocator
in interface PullProvider
public List getUnparsedEntities()
getUnparsedEntities
in interface PullProvider
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |