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

java.lang.Object
  extended by org.apache.openjpa.jdbc.kernel.exps.AbstractVal
      extended by org.apache.openjpa.jdbc.kernel.exps.Const
          extended by org.apache.openjpa.jdbc.kernel.exps.Lit
All Implemented Interfaces:
Serializable, Val, Constant, Literal, Value

public class Lit
extends Const
implements Literal

A literal value in a filter.

Author:
Abe White
See Also:
Serialized Form

Nested Class Summary
 
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.kernel.exps.Literal
TYPE_BOOLEAN, TYPE_CLASS, TYPE_COLLECTION, TYPE_DATE, TYPE_ENUM, TYPE_NUMBER, TYPE_SQ_STRING, TYPE_STRING, TYPE_TIME, TYPE_TIMESTAMP, TYPE_UNKNOWN
 
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
Lit(Object val, int ptype)
          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 getParseType()
          The type the literal was parsed as.
 Object getRawValue()
           
 Class getType()
          Return the expected type for this value, or Object if the type is unknown.
 Object getValue()
          The value of this literal.
 Object getValue(Object[] params)
          Return the value for this constant given the specified parameters.
 ExpState initialize(Select sel, ExpContext ctx, int flags)
          Initialize the value.
 boolean isRaw()
           
 void setImplicitType(Class type)
          Set the implicit type of the value, based on how it is used in the filter.
 void setRaw(boolean isRaw)
           
 void setValue(Object val)
          The value of this literal.
 
Methods inherited from class org.apache.openjpa.jdbc.kernel.exps.Const
appendIsEmpty, appendIsNotEmpty, appendIsNotNull, appendIsNull, appendSize, getMetaData, getSQLValue, getValue, groupBy, isSQLValueNull, length, 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

Lit

public Lit(Object val,
           int ptype)
Constructor. Supply literal value.

Method Detail

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

getParseType

public int getParseType()
Description copied from interface: Literal
The type the literal was parsed as.

Specified by:
getParseType in interface Literal

getValue

public Object getValue()
Description copied from interface: Literal
The value of this literal.

Specified by:
getValue in interface Literal

setValue

public void setValue(Object val)
Description copied from interface: Literal
The value of this literal.

Specified by:
setValue in interface Literal

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

isRaw

public boolean isRaw()

setRaw

public void setRaw(boolean isRaw)

getRawValue

public Object getRawValue()

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


Copyright © 2006-2011 Apache Software Foundation. All Rights Reserved.