org.apache.xpath.axes
Class OneStepIterator
- Cloneable, DTMIterator, java.io.Serializable, ExpressionNode, PathComponent, java.io.Serializable, SourceLocator, SubContextList, XPathVisitable
public class OneStepIterator
This class implements a general iterator for
those LocationSteps with only one step, and perhaps a predicate.
org.apache.xpath.axes.LocPathIterator
, Serialized Form
Object | clone() - Get a cloned iterator.
|
DTMIterator | cloneWithReset() - Get a cloned Iterator that is reset to the beginning
of the query.
|
boolean | deepEquals(Expression expr)
|
void | detach() - Detaches the iterator from the set which it iterated over, releasing
any computational resources and placing the iterator in the INVALID
state.
|
int | getAxis() - Returns the axis being iterated, if it is known.
|
int | getLength() - The number of nodes in the list.
|
boolean | isReverseAxes() - Tells if this is a reverse axes.
|
void | reset() - Reset the iterator.
|
void | setRoot(int context, Object environment) - Initialize the context values for this expression
after it is cloned.
|
allowDetachToRelease , asIterator , asNode , bool , callVisitors , cloneWithReset , detach , execute , executeCharsToContentHandler , getAnalysisBits , getAxis , getContext , getCurrentContextNode , getCurrentNode , getCurrentPos , getDTM , getDTMManager , getExpandEntityReferences , getFilter , getFoundLast , getIsTopLevel , getLastPos , getLength , getPrefixResolver , getRoot , getWhatToShow , getXPathContext , incrementCurrentPos , isDocOrdered , isFresh , isMutable , isNodesetExpr , item , nextNode , previousNode , reset , runTo , setCurrentContextNode , setCurrentPos , setEnvironment , setIsTopLevel , setItem , setRoot , setShouldCacheNodes , size |
acceptNode , callPredicateVisitors , canTraverseOutsideSubtree , clone , deepEquals , fixupVariables , getLastPos , getLocPathIterator , getPredicate , getPredicateCount , getPredicateIndex , getProximityPosition , getProximityPosition , initProximityPosition , isReverseAxes , resetProximityPositions , setLocPathIterator , setPredicateCount |
callVisitors , debugWhatToShow , deepEquals , execute , execute , execute , fixupVariables , getDefaultScore , getLocalName , getNamespace , getNodeTypeTest , getStaticScore , getWhatToShow , initNodeTest , initNodeTest , setLocalName , setNamespace , setStaticScore , setWhatToShow |
asIterator , asIteratorRaw , asNode , assertion , bool , canTraverseOutsideSubtree , deepEquals , error , execute , execute , execute , execute , executeCharsToContentHandler , exprAddChild , exprGetChild , exprGetNumChildren , exprGetParent , exprSetParent , fixupVariables , getColumnNumber , getExpressionOwner , getLineNumber , getPublicId , getSystemId , isNodesetExpr , isStableNumber , num , warn , xstr |
OneStepIterator
public OneStepIterator(DTMAxisIterator iterator,
int axis)
throws TransformerException
Create a OneStepIterator object.
iterator
- The DTM iterator which this iterator will use.axis
- One of Axis.Child, etc., or -1 if the axis is unknown.
TransformerException
-
clone
public Object clone()
throws CloneNotSupportedException
Get a cloned iterator.
- clone in interface DTMIterator
- clone in interface PredicatedNodeTest
- A new iterator that can be used without mutating this one.
cloneWithReset
public DTMIterator cloneWithReset()
throws CloneNotSupportedException
Get a cloned Iterator that is reset to the beginning
of the query.
- cloneWithReset in interface DTMIterator
- cloneWithReset in interface ChildTestIterator
- A cloned NodeIterator set of the start of the query.
detach
public void detach()
Detaches the iterator from the set which it iterated over, releasing
any computational resources and placing the iterator in the INVALID
state. Afterdetach
has been invoked, calls to
nextNode
orpreviousNode
will raise the
exception INVALID_STATE_ERR.
- detach in interface DTMIterator
- detach in interface ChildTestIterator
getAxis
public int getAxis()
Returns the axis being iterated, if it is known.
- getAxis in interface DTMIterator
- getAxis in interface ChildTestIterator
- Axis.CHILD, etc., or -1 if the axis is not known or is of multiple
types.
getLength
public int getLength()
The number of nodes in the list. The range of valid child node indices
is 0 to length-1
inclusive.
- getLength in interface DTMIterator
- getLength in interface LocPathIterator
- The number of nodes in the list, always greater or equal to zero.
isReverseAxes
public boolean isReverseAxes()
Tells if this is a reverse axes. Overrides AxesWalker#isReverseAxes.
- isReverseAxes in interface PredicatedNodeTest
- true for this class.
setRoot
public void setRoot(int context,
Object environment)
Initialize the context values for this expression
after it is cloned.
- setRoot in interface DTMIterator
- setRoot in interface ChildTestIterator
Copyright B) 2004 Apache XML Project. All Rights Reserved.