package client.net.sf.saxon.ce.tree.iter;
import client.net.sf.saxon.ce.om.Item;
import client.net.sf.saxon.ce.om.NodeInfo;
import client.net.sf.saxon.ce.pattern.NodeTest;
import client.net.sf.saxon.ce.trans.XPathException;
import client.net.sf.saxon.ce.value.Value;
/**
* 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.
*/
public abstract class AxisIteratorImpl implements AxisIterator {
protected int position = 0;
protected NodeInfo current;
/**
* Move to the next node, without returning it. Returns true if there is
* a next node, false if the end of the sequence has been reached. After
* calling this method, the current node may be retrieved using the
* current() function.
*/
public boolean moveNext() {
return (next() != null);
}
/**
* Get the current node in the sequence.
* @return the node returned by the most recent call on next()
*/
public Item current() {
return current;
}
/**
* Get the current position
* @return the position of the most recent node returned by next()
*/
public final int position() {
return position;
}
/**
* Return an iterator over an axis, starting at the current node.
*
* @param axis the axis to iterate over, using a constant such as
* {@link client.net.sf.saxon.ce.om.Axis#CHILD}
* @param test a predicate to apply to the nodes before returning them.
*/
public AxisIterator iterateAxis(byte axis, NodeTest test) {
return current.iterateAxis(axis, test);
}
/**
* Return the atomized value of the current node.
*
* @return the atomized value.
* @throws NullPointerException if there is no current node
*/
public Value atomize() throws XPathException {
return current.getTypedValue();
}
/**
* Return the string value of the current node.
*
* @return the string value, as an instance of CharSequence.
* @throws NullPointerException if there is no current node
*/
public CharSequence getStringValue() {
return current.getStringValueCS();
}
/**
* Get properties of this iterator, as a bit-significant integer.
*
* @return the properties of this iterator. This will be some combination of
* properties such as {@link #GROUNDED}, {@link #LAST_POSITION_FINDER},
* and {@link #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.
*/
public int getProperties() {
return 0;
}
}
// This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
// If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
// This Source Code Form is “Incompatible With Secondary Licenses”, as defined by the Mozilla Public License, v. 2.0.