com.avaje.ebeaninternal.server.core

Class OrmQueryRequest<T>

java.lang.Object

com.avaje.ebeaninternal.server.core.BeanRequest

com.avaje.ebeaninternal.server.core.OrmQueryRequest<T>

All Implemented Interfaces:

BeanQueryRequest<T>, SpiOrmQueryRequest<T>

public final class OrmQueryRequest<T>
extends BeanRequest
implements BeanQueryRequest<T>, SpiOrmQueryRequest<T>

Wraps the objects involved in executing a Query.

Constructor Summary

Constructors

Constructor and Description
OrmQueryRequest(SpiEbeanServer server, OrmQueryEngine queryEngine, SpiQuery<T> query, BeanDescriptor<T> desc, SpiTransaction t) Create the InternalQueryRequest.

Method Summary

Methods

Modifier and Type	Method and Description
void	calculateQueryPlanHash() Calculate the query plan hash AFTER any potential AutoFetch tuning.
DeployParser	createDeployParser()
void	endTransIfRequired() Will end a locally created transaction.
void	executeSecondaryQueries(int defaultQueryBatch)
Object	findId() Execute the query as findById.
List<Object>	findIds() Execute the find ids query.
QueryIterator<T>	findIterate() Execute the find returning a QueryIterator.
List<T>	findList() Execute the query as findList.
Map<?,?>	findMap() Execute the query as findMap.
int	findRowCount() Execute the find row count query.
Set<?>	findSet() Execute the query as findSet.
void	findVisit(QueryResultVisitor<T> visitor) Execute the find returning a QueryIterator and visitor pattern.
void	flushPersistenceContextOnIterate()
BeanDescriptor<T>	getBeanDescriptor() Return the BeanDescriptor for the associated bean.
BeanFinder<T>	getBeanFinder() Return a bean specific finder if one has been set.
BeanCollection<T>	getFromQueryCache() Try to get the query result from the query cache.
LoadContext	getGraphContext() Return the graph context for this query.
BeanPropertyAssocMany<?>	getManyProperty() Return the many property that is fetched in the query or null if there is not one.
PersistenceContext	getPersistenceContext() Return the PersistenceContext used for this request.
SpiQuery<T>	getQuery() Return the find that is to be performed.
CQueryPlan	getQueryPlan() Return a queryPlan for the current query if one exists.
HashQueryPlan	getQueryPlanHash() Return the queryPlanHash.
SpiQuery.Type	getQueryType()
int	getSecondaryQueriesMinBatchSize(int defaultQueryBatch) For use with QueryIterator and secondary queries this returns the minimum batch size that should be loaded before executing the secondary queries.
void	initTransIfRequired() This will create a local (readOnly) transaction if no current transaction exists.
boolean	isFindById() Return true if this is a find by id (rather than List Set or Map).
boolean	isRawSql()
Boolean	isReadOnly() Return the Normal, sharedInstance, ReadOnly state of this query.
boolean	isSqlSelect() Return true if this is a query using generated sql.
boolean	isUseBeanCache()
void	logSql(String sql) Log the SQL if the logLevel is appropriate.
void	putQueryPlan(CQueryPlan queryPlan) Put the QueryPlan into the cache.
void	putToQueryCache(BeanCollection<T> queryResult)
void	setBackgroundFetching() This query is using background fetching.
void	setCancelableQuery(CancelableQuery cancelableQuery) Set an Query object that owns the PreparedStatement that can be cancelled.

Methods inherited from class com.avaje.ebeaninternal.server.core.BeanRequest

commitTransIfRequired, createImplicitTransIfRequired, getConnection, getEbeanServer, getServer, getTransaction, isLogSql, isLogSummary, rollbackTransIfRequired

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.avaje.ebean.event.BeanQueryRequest

getEbeanServer, getTransaction

Methods inherited from interface com.avaje.ebeaninternal.server.core.SpiOrmQueryRequest

rollbackTransIfRequired

Constructor Detail

OrmQueryRequest

public OrmQueryRequest(SpiEbeanServer server,
               OrmQueryEngine queryEngine,
               SpiQuery<T> query,
               BeanDescriptor<T> desc,
               SpiTransaction t)

Create the InternalQueryRequest.

Method Detail

executeSecondaryQueries

public void executeSecondaryQueries(int defaultQueryBatch)

getSecondaryQueriesMinBatchSize

public int getSecondaryQueriesMinBatchSize(int defaultQueryBatch)

For use with QueryIterator and secondary queries this returns the minimum batch size that should be loaded before executing the secondary queries.

If -1 is returned then NO secondary queries are registered and simple iteration is fine.

isReadOnly

public Boolean isReadOnly()

