Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.apache.commons.jxpath.ri.axes
Class RootContext  view RootContext download RootContext.java

java.lang.Object
  extended byorg.apache.commons.jxpath.ri.EvalContext
      extended byorg.apache.commons.jxpath.ri.axes.RootContext
All Implemented Interfaces:
org.apache.commons.jxpath.ExpressionContext, java.util.Iterator

public class RootContext
extends org.apache.commons.jxpath.ri.EvalContext

EvalContext that is used to hold the root node for the path traversal.

Version:
$Revision: 1.18 $ $Date: 2004/04/01 02:55:31 $

Field Summary
private  int availableRegister
           
private  org.apache.commons.jxpath.ri.JXPathContextReferenceImpl jxpathContext
           
private static int MAX_REGISTER
           
private  org.apache.commons.jxpath.ri.NamespaceResolver namespaceResolver
           
private  org.apache.commons.jxpath.ri.model.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
RootContext(org.apache.commons.jxpath.ri.JXPathContextReferenceImpl jxpathContext, org.apache.commons.jxpath.ri.model.NodePointer pointer)
           
 
Method Summary
 org.apache.commons.jxpath.ri.EvalContext getAbsoluteRootContext()
           
 org.apache.commons.jxpath.ri.EvalContext getConstantContext(java.lang.Object constant)
           
 org.apache.commons.jxpath.ri.model.NodePointer getCurrentNodePointer()
          Returns the current context node.
 int getCurrentPosition()
           
 org.apache.commons.jxpath.Function getFunction(org.apache.commons.jxpath.ri.QName functionName, java.lang.Object[] parameters)
           
 org.apache.commons.jxpath.JXPathContext getJXPathContext()
          Get the JXPathContext in which this function is being evaluated.
 java.lang.Object getRegisteredValue(int id)
           
 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.
 org.apache.commons.jxpath.ri.EvalContext getVariableContext(org.apache.commons.jxpath.ri.QName variableName)
           
 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)
           
 java.lang.String toString()
          Convert this Object to a human-readable String.
 
Methods inherited from class org.apache.commons.jxpath.ri.EvalContext
getContextNodeList, getContextNodePointer, getDocumentOrder, getNodeSet, getPosition, getSingleNodePointer, hasNext, isChildOrderingRequired, next, remove, reset
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

jxpathContext

private org.apache.commons.jxpath.ri.JXPathContextReferenceImpl jxpathContext

pointer

private org.apache.commons.jxpath.ri.model.NodePointer pointer

registers

private java.lang.Object[] registers

availableRegister

private int availableRegister

namespaceResolver

private org.apache.commons.jxpath.ri.NamespaceResolver namespaceResolver

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(org.apache.commons.jxpath.ri.JXPathContextReferenceImpl jxpathContext,
                   org.apache.commons.jxpath.ri.model.NodePointer pointer)
Method Detail

getJXPathContext

public org.apache.commons.jxpath.JXPathContext getJXPathContext()
Description copied from interface: org.apache.commons.jxpath.ExpressionContext
Get the JXPathContext in which this function is being evaluated.


getRootContext

public RootContext getRootContext()
Description copied from class: org.apache.commons.jxpath.ri.EvalContext
Returns the root context of the path, which provides easy access to variables and functions.


getAbsoluteRootContext

public org.apache.commons.jxpath.ri.EvalContext getAbsoluteRootContext()

getCurrentNodePointer

public org.apache.commons.jxpath.ri.model.NodePointer getCurrentNodePointer()
Description copied from class: org.apache.commons.jxpath.ri.EvalContext
Returns the current context node. Undefined before the beginning of the iteration.


getValue

public java.lang.Object getValue()
Description copied from class: org.apache.commons.jxpath.ri.EvalContext
Typically returns the NodeSet by calling getNodeSet(), but will be overridden for contexts that more naturally produce individual values, e.g. VariableContext


getCurrentPosition

public int getCurrentPosition()

nextNode

public boolean nextNode()
Description copied from class: org.apache.commons.jxpath.ri.EvalContext
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()
Description copied from class: org.apache.commons.jxpath.ri.EvalContext
Returns true if there is another sets of objects to interate over. Resets the current position and node.


setPosition

public boolean setPosition(int position)
Description copied from class: org.apache.commons.jxpath.ri.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.


getConstantContext

public org.apache.commons.jxpath.ri.EvalContext getConstantContext(java.lang.Object constant)

getVariableContext

public org.apache.commons.jxpath.ri.EvalContext getVariableContext(org.apache.commons.jxpath.ri.QName variableName)

getFunction

public org.apache.commons.jxpath.Function getFunction(org.apache.commons.jxpath.ri.QName functionName,
                                                      java.lang.Object[] parameters)

getRegisteredValue

public java.lang.Object getRegisteredValue(int id)

setRegisteredValue

public int setRegisteredValue(java.lang.Object value)

toString

public java.lang.String toString()
Description copied from class: java.lang.Object
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).