|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectnet.sf.saxon.tree.iter.AxisIteratorImpl
public abstract class AxisIteratorImpl
A SequenceIterator is used to iterate over a sequence. An AxisIterator is a SequenceIterator that always iterates over a set of nodes, and that throws no exceptions; it also supports the ability to find the last() position, again with no exceptions. This class is an abstract implementation of AxisIterator that is used as a base class for many concrete implementations. The main functionality that it provides is maintaining the current position.
| Field Summary | |
|---|---|
protected NodeInfo |
current
|
protected int |
position
|
| Fields inherited from interface net.sf.saxon.om.SequenceIterator |
|---|
GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD |
| Constructor Summary | |
|---|---|
AxisIteratorImpl()
|
|
| Method Summary | |
|---|---|
Value |
atomize()
Return the atomized value of the current node. |
void |
close()
Close the iterator. |
NodeInfo |
current()
Get the current node in the sequence. |
int |
getProperties()
Get properties of this iterator, as a bit-significant integer. |
CharSequence |
getStringValue()
Return the string value of the current node. |
AxisIterator |
iterateAxis(byte axis,
NodeTest test)
Return an iterator over an axis, starting at the current node. |
boolean |
moveNext()
Move to the next node, without returning it. |
int |
position()
Get the current position |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface net.sf.saxon.tree.iter.AxisIterator |
|---|
getAnother, next |
| Field Detail |
|---|
protected int position
protected NodeInfo current
| Constructor Detail |
|---|
public AxisIteratorImpl()
| Method Detail |
|---|
public boolean moveNext()
moveNext in interface AxisIteratorpublic NodeInfo current()
current in interface SequenceIteratorcurrent in interface AxisIteratorcurrent in interface UnfailingIteratorpublic final int position()
position in interface SequenceIteratorposition in interface UnfailingIteratorpublic void close()
SequenceIterator(Currently, closing an iterator is important only when the data is being "pushed" in another thread. Closing the iterator terminates that thread and means that it needs to do no additional work. Indeed, failing to close the iterator may cause the push thread to hang waiting for the buffer to be emptied.)
close in interface SequenceIterator
public AxisIterator iterateAxis(byte axis,
NodeTest test)
iterateAxis in interface AxisIteratoraxis - the axis to iterate over, using a constant such as
Axis.CHILDtest - a predicate to apply to the nodes before returning them.
public Value atomize()
throws XPathException
atomize in interface AxisIteratorNullPointerException - if there is no current node
XPathException - if the current node
cannot be atomized, for example because it is an element node with
element-only content.public CharSequence getStringValue()
getStringValue in interface AxisIteratorNullPointerException - if there is no current nodepublic int getProperties()
getProperties in interface SequenceIteratorSequenceIterator.GROUNDED, SequenceIterator.LAST_POSITION_FINDER,
and SequenceIterator.LOOKAHEAD. It is always
acceptable to return the value zero, indicating that there are no known special properties.
It is acceptable for the properties of the iterator to change depending on its state.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||