Compiler (Commons JXPath 1.3 API)

All Known Implementing Classes:: TreeCompiler

public interface Compiler

The Compiler APIs are completely agnostic to the actual types of objects produced and consumed by the APIs. Arguments and return values are declared as java.lang.Object.

Since objects returned by Compiler methods are passed as arguments to other Compiler methods, the descriptions of these methods use virtual types. There are four virtual object types: EXPRESSION, QNAME, STEP and NODE_TEST.

The following example illustrates this notion. This sequence compiles the xpath "foo[round(1 div 2)]/text()":

      Object qname1 = compiler.qname(null, "foo")
      Object expr1 = compiler.number("1");
      Object expr2 = compiler.number("2");
      Object expr3 = compiler.div(expr1, expr2);
      Object expr4 = compiler.
              coreFunction(Compiler.FUNCTION_ROUND, new Object[]{expr3});
      Object test1 = compiler.nodeNameTest(qname1);
      Object step1 = compiler.
              step(Compiler.AXIS_CHILD, test1, new Object[]{expr4});
      Object test2 = compiler.nodeTypeTest(Compiler.NODE_TYPE_TEXT);
      Object step2 = compiler.nodeTypeTest(Compiler.AXIS_CHILD, test2, null);
      Object expr5 = compiler.locationPath(false, new Object[]{step1, step2});

