org.apache.xpath.axes
Class UnionPathIterator
- Cloneable, DTMIterator, java.io.Serializable, ExpressionNode, PathComponent, java.io.Serializable, SourceLocator, SubContextList, XPathVisitable
public class UnionPathIterator
This class extends NodeSetDTM, which implements DTMIterator,
and fetches nodes one at a time in document order based on a XPath
UnionExpr.
As each node is iterated via nextNode(), the node is also stored
in the NodeVector, so that previousNode() can easily be done.
UnionPathIterator() - Constructor to create an instance which you can add location paths to.
|
UnionPathIterator(Compiler compiler, int opPos) - Create a UnionPathIterator object, including creation
of location path iterators from the opcode list, and call back
into the Compiler to create predicate expressions.
|
void | addIterator(DTMIterator expr) - Add an iterator to the union list.
|
void | callVisitors(ExpressionOwner owner, XPathVisitor visitor)
|
Object | clone() - Get a cloned LocPathIterator that holds the same
position as this iterator.
|
static LocPathIterator | createUnionIterator(Compiler compiler, int opPos) - This will return an iterator capable of handling the union of paths given.
|
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.
|
void | fixupVariables(java.util.Vector vars, int globalsSize) - This function is used to fixup variables from QNames to stack frame
indexes at stylesheet build time.
|
int | getAnalysisBits() - Get the analysis bits for this walker, as defined in the WalkerFactory.
|
int | getAxis() - Returns the axis being iterated, if it is known.
|
int | nextNode() - Returns the next node in the set and advances the position of the
iterator in the set.
|
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 |
UnionPathIterator
public UnionPathIterator()
Constructor to create an instance which you can add location paths to.
UnionPathIterator
public UnionPathIterator(Compiler compiler,
int opPos)
throws javax.xml.transform.TransformerException
Create a UnionPathIterator object, including creation
of location path iterators from the opcode list, and call back
into the Compiler to create predicate expressions.
compiler
- The Compiler which is creating
this expression.opPos
- The position of this iterator in the
opcode list from the compiler.
addIterator
public void addIterator(DTMIterator expr)
Add an iterator to the union list.
expr
- non-null reference to a location path iterator.
clone
public Object clone()
throws CloneNotSupportedException
Get a cloned LocPathIterator that holds the same
position as this iterator.
- clone in interface DTMIterator
- clone in interface PredicatedNodeTest
- A clone of this iterator that holds the same node position.
createUnionIterator
public static LocPathIterator createUnionIterator(Compiler compiler,
int opPos)
throws javax.xml.transform.TransformerException
This will return an iterator capable of handling the union of paths given.
compiler
- The Compiler which is creating
this expression.opPos
- The position of this iterator in the
opcode list from the compiler.
- Object that is derived from LocPathIterator.
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 LocPathIterator
fixupVariables
public void fixupVariables(java.util.Vector vars,
int globalsSize)
This function is used to fixup variables from QNames to stack frame
indexes at stylesheet build time.
- fixupVariables in interface PredicatedNodeTest
vars
- List of QNames that correspond to variables. This list
should be searched backwards for the first qualified name that
corresponds to the variable reference qname. The position of the
QName in the vector from the start of the vector will be its position
in the stack frame (but variables above the globalsTop value will need
to be offset to the current stack frame).
getAxis
public int getAxis()
Returns the axis being iterated, if it is known.
- getAxis in interface DTMIterator
- getAxis in interface LocPathIterator
- Axis.CHILD, etc., or -1 if the axis is not known or is of multiple
types.
nextNode
public int nextNode()
Returns the next node in the set and advances the position of the
iterator in the set. After a DTMIterator is created, the first call
to nextNode() returns the first node in the set.
- nextNode in interface DTMIterator
- nextNode in interface LocPathIterator
- The next
Node
in the set being iterated over, or
null
if there are no more members in that set.
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 LocPathIterator
context
- The XPath runtime context for this
transformation.
Copyright © 2006 Apache XML Project. All Rights Reserved.