Module io.ebean.core

Package io.ebeaninternal.server.querydefn

Class DefaultOrmQuery<T>

java.lang.Object

io.ebeaninternal.server.querydefn.AbstractQuery

io.ebeaninternal.server.querydefn.DefaultOrmQuery<T>

All Implemented Interfaces:

CancelableQuery, Query<T>, QueryBuilder<Query<T>,T>, QueryBuilderProjection<Query<T>,T>, SpiCancelableQuery, SpiQuery<T>, SpiQueryFetch, TxnProfileEventCodes

@NonNullApi
public class DefaultOrmQuery<T>
extends AbstractQuery
implements SpiQuery<T>

Default implementation of an Object Relational query.

Nested Class Summary

Nested classes/interfaces inherited from interface io.ebean.Query

Query.LockType, Query.LockWait, Query.Property<T>

Nested classes/interfaces inherited from interface io.ebeaninternal.api.SpiQuery

SpiQuery.Mode, SpiQuery.TemporalMode, SpiQuery.Type

Field Summary

Fields inherited from class io.ebeaninternal.server.querydefn.AbstractQuery

useMaster

Fields inherited from interface io.ebeaninternal.api.TxnProfileEventCodes

EVT_CALLABLESQL, EVT_COMMIT, EVT_DELETE, EVT_DELETE_PERMANENT, EVT_DELETE_SOFT, EVT_INSERT, EVT_ORMUPDATE, EVT_ROLLBACK, EVT_UPDATE, EVT_UPDATESQL, FIND_ATTRIBUTE, FIND_ATTRIBUTE_SET, FIND_COUNT, FIND_DELETE, FIND_EXISTS, FIND_ID_LIST, FIND_ITERATE, FIND_MANY, FIND_MANY_LAZY, FIND_ONE, FIND_ONE_LAZY, FIND_SUBQUERY, FIND_UPDATE

Constructor Summary

Constructors

Constructor	Description
DefaultOrmQuery(BeanDescriptor<T> desc, SpiEbeanServer server, ExpressionFactory expressionFactory)

Method Summary