Version:: $Revision: 652845 $ $Date: 2008-05-02 12:46:46 -0500 (Fri, 02 May 2008) $
Author:: Dmitri Plotnikov

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AXIS_ANCESTOR`
`static int`	`AXIS_ANCESTOR_OR_SELF`
`static int`	`AXIS_ATTRIBUTE`
`static int`	`AXIS_CHILD`
`static int`	`AXIS_DESCENDANT`
`static int`	`AXIS_DESCENDANT_OR_SELF`
`static int`	`AXIS_FOLLOWING`
`static int`	`AXIS_FOLLOWING_SIBLING`
`static int`	`AXIS_NAMESPACE`
`static int`	`AXIS_PARENT`
`static int`	`AXIS_PRECEDING`
`static int`	`AXIS_PRECEDING_SIBLING`
`static int`	`AXIS_SELF`
`static int`	`FUNCTION_BOOLEAN`
`static int`	`FUNCTION_CEILING`
`static int`	`FUNCTION_CONCAT`
`static int`	`FUNCTION_CONTAINS`
`static int`	`FUNCTION_COUNT`
`static int`	`FUNCTION_FALSE`
`static int`	`FUNCTION_FLOOR`
`static int`	`FUNCTION_FORMAT_NUMBER`
`static int`	`FUNCTION_ID`
`static int`	`FUNCTION_KEY`
`static int`	`FUNCTION_LANG`
`static int`	`FUNCTION_LAST`
`static int`	`FUNCTION_LOCAL_NAME`
`static int`	`FUNCTION_NAME`
`static int`	`FUNCTION_NAMESPACE_URI`
`static int`	`FUNCTION_NORMALIZE_SPACE`
`static int`	`FUNCTION_NOT`
`static int`	`FUNCTION_NULL`
`static int`	`FUNCTION_NUMBER`
`static int`	`FUNCTION_POSITION`
`static int`	`FUNCTION_ROUND`
`static int`	`FUNCTION_STARTS_WITH`
`static int`	`FUNCTION_STRING`
`static int`	`FUNCTION_STRING_LENGTH`
`static int`	`FUNCTION_SUBSTRING`
`static int`	`FUNCTION_SUBSTRING_AFTER`
`static int`	`FUNCTION_SUBSTRING_BEFORE`
`static int`	`FUNCTION_SUM`
`static int`	`FUNCTION_TRANSLATE`
`static int`	`FUNCTION_TRUE`
`static int`	`NODE_TYPE_COMMENT`
`static int`	`NODE_TYPE_NODE`
`static int`	`NODE_TYPE_PI`
`static int`	`NODE_TYPE_TEXT`

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`and(Object[] arguments)` Produces an EXPRESSION object representing logical conjunction of all arguments
`Object`	`divide(Object left, Object right)` Produces an EXPRESSION object representing left divided by right
`Object`	`equal(Object left, Object right)` Produces an EXPRESSION object representing the comparison: left equals to right
`Object`	`expressionPath(Object expression, Object[] predicates, Object[] steps)` Produces an EXPRESSION object representing a filter expression
`Object`	`function(int code, Object[] args)` Produces an EXPRESSION object representing the computation of a core function with the supplied arguments.
`Object`	`function(Object name, Object[] args)` Produces an EXPRESSION object representing the computation of a library function with the supplied arguments.
`Object`	`greaterThan(Object left, Object right)` Produces an EXPRESSION object representing the comparison: left greater than right
`Object`	`greaterThanOrEqual(Object left, Object right)` Produces an EXPRESSION object representing the comparison: left greater than or equal to right
`Object`	`lessThan(Object left, Object right)` Produces an EXPRESSION object representing the comparison: left less than right
`Object`	`lessThanOrEqual(Object left, Object right)` Produces an EXPRESSION object representing the comparison: left less than or equal to right
`Object`	`literal(String value)` Produces an EXPRESSION object that represents a string constant.
`Object`	`locationPath(boolean absolute, Object[] steps)` Produces an EXPRESSION object representing a location path
`Object`	`minus(Object argument)` Produces an EXPRESSION object representing unary negation of the argument
`Object`	`minus(Object left, Object right)` Produces an EXPRESSION object representing left minus right
`Object`	`mod(Object left, Object right)` Produces an EXPRESSION object representing left modulo right
`Object`	`multiply(Object left, Object right)` Produces an EXPRESSION object representing left multiplied by right
`Object`	`nodeNameTest(Object qname)` Produces a NODE_TEST object that represents a node name test.
`Object`	`nodeTypeTest(int nodeType)` Produces a NODE_TEST object that represents a node type test.
`Object`	`notEqual(Object left, Object right)` Produces an EXPRESSION object representing the comparison: left is not equal to right
`Object`	`number(String value)` Produces an EXPRESSION object that represents a numeric constant.
`Object`	`or(Object[] arguments)` Produces an EXPRESSION object representing logical disjunction of all arguments
`Object`	`processingInstructionTest(String instruction)` Produces a NODE_TEST object that represents a processing instruction test.
`Object`	`qname(String prefix, String name)` Produces an QNAME that represents a name with an optional prefix.
`Object`	`step(int axis, Object nodeTest, Object[] predicates)` Produces a STEP object that represents a node test.
`Object`	`sum(Object[] arguments)` Produces an EXPRESSION object representing the sum of all argumens
`Object`	`union(Object[] arguments)` Produces an EXPRESSION object representing union of all node sets
`Object`	`variableReference(Object qname)` Produces an EXPRESSION object representing variable reference

- Field Detail
  - NODE_TYPE_NODE
```
static final int NODE_TYPE_NODE
```
    See Also:
    Constant Field Values
  - NODE_TYPE_TEXT
```
static final int NODE_TYPE_TEXT
```
    See Also:
    Constant Field Values
  - NODE_TYPE_COMMENT
```
static final int NODE_TYPE_COMMENT
```
    See Also:
    Constant Field Values
  - NODE_TYPE_PI
```
static final int NODE_TYPE_PI
```
    See Also:
    Constant Field Values
  - AXIS_SELF
```
static final int AXIS_SELF
```
    See Also:
    Constant Field Values
  - AXIS_CHILD
```
static final int AXIS_CHILD
```
    See Also:
    Constant Field Values
  - AXIS_PARENT
```
static final int AXIS_PARENT
```
    See Also:
    Constant Field Values
  - AXIS_ANCESTOR
```
static final int AXIS_ANCESTOR
```
    See Also:
    Constant Field Values
  - AXIS_ATTRIBUTE
```
static final int AXIS_ATTRIBUTE
```
    See Also:
    Constant Field Values
  - AXIS_NAMESPACE
```
static final int AXIS_NAMESPACE
```
    See Also:
    Constant Field Values
  - AXIS_PRECEDING
```
static final int AXIS_PRECEDING
```
    See Also:
    Constant Field Values
  - AXIS_FOLLOWING
```
static final int AXIS_FOLLOWING
```
    See Also:
    Constant Field Values
  - AXIS_DESCENDANT
```
static final int AXIS_DESCENDANT
```
    See Also:
    Constant Field Values
  - AXIS_ANCESTOR_OR_SELF
```
static final int AXIS_ANCESTOR_OR_SELF
```
    See Also:
    Constant Field Values
  - AXIS_FOLLOWING_SIBLING
```
static final int AXIS_FOLLOWING_SIBLING
```
    See Also:
    Constant Field Values
  - AXIS_PRECEDING_SIBLING
```
static final int AXIS_PRECEDING_SIBLING
```
    See Also:
    Constant Field Values
  - AXIS_DESCENDANT_OR_SELF
```
static final int AXIS_DESCENDANT_OR_SELF
```
    See Also:
    Constant Field Values
  - FUNCTION_LAST
```
static final int FUNCTION_LAST
```
    See Also:
    Constant Field Values
  - FUNCTION_POSITION
```
static final int FUNCTION_POSITION
```
    See Also:
    Constant Field Values
  - FUNCTION_COUNT
```
static final int FUNCTION_COUNT
```
    See Also:
    Constant Field Values
  - FUNCTION_ID
```
static final int FUNCTION_ID
```
    See Also:
    Constant Field Values
  - FUNCTION_LOCAL_NAME
```
static final int FUNCTION_LOCAL_NAME
```
    See Also:
    Constant Field Values
  - FUNCTION_NAMESPACE_URI
```
static final int FUNCTION_NAMESPACE_URI
```
    See Also:
    Constant Field Values
  - FUNCTION_NAME
```
static final int FUNCTION_NAME
```
    See Also:
    Constant Field Values
  - FUNCTION_STRING
```
static final int FUNCTION_STRING
```
    See Also:
    Constant Field Values
  - FUNCTION_CONCAT
```
static final int FUNCTION_CONCAT
```
    See Also:
    Constant Field Values
  - FUNCTION_STARTS_WITH
```
static final int FUNCTION_STARTS_WITH
```
    See Also:
    Constant Field Values
  - FUNCTION_CONTAINS
```
static final int FUNCTION_CONTAINS
```
    See Also:
    Constant Field Values
  - FUNCTION_SUBSTRING_BEFORE
```
static final int FUNCTION_SUBSTRING_BEFORE
```
    See Also:
    Constant Field Values
  - FUNCTION_SUBSTRING_AFTER
```
static final int FUNCTION_SUBSTRING_AFTER
```
    See Also:
    Constant Field Values
  - FUNCTION_SUBSTRING
```
static final int FUNCTION_SUBSTRING
```
    See Also:
    Constant Field Values
  - FUNCTION_STRING_LENGTH
```
static final int FUNCTION_STRING_LENGTH
```
    See Also:
    Constant Field Values
  - FUNCTION_NORMALIZE_SPACE
```
static final int FUNCTION_NORMALIZE_SPACE
```
    See Also:
    Constant Field Values
  - FUNCTION_TRANSLATE
```
static final int FUNCTION_TRANSLATE
```
    See Also:
    Constant Field Values
  - FUNCTION_BOOLEAN
```
static final int FUNCTION_BOOLEAN
```
    See Also:
    Constant Field Values
  - FUNCTION_NOT
```
static final int FUNCTION_NOT
```
    See Also:
    Constant Field Values
  - FUNCTION_TRUE
```
static final int FUNCTION_TRUE
```
    See Also:
    Constant Field Values
  - FUNCTION_FALSE
```
static final int FUNCTION_FALSE
```
    See Also:
    Constant Field Values
  - FUNCTION_LANG
```
static final int FUNCTION_LANG
```
    See Also:
    Constant Field Values
  - FUNCTION_NUMBER
```
static final int FUNCTION_NUMBER
```
    See Also:
    Constant Field Values
  - FUNCTION_SUM
```
static final int FUNCTION_SUM
```
    See Also:
    Constant Field Values
  - FUNCTION_FLOOR
```
static final int FUNCTION_FLOOR
```
    See Also:
    Constant Field Values
  - FUNCTION_CEILING
```
static final int FUNCTION_CEILING
```
    See Also:
    Constant Field Values
  - FUNCTION_ROUND
```
static final int FUNCTION_ROUND
```
    See Also:
    Constant Field Values
  - FUNCTION_NULL
```
static final int FUNCTION_NULL
```
    See Also:
    Constant Field Values
  - FUNCTION_KEY
```
static final int FUNCTION_KEY
```
    See Also:
    Constant Field Values
  - FUNCTION_FORMAT_NUMBER
```
static final int FUNCTION_FORMAT_NUMBER
```
    See Also:
    Constant Field Values
- Method Detail
  - number
```
Object number(String value)
```
    Produces an EXPRESSION object that represents a numeric constant.
    
    Parameters:
    value - numeric String
    
    Returns:
    Object
  - literal
```
Object literal(String value)
```
    Produces an EXPRESSION object that represents a string constant.
    
    Parameters:
    value - String literal
    
    Returns:
    Object
  - qname
```
Object qname(String prefix,
           String name)
