org.apache.xpath.axes
public abstract class LocPathIterator extends PredicatedNodeTest implements Cloneable, DTMIterator, Serializable, PathComponent
UNKNOWN: advanced
Field Summary | |
---|---|
int | m_lastFetched The last node that was fetched, usually by nextNode. |
Method Summary | |
---|---|
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) |
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. i.e. if
you call getCurrentPos() and the return is 0, the next
fetch will take place at index 1.
|
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) |
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(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, 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.
|
Parameters: allowRelease true if it is OK for detach to release this iterator for pooling.
Parameters: xctxt The execution context. contextNode The node that "." expresses.
Throws: TransformerException thrown if the active ProblemListener decides the error condition is severe enough to halt processing. javax.xml.transform.TransformerException
UNKNOWN: experimental
Parameters: xctxt The XPath runtime context.
Returns: the first node out of the nodeset, or DTM.NULL.
Parameters: xctxt The runtime execution context.
Returns: The result of the operation as a boolean.
Throws: javax.xml.transform.TransformerException
See Also: XPathVisitable
Returns: A cloned NodeIterator set of the start of the query.
Throws: CloneNotSupportedException
detach
has been invoked, calls to
nextNode
orpreviousNode
will raise the
exception INVALID_STATE_ERR.Parameters: xctxt The XPath execution context.
Returns: An XNodeSet reference that holds this iterator.
Throws: javax.xml.transform.TransformerException
Parameters: xctxt The XPath runtime context. handler The target content handler.
Returns: The result of the expression in the form of a XObject
.
Throws: javax.xml.transform.TransformerException if a runtime exception occurs. org.xml.sax.SAXException
Returns: One of WalkerFactory#BIT_DESCENDANT, etc.
Returns: Axis.CHILD, etc., or -1 if the axis is not known or is of multiple types.
Returns: The node context, same as getRoot().
Returns: The top-level node context of the entire expression.
Returns: The last fetched node, or null if the last fetch was null.
Returns: A value greater than or equal to zero that indicates the next node position to fetch.
Parameters: nodeHandle the nodeHandle.
Returns: a non-null DTM reference.
Returns: a non-null DTMManager reference.
Returns: Always true, since entity reference nodes are not visible in the XPath model.
Returns: Always null.
See Also: org.w3c.dom.traversal.NodeIterator
Returns: true if the last nextNode returned null.
Returns: true if this location path is at the top level of the expression.
UNKNOWN: advanced
See Also: getLastPos
length-1
inclusive.
Returns: The number of nodes in the list, always greater or equal to zero.
Returns: The prefix resolver or this iterator, which may be null.
Returns: The "root" of this iterator, which, in XPath terms, is the node context for this iterator.
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.
Returns: For now, always NodeFilter.SHOW_ALL & ~NodeFilter.SHOW_ENTITY_REFERENCE.
See Also: org.w3c.dom.traversal.NodeIterator
Returns: XPath execution context this iterator is operating on, or null if setRoot has not been called.
Returns: true as a default.
Returns: true of nextNode has not been called.
setItem(int node, int index)
method.
Returns: True if the nodelist can be mutated.
Returns: true if the expression can be represented as a nodeset.
index
th item in the collection. If
index
is greater than or equal to the number of nodes in
the list, this returns null
.Parameters: index Index into the collection.
Returns: The node at the index
th position in the
NodeList
, or null
if that is not a valid
index.
Returns: The next Node
in the set being iterated over, or
null
if there are no more members in that set.
Returns: The previous Node
in the set being iterated over,
ornull
if there are no more members in that set.
Parameters: index The index to run to, or -1 if the iterator should run to the end.
Parameters: n Must be a non-null reference to the node context.
Parameters: i Must be a valid index greater than or equal to zero and less than m_cachedNodes.size().
At this time the exact implementation of this environment is application dependent. Probably a proper interface will be created fairly soon.
Parameters: environment The environment object.
Parameters: b true if this location path is at the top level of the expression.
UNKNOWN: advanced
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.
Parameters: node Node to set index Index of where to set the node
Parameters: context The XPath runtime context for this transformation.
Parameters: b True if this iterator should cache nodes.
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.
Returns: The size of the current cache list.