Class JXPathCompiledExpression

java.lang.Object
org.apache.commons.jxpath.ri.JXPathCompiledExpression
All Implemented Interfaces:
CompiledExpression
public class JXPathCompiledExpression extends Object implements CompiledExpression
RI of CompiledExpression.
Version:
$Revision: 652845 $ $Date: 2008-05-02 12:46:46 -0500 (Fri, 02 May 2008) $
Author:
Dmitri Plotnikov

  • Field Details

  • Constructor Details

    • JXPathCompiledExpression

      public JXPathCompiledExpression(String xpath, Expression expression)
      Create a new JXPathCompiledExpression.
      Parameters:
      xpath - source
      expression - compiled

  • Method Details

    • getXPath

      protected String getXPath()
      Get the source expression.
      Returns:
      String

    • getExpression

      protected Expression getExpression()
      Get the compiled expression.
      Returns:
      Expression

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getValue

      public Object getValue(JXPathContext context)
      Description copied from interface: CompiledExpression
      Evaluates the xpath and returns the resulting object. Primitive types are wrapped into objects.
      Specified by:
      getValue in interface CompiledExpression
      Parameters:
      context - to evaluate
      Returns:
      Object

    • getValue

      public Object getValue(JXPathContext context, Class requiredType)
      Description copied from interface: CompiledExpression
      Evaluates the xpath, converts the result to the specified class and returns the resulting object.
      Specified by:
      getValue in interface CompiledExpression
      Parameters:
      context - to evaluate
      requiredType - return type
      Returns:
      Object

    • setValue

      public void setValue(JXPathContext context, Object value)
      Description copied from interface: CompiledExpression
      Modifies the value of the property described by the supplied xpath. Will throw an exception if one of the following conditions occurs:
      • The xpath does not in fact describe an existing property
      • The property is not writable (no public, non-static set method)
      Specified by:
      setValue in interface CompiledExpression
      Parameters:
      context - base
      value - to set

    • createPath

      public Pointer createPath(JXPathContext context)
      Description copied from interface: CompiledExpression
      Creates intermediate elements of the path by invoking an AbstractFactory, which should first be installed on the context by calling JXPathContext.setFactory(AbstractFactory).
      Specified by:
      createPath in interface CompiledExpression
      Parameters:
      context - base
      Returns:
      Pointer created

    • createPathAndSetValue

      public Pointer createPathAndSetValue(JXPathContext context, Object value)
      Description copied from interface: CompiledExpression
      The same as setValue, except it creates intermediate elements of the path by invoking an AbstractFactory, which should first be installed on the context by calling JXPathContext.setFactory(AbstractFactory).

      Will throw an exception if one of the following conditions occurs:

      • Elements of the xpath aleady exist, by the path does not in fact describe an existing property
      • The AbstractFactory fails to create an instance for an intermediate element.
      • The property is not writable (no public, non-static set method)
      Specified by:
      createPathAndSetValue in interface CompiledExpression
      Parameters:
      context - base
      value - to set
      Returns:
      Pointer created

    • iterate

      public Iterator iterate(JXPathContext context)
      Description copied from interface: CompiledExpression
      Traverses the xpath and returns a Iterator of all results found for the path. If the xpath matches no properties in the graph, the Iterator will not be null.
      Specified by:
      iterate in interface CompiledExpression
      Parameters:
      context - base
      Returns:
      Iterator

    • getPointer

      public Pointer getPointer(JXPathContext context, String xpath)
      Description copied from interface: CompiledExpression
      Traverses the xpath and returns a Pointer. A Pointer provides easy access to a property. If the xpath matches no properties in the graph, the pointer will be null.
      Specified by:
      getPointer in interface CompiledExpression
      Parameters:
      context - base
      xpath - string
      Returns:
      Pointer found

    • iteratePointers

      public Iterator iteratePointers(JXPathContext context)
      Description copied from interface: CompiledExpression
      Traverses the xpath and returns an Iterator of Pointers. A Pointer provides easy access to a property. If the xpath matches no properties in the graph, the Iterator be empty, but not null.
      Specified by:
      iteratePointers in interface CompiledExpression
      Parameters:
      context - to iterate
      Returns:
      Iterator

    • removePath

      public void removePath(JXPathContext context)
      Description copied from interface: CompiledExpression
      Remove the graph element described by this expression.
      Specified by:
      removePath in interface CompiledExpression
      Parameters:
      context - base

    • removeAll

      public void removeAll(JXPathContext context)
      Description copied from interface: CompiledExpression
      Remove all graph elements described by this expression.
      Specified by:
      removeAll in interface CompiledExpression
      Parameters:
      context - base