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

    Version:
    $Revision: 652845 $ $Date: 2008-05-02 12:46:46 -0500 (Fri, 02 May 2008) $
    • Method Detail

      • getValue

        java.lang.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

        java.lang.Object getValue​(JXPathContext context,
                                  java.lang.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
      • setValue

        void setValue​(JXPathContext context,
                      java.lang.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
      • createPathAndSetValue

        Pointer createPathAndSetValue​(JXPathContext context,
                                      java.lang.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
      • iterate

        java.util.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
      • getPointer

        Pointer getPointer​(JXPathContext context,
                           java.lang.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
      • iteratePointers

        java.util.Iterator 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
      • removePath

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

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