Modifier and Type	Method	Description
final void	addNested(String name, OrmQueryDetail nestedDetail, FetchConfig config)	Add a nested fetch graph.
final void	addSoftDeletePredicate(String softDeletePredicate)
final String	alias()	Return root table alias set by QueryBuilder.alias(String) command.
final Query<T>	alias(String alias)
Query<T>	alsoIf(BooleanSupplier predicate, Consumer<Query<T>> consumer)
final Query<T>	apply(FetchPath fetchPath)
final <D> DtoQuery<D>	asDto(Class<D> dtoClass)
final Query<T>	asOf(Timestamp asOfDateTime)
final UpdateQuery<T>	asUpdate()
final String	baseTable()	Return the base table to use if user defined on the query.
final CacheMode	beanCacheMode()	Return the cache mode for using the bean cache (Get and Put).
final BindParams	bindParams()	Return the bind parameters.
final int	bufferFetchSizeHint()	Return the hint for Statement.setFetchSize().
final CacheIdLookup<T>	cacheIdLookup()	Bean cache lookup for find by ids.
final void	checkNamedParameters()	Check that the named parameters have had their values set.
final boolean	checkPagingOrderBy()	Return true if the query should have an order by appended automatically.
final SpiQuerySecondary	convertJoins()	Convert joins as necessary to query joins etc.
SpiQuery<T>	copy()	Return a copy of the query.
SpiQuery<T>	copy(SpiEbeanServer server)	Return a copy of the query attaching to a different EbeanServer.
final CountDistinctOrder	countDistinctOrder()	Returns the count distinct order setting.
final SpiNamedParam	createNamedParameter(String name)	Create a named parameter placeholder.
final int	delete()
final int	delete(Transaction transaction)
final BeanDescriptor<T>	descriptor()	Return the bean descriptor for this query.
final OrmQueryDetail	detail()	Return the query detail.
String	distinctOn()	Return the distinct on clause.
final Query<T>	distinctOn(String distinctOn)
final boolean	exists()
final Query<T>	fetch(String path)
final Query<T>	fetch(String path, FetchConfig joinConfig)
final Query<T>	fetch(String path, String properties)
final Query<T>	fetch(String path, String properties, FetchConfig config)
final Query<T>	fetchCache(String path)
final Query<T>	fetchCache(String path, String properties)
final Query<T>	fetchLazy(String path)
final Query<T>	fetchLazy(String path, String properties)
final void	fetchProperties(String path, OrmQueryProperties other)	Set the fetch properties for the given path.
final void	fetchProperties(String property, Set<String> columns, FetchConfig config)	Specify the fetch properties for the given path.
final Query<T>	fetchQuery(String path)
final Query<T>	fetchQuery(String path, String properties)
final ExpressionList<T>	filterMany(String prop)
final int	findCount()
final void	findEach(int batch, Consumer<List<T>> consumer)
final void	findEach(Consumer<T> consumer)
final void	findEachWhile(Predicate<T> consumer)
final FutureRowCount<T>	findFutureCount()
final FutureIds<T>	findFutureIds()
final FutureList<T>	findFutureList()
final <A> List<A>	findIds()
final QueryIterator<T>	findIterate()
final List<T>	findList()
final <K> Map<K,T>	findMap()
final T	findOne()
final Optional<T>	findOneOrEmpty()
final PagedList<T>	findPagedList()
final Set<T>	findSet()
final <A> A	findSingleAttribute()
final <A> List<A>	findSingleAttributeList()
final <A> Optional<A>	findSingleAttributeOrEmpty()
final <A> Set<A>	findSingleAttributeSet()
final Stream<T>	findStream()
final List<Version<T>>	findVersions()
final List<Version<T>>	findVersionsBetween(Timestamp start, Timestamp end)
final Query<T>	forUpdate()
final Query<T>	forUpdateNoWait()
final Query<T>	forUpdateSkipLocked()
final String	getAlias(String defaultAlias)	Return root table alias with default option.
final Timestamp	getAsOf()	Return the asOf Timestamp which the query should run as.
final int	getAsOfTableCount()	Return the table alias used for the base table.
final Class<T>	getBeanType()
final ExpressionFactory	getExpressionFactory()
final int	getFirstRow()	Return the index of the first row to return in the query.
final Query.LockType	getForUpdateLockType()
final Query.LockWait	getForUpdateLockWait()	Return the ForUpdate mode.
final String	getGeneratedSql()
final Object	getId()
final int	getMaxRows()	Return the maximum number of rows to return in the query.
final OrderBy<T>	getOrderBy()	Return the Order By clause or null if there is none defined.
final String	getOriginKey()	Return the origin key.
final QueryType	getQueryType()
final void	handleLoadError(String fullName, Exception e)	Handles load errors.
final boolean	hasMaxRowsOrFirstRow()	Returns true if either firstRow or maxRows has been set.
final ExpressionList<T>	having()
final Query<T>	having(Expression expression)
final SpiExpressionList<T>	havingExpressions()	Can return null if no expressions where added to the having clause.
final String	hint()	Return the SQL hint to include in the query.
final void	incrementAsOfTableCount()	Increment the counter of tables used in 'As Of' query.
final void	incrementAsOfTableCount(int increment)	Increment the counter of tables used in 'As Of' query.
BindParams	initBindParams()	Return the bind parameters ensuring it is initialised.
final boolean	isAsOfBaseTable()	Return true if the base table is using history.
final boolean	isAsOfQuery()	Return true if this is a 'As Of' query.
final boolean	isAutoTunable()	Return true if AutoTune should be attempted on this query.
final Boolean	isAutoTune()	Return explicit AutoTune setting or null.
final boolean	isAutoTuned()
final boolean	isBeanCacheGet()	Return true if the query should GET against bean cache.
final boolean	isBeanCachePut()	Return true if the query should PUT against the bean cache.
final boolean	isCountDistinct()
final boolean	isDetailEmpty()	Return true if the query detail has neither select or joins specified.
final boolean	isDisableLazyLoading()	Return true if lazy loading has been disabled on the query.
final boolean	isDistinct()	return true if user specified to use SQL DISTINCT (effectively excludes id property).
final boolean	isFindAll()	Return true if this is a "find all" query.
final boolean	isFindById()	Return true if this is a "find by id" query.
final boolean	isForceHitDatabase()	Return true if we must hit the DB (Cache reload or select for update).
final boolean	isForUpdate()
final boolean	isIncludeSoftDeletes()	Return true if this query includes soft deleted rows.
final boolean	isManualId()	Return true if the Id property is manually included in the query (DTO queries).
final boolean	isNativeSql()	Return true if this is a native sql query.
final boolean	isRawSql()	Return true if this is a RawSql query.
final Boolean	isReadOnly()	Return true if the beans returned by this query should be read only.
final boolean	isSingleAttribute()	Return true if this is a single attribute query.
final boolean	isUsageProfiling()	Return false when this is a lazy load or refresh query for a bean.
boolean	isUseMaster()	Return true if this query should not use the read only data source.
final boolean	isUsingFuture()	Return true if this is a future query.
final boolean	isVersionsBetween()	Return true if this is a find versions between query.
final boolean	isWithId()	Return true if the query should include the Id property.
final String	label()	Return the label set on the query.
final int	lazyLoadBatchSize()	Return the default lazy load batch size.
final BeanPropertyAssocMany<?>	lazyLoadMany()	Return the lazy loading 'many' property.
final String	lazyLoadProperty()	Return the property that invoked lazy load.
final String	loadDescription()	Return a more detailed description of the lazy or query load.
final String	loadMode()	Return the load mode (+lazy or +query).
final TableJoin	m2mIncludeJoin()	Return the extra join for a M2M lazy load.
final ManyWhereJoins	manyWhereJoins()	Return the extra joins required to support the where clause for 'Many' properties.
final String	mapKey()	Return the property used to specify keys for a map.
final SpiQuery.Mode	mode()	Return the query mode.
final String	nativeSql()	Return the unmodified native sql query (with named params etc).
final NaturalKeyQueryData<T>	naturalKey()	Collect natural key data for this query or null if the query does not match the requirements of natural key lookup.
final NaturalKeyBindParam	naturalKeyBindParam()	Return a Natural Key bind parameter if supported by this query.
final OrderBy<T>	orderBy()
final Query<T>	orderBy(String orderByClause)
final Query<T>	orderById(boolean orderById)
final boolean	orderByIsEmpty()	Return true if there is no Order By clause.
final ObjectGraphNode	parentNode()	Used to hook back a lazy loading query to the original query (query point).
final PersistenceContext	persistenceContext()	Return the TransactionContext.
final PersistenceContextScope	persistenceContextScope()	Return the PersistenceContextScope that this query should use.
final String	planLabel()	Return the label manually set on the query or from the profile location.
final CQueryPlanKey	prepare(SpiOrmQueryRequest<T> request)	Prepare the query which prepares any expressions (sub-query expressions etc) and calculates the query plan key.
final String	profileEventId()	Return the profile event id based on query mode and type.
final String	profileId()	Return the id used to identify a particular query for the given bean type.
final ProfileLocation	profileLocation()	Return the profile location for this query.
final ProfilingListener	profilingListener()	If return null then no profiling for this query.
final void	queryBindKey(BindValuesKey key)	Build the key for the bind values used in the query (for l2 query cache).
final CacheMode	queryCacheMode()	Return the cache mode if this query should use/check the query cache.
final HashQuery	queryHash()	Return a hash that includes the query plan and bind values.
final Object	queryPlanKey()	Return the query plan key.
final SpiRawSql	rawSql()	Return the RawSql that was set to use for this query.
final void	resetBeanCacheAutoMode(boolean findOne)	Reset AUTO mode to OFF for findList().
final Query<T>	select(FetchGroup<T> fetchGroup)
final Query<T>	select(String columns)
final void	selectAllForLazyLoadProperty()	Return true if select all properties was used to ensure the property invoking a lazy load was included in the query.
final void	selectProperties(OrmQueryProperties properties)	Set the select properties.
final void	selectProperties(Set<String> props)	Specify the select properties.
final Query<T>	setAllowLoadErrors()
final void	setArrayParameter(String name, Collection<?> values)	Bind the named multi-value array parameter which we would use with Postgres ANY.
final void	setAsOfBaseTable()	Set when the base table is using history.
final Query<T>	setAutoTune(boolean autoTune)
final void	setAutoTuned(boolean autoTuned)	Set to true if this query has been tuned by autoTune.
final Query<T>	setBaseTable(String baseTable)
final Query<T>	setBeanCacheMode(CacheMode beanCacheMode)
final Query<T>	setBufferFetchSizeHint(int bufferFetchSizeHint)
final Query<T>	setCountDistinct(CountDistinctOrder countDistinctOrder)
final void	setDefaultFetchBuffer(int fetchSize)	Set the JDBC fetchSize buffer hint if not explicitly set.
final void	setDefaultSelectClause()	Set default select clauses where none have been explicitly defined.
final CQueryPlanKey	setDeleteByIdsPlan()	Set the query to be delete by ids due to cascading delete.
final void	setDetail(OrmQueryDetail detail)	Replace the query detail.
final Query<T>	setDisableLazyLoading(boolean disableLazyLoading)
final Query<T>	setDistinct(boolean distinct)	Internally set to use SQL DISTINCT on the query but still have id property included.
final void	setFilterMany(String prop, ExpressionList<?> filterMany)	Set a filter to a join path.
final Query<T>	setFirstRow(int firstRow)
final void	setGeneratedSql(String generatedSql)	Set the generated sql for debug purposes.
final Query<T>	setHint(String hint)
final Query<T>	setId(Object id)
final Query<T>	setIncludeSoftDeletes()
final Query<T>	setLabel(String label)
final Query<T>	setLazyLoadBatchSize(int lazyLoadBatchSize)
final void	setLazyLoadForParents(BeanPropertyAssocMany<?> many)	This becomes a lazy loading query for a many relationship.
final void	setLazyLoadManyPath(String lazyLoadManyPath)	Set the path of the many when +query/+lazy loading query is executed.
final void	setLazyLoadProperty(String lazyLoadProperty)	Set the property that invoked the lazy load and MUST be included in the lazy loading query.
final void	setLoadDescription(String loadMode, String loadDescription)	Set the load mode (+lazy or +query) and the load description.
final void	setM2MIncludeJoin(TableJoin m2mIncludeJoin)	Set the extra join for a M2M lazy load.
final void	setManualId()	Set to true when we only include the Id property if it is explicitly included in the select().
final Query<T>	setMapKey(String mapKey)
final Query<T>	setMaxRows(int maxRows)
final void	setMode(SpiQuery.Mode mode)	Set the query mode.
final void	setNativeSql(String nativeSql)
final Query<T>	setOrderBy(OrderBy<T> orderBy)
final ObjectGraphNode	setOrigin(CallOrigin callOrigin)	Return the origin point for the query.
final Query<T>	setParameter(int position, Object value)	Set an ordered bind parameter according to its position.
final Query<T>	setParameter(Object value)
final Query<T>	setParameter(String name, Object value)	Set a named bind parameter.
final Query<T>	setParameters(Object... values)
final void	setParentNode(ObjectGraphNode parentNode)	Set the profile point of the bean or collection that is lazy loading.
final void	setPersistenceContext(PersistenceContext persistenceContext)	Set an explicit TransactionContext (typically for a refresh query).
final Query<T>	setPersistenceContextScope(PersistenceContextScope scope)
final Query<T>	setProfileLocation(ProfileLocation profileLocation)
final void	setProfilePath(String label, String relativePath, ProfileLocation profileLocation)	Set the on a secondary query given the label, relativePath and profile location of the parent query.
final void	setProfilingListener(ProfilingListener profilingListener)	This has the effect of turning on profiling for this query.
final Query<T>	setRawSql(RawSql rawSql)
final Query<T>	setReadOnly(boolean readOnly)
final void	setSelectId()	Set the select clause to select the Id property.
final void	setSingleAttribute()	Mark the query as selecting a single attribute.
final void	setTenantId(Object tenantId)	Set the tenantId to use for lazy loading.
final Query<T>	setTimeout(int secs)
final void	setType(SpiQuery.Type type)	Set the query type (List, Set etc).
final void	setupForDeleteOrUpdate()	Setup to be a delete or update query.
final void	setUsageProfiling(boolean usageProfiling)	Set to false if this query should not be included in the AutoTune usage profiling information.
final Query<T>	setUseQueryCache(CacheMode useQueryCache)
final void	simplifyExpressions()	Simplify nested expression lists where possible.
final List<String>	softDeletePredicates()
final SpiQuery.TemporalMode	temporalMode()	Return the Temporal mode for the query.
final Object	tenantId()	Return the tenantId to use for lazy loading.
final int	timeout()	Return the timeout.
final String	toString()
SpiTransaction	transaction()	Return the transaction explicitly assigned or null.
final boolean	tuneFetchProperties(OrmQueryDetail tunedDetail)	AutoTune tune the detail specifying properties to select on already defined joins and adding extra joins where they are missing.
final SpiQuery.Type	type()	Return the type of query (List, Set, Map, Bean, rowCount etc).
final int	update()
final int	update(Transaction transaction)
final OrmUpdateProperties	updateProperties()	Return the properties for an update query.
final Query<T>	usingConnection(Connection connection)
final Query<T>	usingDatabase(Database database)
final void	usingFuture()	Set that this is a future query that will execute in the background.
Query<T>	usingMaster()
final Query<T>	usingTransaction(Transaction transaction)
final Set<String>	validate()
final Set<String>	validate(BeanType<T> desc)	Validate all the expression properties/paths given the bean descriptor.
final Timestamp	versionEnd()	Return the find versions end timestamp.
final Timestamp	versionStart()	Return the find versions start timestamp.
final ExpressionList<T>	where()
final Query<T>	where(Expression expression)
final SpiExpressionList<T>	whereExpressions()	Can return null if no expressions where added to the where clause.
final Query<T>	withLock(Query.LockType lockType)
final Query<T>	withLock(Query.LockType lockType, Query.LockWait lockWait)

