Class RootContext
java.lang.Object
org.apache.commons.jxpath.ri.EvalContext
org.apache.commons.jxpath.ri.axes.RootContext
- All Implemented Interfaces:
Iterator
,ExpressionContext
EvalContext that is used to hold the root node for the path traversal.
- Version:
- $Revision: 652845 $ $Date: 2008-05-02 12:46:46 -0500 (Fri, 02 May 2008) $
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private JXPathContextReferenceImpl
private static final int
private NodePointer
private Object[]
static final Object
Fields inherited from class org.apache.commons.jxpath.ri.EvalContext
parentContext, position, rootContext
-
Constructor Summary
ConstructorsConstructorDescriptionRootContext
(JXPathContextReferenceImpl jxpathContext, NodePointer pointer) Create a new RootContext. -
Method Summary
Modifier and TypeMethodDescriptionGet absolute root contextgetConstantContext
(Object constant) Get a context that points to the specified object.Returns the current context node.int
Get the current position.getFunction
(QName functionName, Object[] parameters) Get the specified function from the context.Get the JXPathContext in which this function is being evaluated.getRegisteredValue
(int id) Get a registered value.Returns the root context of the path, which provides easy access to variables and functions.getValue()
Typically returns the NodeSet by calling getNodeSet(), but will be overridden for contexts that more naturally produce individual values, e.g.getVariableContext
(QName variableName) Get variable context.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.int
setRegisteredValue
(Object value) Set the next registered value.toString()
Methods inherited from class org.apache.commons.jxpath.ri.EvalContext
getContextNodeList, getContextNodePointer, getDocumentOrder, getNodeSet, getPosition, getSingleNodePointer, hasNext, isChildOrderingRequired, next, remove, reset, sortPointers
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Iterator
forEachRemaining
-
Field Details
-
jxpathContext
-
pointer
-
registers
-
availableRegister
private int availableRegister -
UNKNOWN_VALUE
-
MAX_REGISTER
private static final int MAX_REGISTER- See Also:
-
-
Constructor Details
-
RootContext
Create a new RootContext.- Parameters:
jxpathContext
- contextpointer
- pointer
-
-
Method Details
-
getJXPathContext
Description copied from interface:ExpressionContext
Get the JXPathContext in which this function is being evaluated.- Specified by:
getJXPathContext
in interfaceExpressionContext
- Overrides:
getJXPathContext
in classEvalContext
- Returns:
- A list representing the current context nodes.
-
getRootContext
Description copied from class:EvalContext
Returns the root context of the path, which provides easy access to variables and functions.- Overrides:
getRootContext
in classEvalContext
- Returns:
- RootContext
-
getAbsoluteRootContext
Get absolute root context- Returns:
- EvalContext
-
getCurrentNodePointer
Description copied from class:EvalContext
Returns the current context node. Undefined before the beginning of the iteration.- Specified by:
getCurrentNodePointer
in classEvalContext
- Returns:
- NodePoiner
-
getValue
Description copied from class:EvalContext
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 classEvalContext
- Returns:
- Object
-
getCurrentPosition
public int getCurrentPosition()Description copied from class:EvalContext
Get the current position.- Overrides:
getCurrentPosition
in classEvalContext
- Returns:
- int position.
-
nextNode
public boolean nextNode()Description copied from class:EvalContext
Returns true if there is another object in the current set. Switches the current position and node to the next object.- Specified by:
nextNode
in classEvalContext
- Returns:
- boolean
-
nextSet
public boolean nextSet()Description copied from class:EvalContext
Returns true if there is another sets of objects to interate over. Resets the current position and node.- Overrides:
nextSet
in classEvalContext
- Returns:
- boolean
-
setPosition
public boolean setPosition(int position) Description copied from class:EvalContext
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 classEvalContext
- Parameters:
position
- to set- Returns:
- boolean
-
getConstantContext
Get a context that points to the specified object.- Parameters:
constant
- object- Returns:
- EvalContext
-
getVariableContext
Get variable context.- Parameters:
variableName
- variable name- Returns:
- EvalContext
-
getFunction
Get the specified function from the context.- Parameters:
functionName
- QNameparameters
- Object[]- Returns:
- Function
-
getRegisteredValue
Get a registered value.- Parameters:
id
- int- Returns:
- Object
-
setRegisteredValue
Set the next registered value.- Parameters:
value
- Object- Returns:
- the id that can reclaim value.
-
toString
- Overrides:
toString
in classEvalContext
-