Package org.apache.commons.jxpath

Interface CompiledExpression

All Known Implementing Classes:
JXPathCompiledExpression
public interface CompiledExpression
Represents a compiled XPath. The interpretation of compiled XPaths may be faster, because it bypasses the compilation step. The reference implementation of JXPathContext also globally caches some of the results of compilation, so the direct use of JXPathContext is not always less efficient than the use of CompiledExpression.

Use CompiledExpression only when there is a need to evaluate the same expression multiple times and the CompiledExpression can be conveniently cached.

To acquire a CompiledExpression, call JXPathContext.compile

  • Method Details

    • createPath

      Pointer createPath(JXPathContext context)
      Creates intermediate elements of the path by invoking an AbstractFactory, which should first be installed on the context by calling JXPathContext.setFactory(org.apache.commons.jxpath.AbstractFactory).
      Parameters:
      context - base
      Returns:
      Pointer created

    • createPathAndSetValue

      Pointer createPathAndSetValue(JXPathContext context, Object value)
      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(org.apache.commons.jxpath.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)
      Parameters:
      context - base
      value - to set
      Returns:
      Pointer created

    • getPointer

      Pointer getPointer(JXPathContext context, String xpath)
      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.
      Parameters:
      context - base
      xpath - string
      Returns:
      Pointer found

    • getValue

      Object getValue(JXPathContext context)
      Evaluates the XPath and returns the resulting object. Primitive types are wrapped into objects.
      Parameters:
      context - to evaluate
      Returns:
      Object

    • getValue

      Object getValue(JXPathContext context, Class requiredType)
      Evaluates the xpath, converts the result to the specified class and returns the resulting object.
      Parameters:
      context - to evaluate
      requiredType - return type
      Returns:
      Object

    • iterate

      Iterator iterate(JXPathContext context)
      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.
      Parameters:
      context - base
      Returns:
      Iterator

    • iteratePointers

      Iterator<Pointer> iteratePointers(JXPathContext context)
      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.
      Parameters:
      context - to iterate
      Returns:
      Iterator

    • removeAll

      void removeAll(JXPathContext context)
      Remove all graph elements described by this expression.
      Parameters:
      context - base

    • removePath

      void removePath(JXPathContext context)
      Remove the graph element described by this expression.
      Parameters:
      context - base

    • setValue

      void setValue(JXPathContext context, Object value)
      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)
      Parameters:
      context - base
      value - to set