org.apache.xpath.axes
Interface ContextNodeList
- NodeSet
public interface ContextNodeList
Classes who implement this interface can be a
current node list,
also refered to here as a
context node list.
Object | clone() - Get a clone of this iterator.
|
NodeIterator | cloneWithReset() - Get a cloned Iterator that is reset to the start of the iteration.
|
Node | getCurrentNode() - Get the current 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.
|
int | getLast() - Get the index of the last node in this list.
|
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.
|
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 | setCurrentPos(int i) - Set the current position in the node set.
|
void | setLast(int last) - Set the index of the last node in this list.
|
void | setShouldCacheNodes(boolean b) - If setShouldCacheNodes(true) is called, then nodes will
be cached.
|
int | size() - Get the length of the list.
|
clone
public Object clone()
throws CloneNotSupportedException
Get a clone of this iterator. Be aware that this operation may be
somewhat expensive.
cloneWithReset
public NodeIterator cloneWithReset()
throws CloneNotSupportedException
Get a cloned Iterator that is reset to the start of the iteration.
- A clone of this iteration that has been reset.
getCurrentNode
public Node getCurrentNode()
- The current node, or null.
getCurrentPos
public 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.
getLast
public int getLast()
Get the index of the last node in this list.
- the index of the last node in this list.
isFresh
public 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.
- true if the iteration of this list has not yet begun.
reset
public void reset()
Reset the iterator.
runTo
public void runTo(int index)
If an index is requested, NodeSetDTM will call this method
to run the iterator to the index. By default this sets
m_next to the index. If the index argument is -1, this
signals that the iterator should be run to the end.
index
- The index to run to, or -1 if the iterator should be run
to the end.
setCurrentPos
public void setCurrentPos(int i)
Set the current position in the node set.
i
- Must be a valid index.
setLast
public void setLast(int last)
Set the index of the last node in this list.
last
- the index of the last node in this list.
setShouldCacheNodes
public void setShouldCacheNodes(boolean b)
If setShouldCacheNodes(true) is called, then nodes will
be cached. They are not cached by default.
b
- true if the nodes should be cached.
size
public int size()
Get the length of the list.
- The number of nodes in this node list.
Copyright B) 2005 Apache XML Project. All Rights Reserved.