Return the Normal, sharedInstance, ReadOnly state of this query.

getBeanDescriptor

public BeanDescriptor<T> getBeanDescriptor()

Return the BeanDescriptor for the associated bean.

Specified by:

getBeanDescriptor in interface SpiOrmQueryRequest<T>

getGraphContext

public LoadContext getGraphContext()

Return the graph context for this query.

calculateQueryPlanHash

public void calculateQueryPlanHash()

Calculate the query plan hash AFTER any potential AutoFetch tuning.

isRawSql

public boolean isRawSql()

createDeployParser

public DeployParser createDeployParser()

isSqlSelect

public boolean isSqlSelect()

Return true if this is a query using generated sql. If false this query will use raw sql (Entity bean based on raw sql select).

getPersistenceContext

public PersistenceContext getPersistenceContext()

Return the PersistenceContext used for this request.

initTransIfRequired

public void initTransIfRequired()

This will create a local (readOnly) transaction if no current transaction exists.

A transaction may have been passed in explicitly or currently be active in the thread local. If not, then a readOnly transaction is created to execute this query.

Specified by:

initTransIfRequired in interface SpiOrmQueryRequest<T>

Specified by:

initTransIfRequired in class BeanRequest

endTransIfRequired

public void endTransIfRequired()

Will end a locally created transaction.

It ends the transaction by using a rollback() as the transaction is known to be readOnly.

Specified by:

endTransIfRequired in interface SpiOrmQueryRequest<T>

setBackgroundFetching

public void setBackgroundFetching()

This query is using background fetching.

isFindById

public boolean isFindById()

Return true if this is a find by id (rather than List Set or Map).

findId

public Object findId()

Execute the query as findById.

Specified by:

findId in interface SpiOrmQueryRequest<T>

findRowCount

public int findRowCount()

Description copied from interface: SpiOrmQueryRequest

Execute the find row count query.

Specified by:

findRowCount in interface SpiOrmQueryRequest<T>

findIds

public List<Object> findIds()

Description copied from interface: SpiOrmQueryRequest

Execute the find ids query.

Specified by:

findIds in interface SpiOrmQueryRequest<T>

findVisit

public void findVisit(QueryResultVisitor<T> visitor)

Description copied from interface: SpiOrmQueryRequest

Execute the find returning a QueryIterator and visitor pattern.

Specified by:

findVisit in interface SpiOrmQueryRequest<T>

findIterate

public QueryIterator<T> findIterate()

Description copied from interface: SpiOrmQueryRequest

Execute the find returning a QueryIterator.

Specified by:

findIterate in interface SpiOrmQueryRequest<T>

findList

public List<T> findList()

Execute the query as findList.

Specified by:

findList in interface SpiOrmQueryRequest<T>

findSet

public Set<?> findSet()

Execute the query as findSet.

Specified by:

findSet in interface SpiOrmQueryRequest<T>

findMap

public Map<?,?> findMap()

Execute the query as findMap.

Specified by:

findMap in interface SpiOrmQueryRequest<T>

getQueryType

public SpiQuery.Type getQueryType()

getBeanFinder

public BeanFinder<T> getBeanFinder()

Return a bean specific finder if one has been set.

getQuery

public SpiQuery<T> getQuery()

Return the find that is to be performed.

Specified by:

getQuery in interface BeanQueryRequest<T>

Specified by:

getQuery in interface SpiOrmQueryRequest<T>

getManyProperty

public BeanPropertyAssocMany<?> getManyProperty()

Return the many property that is fetched in the query or null if there is not one.

getQueryPlan

public CQueryPlan getQueryPlan()

Return a queryPlan for the current query if one exists. Returns null if no query plan for this query exists.

getQueryPlanHash

public HashQueryPlan getQueryPlanHash()

Return the queryPlanHash.

This identifies the query plan for a given bean type. It effectively matches a SQL statement with ? bind variables. A query plan can be reused with just the bind variables changing.

putQueryPlan

public void putQueryPlan(CQueryPlan queryPlan)

Put the QueryPlan into the cache.

isUseBeanCache

public boolean isUseBeanCache()

getFromQueryCache

public BeanCollection<T> getFromQueryCache()

Try to get the query result from the query cache.

Specified by:

getFromQueryCache in interface SpiOrmQueryRequest<T>

putToQueryCache

public void putToQueryCache(BeanCollection<T> queryResult)

setCancelableQuery

public void setCancelableQuery(CancelableQuery cancelableQuery)

Set an Query object that owns the PreparedStatement that can be cancelled.

logSql

public void logSql(String sql)

Log the SQL if the logLevel is appropriate.

flushPersistenceContextOnIterate

public void flushPersistenceContextOnIterate()