Methods inherited from class io.ebeaninternal.server.querydefn.AbstractQuery

cancel, checkCancelled, setCancelableQuery

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.ebean.CancelableQuery

cancel

Methods inherited from interface io.ebean.Query

order, order, setOrder

Methods inherited from interface io.ebean.QueryBuilder

setUseCache, setUseQueryCache

Methods inherited from interface io.ebeaninternal.api.SpiCancelableQuery

checkCancelled, setCancelableQuery

Constructor Details

DefaultOrmQuery

public DefaultOrmQuery(BeanDescriptor<T> desc,
 SpiEbeanServer server,
 ExpressionFactory expressionFactory)

Method Details

setNativeSql

public final void setNativeSql(String nativeSql)

asDto

public final <D> DtoQuery<D> asDto(Class<D> dtoClass)

Specified by:

asDto in interface QueryBuilder<Query<T>,T>

asUpdate

public final UpdateQuery<T> asUpdate()

Specified by:

asUpdate in interface QueryBuilder<Query<T>,T>

descriptor

public final BeanDescriptor<T> descriptor()

Description copied from interface: SpiQuery

Return the bean descriptor for this query.

Specified by:

descriptor in interface SpiQuery<T>

isFindAll

public final boolean isFindAll()

Description copied from interface: SpiQuery

Return true if this is a "find all" query. Used to set a "find all" profile location if necessary.

Specified by:

isFindAll in interface SpiQuery<T>

isFindById

public final boolean isFindById()

Description copied from interface: SpiQuery

Return true if this is a "find by id" query. This includes a check for a single "equal to" expression for the Id.

Specified by:

isFindById in interface SpiQuery<T>

profileEventId

public final String profileEventId()

Description copied from interface: SpiQuery

Return the profile event id based on query mode and type.

Specified by:

profileEventId in interface SpiQuery<T>

profileId

public final String profileId()

Description copied from interface: SpiQuery

Return the id used to identify a particular query for the given bean type.

Specified by:

profileId in interface SpiQuery<T>

setProfileLocation

public final Query<T> setProfileLocation(ProfileLocation profileLocation)

Specified by:

setProfileLocation in interface Query<T>

label

public final String label()

Description copied from interface: SpiQuery

Return the label set on the query.

Specified by:

label in interface SpiQuery<T>

hint

public final String hint()

Description copied from interface: SpiQuery

Return the SQL hint to include in the query.

Specified by:

hint in interface SpiQuery<T>

planLabel

public final String planLabel()

Description copied from interface: SpiQuery

Return the label manually set on the query or from the profile location.

Specified by:

planLabel in interface SpiQuery<T>

setProfilePath

public final void setProfilePath(String label,
 String relativePath,
 @Nullable
 ProfileLocation profileLocation)

Description copied from interface: SpiQuery

Set the on a secondary query given the label, relativePath and profile location of the parent query.

Specified by:

setProfilePath in interface SpiQuery<T>

setLabel

public final Query<T> setLabel(String label)

Specified by:

setLabel in interface QueryBuilder<Query<T>,T>

setHint

public final Query<T> setHint(String hint)

Specified by:

setHint in interface QueryBuilder<Query<T>,T>

isAutoTunable

public final boolean isAutoTunable()

Description copied from interface: SpiQuery

Return true if AutoTune should be attempted on this query.

Specified by:

isAutoTunable in interface SpiQuery<T>

apply

public final Query<T> apply(FetchPath fetchPath)

Specified by:

apply in interface QueryBuilderProjection<Query<T>,T>

alsoIf

public Query<T> alsoIf(BooleanSupplier predicate,
 Consumer<Query<T>> consumer)

Specified by:

alsoIf in interface QueryBuilder<Query<T>,T>

addSoftDeletePredicate

public final void addSoftDeletePredicate(String softDeletePredicate)

Specified by:

addSoftDeletePredicate in interface SpiQuery<T>

softDeletePredicates

public final List<String> softDeletePredicates()

Specified by:

softDeletePredicates in interface SpiQuery<T>

isAsOfBaseTable

public final boolean isAsOfBaseTable()

Description copied from interface: SpiQuery

Return true if the base table is using history.

Specified by:

isAsOfBaseTable in interface SpiQuery<T>

setAsOfBaseTable

public final void setAsOfBaseTable()

Description copied from interface: SpiQuery

Set when the base table is using history.

Specified by:

setAsOfBaseTable in interface SpiQuery<T>

setAllowLoadErrors

public final Query<T> setAllowLoadErrors()

Specified by:

setAllowLoadErrors in interface QueryBuilder<Query<T>,T>

incrementAsOfTableCount

public final void incrementAsOfTableCount()

Description copied from interface: SpiQuery

Increment the counter of tables used in 'As Of' query.

Specified by:

incrementAsOfTableCount in interface SpiQuery<T>

incrementAsOfTableCount

public final void incrementAsOfTableCount(int increment)

Description copied from interface: SpiQuery

Increment the counter of tables used in 'As Of' query.

Specified by:

incrementAsOfTableCount in interface SpiQuery<T>

getAsOfTableCount

public final int getAsOfTableCount()

Description copied from interface: SpiQuery

Return the table alias used for the base table.

Specified by:

getAsOfTableCount in interface SpiQuery<T>

getAsOf

public final Timestamp getAsOf()

Description copied from interface: SpiQuery

Return the asOf Timestamp which the query should run as.

Specified by:

getAsOf in interface SpiQuery<T>

asOf

public final Query<T> asOf(Timestamp asOfDateTime)

Specified by:

asOf in interface QueryBuilder<Query<T>,T>

setIncludeSoftDeletes

public final Query<T> setIncludeSoftDeletes()

Specified by:

setIncludeSoftDeletes in interface QueryBuilder<Query<T>,T>

rawSql

public final SpiRawSql rawSql()

Description copied from interface: SpiQuery

Return the RawSql that was set to use for this query.

Specified by:

rawSql in interface SpiQuery<T>

setRawSql

public final Query<T> setRawSql(RawSql rawSql)

Specified by:

setRawSql in interface QueryBuilder<Query<T>,T>

getOriginKey

public final String getOriginKey()

Description copied from interface: SpiQuery

Return the origin key.

Specified by:

getOriginKey in interface SpiQuery<T>

lazyLoadBatchSize

public final int lazyLoadBatchSize()

Description copied from interface: SpiQuery

Return the default lazy load batch size.

Specified by:

lazyLoadBatchSize in interface SpiQuery<T>

setLazyLoadBatchSize

public final Query<T> setLazyLoadBatchSize(int lazyLoadBatchSize)

Specified by:

setLazyLoadBatchSize in interface QueryBuilder<Query<T>,T>

lazyLoadProperty

public final String lazyLoadProperty()

Description copied from interface: SpiQuery

Return the property that invoked lazy load.

Specified by:

lazyLoadProperty in interface SpiQuery<T>

setLazyLoadProperty

public final void setLazyLoadProperty(String lazyLoadProperty)

Description copied from interface: SpiQuery

Set the property that invoked the lazy load and MUST be included in the lazy loading query.

Specified by:

setLazyLoadProperty in interface SpiQuery<T>

getExpressionFactory

public final ExpressionFactory getExpressionFactory()

Specified by:

getExpressionFactory in interface Query<T>

manyWhereJoins

public final ManyWhereJoins manyWhereJoins()

Return the extra joins required to support the where clause for 'Many' properties.

Specified by:

manyWhereJoins in interface SpiQuery<T>

selectAllForLazyLoadProperty

public final void selectAllForLazyLoadProperty()

Return true if select all properties was used to ensure the property invoking a lazy load was included in the query.

Specified by:

selectAllForLazyLoadProperty in interface SpiQuery<T>

setLazyLoadManyPath

public final void setLazyLoadManyPath(String lazyLoadManyPath)

Description copied from interface: SpiQuery

Set the path of the many when +query/+lazy loading query is executed.

Specified by:

setLazyLoadManyPath in interface SpiQuery<T>

convertJoins

public final SpiQuerySecondary convertJoins()

Description copied from interface: SpiQuery

Convert joins as necessary to query joins etc.

Specified by:

convertJoins in interface SpiQuery<T>

setDefaultSelectClause

public final void setDefaultSelectClause()

Description copied from interface: SpiQuery

Set default select clauses where none have been explicitly defined.

Specified by:

setDefaultSelectClause in interface SpiQuery<T>

setTenantId

public final void setTenantId(Object tenantId)

Description copied from interface: SpiQuery

Set the tenantId to use for lazy loading.

Specified by:

setTenantId in interface SpiQuery<T>

tenantId

public final Object tenantId()

Description copied from interface: SpiQuery

Return the tenantId to use for lazy loading.

Specified by:

tenantId in interface SpiQuery<T>

setDetail

public final void setDetail(OrmQueryDetail detail)

Description copied from interface: SpiQuery

Replace the query detail. This is used by the AutoTune feature to as a fast way to set the query properties and joins.

Note care must be taken to keep the where, orderBy, firstRows and maxRows held in the detail attributes.

Specified by:

setDetail in interface SpiQuery<T>

tuneFetchProperties

public final boolean tuneFetchProperties(OrmQueryDetail tunedDetail)

Description copied from interface: SpiQuery

AutoTune tune the detail specifying properties to select on already defined joins and adding extra joins where they are missing.

Specified by:

tuneFetchProperties in interface SpiQuery<T>

detail

public final OrmQueryDetail detail()

Description copied from interface: SpiQuery

Return the query detail.

Specified by:

detail in interface SpiQuery<T>

filterMany

public final ExpressionList<T> filterMany(String prop)

Specified by:

filterMany in interface Query<T>

setFilterMany

public final void setFilterMany(String prop,
 ExpressionList<?> filterMany)

Description copied from interface: SpiQuery

Set a filter to a join path.

Specified by:

setFilterMany in interface SpiQuery<T>

setupForDeleteOrUpdate

public final void setupForDeleteOrUpdate()

Setup to be a delete or update query.

Specified by:

setupForDeleteOrUpdate in interface SpiQuery<T>

setDeleteByIdsPlan

public final CQueryPlanKey setDeleteByIdsPlan()

Description copied from interface: SpiQuery

Set the query to be delete by ids due to cascading delete.

Specified by:

setDeleteByIdsPlan in interface SpiQuery<T>

setSelectId

public final void setSelectId()

Set the select clause to select the Id property.

Specified by:

setSelectId in interface SpiQuery<T>

setSingleAttribute

public final void setSingleAttribute()

Description copied from interface: SpiQuery

Mark the query as selecting a single attribute.

Specified by:

setSingleAttribute in interface SpiQuery<T>

isSingleAttribute

public final boolean isSingleAttribute()

Return true if this is a single attribute query.

Specified by:

isSingleAttribute in interface SpiQuery<T>

countDistinctOrder

public final CountDistinctOrder countDistinctOrder()

Description copied from interface: SpiQuery

Returns the count distinct order setting.

Specified by:

countDistinctOrder in interface SpiQuery<T>

isWithId

public final boolean isWithId()

Description copied from interface: SpiQuery

Return true if the query should include the Id property.

distinct and single attribute queries exclude the Id property.

Specified by:

isWithId in interface SpiQuery<T>

cacheIdLookup

public final CacheIdLookup<T> cacheIdLookup()

Description copied from interface: SpiQuery

Bean cache lookup for find by ids.

Specified by:

cacheIdLookup in interface SpiQuery<T>

naturalKey

public final NaturalKeyQueryData<T> naturalKey()

Description copied from interface: SpiQuery

Collect natural key data for this query or null if the query does not match the requirements of natural key lookup.

Specified by:

naturalKey in interface SpiQuery<T>

naturalKeyBindParam

public final NaturalKeyBindParam naturalKeyBindParam()

Description copied from interface: SpiQuery

Return a Natural Key bind parameter if supported by this query.

Specified by:

naturalKeyBindParam in interface SpiQuery<T>

copy

public SpiQuery<T> copy()

Description copied from interface: SpiQuery

Return a copy of the query.

Note that this does NOT copy the forUpdate property. See #2762.

