FileDocCategorySizeDatePackage
ContextNodeList.javaAPI DocJava SE 5 API3752Fri Aug 26 14:56:06 BST 2005com.sun.org.apache.xpath.internal.axes

ContextNodeList

public interface ContextNodeList
Classes who implement this interface can be a current node list, also refered to here as a context node list.
xsl.usage
advanced

Fields Summary
Constructors Summary
Methods Summary
public java.lang.Objectclone()
Get a clone of this iterator. Be aware that this operation may be somewhat expensive.

return
A clone of this object.
throws
CloneNotSupportedException

public org.w3c.dom.traversal.NodeIteratorcloneWithReset()
Get a cloned Iterator that is reset to the start of the iteration.

return
A clone of this iteration that has been reset.
throws
CloneNotSupportedException

public org.w3c.dom.NodegetCurrentNode()
Get the current node.

return
The current node, or null.

public intgetCurrentPos()
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.

return
The position of the current node in the current node list.

public intgetLast()
Get the index of the last node in this list.

return
the index of the last node in this list.

public booleanisFresh()
Tells if this NodeSetDTM is "fresh", in other words, if the first nextNode() that is called will return the first node in the set.

return
true if the iteration of this list has not yet begun.

public voidreset()
Reset the iterator.

public voidrunTo(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.

param
index The index to run to, or -1 if the iterator should be run to the end.

public voidsetCurrentPos(int i)
Set the current position in the node set.

param
i Must be a valid index.

public voidsetLast(int last)
Set the index of the last node in this list.

param
last the index of the last node in this list.

public voidsetShouldCacheNodes(boolean b)
If setShouldCacheNodes(true) is called, then nodes will be cached. They are not cached by default.

param
b true if the nodes should be cached.

public intsize()
Get the length of the list.

return
The number of nodes in this node list.