public abstract class LocPathIterator extends PredicatedNodeTest implements java.lang.Cloneable, DTMIterator, java.io.Serializable, PathComponent
| Modifier and Type | Field and Description |
|---|---|
int |
m_lastFetched
The last node that was fetched, usually by nextNode.
|
SCORE_NODETEST, SCORE_NONE, SCORE_NSWILD, SCORE_OTHER, SCORE_QNAME, SHOW_BYFUNCTION, SUPPORTS_PRE_STRIPPING, WILDFILTER_ACCEPT, FILTER_REJECT, FILTER_SKIP| 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. for current() support).
|
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.
|
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(java.lang.Object environment)
Set 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.
|
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.
|
void |
setRoot(int context,
java.lang.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, deepEquals, fixupVariables, getLocPathIterator, getPredicate, getPredicateCount, getPredicateIndex, getProximityPosition, getProximityPosition, initProximityPosition, isReverseAxes, resetProximityPositions, setLocPathIterator, setPredicateCountdebugWhatToShow, execute, execute, getDefaultScore, getLocalName, getNamespace, getNodeTypeTest, getStaticScore, initNodeTest, initNodeTest, setLocalName, setNamespace, setStaticScore, setWhatToShowasIteratorRaw, assertion, error, execute, exprAddChild, exprGetChild, exprGetNumChildren, exprGetParent, exprSetParent, getColumnNumber, getExpressionOwner, getLineNumber, getPublicId, getSystemId, isStableNumber, num, warn, xstrequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitclonepublic transient int m_lastFetched
public int getAnalysisBits()
getAnalysisBits in interface PathComponentpublic void setEnvironment(java.lang.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 DTMIteratornodeHandle - the nodeHandle.public DTMManager getDTMManager()
getDTMManager in interface DTMIteratorpublic XObject execute(XPathContext xctxt) throws TransformerException
execute in class NodeTestxctxt - The XPath execution context.TransformerExceptionpublic void executeCharsToContentHandler(XPathContext xctxt, ContentHandler handler) throws TransformerException, SAXException
executeCharsToContentHandler in class Expressionxctxt - The XPath runtime context.handler - The target content handler.TransformerException - if a runtime exception
occurs.SAXExceptionpublic DTMIterator asIterator(XPathContext xctxt, int contextNode) throws TransformerException
asIterator in class Expressionxctxt - The execution context.contextNode - The node that "." expresses.TransformerException - thrown if the active ProblemListener decides
the error condition is severe enough to halt processing.TransformerExceptionpublic boolean isNodesetExpr()
isNodesetExpr in class Expressionpublic int asNode(XPathContext xctxt) throws TransformerException
asNode in class Expressionxctxt - The XPath runtime context.TransformerExceptionpublic boolean bool(XPathContext xctxt) throws TransformerException
bool in class Expressionxctxt - The runtime execution context.TransformerExceptionpublic 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,
java.lang.Object environment)
setRoot in interface DTMIteratorcontext - 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.
public final int getCurrentPos()
getCurrentPos in interface DTMIteratorpublic void setShouldCacheNodes(boolean b)
setShouldCacheNodes in interface DTMIteratorb - True if this iterator should cache nodes.public boolean isMutable()
setItem(int node, int index) method.isMutable in interface DTMIteratorpublic void setCurrentPos(int i)
setCurrentPos in interface DTMIteratori - 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 DTMIteratorindex - 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 DTMIteratornode - Node to setindex - Index of where to set the nodepublic int getLength()
length-1 inclusive.getLength in interface DTMIteratorpublic boolean isFresh()
isFresh in interface DTMIteratorpublic int previousNode()
previousNode in interface DTMIteratorNode 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 DTMIteratorgetWhatToShow in class NodeTestNodeIteratorpublic DTMFilter getFilter()
NodeIteratorpublic int getRoot()
getRoot in interface DTMIteratorpublic boolean getExpandEntityReferences()
getExpandEntityReferences in interface DTMIteratorpublic void allowDetachToRelease(boolean allowRelease)
allowDetachToRelease in interface DTMIteratorallowRelease - 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 DTMIteratorpublic void reset()
reset in interface DTMIteratorpublic DTMIterator cloneWithReset() throws java.lang.CloneNotSupportedException
cloneWithReset in interface DTMIteratorjava.lang.CloneNotSupportedExceptionpublic abstract int nextNode()
nextNode in interface DTMIteratorNode in the set being iterated over, or
null if there are no more members in that set.public int getCurrentNode()
getCurrentNode in interface DTMIteratorpublic void runTo(int index)
runTo in interface DTMIteratorindex - 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)
XPathVisitablecallVisitors in interface XPathVisitablecallVisitors in class NodeTestowner - 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 DTMIteratorpublic int getAxis()
getAxis in interface DTMIteratorpublic int getLastPos(XPathContext xctxt)
PredicatedNodeTestgetLastPos in interface SubContextListgetLastPos in class PredicatedNodeTestxctxt - XPath runtime context.PredicatedNodeTest.getLastPos(XPathContext)Copyright © 2014 Apache XML Project. All Rights Reserved.