org.apache.openjpa.jdbc.kernel.exps
Class Param

java.lang.Object
  org.apache.openjpa.jdbc.kernel.exps.AbstractVal
      org.apache.openjpa.jdbc.kernel.exps.Const
          org.apache.openjpa.jdbc.kernel.exps.Param

All Implemented Interfaces:

Serializable, Val, Constant, Parameter, Value

public class Param
extends Const
implements Parameter

A parameter in a filter.

Author:

Abe White

See Also:

Serialized Form

Nested Class Summary

static class

Param.ParamExpState Expression state.

Nested classes/interfaces inherited from class org.apache.openjpa.jdbc.kernel.exps.Const

Const.ConstExpState

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

Param(Object key, Class type)
Constructor.

Method Summary

void	appendTo(Select sel, ExpContext ctx, ExpState state, SQLBuffer sql, int index) Append the indexth 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.
int	getIndex()
Object	getParameterKey() Returns the key of the parameter.
Object	getSQLValue(Select sel, ExpContext ctx, ExpState state) Return the SQL value of this constant.
Class	getType() Return the expected type for this value, or Object if the type is unknown.
Object	getValue(ExpContext ctx, ExpState state) Return the value of this constant.
Object	getValue(Object[] params) Return the value for this constant given the specified parameters.
ClassMapping	getValueMetaData(ExpContext ctx)
ExpState	initialize(Select sel, ExpContext ctx, int flags) Initialize the value.
int	length(Select sel, ExpContext ctx, ExpState state) Return the number of SQL elements in this value.
void	setImplicitType(Class type) Set the implicit type of the value, based on how it is used in the filter.
void	setIndex(int idx) Set the index of this parameter.

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

appendIsEmpty, appendIsNotEmpty, appendIsNotNull, appendIsNull, appendSize, getMetaData, groupBy, isSQLValueNull, load, orderBy, select, selectColumns, setMetaData

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

acceptVisit, appendIndex, appendType, getAlias, getId, getName, getPath, getSelectAs, isAggregate, isVariable, 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.kernel.exps.Value

acceptVisit, getAlias, getMetaData, getName, getPath, getSelectAs, isAggregate, isVariable, isXPath, setAlias, setMetaData

Constructor Detail

Param

public Param(Object key,
             Class type)

Constructor. Supply parameter name and type.

Method Detail

getParameterKey

public Object getParameterKey()

Description copied from interface: Parameter

Returns the key of the parameter.

Specified by:

getParameterKey in interface Parameter

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

getIndex

public int getIndex()

setIndex

public void setIndex(int idx)

Description copied from interface: Parameter

Set the index of this parameter.

Specified by:

setIndex in interface Parameter

getValueMetaData

public ClassMapping getValueMetaData(ExpContext ctx)

getValue

public Object getValue(Object[] params)

Description copied from interface: Constant

Return the value for this constant given the specified parameters.

Specified by:

getValue in interface Constant

getValue

public Object getValue(ExpContext ctx,
                       ExpState state)

Description copied from class: Const

Return the value of this constant. May be more robust than the parameters-only form.

Overrides:

getValue in class Const

getSQLValue

public Object getSQLValue(Select sel,
                          ExpContext ctx,
                          ExpState state)

Description copied from class: Const

Return the SQL value of this constant.

Overrides:

getSQLValue in class Const

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

Overrides:

initialize in class Const

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

Overrides:

calculateValue in class Const

other - the value being compared to, or null if not a comparison

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

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

Overrides:

length in class Const