Specified by:

copy in interface QueryBuilder<Query<T>,T>

Specified by:

copy in interface SpiQuery<T>

copy

public SpiQuery<T> copy(SpiEbeanServer server)

Description copied from interface: SpiQuery

Return a copy of the query attaching to a different EbeanServer.

Specified by:

copy in interface SpiQuery<T>

setPersistenceContextScope

public final Query<T> setPersistenceContextScope(PersistenceContextScope scope)

Specified by:

setPersistenceContextScope in interface QueryBuilder<Query<T>,T>

persistenceContextScope

public final PersistenceContextScope persistenceContextScope()

Description copied from interface: SpiQuery

Return the PersistenceContextScope that this query should use.

This can be null and in that case use the default scope.

Specified by:

persistenceContextScope in interface SpiQuery<T>

type

public final SpiQuery.Type type()

Description copied from interface: SpiQuery

Return the type of query (List, Set, Map, Bean, rowCount etc).

Specified by:

type in interface SpiQuery<T>

setType

public final void setType(SpiQuery.Type type)

Description copied from interface: SpiQuery

Set the query type (List, Set etc).

Specified by:

setType in interface SpiQuery<T>

distinctOn

public String distinctOn()

Description copied from interface: SpiQuery

Return the distinct on clause.

Specified by:

distinctOn in interface SpiQuery<T>

loadDescription

public final String loadDescription()

Description copied from interface: SpiQuery

Return a more detailed description of the lazy or query load.

Specified by:

loadDescription in interface SpiQuery<T>

loadMode

public final String loadMode()

Description copied from interface: SpiQuery

Return the load mode (+lazy or +query).

Specified by:

loadMode in interface SpiQuery<T>

setLoadDescription

public final void setLoadDescription(String loadMode,
 String loadDescription)

Description copied from interface: SpiQuery

Set the load mode (+lazy or +query) and the load description.

Specified by:

setLoadDescription in interface SpiQuery<T>

persistenceContext

public final PersistenceContext persistenceContext()

Return the TransactionContext.

If no TransactionContext is present on the query then the TransactionContext from the Transaction is used (transaction scoped persistence context).

Specified by:

persistenceContext in interface SpiQuery<T>

setPersistenceContext

public final void setPersistenceContext(PersistenceContext persistenceContext)

Set an explicit TransactionContext (typically for a refresh query).

If no TransactionContext is present on the query then the TransactionContext from the Transaction is used (transaction scoped persistence context).

Specified by:

setPersistenceContext in interface SpiQuery<T>

setLazyLoadForParents

public final void setLazyLoadForParents(BeanPropertyAssocMany<?> many)

Description copied from interface: SpiQuery

This becomes a lazy loading query for a many relationship.

Specified by:

setLazyLoadForParents in interface SpiQuery<T>

lazyLoadMany

public final BeanPropertyAssocMany<?> lazyLoadMany()

Description copied from interface: SpiQuery

Return the lazy loading 'many' property.

Specified by:

lazyLoadMany in interface SpiQuery<T>

isDetailEmpty

public final boolean isDetailEmpty()

Return true if the query detail has neither select or joins specified.

Specified by:

isDetailEmpty in interface SpiQuery<T>

isAutoTuned

public final boolean isAutoTuned()

Specified by:

isAutoTuned in interface Query<T>

setAutoTuned

public final void setAutoTuned(boolean autoTuned)

Description copied from interface: SpiQuery

Set to true if this query has been tuned by autoTune.

Specified by:

setAutoTuned in interface SpiQuery<T>

isAutoTune

public final Boolean isAutoTune()

Description copied from interface: SpiQuery

Return explicit AutoTune setting or null. If null then not explicitly set so we use the default behaviour.

Specified by:

isAutoTune in interface SpiQuery<T>

setAutoTune

public final Query<T> setAutoTune(boolean autoTune)

Specified by:

setAutoTune in interface QueryBuilder<Query<T>,T>

withLock

public final Query<T> withLock(Query.LockType lockType)

Specified by:

withLock in interface QueryBuilder<Query<T>,T>

withLock

public final Query<T> withLock(Query.LockType lockType,
 Query.LockWait lockWait)

Specified by:

withLock in interface QueryBuilder<Query<T>,T>

forUpdate

public final Query<T> forUpdate()

Specified by:

forUpdate in interface QueryBuilder<Query<T>,T>

forUpdateNoWait

public final Query<T> forUpdateNoWait()

Specified by:

forUpdateNoWait in interface QueryBuilder<Query<T>,T>

forUpdateSkipLocked

public final Query<T> forUpdateSkipLocked()

Specified by:

forUpdateSkipLocked in interface QueryBuilder<Query<T>,T>

isForUpdate

public final boolean isForUpdate()

Specified by:

isForUpdate in interface Query<T>

getForUpdateLockWait

public final Query.LockWait getForUpdateLockWait()

Description copied from interface: SpiQuery

Return the ForUpdate mode.

Specified by:

getForUpdateLockWait in interface Query<T>

Specified by:

getForUpdateLockWait in interface SpiQuery<T>

getForUpdateLockType

public final Query.LockType getForUpdateLockType()

Specified by:

getForUpdateLockType in interface Query<T>

profilingListener

public final ProfilingListener profilingListener()

Description copied from interface: SpiQuery

If return null then no profiling for this query. If a ProfilingListener is returned this implies that profiling is turned on for this query (and all the objects this query creates).

Specified by:

profilingListener in interface SpiQuery<T>

setProfilingListener

public final void setProfilingListener(ProfilingListener profilingListener)

Description copied from interface: SpiQuery

This has the effect of turning on profiling for this query.

Specified by:

setProfilingListener in interface SpiQuery<T>

getQueryType

public final QueryType getQueryType()

Specified by:

getQueryType in interface Query<T>

mode

public final SpiQuery.Mode mode()

Description copied from interface: SpiQuery

Return the query mode.

Specified by:

mode in interface SpiQuery<T>

temporalMode

public final SpiQuery.TemporalMode temporalMode()

Description copied from interface: SpiQuery

Return the Temporal mode for the query.

Specified by:

temporalMode in interface SpiQuery<T>

isAsOfQuery

public final boolean isAsOfQuery()

Description copied from interface: SpiQuery

Return true if this is a 'As Of' query.

Specified by:

isAsOfQuery in interface SpiQuery<T>

isIncludeSoftDeletes

public final boolean isIncludeSoftDeletes()

Description copied from interface: SpiQuery

Return true if this query includes soft deleted rows.

Specified by:

isIncludeSoftDeletes in interface SpiQuery<T>

setMode

public final void setMode(SpiQuery.Mode mode)

Description copied from interface: SpiQuery

Set the query mode.

Specified by:

setMode in interface SpiQuery<T>

usingFuture

public final void usingFuture()

Description copied from interface: SpiQuery

Set that this is a future query that will execute in the background.

Specified by:

usingFuture in interface SpiQuery<T>

isUsingFuture

public final boolean isUsingFuture()

Description copied from interface: SpiQuery

Return true if this is a future query.

Specified by:

isUsingFuture in interface SpiQuery<T>

isUsageProfiling

public final boolean isUsageProfiling()

Description copied from interface: SpiQuery

Return false when this is a lazy load or refresh query for a bean.

We just take/copy the data from those beans and don't collect AutoTune usage profiling on those lazy load or refresh beans.

Specified by:

isUsageProfiling in interface SpiQuery<T>

setUsageProfiling

public final void setUsageProfiling(boolean usageProfiling)

Description copied from interface: SpiQuery

Set to false if this query should not be included in the AutoTune usage profiling information.

