| java.lang.Object
 org.apache.commons.jxpath.ri.EvalContext
All known Subclasses: org.apache.commons.jxpath.ri.axes.ChildContext, org.apache.commons.jxpath.ri.axes.SelfContext, org.apache.commons.jxpath.ri.axes.PrecedingOrFollowingContext, org.apache.commons.jxpath.ri.axes.NamespaceContext, org.apache.commons.jxpath.ri.axes.PredicateContext, org.apache.commons.jxpath.ri.axes.InitialContext, org.apache.commons.jxpath.ri.axes.AttributeContext, org.apache.commons.jxpath.ri.axes.NodeSetContext, org.apache.commons.jxpath.ri.axes.AncestorContext, org.apache.commons.jxpath.ri.axes.DescendantContext, org.apache.commons.jxpath.ri.axes.RootContext, org.apache.commons.jxpath.ri.axes.ParentContext,
| EvalContext | | abstract public class EvalContext implements ExpressionContext,Iterator(Code) | | An XPath evaluation context.
When evaluating a path, a chain of EvalContexts is created, each context in
the chain representing a step of the path. Subclasses of EvalContext
implement behavior of various XPath axes: "child::", "parent::" etc.
author:
Dmitri Plotnikov
version:
$Revision: 1.30 $ $Date: 2004/03/25 05:42:01 $ |
| Method Summary | |
| public List | getContextNodeList()
Returns the list of all Pointers in this context for the current
position of the parent context. | | public Pointer | getContextNodePointer()
| | abstract public NodePointer | getCurrentNodePointer()
Returns the current context node. | | public int | getCurrentPosition()
| | public int | getDocumentOrder()
Determines the document order for this context. | | public JXPathContext | getJXPathContext()
| | public NodeSet | getNodeSet()
Returns the list of all Pointers in this context for all positions
of the parent contexts. | | public int | getPosition()
| | public RootContext | getRootContext()
Returns the root context of the path, which provides easy
access to variables and functions. | | public Pointer | getSingleNodePointer()
Returns the first encountered Pointer that matches the current
context's criteria. | | public Object | getValue()
Typically returns the NodeSet by calling getNodeSet(),
but will be overridden for contexts that more naturally produce
individual values, e.g. | | public boolean | hasNext()
Returns true if there are mode nodes matching the context's constraints. | | public boolean | isChildOrderingRequired()
Even if this context has the natural ordering and therefore does
not require collecting and sorting all nodes prior to returning them,
such operation may be required for any child context. | | public Object | next()
| | abstract public boolean | nextNode()
Returns true if there is another object in the current set. | | public boolean | nextSet()
Returns true if there is another sets of objects to interate over. | | public void | remove()
| | public void | reset()
Sets current position = 0, which is the pre-iteration state. | | public boolean | setPosition(int position)
Moves the current position to the specified index. | | public String | toString()
|
| position | | protected int position(Code) | | |
| getContextNodeList | | public List getContextNodeList()(Code) | | Returns the list of all Pointers in this context for the current
position of the parent context.
|
| getContextNodePointer | | public Pointer getContextNodePointer()(Code) | | |
| getCurrentNodePointer | | abstract public NodePointer getCurrentNodePointer()(Code) | | Returns the current context node. Undefined before the beginning
of the iteration.
|
| getCurrentPosition | | public int getCurrentPosition()(Code) | | |
| getDocumentOrder | | public int getDocumentOrder()(Code) | | Determines the document order for this context.
1 ascending order, -1 descending order,0 - does not require ordering |
| getNodeSet | | public NodeSet getNodeSet()(Code) | | Returns the list of all Pointers in this context for all positions
of the parent contexts. If there was an ongoing iteration over
this context, the method should not be called.
|
| getPosition | | public int getPosition()(Code) | | |
| getRootContext | | public RootContext getRootContext()(Code) | | Returns the root context of the path, which provides easy
access to variables and functions.
|
| getSingleNodePointer | | public Pointer getSingleNodePointer()(Code) | | Returns the first encountered Pointer that matches the current
context's criteria.
|
| getValue | | public Object getValue()(Code) | | Typically returns the NodeSet by calling getNodeSet(),
but will be overridden for contexts that more naturally produce
individual values, e.g. VariableContext
|
| hasNext | | public boolean hasNext()(Code) | | Returns true if there are mode nodes matching the context's constraints.
|
| isChildOrderingRequired | | public boolean isChildOrderingRequired()(Code) | | Even if this context has the natural ordering and therefore does
not require collecting and sorting all nodes prior to returning them,
such operation may be required for any child context.
|
| next | | public Object next()(Code) | | Returns the next node pointer in the context
|
| nextNode | | abstract public boolean nextNode()(Code) | | Returns true if there is another object in the current set.
Switches the current position and node to the next object.
|
| nextSet | | public boolean nextSet()(Code) | | Returns true if there is another sets of objects to interate over.
Resets the current position and node.
|
| remove | | public void remove()(Code) | | Operation is not supported
|
| reset | | public void reset()(Code) | | Sets current position = 0, which is the pre-iteration state.
|
| setPosition | | public boolean setPosition(int position)(Code) | | 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.
|
|
|