```
    Produces an QNAME that represents a name with an optional prefix.
    
    Parameters:
    prefix - String prefix
    name - String name
    
    Returns:
    Object
  - sum
```
Object sum(Object[] arguments)
```
    Produces an EXPRESSION object representing the sum of all argumens
    
    Parameters:
    arguments - are EXPRESSION objects
    
    Returns:
    Object
  - minus
```
Object minus(Object left,
           Object right)
```
    Produces an EXPRESSION object representing left minus right
    
    Parameters:
    left - is an EXPRESSION object
    right - is an EXPRESSION object
    
    Returns:
    Object
  - multiply
```
Object multiply(Object left,
              Object right)
```
    Produces an EXPRESSION object representing left multiplied by right
    
    Parameters:
    left - is an EXPRESSION object
    right - is an EXPRESSION object
    
    Returns:
    Object
  - divide
```
Object divide(Object left,
            Object right)
```
    Produces an EXPRESSION object representing left divided by right
    
    Parameters:
    left - is an EXPRESSION object
    right - is an EXPRESSION object
    
    Returns:
    Object
  - mod
```
Object mod(Object left,
         Object right)
```
    Produces an EXPRESSION object representing left modulo right
    
    Parameters:
    left - is an EXPRESSION object
    right - is an EXPRESSION object
    
    Returns:
    Object
  - lessThan
```
Object lessThan(Object left,
              Object right)
