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.
-
Field Summary
FieldsFields inherited from class org.apache.commons.jxpath.ri.EvalContext
parentContext, position, rootContext -
Constructor Summary
ConstructorsConstructorDescriptionRootContext(JXPathContextReferenceImpl jxpathContext, NodePointer pointer) Constructs a new RootContext. -
Method Summary
Modifier and TypeMethodDescriptionGets absolute root contextgetConstantContext(Object constant) Gets a context that points to the specified object.Returns the current context node.intGets the current position.getFunction(QName functionName, Object[] parameters) Gets the specified function from the context.Gets the JXPathContext in which this function is being evaluated.getRegisteredValue(int id) Gets 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) Gets variable context.booleannextNode()Returns true if there is another object in the current set.booleannextSet()Returns true if there is another sets of objects to interate over.booleansetPosition(int position) Moves the current position to the specified index.intsetRegisteredValue(Object value) Sets 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, sortPointersMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface java.util.Iterator
forEachRemaining
-
Field Details
-
UNKNOWN_VALUE
Unknown value marker.
-
-
Constructor Details
-
RootContext
Constructs a new RootContext.- Parameters:
jxpathContext- contextpointer- pointer
-
-
Method Details
-
getAbsoluteRootContext
Gets absolute root context- Returns:
- EvalContext
-
getConstantContext
Gets a context that points to the specified object.- Parameters:
constant- object- Returns:
- EvalContext
-
getCurrentNodePointer
Description copied from class:EvalContextReturns the current context node. Undefined before the beginning of the iteration.- Specified by:
getCurrentNodePointerin classEvalContext- Returns:
- NodePoiner
-
getCurrentPosition
Description copied from class:EvalContextGets the current position.- Overrides:
getCurrentPositionin classEvalContext- Returns:
- int position.
-
getFunction
Gets the specified function from the context.- Parameters:
functionName- QNameparameters- Object[]- Returns:
- Function
-
getJXPathContext
Description copied from interface:ExpressionContextGets the JXPathContext in which this function is being evaluated.- Specified by:
getJXPathContextin interfaceExpressionContext- Overrides:
getJXPathContextin classEvalContext- Returns:
- A list representing the current context nodes.
-
getRegisteredValue
Gets a registered value.- Parameters:
id- int- Returns:
- Object
-
getRootContext
Description copied from class:EvalContextReturns the root context of the path, which provides easy access to variables and functions.- Overrides:
getRootContextin classEvalContext- Returns:
- RootContext
-
getValue
Description copied from class:EvalContextTypically returns the NodeSet by calling getNodeSet(), but will be overridden for contexts that more naturally produce individual values, e.g. VariableContext- Overrides:
getValuein classEvalContext- Returns:
- Object
-
getVariableContext
Gets variable context.- Parameters:
variableName- variable name- Returns:
- EvalContext
-
nextNode
Description copied from class:EvalContextReturns true if there is another object in the current set. Switches the current position and node to the next object.- Specified by:
nextNodein classEvalContext- Returns:
- boolean
-
nextSet
Description copied from class:EvalContextReturns true if there is another sets of objects to interate over. Resets the current position and node.- Overrides:
nextSetin classEvalContext- Returns:
- boolean
-
setPosition
Description copied from class:EvalContextMoves 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:
setPositionin classEvalContext- Parameters:
position- to set- Returns:
- boolean
-
setRegisteredValue
Sets the next registered value.- Parameters:
value- Object- Returns:
- the id that can reclaim value.
-
toString
- Overrides:
toStringin classEvalContext
-