Specified by:

setUsageProfiling in interface SpiQuery<T>

setParentNode

public final void setParentNode(ObjectGraphNode parentNode)

Description copied from interface: SpiQuery

Set the profile point of the bean or collection that is lazy loading.

This enables use to hook this back to the original 'root' query by the queryPlanHash and stackPoint.

Specified by:

setParentNode in interface SpiQuery<T>

parentNode

public final ObjectGraphNode parentNode()

Description copied from interface: SpiQuery

Used to hook back a lazy loading query to the original query (query point).

This will return null or an "original" query.

Specified by:

parentNode in interface SpiQuery<T>

setOrigin

public final ObjectGraphNode setOrigin(CallOrigin callOrigin)

Description copied from interface: SpiQuery

Return the origin point for the query.

This MUST be call prior to a query being changed via tuning. This is because the queryPlanHash is used to identify the query point.

Specified by:

setOrigin in interface SpiQuery<T>

isNativeSql

public final boolean isNativeSql()

Description copied from interface: SpiQuery

Return true if this is a native sql query.

Specified by:

isNativeSql in interface SpiQuery<T>

nativeSql

public final String nativeSql()

Description copied from interface: SpiQuery

Return the unmodified native sql query (with named params etc).

Specified by:

nativeSql in interface SpiQuery<T>

queryPlanKey

public final Object queryPlanKey()

Description copied from interface: SpiQuery

Return the query plan key.

Specified by:

queryPlanKey in interface SpiQuery<T>

prepare

public final CQueryPlanKey prepare(SpiOrmQueryRequest<T> request)

Prepare the query which prepares any expressions (sub-query expressions etc) and calculates the query plan key.

Specified by:

prepare in interface SpiQuery<T>

queryBindKey

public final void queryBindKey(BindValuesKey key)

Description copied from interface: SpiQuery

Build the key for the bind values used in the query (for l2 query cache).

Combined with queryPlanHash() to return queryHash (a unique key for a query).

Specified by:

queryBindKey in interface SpiQuery<T>

queryHash

public final HashQuery queryHash()

Return a hash that includes the query plan and bind values.

This hash can be used to identify if we have executed the exact same query (including bind values) before.

Specified by:

queryHash in interface SpiQuery<T>

isRawSql

public final boolean isRawSql()

Description copied from interface: SpiQuery

Return true if this is a RawSql query.

Specified by:

isRawSql in interface SpiQuery<T>

timeout

public final int timeout()

Return the timeout.

Specified by:

timeout in interface SpiQuery<T>

hasMaxRowsOrFirstRow

public final boolean hasMaxRowsOrFirstRow()

Description copied from interface: SpiQuery

Returns true if either firstRow or maxRows has been set.

Specified by:

hasMaxRowsOrFirstRow in interface SpiQuery<T>

isVersionsBetween

public final boolean isVersionsBetween()

Description copied from interface: SpiQuery

Return true if this is a find versions between query.

Specified by:

isVersionsBetween in interface SpiQuery<T>

versionStart

public final Timestamp versionStart()

Description copied from interface: SpiQuery

Return the find versions start timestamp.

Specified by:

versionStart in interface SpiQuery<T>

versionEnd

public final Timestamp versionEnd()

Description copied from interface: SpiQuery

Return the find versions end timestamp.

Specified by:

versionEnd in interface SpiQuery<T>

isReadOnly

public final Boolean isReadOnly()

Description copied from interface: SpiQuery

Return true if the beans returned by this query should be read only.

Specified by:

isReadOnly in interface SpiQuery<T>

setReadOnly

public final Query<T> setReadOnly(boolean readOnly)

Specified by:

setReadOnly in interface QueryBuilder<Query<T>,T>

isBeanCachePut

public final boolean isBeanCachePut()

Description copied from interface: SpiQuery

Return true if the query should PUT against the bean cache.

Specified by:

isBeanCachePut in interface SpiQuery<T>

isBeanCacheGet

public final boolean isBeanCacheGet()

Description copied from interface: SpiQuery

Return true if the query should GET against bean cache.

Specified by:

isBeanCacheGet in interface SpiQuery<T>

isForceHitDatabase

public final boolean isForceHitDatabase()

Description copied from interface: SpiQuery

Return true if we must hit the DB (Cache reload or select for update).

Specified by:

isForceHitDatabase in interface SpiQuery<T>

resetBeanCacheAutoMode

public final void resetBeanCacheAutoMode(boolean findOne)

Description copied from interface: SpiQuery

Reset AUTO mode to OFF for findList(). Expect explicit cache use with findList().

Specified by:

resetBeanCacheAutoMode in interface SpiQuery<T>

beanCacheMode

public final CacheMode beanCacheMode()

Description copied from interface: SpiQuery

Return the cache mode for using the bean cache (Get and Put).

Specified by:

beanCacheMode in interface SpiQuery<T>

queryCacheMode

public final CacheMode queryCacheMode()

Description copied from interface: SpiQuery

Return the cache mode if this query should use/check the query cache.

Specified by:

queryCacheMode in interface SpiQuery<T>

setBeanCacheMode

public final Query<T> setBeanCacheMode(CacheMode beanCacheMode)

Specified by:

setBeanCacheMode in interface QueryBuilder<Query<T>,T>

setUseQueryCache

public final Query<T> setUseQueryCache(CacheMode useQueryCache)

Specified by:

setUseQueryCache in interface QueryBuilder<Query<T>,T>

setTimeout

public final Query<T> setTimeout(int secs)

Specified by:

setTimeout in interface QueryBuilder<Query<T>,T>

selectProperties

public final void selectProperties(Set<String> props)

Description copied from interface: SpiQueryFetch

Specify the select properties.

Specified by:

selectProperties in interface SpiQueryFetch

fetchProperties

public final void fetchProperties(String property,
 Set<String> columns,
 FetchConfig config)

Description copied from interface: SpiQueryFetch

Specify the fetch properties for the given path.

Specified by:

fetchProperties in interface SpiQueryFetch

selectProperties

public final void selectProperties(OrmQueryProperties properties)

Description copied from interface: SpiQuery

Set the select properties.

Specified by:

selectProperties in interface SpiQuery<T>

fetchProperties

public final void fetchProperties(String path,
 OrmQueryProperties other)

Description copied from interface: SpiQuery

Set the fetch properties for the given path.

Specified by:

fetchProperties in interface SpiQuery<T>

addNested

public final void addNested(String name,
 OrmQueryDetail nestedDetail,
 FetchConfig config)

Description copied from interface: SpiQueryFetch

Add a nested fetch graph.

Specified by:

addNested in interface SpiQueryFetch

distinctOn

public final Query<T> distinctOn(String distinctOn)

Specified by:

distinctOn in interface QueryBuilderProjection<Query<T>,T>

select

public final Query<T> select(String columns)

Specified by:

select in interface QueryBuilderProjection<Query<T>,T>

select

public final Query<T> select(FetchGroup<T> fetchGroup)

Specified by:

select in interface QueryBuilderProjection<Query<T>,T>

fetch

public final Query<T> fetch(String path)

Specified by:

fetch in interface QueryBuilderProjection<Query<T>,T>

fetch

public final Query<T> fetch(String path,
 FetchConfig joinConfig)

Specified by:

fetch in interface QueryBuilderProjection<Query<T>,T>

fetch

public final Query<T> fetch(String path,
 String properties)

Specified by:

fetch in interface QueryBuilderProjection<Query<T>,T>

fetch

public final Query<T> fetch(String path,
 String properties,
 FetchConfig config)

Specified by:

fetch in interface QueryBuilderProjection<Query<T>,T>