```
    Produces an EXPRESSION object representing the comparison: left less than right
    
    Parameters:
    left - is an EXPRESSION object
    right - is an EXPRESSION object
    
    Returns:
    Object
  - lessThanOrEqual
```
Object lessThanOrEqual(Object left,
                     Object right)
```
    Produces an EXPRESSION object representing the comparison: left less than or equal to right
    
    Parameters:
    left - is an EXPRESSION object
    right - is an EXPRESSION object
    
    Returns:
    Object
  - greaterThan
```
Object greaterThan(Object left,
                 Object right)
```
    Produces an EXPRESSION object representing the comparison: left greater than right
    
    Parameters:
    left - is an EXPRESSION object
    right - is an EXPRESSION object
    
    Returns:
    Object
  - greaterThanOrEqual
```
Object greaterThanOrEqual(Object left,
                        Object right)
```
    Produces an EXPRESSION object representing the comparison: left greater than or equal to right
    
    Parameters:
    left - is an EXPRESSION object
    right - is an EXPRESSION object
    
    Returns:
    Object
  - equal
```
Object equal(Object left,
           Object right)
```
    Produces an EXPRESSION object representing the comparison: left equals to right
    
    Parameters:
    left - is an EXPRESSION object
    right - is an EXPRESSION object
    
    Returns:
    Object
  - notEqual
```
Object notEqual(Object left,
              Object right)
```
    Produces an EXPRESSION object representing the comparison: left is not equal to right
    
    Parameters:
    left - is an EXPRESSION object
    right - is an EXPRESSION object
    
    Returns:
    Object
  - minus
```
Object minus(Object argument)
```
    Produces an EXPRESSION object representing unary negation of the argument
    
    Parameters:
    argument - is an EXPRESSION object
    
    Returns:
    Object
  - variableReference
```
Object variableReference(Object qname)
```
    Produces an EXPRESSION object representing variable reference
    
    Parameters:
    qname - is a QNAME object
    
    Returns:
    Object
  - function
```
Object function(int code,
              Object[] args)
```
    Produces an EXPRESSION object representing the computation of a core function with the supplied arguments.
    
    Parameters:
    code - is one of FUNCTION_... constants
    args - are EXPRESSION objects
    
    Returns:
    Object
  - function
```
Object function(Object name,
              Object[] args)
```
    Produces an EXPRESSION object representing the computation of a library function with the supplied arguments.
    
    Parameters:
    name - is a QNAME object (function name)
    args - are EXPRESSION objects
    
    Returns:
    Object
  - and
```
Object and(Object[] arguments)
```
    Produces an EXPRESSION object representing logical conjunction of all arguments
    
    Parameters:
    arguments - are EXPRESSION objects
    
    Returns:
    Object
  - or
```
Object or(Object[] arguments)
```
    Produces an EXPRESSION object representing logical disjunction of all arguments
    
    Parameters:
    arguments - are EXPRESSION objects
    
    Returns:
    Object
  - union
```
Object union(Object[] arguments)
```
    Produces an EXPRESSION object representing union of all node sets
    
    Parameters:
    arguments - are EXPRESSION objects
    
    Returns:
    Object
  - nodeNameTest
```
Object nodeNameTest(Object qname)
```
    Produces a NODE_TEST object that represents a node name test.
    
    Parameters:
    qname - is a QNAME object
    
    Returns:
    Object
  - nodeTypeTest
```
Object nodeTypeTest(int nodeType)
```
    Produces a NODE_TEST object that represents a node type test.
    
    Parameters:
    nodeType - is a NODE_TEST object
    
    Returns:
    Object
  - processingInstructionTest
```
Object processingInstructionTest(String instruction)
```
    Produces a NODE_TEST object that represents a processing instruction test.
    
    Parameters:
    instruction - is a NODE_TEST object
    
    Returns:
    Object
  - step
```
Object step(int axis,
          Object nodeTest,
          Object[] predicates)
```
    Produces a STEP object that represents a node test.
    
    Parameters:
    axis - is one of the AXIS_... constants
    nodeTest - is a NODE_TEST object
    predicates - are EXPRESSION objects
    
    Returns:
    Object
  - locationPath
```
Object locationPath(boolean absolute,
                  Object[] steps)
```
    Produces an EXPRESSION object representing a location path
    
    Parameters:
    absolute - indicates whether the path is absolute
    steps - are STEP objects
    
    Returns:
    Object
  - expressionPath
```
Object expressionPath(Object expression,
                    Object[] predicates,
                    Object[] steps)
```
    Produces an EXPRESSION object representing a filter expression
    
    Parameters:
    expression - is an EXPRESSION object
    predicates - are EXPRESSION objects
    steps - are STEP objects
    
    Returns:
    Object

Interface Compiler

Field Summary

Method Summary

Field Detail

NODE_TYPE_NODE

NODE_TYPE_TEXT

NODE_TYPE_COMMENT

NODE_TYPE_PI

AXIS_SELF

AXIS_CHILD

AXIS_PARENT

AXIS_ANCESTOR

AXIS_ATTRIBUTE

AXIS_NAMESPACE

AXIS_PRECEDING

AXIS_FOLLOWING

AXIS_DESCENDANT

AXIS_ANCESTOR_OR_SELF

AXIS_FOLLOWING_SIBLING

AXIS_PRECEDING_SIBLING

AXIS_DESCENDANT_OR_SELF

FUNCTION_LAST

FUNCTION_POSITION

FUNCTION_COUNT

FUNCTION_ID

FUNCTION_LOCAL_NAME

FUNCTION_NAMESPACE_URI

FUNCTION_NAME

FUNCTION_STRING

FUNCTION_CONCAT

FUNCTION_STARTS_WITH

FUNCTION_CONTAINS

FUNCTION_SUBSTRING_BEFORE

FUNCTION_SUBSTRING_AFTER

FUNCTION_SUBSTRING

FUNCTION_STRING_LENGTH

FUNCTION_NORMALIZE_SPACE

FUNCTION_TRANSLATE

FUNCTION_BOOLEAN

FUNCTION_NOT

FUNCTION_TRUE

FUNCTION_FALSE

FUNCTION_LANG

FUNCTION_NUMBER

FUNCTION_SUM

FUNCTION_FLOOR

FUNCTION_CEILING

FUNCTION_ROUND

FUNCTION_NULL

FUNCTION_KEY

FUNCTION_FORMAT_NUMBER

Method Detail

number

literal

qname

sum

minus

multiply

divide

mod

lessThan

lessThanOrEqual

greaterThan

greaterThanOrEqual

equal

notEqual

minus

variableReference

function

function

and

or

union

nodeNameTest

nodeTypeTest

processingInstructionTest

step

locationPath

expressionPath