|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.openjpa.jdbc.kernel.exps.Param
public class Param
A parameter in a filter.
Nested Class Summary | |
---|---|
protected static class |
Const.ConstExpState
Constant expression state. |
Field Summary | |
---|---|
protected static String |
FALSE
|
protected static String |
TRUE
|
Fields inherited from interface org.apache.openjpa.jdbc.kernel.exps.Val |
---|
FORCE_OUTER, JOIN_REL, NULL_CMP |
Constructor Summary | |
---|---|
Param(String name,
Class type)
Constructor. |
Method Summary | |
---|---|
void |
acceptVisit(ExpressionVisitor visitor)
Accept a visit from a tree visitor. |
void |
appendIsEmpty(Select sel,
ExpContext ctx,
ExpState state,
SQLBuffer sql)
Append the SQL testing whether this value is empty to the given buffer. |
void |
appendIsNotEmpty(Select sel,
ExpContext ctx,
ExpState state,
SQLBuffer sql)
Append the SQL testing whether this value is not empty to the given buffer. |
void |
appendIsNotNull(Select sel,
ExpContext ctx,
ExpState state,
SQLBuffer sql)
Append the SQL testing whether this value is not null to the given buffer. |
void |
appendIsNull(Select sel,
ExpContext ctx,
ExpState state,
SQLBuffer sql)
Append the SQL testing whether this value is null to the given buffer. |
void |
appendSize(Select sel,
ExpContext ctx,
ExpState state,
SQLBuffer sql)
Append the SQL checking the size of this value. |
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. |
int |
getIndex()
|
ClassMetaData |
getMetaData()
Return any associated persistent type. |
String |
getName()
|
String |
getParameterName()
Returns the name 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. |
void |
groupBy(Select sel,
ExpContext ctx,
ExpState state)
Group by this value. |
ExpState |
initialize(Select sel,
ExpContext ctx,
int flags)
Initialize the value. |
boolean |
isAggregate()
Return true if this value is an aggregate. |
boolean |
isSQLValueNull(Select sel,
ExpContext ctx,
ExpState state)
Return true if this constant's SQL value is equivalent to NULL. |
boolean |
isVariable()
Return true if this value is a variable. |
boolean |
isXPath()
Return true if this value is an XML Path. |
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 |
setIndex(int idx)
Set the index of this parameter. |
void |
setMetaData(ClassMetaData meta)
Associate a persistent type with this value. |
Object |
toDataStoreValue(Select sel,
ExpContext ctx,
ExpState state,
Object val)
Return the datastore value of the given object in the context of this value. |
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, getMetaData, isAggregate, isVariable, isXPath, setMetaData |
Field Detail |
---|
protected static final String TRUE
protected static final String FALSE
Constructor Detail |
---|
public Param(String name, Class type)
Method Detail |
---|
public String getName()
public String getParameterName()
Parameter
getParameterName
in interface Parameter
public Class getType()
Value
Object
if
the type is unknown.
getType
in interface Value
public void setImplicitType(Class type)
Value
Object
from Value.getType()
.
setImplicitType
in interface Value
public int getIndex()
public void setIndex(int idx)
Parameter
setIndex
in interface Parameter
public Object getValue(Object[] params)
Constant
getValue
in interface Constant
public Object getSQLValue(Select sel, ExpContext ctx, ExpState state)
public ExpState initialize(Select sel, ExpContext ctx, int flags)
Val
initialize
in interface Val
public void calculateValue(Select sel, ExpContext ctx, ExpState state, Val other, ExpState otherState)
Val
length
or any append
methods.
calculateValue
in interface Val
other
- the value being compared to, or null if not a comparisonpublic void appendTo(Select sel, ExpContext ctx, ExpState state, SQLBuffer sql, int index)
Val
index
th SQL element to the given buffer.
appendTo
in interface Val
public ClassMetaData getMetaData()
Value
getMetaData
in interface Value
public void setMetaData(ClassMetaData meta)
Value
setMetaData
in interface Value
public boolean isSQLValueNull(Select sel, ExpContext ctx, ExpState state)
public Object getValue(ExpContext ctx, ExpState state)
public void select(Select sel, ExpContext ctx, ExpState state, boolean pks)
Val
select
in interface Val
public void selectColumns(Select sel, ExpContext ctx, ExpState state, boolean pks)
Val
selectColumns
in interface Val
public void groupBy(Select sel, ExpContext ctx, ExpState state)
Val
groupBy
in interface Val
public void orderBy(Select sel, ExpContext ctx, ExpState state, boolean asc)
Val
orderBy
in interface Val
public Object load(ExpContext ctx, ExpState state, Result res) throws SQLException
Val
load
in interface Val
SQLException
public int length(Select sel, ExpContext ctx, ExpState state)
Val
length
in interface Val
public void appendIsEmpty(Select sel, ExpContext ctx, ExpState state, SQLBuffer sql)
Val
appendIsEmpty
in interface Val
public void appendIsNotEmpty(Select sel, ExpContext ctx, ExpState state, SQLBuffer sql)
Val
appendIsNotEmpty
in interface Val
public void appendSize(Select sel, ExpContext ctx, ExpState state, SQLBuffer sql)
Val
appendSize
in interface Val
public void appendIsNull(Select sel, ExpContext ctx, ExpState state, SQLBuffer sql)
Val
appendIsNull
in interface Val
public void appendIsNotNull(Select sel, ExpContext ctx, ExpState state, SQLBuffer sql)
Val
appendIsNotNull
in interface Val
public boolean isVariable()
Value
isVariable
in interface Value
public boolean isAggregate()
Value
isAggregate
in interface Value
public boolean isXPath()
Value
isXPath
in interface Value
public Object toDataStoreValue(Select sel, ExpContext ctx, ExpState state, Object val)
Val
toDataStoreValue
in interface Val
public void acceptVisit(ExpressionVisitor visitor)
Value
acceptVisit
in interface Value
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |