com.avaje.ebeaninternal.server.query

Class CQuery<T>

java.lang.Object

com.avaje.ebeaninternal.server.query.CQuery<T>

All Implemented Interfaces:

DbReadContext, CancelableQuery

public class CQuery<T>
extends Object
implements DbReadContext, CancelableQuery

An object that represents a SqlSelect statement.

The SqlSelect is based on a tree (Object Graph). The tree is traversed to see what parts are included in the tree according to the value of find.getInclude();

The tree structure is flattened into a SqlSelectChain. The SqlSelectChain is the key object used in reading the flat resultSet back into Objects.

Constructor Summary

Constructors

Constructor and Description
CQuery(OrmQueryRequest<T> request, CQueryPredicates predicates, CQueryPlan queryPlan) Create the Sql select based on the request.

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() Cancel the query.
void	close() Close the resources.
BeanCollection<T>	continueFetchingInBackground()
javax.persistence.PersistenceException	createPersistenceException(SQLException e) Create a PersistenceException including interesting information like the bindLog and sql used.
static javax.persistence.PersistenceException	createPersistenceException(SQLException e, SpiTransaction t, String bindLog, String sql) Create a PersistenceException including interesting information like the bindLog and sql used.
String	getBeanName() Return the short bean name.
String	getBeanType()
String	getBindLog()
DataReader	getDataReader() Return the DataReader.
String	getGeneratedSql() Return the generated sql.
LoadContext	getGraphContext()
T	getLoadedBean() Return the last read bean.
String	getLoadedRowDetail()
String	getLogWhereSql() Return the where predicate for display in the transaction log.
BeanPropertyAssocMany<?>	getManyProperty() Return the property that is associated with the many.
String	getName() Return the query name.
PersistenceContext	getPersistenceContext() Return the persistence context.
CQueryPredicates	getPredicates()
long	getQueryExecutionTimeMicros()
SpiQuery.Mode	getQueryMode() Return the query mode.
SpiOrmQueryRequest<?>	getQueryRequest()
SqlTree	getSqlTree() Return the SqlSelectChain.
String	getSummary() Get the summary of the sql.
SpiTransaction	getTransaction()
protected boolean	hasNextBean(boolean inForeground)
boolean	isAutoFetchProfiling() Should we create profileNodes for beans created in this query.
boolean	isRawSql() Return true if this is a raw sql query as opposed to Ebean generated sql.
Boolean	isReadOnly() Return the state of the object graph.
boolean	prepareBindExecuteQuery() Prepare bind and execute the query normally.
boolean	prepareBindExecuteQueryForwardOnly(boolean dbPlatformForwardOnlyHint) Prepare bind and execute query with Forward only hints.
void	profileBean(EntityBeanIntercept ebi, String prefix) Add autoFetch profiling for a loaded entity bean.
void	propagateState(Object e) Propagate the state to the bean.
boolean	readBean()
BeanCollection<T>	readCollection()
QueryIterator<T>	readIterate(int bufferSize, OrmQueryRequest<T> request)
void	register(String path, BeanCollection<?> bc) Register a collection for lazy loading.
void	register(String path, EntityBeanIntercept ebi) Register a reference for lazy loading.
void	setCurrentPrefix(String currentPrefix, Map<String,String> currentPathMap) Set the JoinNode - used by proxy/reference beans for profiling.
void	setLoadedBean(Object bean, Object id, Object lazyLoadParentId) Set back the bean that has just been loaded with its id.
void	setLoadedManyBean(Object manyValue) Set back the 'detail' bean that has just been loaded.
protected void	updateExecutionStatistics()
boolean	useBackgroundToContinueFetch()

Methods inherited from class java.lang.Object

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

Constructor Detail

CQuery

public CQuery(OrmQueryRequest<T> request,
      CQueryPredicates predicates,
      CQueryPlan queryPlan)

Create the Sql select based on the request.

Method Detail

isReadOnly

public Boolean isReadOnly()

Description copied from interface: DbReadContext

Return the state of the object graph.

Specified by:

isReadOnly in interface DbReadContext

propagateState

public void propagateState(Object e)

Description copied from interface: DbReadContext

Propagate the state to the bean.

Specified by:

propagateState in interface DbReadContext

getDataReader

public DataReader getDataReader()

Description copied from interface: DbReadContext

Return the DataReader.

Specified by:

getDataReader in interface DbReadContext

getQueryMode

public SpiQuery.Mode getQueryMode()

Description copied from interface: DbReadContext

Return the query mode.

Specified by:

getQueryMode in interface DbReadContext

getPredicates

public CQueryPredicates getPredicates()

getGraphContext

public LoadContext getGraphContext()

getQueryRequest

public SpiOrmQueryRequest<?> getQueryRequest()

