org.apache.commons.jxpath.ri.axes

Class InitialContext

Implemented Interfaces:
ExpressionContext, Iterator

public class InitialContext
extends EvalContext

A single-set EvalContext that provides access to the current node of the parent context and nothing else. It does not pass the iteration on to the parent context.
Version:
$Revision: 1.14 $ $Date: 2004/03/25 05:42:01 $
Author:
Dmitri Plotnikov

Field Summary

Fields inherited from class org.apache.commons.jxpath.ri.EvalContext

parentContext, position, rootContext

Constructor Summary

InitialContext(EvalContext parentContext)

Method Summary

NodePointer
getCurrentNodePointer()
Returns the current context node.
Pointer
getSingleNodePointer()
Returns the first encountered Pointer that matches the current context's criteria.
Object
getValue()
Typically returns the NodeSet by calling getNodeSet(), but will be overridden for contexts that more naturally produce individual values, e.g.
boolean
nextNode()
Returns true if there is another object in the current set.
boolean
nextSet()
Returns true if there is another sets of objects to interate over.
boolean
setPosition(int position)
Moves the current position to the specified index.

Methods inherited from class org.apache.commons.jxpath.ri.EvalContext

getContextNodeList, getContextNodePointer, getCurrentNodePointer, getCurrentPosition, getDocumentOrder, getJXPathContext, getNodeSet, getPosition, getRootContext, getSingleNodePointer, getValue, hasNext, isChildOrderingRequired, next, nextNode, nextSet, remove, reset, setPosition, toString

Constructor Details

InitialContext

public InitialContext(EvalContext parentContext)

Method Details

getCurrentNodePointer

public NodePointer getCurrentNodePointer()
Returns the current context node. Undefined before the beginning of the iteration.
Overrides:
getCurrentNodePointer in interface EvalContext

getSingleNodePointer

public Pointer getSingleNodePointer()
Returns the first encountered Pointer that matches the current context's criteria.
Overrides:
getSingleNodePointer in interface EvalContext

getValue

public Object getValue()
Typically returns the NodeSet by calling getNodeSet(), but will be overridden for contexts that more naturally produce individual values, e.g. VariableContext
Overrides:
getValue in interface EvalContext

nextNode

public boolean nextNode()
Returns true if there is another object in the current set. Switches the current position and node to the next object.
Overrides:
nextNode in interface EvalContext

nextSet

public boolean nextSet()
Returns true if there is another sets of objects to interate over. Resets the current position and node.
Overrides:
nextSet in interface EvalContext

setPosition

public boolean setPosition(int position)
Moves the current position to the specified index. Used with integer predicates to quickly get to the n'th element of the node set. Returns false if the position is out of the node set range. You can call it with 0 as the position argument to restart the iteration.
Overrides:
setPosition in interface EvalContext