fetchQuery

public final Query<T> fetchQuery(String path)

Specified by:

fetchQuery in interface QueryBuilderProjection<Query<T>,T>

fetchCache

public final Query<T> fetchCache(String path)

Specified by:

fetchCache in interface QueryBuilderProjection<Query<T>,T>

fetchLazy

public final Query<T> fetchLazy(String path)

Specified by:

fetchLazy in interface QueryBuilderProjection<Query<T>,T>

fetchQuery

public final Query<T> fetchQuery(String path,
 String properties)

Specified by:

fetchQuery in interface QueryBuilderProjection<Query<T>,T>

fetchCache

public final Query<T> fetchCache(String path,
 String properties)

Specified by:

fetchCache in interface QueryBuilderProjection<Query<T>,T>

fetchLazy

public final Query<T> fetchLazy(String path,
 String properties)

Specified by:

fetchLazy in interface QueryBuilderProjection<Query<T>,T>

transaction

public SpiTransaction transaction()

Description copied from interface: SpiQuery

Return the transaction explicitly assigned or null.

Specified by:

transaction in interface SpiQuery<T>

usingTransaction

public final Query<T> usingTransaction(Transaction transaction)

Specified by:

usingTransaction in interface QueryBuilder<Query<T>,T>

usingConnection

public final Query<T> usingConnection(Connection connection)

Specified by:

usingConnection in interface QueryBuilder<Query<T>,T>

usingDatabase

public final Query<T> usingDatabase(Database database)

Specified by:

usingDatabase in interface QueryBuilder<Query<T>,T>

usingMaster

public Query<T> usingMaster()

Specified by:

usingMaster in interface QueryBuilder<Query<T>,T>

isUseMaster

public boolean isUseMaster()

Description copied from interface: SpiQuery

Return true if this query should not use the read only data source.

Specified by:

isUseMaster in interface SpiQuery<T>

delete

public final int delete()

Specified by:

delete in interface QueryBuilder<Query<T>,T>

delete

public final int delete(Transaction transaction)

Specified by:

delete in interface Query<T>

update

public final int update()

Specified by:

update in interface Query<T>

update

public final int update(Transaction transaction)

Specified by:

update in interface Query<T>

findIds

public final <A> List<A> findIds()

Specified by:

findIds in interface QueryBuilder<Query<T>,T>

exists

public final boolean exists()

Specified by:

exists in interface QueryBuilder<Query<T>,T>

findCount

public final int findCount()

Specified by:

findCount in interface QueryBuilder<Query<T>,T>

findEachWhile

public final void findEachWhile(Predicate<T> consumer)

Specified by:

findEachWhile in interface QueryBuilder<Query<T>,T>

findEach

public final void findEach(Consumer<T> consumer)

Specified by:

findEach in interface QueryBuilder<Query<T>,T>

findEach

public final void findEach(int batch,
 Consumer<List<T>> consumer)

Specified by:

findEach in interface QueryBuilder<Query<T>,T>

findIterate

public final QueryIterator<T> findIterate()

Specified by:

findIterate in interface QueryBuilder<Query<T>,T>

findStream

public final Stream<T> findStream()

Specified by:

findStream in interface QueryBuilder<Query<T>,T>

findVersions

public final List<Version<T>> findVersions()

Specified by:

findVersions in interface QueryBuilder<Query<T>,T>

findVersionsBetween

public final List<Version<T>> findVersionsBetween(Timestamp start,
 Timestamp end)

Specified by:

findVersionsBetween in interface QueryBuilder<Query<T>,T>

findList

public final List<T> findList()

Specified by:

findList in interface QueryBuilder<Query<T>,T>

findSet

public final Set<T> findSet()

Specified by:

findSet in interface QueryBuilder<Query<T>,T>

findMap

public final <K> Map<K,T> findMap()

Specified by:

findMap in interface QueryBuilder<Query<T>,T>

findSingleAttributeList

public final <A> List<A> findSingleAttributeList()

Specified by:

findSingleAttributeList in interface QueryBuilder<Query<T>,T>

findSingleAttributeSet

public final <A> Set<A> findSingleAttributeSet()

Specified by:

findSingleAttributeSet in interface QueryBuilder<Query<T>,T>

findSingleAttribute

public final <A> A findSingleAttribute()

Specified by:

findSingleAttribute in interface QueryBuilder<Query<T>,T>

findSingleAttributeOrEmpty

public final <A> Optional<A> findSingleAttributeOrEmpty()

Specified by:

findSingleAttributeOrEmpty in interface QueryBuilder<Query<T>,T>

findOne

public final T findOne()

Specified by:

findOne in interface QueryBuilder<Query<T>,T>

findOneOrEmpty

public final Optional<T> findOneOrEmpty()

Specified by:

findOneOrEmpty in interface QueryBuilder<Query<T>,T>

findFutureIds

public final FutureIds<T> findFutureIds()

Specified by:

findFutureIds in interface QueryBuilder<Query<T>,T>

findFutureList

public final FutureList<T> findFutureList()

Specified by:

findFutureList in interface QueryBuilder<Query<T>,T>

findFutureCount

public final FutureRowCount<T> findFutureCount()

Specified by:

findFutureCount in interface QueryBuilder<Query<T>,T>

findPagedList

public final PagedList<T> findPagedList()

Specified by:

findPagedList in interface QueryBuilder<Query<T>,T>

setParameter

public final Query<T> setParameter(Object value)

Specified by:

setParameter in interface Query<T>

setParameters

public final Query<T> setParameters(Object... values)

Specified by:

setParameters in interface Query<T>

setParameter

public final Query<T> setParameter(int position,
 Object value)

Set an ordered bind parameter according to its position. Note that the position starts at 1 to be consistent with JDBC PreparedStatement. You need to set a parameter value for each ? you have in the query.

Specified by:

setParameter in interface Query<T>

setParameter

public final Query<T> setParameter(String name,
 Object value)

Set a named bind parameter. Named parameters have a colon to prefix the name.

Specified by:

setParameter in interface Query<T>

setArrayParameter

public final void setArrayParameter(String name,
 Collection<?> values)

Description copied from interface: SpiQuery

Bind the named multi-value array parameter which we would use with Postgres ANY.

Specified by:

setArrayParameter in interface SpiQuery<T>

checkPagingOrderBy

public final boolean checkPagingOrderBy()

Description copied from interface: SpiQuery

Return true if the query should have an order by appended automatically.

Specified by:

checkPagingOrderBy in interface SpiQuery<T>

orderByIsEmpty

public final boolean orderByIsEmpty()

Description copied from interface: SpiQuery

Return true if there is no Order By clause.

Specified by:

orderByIsEmpty in interface SpiQuery<T>

getOrderBy

public final OrderBy<T> getOrderBy()

Description copied from interface: SpiQuery

Return the Order By clause or null if there is none defined.

Specified by:

getOrderBy in interface SpiQuery<T>

orderBy

public final OrderBy<T> orderBy()

Specified by:

orderBy in interface Query<T>

orderBy

public final Query<T> orderBy(String orderByClause)

Specified by:

orderBy in interface QueryBuilder<Query<T>,T>

setOrderBy

public final Query<T> setOrderBy(OrderBy<T> orderBy)

Specified by:

setOrderBy in interface QueryBuilder<Query<T>,T>

isManualId

public final boolean isManualId()

Description copied from interface: SpiQuery

Return true if the Id property is manually included in the query (DTO queries).

Specified by:

isManualId in interface SpiQuery<T>

setManualId

public final void setManualId()

Description copied from interface: SpiQuery

Set to true when we only include the Id property if it is explicitly included in the select().