cancel

public void cancel()

Description copied from interface: CancelableQuery

Cancel the query.

For JDBC this translates to calling cancel on the PreparedStatement.

Specified by:

cancel in interface CancelableQuery

prepareBindExecuteQueryForwardOnly

public boolean prepareBindExecuteQueryForwardOnly(boolean dbPlatformForwardOnlyHint)
                                           throws SQLException

Prepare bind and execute query with Forward only hints.

Throws:

SQLException

prepareBindExecuteQuery

public boolean prepareBindExecuteQuery()
                                throws SQLException

Prepare bind and execute the query normally.

Throws:

SQLException

close

public void close()

Close the resources.

The jdbc resultSet and statement need to be closed. Its important that this method is called.

getPersistenceContext

public PersistenceContext getPersistenceContext()

Return the persistence context.

Specified by:

getPersistenceContext in interface DbReadContext

setLoadedBean

public void setLoadedBean(Object bean,
                 Object id,
                 Object lazyLoadParentId)

Description copied from interface: DbReadContext

Set back the bean that has just been loaded with its id.

Specified by:

setLoadedBean in interface DbReadContext

setLoadedManyBean

public void setLoadedManyBean(Object manyValue)

Description copied from interface: DbReadContext

Set back the 'detail' bean that has just been loaded.

Specified by:

setLoadedManyBean in interface DbReadContext

getLoadedBean

public T getLoadedBean()

Return the last read bean.

getQueryExecutionTimeMicros

public long getQueryExecutionTimeMicros()

readBean

public boolean readBean()
                 throws SQLException

Throws:

SQLException

continueFetchingInBackground

public BeanCollection<T> continueFetchingInBackground()
                                               throws SQLException

Throws:

SQLException

readCollection

public BeanCollection<T> readCollection()
                                 throws SQLException

Throws:

SQLException

updateExecutionStatistics

protected void updateExecutionStatistics()

readIterate

public QueryIterator<T> readIterate(int bufferSize,
                           OrmQueryRequest<T> request)

hasNextBean

protected boolean hasNextBean(boolean inForeground)
                       throws SQLException

Throws:

SQLException

getLoadedRowDetail

public String getLoadedRowDetail()

register

public void register(String path,
            EntityBeanIntercept ebi)

Description copied from interface: DbReadContext

Register a reference for lazy loading.

Specified by:

register in interface DbReadContext

register

public void register(String path,
            BeanCollection<?> bc)

Description copied from interface: DbReadContext

Register a collection for lazy loading.

Specified by:

register in interface DbReadContext

useBackgroundToContinueFetch

public boolean useBackgroundToContinueFetch()

getName

public String getName()

Return the query name.

isRawSql

public boolean isRawSql()

Return true if this is a raw sql query as opposed to Ebean generated sql.

Specified by:

isRawSql in interface DbReadContext

getLogWhereSql

public String getLogWhereSql()

Return the where predicate for display in the transaction log.

getManyProperty

public BeanPropertyAssocMany<?> getManyProperty()

Return the property that is associated with the many. There can only be one per SqlSelect. This can be null.

Specified by:

getManyProperty in interface DbReadContext

getSummary

public String getSummary()

Get the summary of the sql.

getSqlTree

public SqlTree getSqlTree()

Return the SqlSelectChain. This is the flattened structure that represents this query.

getBindLog

public String getBindLog()

getTransaction

public SpiTransaction getTransaction()

getBeanType

public String getBeanType()

getBeanName

public String getBeanName()

Return the short bean name.

getGeneratedSql

public String getGeneratedSql()

Return the generated sql.

createPersistenceException

public javax.persistence.PersistenceException createPersistenceException(SQLException e)

Create a PersistenceException including interesting information like the bindLog and sql used.

createPersistenceException

public static javax.persistence.PersistenceException createPersistenceException(SQLException e,
                                                                SpiTransaction t,
                                                                String bindLog,
                                                                String sql)

Create a PersistenceException including interesting information like the bindLog and sql used.

isAutoFetchProfiling

public boolean isAutoFetchProfiling()

Should we create profileNodes for beans created in this query.

This is true for all queries except lazy load bean queries.

Specified by:

isAutoFetchProfiling in interface DbReadContext

profileBean

public void profileBean(EntityBeanIntercept ebi,
               String prefix)

Description copied from interface: DbReadContext

Add autoFetch profiling for a loaded entity bean.

Specified by:

profileBean in interface DbReadContext

setCurrentPrefix

public void setCurrentPrefix(String currentPrefix,
                    Map<String,String> currentPathMap)

Description copied from interface: DbReadContext

Set the JoinNode - used by proxy/reference beans for profiling.

Specified by:

setCurrentPrefix in interface DbReadContext