com.avaje.ebeaninternal.api

Interface SpiExpression

All Superinterfaces:

Expression, Serializable

All Known Implementing Classes:

AbstractExpression, DefaultExampleExpression, IdInExpression, SimpleExpression

public interface SpiExpression
extends Expression

An expression that becomes part of a Where clause or Having clause.

Method Summary

Methods

Modifier and Type	Method and Description
void	addBindValues(SpiExpressionRequest request) Add the parameter values to be set against query.
void	addSql(SpiExpressionRequest request) Add some sql to the query.
void	containsMany(BeanDescriptor<?> desc, ManyWhereJoins whereManyJoins) Process "Many" properties populating ManyWhereJoins.
void	queryAutoFetchHash(HashQueryPlanBuilder builder) Calculate a hash value used to identify a query for AutoFetch tuning.
int	queryBindHash() Return the hash value for the values that will be bound.
void	queryPlanHash(BeanQueryRequest<?> request, HashQueryPlanBuilder builder) Calculate a hash value for the expression.

Method Detail

containsMany

void containsMany(BeanDescriptor<?> desc,
                ManyWhereJoins whereManyJoins)

Process "Many" properties populating ManyWhereJoins.

Predicates on Many properties require an extra independent join clause.

queryAutoFetchHash

void queryAutoFetchHash(HashQueryPlanBuilder builder)

Calculate a hash value used to identify a query for AutoFetch tuning.

That is, if the hash changes then the query will be considered different from an AutoFetch perspective and get different tuning.

queryPlanHash

void queryPlanHash(BeanQueryRequest<?> request,
                 HashQueryPlanBuilder builder)

Calculate a hash value for the expression. This includes the expression type and property but should exclude the bind values.

This is used where queries are the same except for the bind values, in which case the query execution plan can be reused.

queryBindHash

int queryBindHash()

Return the hash value for the values that will be bound.

addSql

void addSql(SpiExpressionRequest request)

Add some sql to the query.

This will contain ? as a place holder for each associated bind values.

The 'sql' added to the query can contain object property names rather than db tables and columns. This 'sql' is later parsed converting the logical property names to their full database column names.

Parameters:

request - the associated request.

addBindValues

void addBindValues(SpiExpressionRequest request)

Add the parameter values to be set against query. For each ? place holder there should be a corresponding value that is added to the bindList.

Parameters:

request - the associated request.