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

java.lang.Object
  org.apache.openjpa.jdbc.kernel.exps.AbstractVal
      org.apache.openjpa.jdbc.kernel.exps.MapKey

All Implemented Interfaces:

Serializable, Val, Value

public class MapKey
extends AbstractVal

Returns the key of a map value.

Since:

2.0.0

Author:

Catalina Wei

See Also:

Serialized Form

Nested Class Summary

static class

MapKey.KeyExpState Expression state.

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

MapKey(Val key)
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.
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.
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.
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 org.apache.openjpa.jdbc.kernel.exps.AbstractVal

acceptVisit, appendIndex, appendIsEmpty, appendIsNotEmpty, appendIsNotNull, appendIsNull, appendSize, appendType, getAlias, getId, getName, getPath, getSelectAs, isAggregate, isVariable, isXPath, setAlias

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MapKey

public MapKey(Val key)

Constructor. Provide the map value to operate on.

Method Detail

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.

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.

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

groupBy

public void groupBy(Select sel,
                    ExpContext ctx,
                    ExpState state)

Description copied from interface: Val

Group by this value.

orderBy

public void orderBy(Select sel,
                    ExpContext ctx,
                    ExpState state,
                    boolean asc)

Description copied from interface: Val

Order by this 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.

length

public int length(Select sel,
                  ExpContext ctx,
                  ExpState state)

Description copied from interface: Val

Return the number of SQL elements in this value.

load

public Object load(ExpContext ctx,
                   ExpState state,
                   Result res)
            throws SQLException

Description copied from interface: Val

Load the data for this value.

Throws:

SQLException

select

public void select(Select sel,
                   ExpContext ctx,
                   ExpState state,
                   boolean pks)

Description copied from interface: Val

Select the data for this value.

selectColumns

public void selectColumns(Select sel,
                          ExpContext ctx,
                          ExpState state,
                          boolean pks)

Description copied from interface: Val

Select just the columns for this value.

getMetaData

public ClassMetaData getMetaData()

Description copied from interface: Value

Return any associated persistent type.

getType

public Class getType()

Description copied from interface: Value

Return the expected type for this value, or Object if the type is unknown.

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().

setMetaData

public void setMetaData(ClassMetaData meta)

Description copied from interface: Value

Associate a persistent type with this value.

toDataStoreValue

public Object toDataStoreValue(Select sel,
                               ExpContext ctx,
                               ExpState state,
                               Object val)

Description copied from interface: Val

Return the datastore value of the given object in the context of this value.

Specified by:

toDataStoreValue in interface Val

Overrides:

toDataStoreValue in class AbstractVal