Extension (OpenJPA Parent POM 2.4.0 API)

java.lang.Object
- org.apache.openjpa.jdbc.kernel.exps.AbstractVal
- - org.apache.openjpa.jdbc.kernel.exps.Extension

All Implemented Interfaces:

Serializable, Exp, Val, Expression, Value
```
 class Extension
extends AbstractVal
implements Val, Exp
```
Filter listener that evaluates to a value.

Author:

Abe White

Field Summary
- Fields inherited from class org.apache.openjpa.jdbc.kernel.exps.AbstractVal
  FALSE, TRUE
- Fields inherited from interface org.apache.openjpa.jdbc.kernel.exps.Val
  ABS_VAL, ARGS_VAL, CMP_EQUAL, COALESCE_VAL, CONCAT_VAL, FORCE_OUTER, GENERALCASE_VAL, INDEXOF_VAL, JOIN_REL, LENGTH_VAL, LOCATE_VAL, LOWER_VAL, MATH_VAL, NULL_CMP, NULLIF_VAL, SIMPLECASE_VAL, SQRT_VAL, SUBSTRING_VAL, TRIM_VAL, UPPER_VAL, VAL, WHENCONDITION_VAL, WHENSCALAR_VAL

Constructor Summary

Constructors
Constructor and Description

Extension(JDBCFilterListener listener, Val target, Val arg, ClassMapping candidate)
Constructor.

Constructors
Constructor and Description
`Extension(JDBCFilterListener listener, Val target, Val arg, ClassMapping candidate)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`acceptVisit(ExpressionVisitor visitor)` Accept a visit from a tree visitor.
`void`	`appendTo(Select sel, ExpContext ctx, ExpState state, SQLBuffer sql)` Append the SQL for this expression to the given buffer.
`void`	`appendTo(Select sel, ExpContext ctx, ExpState state, SQLBuffer sql, int index)` Append the `index`th SQL element to the given buffer.
`void`	`calculateValue(Select sel, ExpContext ctx, ExpState state, Val other, ExpState otherState)` Calculate and cache the SQL for this value.
`ClassMetaData`	`getMetaData()` Return any associated persistent type.
`Class`	`getType()` Return the expected type for this value, or `Object` if the type is unknown.
`void`	`groupBy(Select sel, ExpContext ctx, ExpState state)` Group by this value.
`ExpState`	`initialize(Select sel, ExpContext ctx, int flags)` Initialize the value.
`ExpState`	`initialize(Select sel, ExpContext ctx, Map contains)` Initialize the expression.
`boolean`	`isAggregate()` Return true if this value is an aggregate.
`boolean`	`isVariable()` Return true if this value is a variable.
`int`	`length(Select sel, ExpContext ctx, ExpState state)` Return the number of SQL elements in this value.
`Object`	`load(ExpContext ctx, ExpState state, Result res)` Load the data for this value.
`void`	`orderBy(Select sel, ExpContext ctx, ExpState state, boolean asc)` Order by this value.
`void`	`select(Select sel, ExpContext ctx, ExpState state, boolean pks)` Select the data for this value.
`void`	`selectColumns(Select sel, ExpContext ctx, ExpState state, boolean pks)` Select just the columns for this value.
`void`	`setImplicitType(Class type)` Set the implicit type of the value, based on how it is used in the filter.
`void`	`setMetaData(ClassMetaData meta)` Associate a persistent type with this value.

Methods inherited from class org.apache.openjpa.jdbc.kernel.exps.AbstractVal
appendIndex, appendIsEmpty, appendIsNotEmpty, appendIsNotNull, appendIsNull, appendSize, appendType, getAlias, getId, getName, getPath, getSelectAs, isXPath, setAlias, toDataStoreValue

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.openjpa.jdbc.kernel.exps.Val
appendIndex, appendIsEmpty, appendIsNotEmpty, appendIsNotNull, appendIsNull, appendSize, appendType, getId, getSelectAs, toDataStoreValue

Methods inherited from interface org.apache.openjpa.kernel.exps.Value
getAlias, getName, getPath, isXPath, setAlias

- Constructor Detail
  - Extension
```
public Extension(JDBCFilterListener listener,
         Val target,
         Val arg,
         ClassMapping candidate)