Specified by:

setManualId in interface SpiQuery<T>

isDistinct

public final boolean isDistinct()

return true if user specified to use SQL DISTINCT (effectively excludes id property).

Specified by:

isDistinct in interface SpiQuery<T>

setDistinct

public final Query<T> setDistinct(boolean distinct)

Internally set to use SQL DISTINCT on the query but still have id property included.

Specified by:

setDistinct in interface QueryBuilder<Query<T>,T>

setCountDistinct

public final Query<T> setCountDistinct(CountDistinctOrder countDistinctOrder)

Specified by:

setCountDistinct in interface QueryBuilder<Query<T>,T>

isCountDistinct

public final boolean isCountDistinct()

Specified by:

isCountDistinct in interface Query<T>

getBeanType

public final Class<T> getBeanType()

Specified by:

getBeanType in interface QueryBuilder<Query<T>,T>

toString

public final String toString()

Overrides:

toString in class Object

m2mIncludeJoin

public final TableJoin m2mIncludeJoin()

Description copied from interface: SpiQuery

Return the extra join for a M2M lazy load.

Specified by:

m2mIncludeJoin in interface SpiQuery<T>

setM2MIncludeJoin

public final void setM2MIncludeJoin(TableJoin m2mIncludeJoin)

Description copied from interface: SpiQuery

Set the extra join for a M2M lazy load.

Specified by:

setM2MIncludeJoin in interface SpiQuery<T>

setDisableLazyLoading

public final Query<T> setDisableLazyLoading(boolean disableLazyLoading)

Specified by:

setDisableLazyLoading in interface QueryBuilder<Query<T>,T>

isDisableLazyLoading

public final boolean isDisableLazyLoading()

Description copied from interface: SpiQuery

Return true if lazy loading has been disabled on the query.

Specified by:

isDisableLazyLoading in interface SpiQuery<T>

getFirstRow

public final int getFirstRow()

Description copied from interface: SpiQuery

Return the index of the first row to return in the query.

Specified by:

getFirstRow in interface Query<T>

Specified by:

getFirstRow in interface SpiQuery<T>

setFirstRow

public final Query<T> setFirstRow(int firstRow)

Specified by:

setFirstRow in interface QueryBuilder<Query<T>,T>

getMaxRows

public final int getMaxRows()

Description copied from interface: SpiQuery

Return the maximum number of rows to return in the query.

Specified by:

getMaxRows in interface Query<T>

Specified by:

getMaxRows in interface SpiQuery<T>

setMaxRows

public final Query<T> setMaxRows(int maxRows)

Specified by:

setMaxRows in interface QueryBuilder<Query<T>,T>

mapKey

public final String mapKey()

Description copied from interface: SpiQuery

Return the property used to specify keys for a map.

Specified by:

mapKey in interface SpiQuery<T>

setMapKey

public final Query<T> setMapKey(String mapKey)

Specified by:

setMapKey in interface QueryBuilder<Query<T>,T>

getId

public final Object getId()

Specified by:

getId in interface Query<T>

setId

public final Query<T> setId(Object id)

Specified by:

setId in interface Query<T>

bindParams

public final BindParams bindParams()

Description copied from interface: SpiQuery

Return the bind parameters.

Specified by:

bindParams in interface SpiQuery<T>

initBindParams

public BindParams initBindParams()

Description copied from interface: SpiQuery

Return the bind parameters ensuring it is initialised.

Specified by:

initBindParams in interface SpiQuery<T>

where

public final Query<T> where(Expression expression)

Specified by:

where in interface Query<T>

where

public final ExpressionList<T> where()

Specified by:

where in interface Query<T>

simplifyExpressions

public final void simplifyExpressions()

Description copied from interface: SpiQuery

Simplify nested expression lists where possible.

Specified by:

simplifyExpressions in interface SpiQuery<T>

having

public final Query<T> having(Expression expression)

Specified by:

having in interface Query<T>

having

public final ExpressionList<T> having()

Specified by:

having in interface Query<T>

havingExpressions

public final SpiExpressionList<T> havingExpressions()

Description copied from interface: SpiQuery

Can return null if no expressions where added to the having clause.

Specified by:

havingExpressions in interface SpiQuery<T>

whereExpressions

public final SpiExpressionList<T> whereExpressions()

Description copied from interface: SpiQuery

Can return null if no expressions where added to the where clause.

Specified by:

whereExpressions in interface SpiQuery<T>

getGeneratedSql

public final String getGeneratedSql()

Specified by:

getGeneratedSql in interface QueryBuilder<Query<T>,T>

setGeneratedSql

public final void setGeneratedSql(String generatedSql)

Description copied from interface: SpiQuery

Set the generated sql for debug purposes.

Specified by:

setGeneratedSql in interface SpiQuery<T>

checkNamedParameters

public final void checkNamedParameters()

Description copied from interface: SpiQuery

Check that the named parameters have had their values set.

Specified by:

checkNamedParameters in interface SpiQuery<T>

createNamedParameter

public final SpiNamedParam createNamedParameter(String name)

Description copied from interface: SpiQuery

Create a named parameter placeholder.

Specified by:

createNamedParameter in interface SpiQuery<T>

setDefaultFetchBuffer

public final void setDefaultFetchBuffer(int fetchSize)

Description copied from interface: SpiQuery

Set the JDBC fetchSize buffer hint if not explicitly set.

Specified by:

setDefaultFetchBuffer in interface SpiQuery<T>

setBufferFetchSizeHint

public final Query<T> setBufferFetchSizeHint(int bufferFetchSizeHint)

Specified by:

setBufferFetchSizeHint in interface QueryBuilder<Query<T>,T>

bufferFetchSizeHint

public final int bufferFetchSizeHint()

Description copied from interface: SpiQuery

Return the hint for Statement.setFetchSize().

Specified by:

bufferFetchSizeHint in interface SpiQuery<T>

setBaseTable

public final Query<T> setBaseTable(String baseTable)

Specified by:

setBaseTable in interface QueryBuilder<Query<T>,T>

baseTable

public final String baseTable()

Description copied from interface: SpiQuery

Return the base table to use if user defined on the query.

Specified by:

baseTable in interface SpiQuery<T>

alias

public final Query<T> alias(String alias)

Specified by:

alias in interface QueryBuilder<Query<T>,T>

alias

public final String alias()

Description copied from interface: SpiQuery

Return root table alias set by QueryBuilder.alias(String) command.

Specified by:

alias in interface SpiQuery<T>

getAlias

public final String getAlias(String defaultAlias)

Description copied from interface: SpiQuery

Return root table alias with default option.

Specified by:

getAlias in interface SpiQuery<T>

validate

public final Set<String> validate()

Specified by:

validate in interface QueryBuilder<Query<T>,T>

validate

public final Set<String> validate(BeanType<T> desc)

Validate all the expression properties/paths given the bean descriptor.

Specified by:

validate in interface SpiQuery<T>

updateProperties

public final OrmUpdateProperties updateProperties()

Description copied from interface: SpiQuery

Return the properties for an update query.

Specified by:

updateProperties in interface SpiQuery<T>

profileLocation

public final ProfileLocation profileLocation()

Description copied from interface: SpiQuery

Return the profile location for this query.

Specified by:

profileLocation in interface SpiQuery<T>

handleLoadError

public final void handleLoadError(String fullName,
 Exception e)

Description copied from interface: SpiQuery

Handles load errors.

Specified by:

handleLoadError in interface SpiQuery<T>

orderById

public final Query<T> orderById(boolean orderById)

Specified by:

orderById in interface QueryBuilder<Query<T>,T>