Class RootContext
- java.lang.Object
-
- org.apache.commons.jxpath.ri.EvalContext
-
- org.apache.commons.jxpath.ri.axes.RootContext
-
- All Implemented Interfaces:
java.util.Iterator
,ExpressionContext
public class RootContext extends EvalContext
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) $
- Author:
- Dmitri Plotnikov
-
-
Field Summary
Fields Modifier and Type Field Description private int
availableRegister
private JXPathContextReferenceImpl
jxpathContext
private static int
MAX_REGISTER
private NodePointer
pointer
private java.lang.Object[]
registers
static java.lang.Object
UNKNOWN_VALUE
-
Fields inherited from class org.apache.commons.jxpath.ri.EvalContext
parentContext, position, rootContext
-
-
Constructor Summary
Constructors Constructor Description RootContext(JXPathContextReferenceImpl jxpathContext, NodePointer pointer)
Create a new RootContext.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EvalContext
getAbsoluteRootContext()
Get absolute root contextEvalContext
getConstantContext(java.lang.Object constant)
Get a context that points to the specified object.NodePointer
getCurrentNodePointer()
Returns the current context node.int
getCurrentPosition()
Get the current position.Function
getFunction(QName functionName, java.lang.Object[] parameters)
Get the specified function from the context.JXPathContext
getJXPathContext()
Get the JXPathContext in which this function is being evaluated.java.lang.Object
getRegisteredValue(int id)
Get a registered value.RootContext
getRootContext()
Returns the root context of the path, which provides easy access to variables and functions.java.lang.Object
getValue()
Typically returns the NodeSet by calling getNodeSet(), but will be overridden for contexts that more naturally produce individual values, e.g.EvalContext
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(java.lang.Object value)
Set the next registered value.java.lang.String
toString()
-
Methods inherited from class org.apache.commons.jxpath.ri.EvalContext
getContextNodeList, getContextNodePointer, getDocumentOrder, getNodeSet, getPosition, getSingleNodePointer, hasNext, isChildOrderingRequired, next, remove, reset, sortPointers
-
-
-
-
Field Detail
-
jxpathContext
private JXPathContextReferenceImpl jxpathContext
-
pointer
private NodePointer pointer
-
registers
private java.lang.Object[] registers
-
availableRegister
private int availableRegister
-
UNKNOWN_VALUE
public static final java.lang.Object UNKNOWN_VALUE
-
MAX_REGISTER
private static final int MAX_REGISTER
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
RootContext
public RootContext(JXPathContextReferenceImpl jxpathContext, NodePointer pointer)
Create a new RootContext.- Parameters:
jxpathContext
- contextpointer
- pointer
-
-
Method Detail
-
getJXPathContext
public JXPathContext 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
public RootContext 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
public EvalContext getAbsoluteRootContext()
Get absolute root context- Returns:
- EvalContext
-
getCurrentNodePointer
public NodePointer 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
public java.lang.Object 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
public EvalContext getConstantContext(java.lang.Object constant)
Get a context that points to the specified object.- Parameters:
constant
- object- Returns:
- EvalContext
-
getVariableContext
public EvalContext getVariableContext(QName variableName)
Get variable context.- Parameters:
variableName
- variable name- Returns:
- EvalContext
-
getFunction
public Function getFunction(QName functionName, java.lang.Object[] parameters)
Get the specified function from the context.- Parameters:
functionName
- QNameparameters
- Object[]- Returns:
- Function
-
getRegisteredValue
public java.lang.Object getRegisteredValue(int id)
Get a registered value.- Parameters:
id
- int- Returns:
- Object
-
setRegisteredValue
public int setRegisteredValue(java.lang.Object value)
Set the next registered value.- Parameters:
value
- Object- Returns:
- the id that can reclaim value.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classEvalContext
-
-