public abstract class LocPathIterator extends PredicatedNodeTest implements Cloneable, DTMIterator, Serializable, PathComponent
Modifier and Type | Field and Description |
---|---|
protected boolean |
m_allowDetach
Control over whether it is OK for detach to reset the iterator.
|
protected DTM |
m_cdtm
The dtm of the context node.
|
protected IteratorPool |
m_clones
The pool for cloned iterators.
|
protected int |
m_context
The context node for this iterator, which doesn't change through
the course of the iteration.
|
protected int |
m_currentContextNode
The node context from where the expression is being
executed from (i.e.
|
protected XPathContext |
m_execContext
The XPathContext reference, needed for execution of many
operations.
|
int |
m_lastFetched
The last node that was fetched, usually by nextNode.
|
protected int |
m_length |
protected int |
m_pos
The current position of the context node.
|
m_foundLast, m_lpi, m_predCount, m_proximityPositions
m_name, m_whatToShow, SCORE_NODETEST, SCORE_NONE, SCORE_NSWILD, SCORE_OTHER, SCORE_QNAME, SHOW_BYFUNCTION, SUPPORTS_PRE_STRIPPING, WILD
FILTER_ACCEPT, FILTER_REJECT, FILTER_SKIP
Modifier | Constructor and Description |
---|---|
protected |
LocPathIterator()
Create a LocPathIterator object.
|
protected |
LocPathIterator(Compiler compiler,
int opPos,
int analysis)
Create a LocPathIterator object, including creation
of step walkers from the opcode list, and call back
into the Compiler to create predicate expressions.
|
protected |
LocPathIterator(Compiler compiler,
int opPos,
int analysis,
boolean shouldLoadWalkers)
Create a LocPathIterator object, including creation
of step walkers from the opcode list, and call back
into the Compiler to create predicate expressions.
|
protected |
LocPathIterator(PrefixResolver nscontext)
Create a LocPathIterator object.
|
Modifier and Type | Method and Description |
---|---|
void |
allowDetachToRelease(boolean allowRelease)
Specify if it's OK for detach to release the iterator for reuse.
|
DTMIterator |
asIterator(XPathContext xctxt,
int contextNode)
Given an select expression and a context, evaluate the XPath
and return the resulting iterator.
|
int |
asNode(XPathContext xctxt)
Return the first node out of the nodeset, if this expression is
a nodeset expression.
|
boolean |
bool(XPathContext xctxt)
Evaluate this operation directly to a boolean.
|
void |
callVisitors(ExpressionOwner owner,
XPathVisitor visitor)
This will traverse the heararchy, calling the visitor for
each member.
|
DTMIterator |
cloneWithReset()
Get a cloned Iterator that is reset to the beginning
of the query.
|
void |
detach()
Detaches the iterator from the set which it iterated over, releasing
any computational resources and placing the iterator in the INVALID
state.
|
XObject |
execute(XPathContext xctxt)
Execute this iterator, meaning create a clone that can
store state, and initialize it for fast execution from
the current runtime state.
|
void |
executeCharsToContentHandler(XPathContext xctxt,
ContentHandler handler)
Execute an expression in the XPath runtime context, and return the
result of the expression.
|
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 |
getContext()
The node context for the iterator.
|
int |
getCurrentContextNode()
The node context from where the expression is being
executed from (i.e.
|
int |
getCurrentNode()
Return the last fetched node.
|
int |
getCurrentPos()
Get the current position, which is one less than
the next nextNode() call will retrieve.
|
DTM |
getDTM(int nodeHandle)
Get an instance of a DTM that "owns" a node handle.
|
DTMManager |
getDTMManager()
Get an instance of the DTMManager.
|
boolean |
getExpandEntityReferences()
The value of this flag determines whether the children of entity
reference nodes are visible to the iterator.
|
DTMFilter |
getFilter()
The filter used to screen nodes.
|
boolean |
getFoundLast()
Tells if we've found the last node yet.
|
boolean |
getIsTopLevel()
Get if this is an iterator at the upper level of
the XPath.
|
int |
getLastPos(XPathContext xctxt)
Get the index of the last node that can be itterated to.
|
int |
getLength()
The number of nodes in the list.
|
PrefixResolver |
getPrefixResolver()
Return the saved reference to the prefix resolver that
was in effect when this iterator was created.
|
int |
getRoot()
The root node of the Iterator, as specified when it was created.
|
int |
getWhatToShow()
This attribute determines which node types are presented via the
iterator.
|
XPathContext |
getXPathContext()
The XPath execution context we are operating on.
|
void |
incrementCurrentPos()
Increment the current position in the node set.
|
boolean |
isDocOrdered()
Returns true if all the nodes in the iteration well be returned in document
order.
|
boolean |
isFresh()
Tells if this NodeSetDTM is "fresh", in other words, if
the first nextNode() that is called will return the
first node in the set.
|
boolean |
isMutable()
Tells if this iterator can have nodes added to it or set via
the
setItem(int node, int index) method. |
boolean |
isNodesetExpr()
Tell if the expression is a nodeset expression.
|
int |
item(int index)
Returns the
index th item in the collection. |
abstract int |
nextNode()
Returns the next node in the set and advances the position of the
iterator in the set.
|
int |
previousNode()
Returns the previous node in the set and moves the position of the
iterator backwards in the set.
|
void |
reset()
Reset the iterator.
|
protected int |
returnNextNode(int nextNode)
Bottleneck the return of a next node, to make returns
easier from nextNode().
|
void |
runTo(int index)
If an index is requested, NodeSetDTM will call this method
to run the iterator to the index.
|
void |
setCurrentContextNode(int n)
Set the current context node for this iterator.
|
void |
setCurrentPos(int i)
Set the current position in the node set.
|
void |
setEnvironment(Object environment)
Set the environment in which this iterator operates, which should provide:
a node (the context node...
|
void |
setIsTopLevel(boolean b)
Set if this is an iterator at the upper level of
the XPath.
|
void |
setItem(int node,
int index)
Sets the node at the specified index of this vector to be the
specified node.
|
protected void |
setNextPosition(int next)
Set the next position index of this iterator.
|
void |
setRoot(int context,
Object environment)
Initialize the context values for this expression
after it is cloned.
|
void |
setShouldCacheNodes(boolean b)
If setShouldCacheNodes(true) is called, then nodes will
be cached.
|
int |
size()
Get the length of the cached nodes.
|
acceptNode, callPredicateVisitors, canTraverseOutsideSubtree, clone, countProximityPosition, deepEquals, fixupVariables, getLocPathIterator, getPredicate, getPredicateCount, getPredicateIndex, getProximityPosition, getProximityPosition, getProximityPosition, initPredicateInfo, initProximityPosition, isReverseAxes, nodeToString, resetProximityPositions, setLocPathIterator, setPredicateCount
calcScore, debugWhatToShow, execute, execute, getDefaultScore, getLocalName, getNamespace, getNodeTypeTest, getStaticScore, initNodeTest, initNodeTest, setLocalName, setNamespace, setStaticScore, setWhatToShow
asIteratorRaw, assertion, error, execute, exprAddChild, exprGetChild, exprGetNumChildren, exprGetParent, exprSetParent, getColumnNumber, getExpressionOwner, getLineNumber, getPublicId, getSystemId, isSameClass, isStableNumber, num, warn, xstr
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
clone
protected boolean m_allowDetach
protected transient IteratorPool m_clones
protected transient DTM m_cdtm
public transient int m_lastFetched
protected transient int m_context
protected transient int m_currentContextNode
protected transient int m_pos
protected transient int m_length
protected transient XPathContext m_execContext
protected LocPathIterator()
protected LocPathIterator(PrefixResolver nscontext)
nscontext
- The namespace context for this iterator,
should be OK if null.protected LocPathIterator(Compiler compiler, int opPos, int analysis) throws TransformerException
compiler
- The Compiler which is creating
this expression.opPos
- The position of this iterator in the
opcode list from the compiler.TransformerException
protected LocPathIterator(Compiler compiler, int opPos, int analysis, boolean shouldLoadWalkers) throws TransformerException
compiler
- The Compiler which is creating
this expression.opPos
- The position of this iterator in the
opcode list from the compiler.shouldLoadWalkers
- True if walkers should be
loaded, or false if this is a derived iterator and
it doesn't wish to load child walkers.TransformerException
public int getAnalysisBits()
getAnalysisBits
in interface PathComponent
public void setEnvironment(Object environment)
At this time the exact implementation of this environment is application dependent. Probably a proper interface will be created fairly soon.
environment
- The environment object.public DTM getDTM(int nodeHandle)
getDTM
in interface DTMIterator
nodeHandle
- the nodeHandle.public DTMManager getDTMManager()
getDTMManager
in interface DTMIterator
public XObject execute(XPathContext xctxt) throws TransformerException
execute
in class NodeTest
xctxt
- The XPath execution context.TransformerException
public void executeCharsToContentHandler(XPathContext xctxt, ContentHandler handler) throws TransformerException, SAXException
executeCharsToContentHandler
in class Expression
xctxt
- The XPath runtime context.handler
- The target content handler.TransformerException
- if a runtime exception
occurs.SAXException
public DTMIterator asIterator(XPathContext xctxt, int contextNode) throws TransformerException
asIterator
in class Expression
xctxt
- The execution context.contextNode
- The node that "." expresses.TransformerException
- thrown if the active ProblemListener decides
the error condition is severe enough to halt processing.TransformerException
public boolean isNodesetExpr()
isNodesetExpr
in class Expression
public int asNode(XPathContext xctxt) throws TransformerException
asNode
in class Expression
xctxt
- The XPath runtime context.TransformerException
public boolean bool(XPathContext xctxt) throws TransformerException
bool
in class Expression
xctxt
- The runtime execution context.TransformerException
public void setIsTopLevel(boolean b)
b
- true if this location path is at the top level of the
expression.public boolean getIsTopLevel()
public void setRoot(int context, Object environment)
setRoot
in interface DTMIterator
context
- The XPath runtime context for this
transformation.environment
- The environment object.
The environment in which this iterator operates, which should provide:
At this time the exact implementation of this environment is application dependent. Probably a proper interface will be created fairly soon.
protected void setNextPosition(int next)
next
- A value greater than or equal to zero that indicates the next
node position to fetch.public final int getCurrentPos()
getCurrentPos
in interface DTMIterator
public void setShouldCacheNodes(boolean b)
setShouldCacheNodes
in interface DTMIterator
b
- True if this iterator should cache nodes.public boolean isMutable()
setItem(int node, int index)
method.isMutable
in interface DTMIterator
public void setCurrentPos(int i)
setCurrentPos
in interface DTMIterator
i
- Must be a valid index greater
than or equal to zero and less than m_cachedNodes.size().public void incrementCurrentPos()
public int size()
Note: for the moment at least, this only returns the size of the nodes that have been fetched to date, it doesn't attempt to run to the end to make sure we have found everything. This should be reviewed.
public int item(int index)
index
th item in the collection. If
index
is greater than or equal to the number of nodes in
the list, this returns null
.item
in interface DTMIterator
index
- Index into the collection.index
th position in the
NodeList
, or null
if that is not a valid
index.public void setItem(int node, int index)
The index must be a value greater than or equal to 0 and less than the current size of the vector. The iterator must be in cached mode.
Meant to be used for sorted iterators.
setItem
in interface DTMIterator
node
- Node to setindex
- Index of where to set the nodepublic int getLength()
length-1
inclusive.getLength
in interface DTMIterator
public boolean isFresh()
isFresh
in interface DTMIterator
public int previousNode()
previousNode
in interface DTMIterator
Node
in the set being iterated over,
ornull
if there are no more members in that set.public int getWhatToShow()
NodeFilter
interface.
This is somewhat useless at this time, since it doesn't really return information that tells what this iterator will show. It is here only to fullfill the DOM NodeIterator interface.
getWhatToShow
in interface DTMIterator
getWhatToShow
in class NodeTest
NodeIterator
public DTMFilter getFilter()
NodeIterator
public int getRoot()
getRoot
in interface DTMIterator
public boolean getExpandEntityReferences()
getExpandEntityReferences
in interface DTMIterator
public void allowDetachToRelease(boolean allowRelease)
allowDetachToRelease
in interface DTMIterator
allowRelease
- true if it is OK for detach to release this iterator
for pooling.public void detach()
detach
has been invoked, calls to
nextNode
orpreviousNode
will raise the
exception INVALID_STATE_ERR.detach
in interface DTMIterator
public void reset()
reset
in interface DTMIterator
public DTMIterator cloneWithReset() throws CloneNotSupportedException
cloneWithReset
in interface DTMIterator
CloneNotSupportedException
public abstract int nextNode()
nextNode
in interface DTMIterator
Node
in the set being iterated over, or
null
if there are no more members in that set.protected int returnNextNode(int nextNode)
nextNode
- The next node found, may be null.public int getCurrentNode()
getCurrentNode
in interface DTMIterator
public void runTo(int index)
runTo
in interface DTMIterator
index
- The index to run to, or -1 if the iterator
should run to the end.public final boolean getFoundLast()
public final XPathContext getXPathContext()
public final int getContext()
public final int getCurrentContextNode()
public final void setCurrentContextNode(int n)
n
- Must be a non-null reference to the node context.public final PrefixResolver getPrefixResolver()
public void callVisitors(ExpressionOwner owner, XPathVisitor visitor)
XPathVisitable
callVisitors
in interface XPathVisitable
callVisitors
in class NodeTest
owner
- The owner of the visitor, where that path may be
rewritten if needed.visitor
- The visitor whose appropriate method will be called.XPathVisitable.callVisitors(ExpressionOwner, XPathVisitor)
public boolean isDocOrdered()
isDocOrdered
in interface DTMIterator
public int getAxis()
getAxis
in interface DTMIterator
public int getLastPos(XPathContext xctxt)
PredicatedNodeTest
getLastPos
in interface SubContextList
getLastPos
in class PredicatedNodeTest
xctxt
- XPath runtime context.PredicatedNodeTest.getLastPos(XPathContext)
Copyright © 2017 JBoss by Red Hat. All rights reserved.