org.apache.openjpa.jdbc.kernel.exps
Interface Val

All Superinterfaces:

Value

All Known Implementing Classes:

Args, Lit, Param

public interface Val
extends Value

A Value represents any non-operator in a query filter, including constants, variables, and object fields.

Author:

Abe White

Field Summary

static int	FORCE_OUTER Initialization flag indicating to force an outer join into any relation path.
static int	JOIN_REL Initialization flag indicating to join into any relation path.
static int	NULL_CMP Initialization flag indicating that this value will be compared to null.

Method Summary

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 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.
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.
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 interface org.apache.openjpa.kernel.exps.Value

acceptVisit, getMetaData, getType, isAggregate, isVariable, isXPath, setImplicitType, setMetaData

Field Detail

NULL_CMP

static final int NULL_CMP

Initialization flag indicating that this value will be compared to null.

See Also:

Constant Field Values

JOIN_REL

static final int JOIN_REL

Initialization flag indicating to join into any relation path.

See Also:

Constant Field Values

FORCE_OUTER

static final int FORCE_OUTER

Initialization flag indicating to force an outer join into any relation path.

See Also:

Constant Field Values

Method Detail

initialize

ExpState initialize(Select sel,
                    ExpContext ctx,
                    int flags)

Initialize the value. This method should recursively initialize any sub-values.

toDataStoreValue

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

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

select

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

Select the data for this value.

selectColumns

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

Select just the columns for this value.

groupBy

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

Group by this value.

orderBy

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

Order by this value.

load

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

Load the data for this value.

Throws:

SQLException

calculateValue

void calculateValue(Select sel,
                    ExpContext ctx,
                    ExpState state,
                    Val other,
                    ExpState otherState)

Calculate and cache the SQL for this value. This method is called before length or any append methods.

Parameters:

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

length

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

Return the number of SQL elements in this value.

appendTo

void appendTo(Select sel,
              ExpContext ctx,
              ExpState state,
              SQLBuffer sql,
              int index)

Append the indexth SQL element to the given buffer.

appendIsEmpty

void appendIsEmpty(Select sel,
                   ExpContext ctx,
                   ExpState state,
                   SQLBuffer sql)

Append the SQL testing whether this value is empty to the given buffer.

appendIsNotEmpty

void appendIsNotEmpty(Select sel,
                      ExpContext ctx,
                      ExpState state,
                      SQLBuffer sql)

Append the SQL testing whether this value is not empty to the given buffer.

appendSize

void appendSize(Select sel,
                ExpContext ctx,
                ExpState state,
                SQLBuffer sql)

Append the SQL checking the size of this value.

appendIsNull

void appendIsNull(Select sel,
                  ExpContext ctx,
                  ExpState state,
                  SQLBuffer sql)

Append the SQL testing whether this value is null to the given buffer.

appendIsNotNull

void appendIsNotNull(Select sel,
                     ExpContext ctx,
                     ExpState state,
                     SQLBuffer sql)

Append the SQL testing whether this value is not null to the given buffer.