Package org.htmlunit.xpath.axes
Class ChildTestIterator
- java.lang.Object
-
- All Implemented Interfaces:
java.lang.Cloneable
,javax.xml.transform.SourceLocator
,PathComponent
,SubContextList
,ExpressionNode
,DTMIterator
,XPathVisitable
- Direct Known Subclasses:
AttributeIterator
,OneStepIterator
,OneStepIteratorForward
,UnionChildIterator
public class ChildTestIterator extends BasicTestIterator
This class implements an optimized iterator for children patterns that have a node test, and possibly a predicate.- See Also:
BasicTestIterator
-
-
Field Summary
Fields Modifier and Type Field Description protected DTMAxisTraverser
m_traverser
The traverser to use to navigate over the descendants.-
Fields inherited from class org.htmlunit.xpath.axes.LocPathIterator
m_cdtm, m_clones, m_context, m_currentContextNode, m_execContext, m_lastFetched, m_length, m_pos, m_stackFrame
-
Fields inherited from class org.htmlunit.xpath.axes.PredicatedNodeTest
DEBUG_PREDICATECOUNTING, m_foundLast, m_lpi, m_predCount, m_predicateIndex, m_proximityPositions
-
Fields inherited from class org.htmlunit.xpath.patterns.NodeTest
m_name, m_whatToShow, SCORE_NODETEST, SCORE_NONE, SCORE_NSWILD, SCORE_OTHER, SCORE_QNAME, SHOW_BYFUNCTION, WILD
-
Fields inherited from interface org.htmlunit.xpath.xml.dtm.DTMIterator
FILTER_ACCEPT, FILTER_SKIP
-
-
Constructor Summary
Constructors Constructor Description ChildTestIterator(Compiler compiler, int opPos, int analysis)
Create a ChildTestIterator object.ChildTestIterator(DTMAxisTraverser traverser)
Create a ChildTestIterator object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DTMIterator
cloneWithReset()
Get a cloned Iterator that is reset to the start of the iteration.void
detach()
Detaches theDTMIterator
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.protected int
getNextNode()
Get the next node via getNextXXX.void
setRoot(int context, java.lang.Object environment)
Reset the root node of theDTMIterator
, overriding the value specified when it was created.-
Methods inherited from class org.htmlunit.xpath.axes.BasicTestIterator
nextNode
-
Methods inherited from class org.htmlunit.xpath.axes.LocPathIterator
asIterator, asNode, bool, callVisitors, execute, getAnalysisBits, getCurrentNode, getCurrentPos, getDTM, getDTMManager, getExpandEntityReferences, getIsTopLevel, getLastPos, getLength, getPrefixResolver, getRoot, getWhatToShow, getXPathContext, incrementCurrentPos, isDocOrdered, isFresh, item, previousNode, reset, returnNextNode, runTo, setCurrentPos, setIsTopLevel, setShouldCacheNodes
-
Methods inherited from class org.htmlunit.xpath.axes.PredicatedNodeTest
acceptNode, callPredicateVisitors, canTraverseOutsideSubtree, clone, countProximityPosition, deepEquals, executePredicates, getPredicate, getPredicateCount, getProximityPosition, getProximityPosition, getProximityPosition, initPredicateInfo, initProximityPosition, isReverseAxes, nodeToString, resetProximityPositions, setLocPathIterator, setPredicateCount
-
Methods inherited from class org.htmlunit.xpath.patterns.NodeTest
calcScore, execute, execute, getLocalName, getNamespace, getNodeTypeTest, getStaticScore, initNodeTest, initNodeTest, setLocalName, setNamespace, setStaticScore, setWhatToShow
-
Methods inherited from class org.htmlunit.xpath.Expression
assertion, error, execute, exprGetParent, exprSetParent, getColumnNumber, getExpressionOwner, getLineNumber, getPublicId, getSystemId, isSameClass, isStableNumber, num
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.htmlunit.xpath.xml.dtm.DTMIterator
clone
-
-
-
-
Field Detail
-
m_traverser
protected transient DTMAxisTraverser m_traverser
The traverser to use to navigate over the descendants.
-
-
Constructor Detail
-
ChildTestIterator
ChildTestIterator(Compiler compiler, int opPos, int analysis) throws javax.xml.transform.TransformerException
Create a ChildTestIterator object.- Parameters:
compiler
- A reference to the Compiler that contains the op map.opPos
- The position within the op map, which contains the location path expression for this itterator.- Throws:
javax.xml.transform.TransformerException
- if any
-
ChildTestIterator
public ChildTestIterator(DTMAxisTraverser traverser)
Create a ChildTestIterator object.- Parameters:
traverser
- Traverser that tells how the KeyIterator is to be handled.
-
-
Method Detail
-
getNextNode
protected int getNextNode()
Get the next node via getNextXXX. Bottlenecked for derived class override.- Specified by:
getNextNode
in classBasicTestIterator
- Returns:
- The next node on the axis, or DTM.NULL.
-
cloneWithReset
public DTMIterator cloneWithReset() throws java.lang.CloneNotSupportedException
Get a cloned Iterator that is reset to the start of the iteration.- Specified by:
cloneWithReset
in interfaceDTMIterator
- Overrides:
cloneWithReset
in classBasicTestIterator
- Returns:
- A clone of this iteration that has been reset.
- Throws:
java.lang.CloneNotSupportedException
- if any
-
setRoot
public void setRoot(int context, java.lang.Object environment)
Reset the root node of theDTMIterator
, overriding the value specified when it was created. Note the root node is not the root node of the document tree, but the context node from where the iteration begins.- Specified by:
setRoot
in interfaceDTMIterator
- Overrides:
setRoot
in classLocPathIterator
- Parameters:
context
- int Handle of the context node.environment
- The environment object. The environment in which this iterator operates, which should provide:- a node (the context node... same value as "root" defined below)
- a pair of non-zero positive integers (the context position and the context size)
- a set of variable bindings
- a function library
- the set of namespace declarations in scope for the expression.
At this time the exact implementation of this environment is application dependent. Probably a proper interface will be created fairly soon.
-
getAxis
public int getAxis()
Returns the axis being iterated, if it is known.- Specified by:
getAxis
in interfaceDTMIterator
- Overrides:
getAxis
in classLocPathIterator
- Returns:
- Axis.CHILD, etc., or -1 if the axis is not known or is of multiple types.
-
detach
public void detach()
Detaches theDTMIterator
from the set which it iterated over, releasing any computational resources and placing the iterator in the INVALID state. Afterdetach
has been invoked, calls tonextNode
orpreviousNode
will raise a runtime exception.- Specified by:
detach
in interfaceDTMIterator
- Overrides:
detach
in classLocPathIterator
-
-