```
    Constructor.
- Method Detail
  - getMetaData
```
public ClassMetaData getMetaData()
```
    Description copied from interface: Value
    
    Return any associated persistent type.
    
    Specified by:
    
    getMetaData in interface Value
  - setMetaData
```
public void setMetaData(ClassMetaData meta)
```
    Description copied from interface: Value
    
    Associate a persistent type with this value.
    
    Specified by:
    
    setMetaData in interface Value
  - isVariable
```
public boolean isVariable()
```
    Description copied from interface: Value
    
    Return true if this value is a variable.
    
    Specified by:
    
    isVariable in interface Value
    
    Overrides:
    
    isVariable in class AbstractVal
  - isAggregate
```
public boolean isAggregate()
```
    Description copied from interface: Value
    
    Return true if this value is an aggregate.
    
    Specified by:
    
    isAggregate in interface Value
    
    Overrides:
    
    isAggregate in class AbstractVal
  - getType
```
public Class getType()
```
    Description copied from interface: Value
    
    Return the expected type for this value, or Object if the type is unknown.
    
    Specified by:
    
    getType in interface Value
  - setImplicitType
```
public void setImplicitType(Class type)
```
    Description copied from interface: Value
    
    Set the implicit type of the value, based on how it is used in the filter. This method is only called on values who return Object from Value.getType().
    
    Specified by:
    
    setImplicitType in interface Value
  - initialize
```
public ExpState initialize(Select sel,
                  ExpContext ctx,
                  int flags)
```
    Description copied from interface: Val
    
    Initialize the value. This method should recursively initialize any sub-values.
    
    Specified by:
    
    initialize in interface Val
  - select
```
public void select(Select sel,
          ExpContext ctx,
          ExpState state,
          boolean pks)
```
    Description copied from interface: Val
    
    Select the data for this value.
    
    Specified by:
    
    select in interface Val
  - selectColumns
```
public void selectColumns(Select sel,
                 ExpContext ctx,
                 ExpState state,
                 boolean pks)
```
    Description copied from interface: Val
    
    Select just the columns for this value.
    
    Specified by:
    
    selectColumns in interface Exp
    
    Specified by:
    
    selectColumns in interface Val
  - groupBy
```
public void groupBy(Select sel,
           ExpContext ctx,
           ExpState state)
```
    Description copied from interface: Val
    
    Group by this value.
    
    Specified by:
    
    groupBy in interface Val
  - orderBy
```
public void orderBy(Select sel,
           ExpContext ctx,
           ExpState state,
           boolean asc)
```
    Description copied from interface: Val
    
    Order by this value.
    
    Specified by:
    
    orderBy in interface Val
  - load
```
public Object load(ExpContext ctx,
          ExpState state,
          Result res)
            throws SQLException
```
    Description copied from interface: Val
    
    Load the data for this value.
    
    Specified by:
    
    load in interface Val
    
    Throws:
    
    SQLException
  - calculateValue
```
public void calculateValue(Select sel,
                  ExpContext ctx,
                  ExpState state,
                  Val other,
                  ExpState otherState)
```
    Description copied from interface: Val
    
    Calculate and cache the SQL for this value. This method is called before length or any append methods.
    
    Specified by:
    
    calculateValue in interface Val
    
    other - the value being compared to, or null if not a comparison
  - length
```
public int length(Select sel,
         ExpContext ctx,
         ExpState state)
```
    Description copied from interface: Val
    
    Return the number of SQL elements in this value.
    
    Specified by:
    
    length in interface Val
  - appendTo
```
public void appendTo(Select sel,
            ExpContext ctx,
            ExpState state,
            SQLBuffer sql,
            int index)
```
    Description copied from interface: Val
    
    Append the indexth SQL element to the given buffer.
    
    Specified by:
    
    appendTo in interface Val
  - acceptVisit
```
public void acceptVisit(ExpressionVisitor visitor)
```
    Description copied from interface: Value
    
    Accept a visit from a tree visitor.
    
    Specified by:
    
    acceptVisit in interface Expression
    
    Specified by:
    
    acceptVisit in interface Value
    
    Overrides:
    
    acceptVisit in class AbstractVal
  - initialize
```
public ExpState initialize(Select sel,
                  ExpContext ctx,
                  Map contains)
```
    Description copied from interface: Exp
    
    Initialize the expression. This method should recursively initialize any sub-expressions or values.
    
    Specified by:
    
    initialize in interface Exp
    
    contains - map of relation paths to the number of times the paths appear in a contains() expression; used to ensure paths used for contains() within the same AND expression used different aliases
  - appendTo
```
public void appendTo(Select sel,
            ExpContext ctx,
            ExpState state,
            SQLBuffer sql)
```
    Description copied from interface: Exp
    
    Append the SQL for this expression to the given buffer. The SQL should optionally include any joins this expression needs.
    
    Specified by:
    
    appendTo in interface Exp

Class Extension

Field Summary

Fields inherited from class org.apache.openjpa.jdbc.kernel.exps.AbstractVal

Fields inherited from interface org.apache.openjpa.jdbc.kernel.exps.Val

Constructor Summary

Method Summary

Methods inherited from class org.apache.openjpa.jdbc.kernel.exps.AbstractVal

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.openjpa.jdbc.kernel.exps.Val

Methods inherited from interface org.apache.openjpa.kernel.exps.Value

Constructor Detail

Extension

Method Detail

getMetaData

setMetaData

isVariable

isAggregate

getType

setImplicitType

initialize

select

selectColumns

groupBy

orderBy

load

calculateValue

length

appendTo

acceptVisit

initialize

appendTo