org.apache.xpath.axes

Class FilterExprIteratorSimple

Implemented Interfaces:
Cloneable, DTMIterator, java.io.Serializable, ExpressionNode, PathComponent, java.io.Serializable, SourceLocator, SubContextList, XPathVisitable

public class FilterExprIteratorSimple
extends LocPathIterator

Class to use for one-step iteration that doesn't have a predicate, and doesn't need to set the context.
See Also:
Serialized Form

Field Summary

Fields inherited from class org.apache.xpath.axes.LocPathIterator

m_lastFetched

Fields inherited from class org.apache.xpath.patterns.NodeTest

SCORE_NODETEST, SCORE_NONE, SCORE_NSWILD, SCORE_OTHER, SCORE_QNAME, SHOW_BYFUNCTION, SUPPORTS_PRE_STRIPPING, WILD

Fields inherited from interface org.apache.xml.dtm.DTMIterator

FILTER_ACCEPT, FILTER_REJECT, FILTER_SKIP

Constructor Summary

FilterExprIteratorSimple()
Create a FilterExprIteratorSimple object.
FilterExprIteratorSimple(Expression expr)
Create a FilterExprIteratorSimple object.

Method Summary

void
callPredicateVisitors(XPathVisitor visitor)
This will traverse the heararchy, calling the visitor for each member.
boolean
deepEquals(Expression expr)
void
detach()
Detaches the walker from the set which it iterated over, releasing any computational resources and placing the iterator in the INVALID state.
static XNodeSet
executeFilterExpr(int context, XPathContext xctxt, PrefixResolver prefixResolver, boolean isTopLevel, int stackFrame, Expression expr)
Execute the expression.
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.
Expression
getInnerExpression()
Get the inner contained expression of this filter.
boolean
isDocOrdered()
Returns true if all the nodes in the iteration well be returned in document order.
int
nextNode()
Returns the next node in the set and advances the position of the iterator in the set.
void
setInnerExpression(Expression expr)
Set the inner contained expression of this filter.
void
setRoot(int context, Object environment)
Initialize the context values for this expression after it is cloned.

Methods inherited from class org.apache.xpath.axes.LocPathIterator

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

Methods inherited from class org.apache.xpath.axes.PredicatedNodeTest

acceptNode, callPredicateVisitors, canTraverseOutsideSubtree, clone, deepEquals, fixupVariables, getLastPos, getLocPathIterator, getPredicate, getPredicateCount, getPredicateIndex, getProximityPosition, getProximityPosition, initProximityPosition, isReverseAxes, resetProximityPositions, setLocPathIterator, setPredicateCount

Methods inherited from class org.apache.xpath.patterns.NodeTest

callVisitors, debugWhatToShow, deepEquals, execute, execute, execute, fixupVariables, getDefaultScore, getLocalName, getNamespace, getNodeTypeTest, getStaticScore, getWhatToShow, initNodeTest, initNodeTest, setLocalName, setNamespace, setStaticScore, setWhatToShow

Methods inherited from class org.apache.xpath.Expression

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

Constructor Details

FilterExprIteratorSimple

public FilterExprIteratorSimple()
Create a FilterExprIteratorSimple object.

FilterExprIteratorSimple

public FilterExprIteratorSimple(Expression expr)
Create a FilterExprIteratorSimple object.

Method Details

callPredicateVisitors

public void callPredicateVisitors(XPathVisitor visitor)
This will traverse the heararchy, calling the visitor for each member. If the called visitor method returns false, the subtree should not be called.
Overrides:
callPredicateVisitors in interface PredicatedNodeTest
Parameters:
visitor - The visitor whose appropriate method will be called.

deepEquals

public boolean deepEquals(Expression expr)
Overrides:
deepEquals in interface PredicatedNodeTest

detach

public void detach()
Detaches the walker from the set which it iterated over, releasing any computational resources and placing the iterator in the INVALID state.
Specified by:
detach in interface DTMIterator
Overrides:
detach in interface LocPathIterator

executeFilterExpr

public static XNodeSet executeFilterExpr(int context,
                                         XPathContext xctxt,
                                         PrefixResolver prefixResolver,
                                         boolean isTopLevel,
                                         int stackFrame,
                                         Expression expr)
            throws WrappedRuntimeException
Execute the expression. Meant for reuse by other FilterExpr iterators that are not derived from this object.

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.
Overrides:
fixupVariables in interface PredicatedNodeTest
Parameters:
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).

getAnalysisBits

public int getAnalysisBits()
Get the analysis bits for this walker, as defined in the WalkerFactory.
Specified by:
getAnalysisBits in interface PathComponent
Overrides:
getAnalysisBits in interface LocPathIterator
Returns:
One of WalkerFactory#BIT_DESCENDANT, etc.

getAxis

public int getAxis()
Returns the axis being iterated, if it is known.
Specified by:
getAxis in interface DTMIterator
Overrides:
getAxis in interface LocPathIterator
Returns:
Axis.CHILD, etc., or -1 if the axis is not known or is of multiple types.

getInnerExpression

public Expression getInnerExpression()
Get the inner contained expression of this filter.

isDocOrdered

public boolean isDocOrdered()
Returns true if all the nodes in the iteration well be returned in document order. Warning: This can only be called after setRoot has been called!
Specified by:
isDocOrdered in interface DTMIterator
Overrides:
isDocOrdered in interface LocPathIterator
Returns:
true as a default.

nextNode

public int nextNode()
Returns the next node in the set and advances the position of the iterator in the set. After a NodeIterator is created, the first call to nextNode() returns the first node in the set.
Specified by:
nextNode in interface DTMIterator
Overrides:
nextNode in interface LocPathIterator
Returns:
The next Node in the set being iterated over, or null if there are no more members in that set.

setInnerExpression

public void setInnerExpression(Expression expr)
Set the inner contained expression of this filter.

setRoot

public void setRoot(int context,
                    Object environment)
Initialize the context values for this expression after it is cloned.
Specified by:
setRoot in interface DTMIterator
Overrides:
setRoot in interface LocPathIterator
Parameters:
context - The XPath runtime context for this transformation.

Copyright B) 2006 Apache XML Project. All Rights Reserved.