SpiQuery (avaje-ebeanorm 3.3.1 API)

All Superinterfaces:

Query<T>, Serializable

All Known Implementing Classes:

DefaultOrmQuery
```
public interface SpiQuery<T>
extends Query<T>
```
Object Relational query - Internal extension to Query object.

Property Summary

Properties
Type Property and Description

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

Properties
Type	Property and Description
`boolean`	`selectAllForLazyLoad` Return true if select all properties was used to ensure the property invoking a lazy load was included in the query.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class SpiQuery.Mode

static class SpiQuery.Type
The type of query result.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`SpiQuery.Mode`
`static class`	`SpiQuery.Type` The type of query result.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`contextAdd(EntityBean bean)` Adds this bean to the persistence context prior to executing the query.
`void`	`convertManyFetchJoinsToQueryJoins(boolean allowOne, int queryBatch)` Convert any many joins fetch joins to query joins.
`void`	`convertWhereNaturalKeyToId(Object idValue)` Convert this natural key query into a find by id query.
`SpiQuery<T>`	`copy()` Return a copy of the query.
`boolean`	`createOwnTransaction()` Return true if this query should use its own transaction.
`String`	`getAdditionalHaving()` Return additional having clause.
`String`	`getAdditionalWhere()` Return additional where clause.
`AutoFetchManager`	`getAutoFetchManager()` If return null then no autoFetch profiling for this query.
`int`	`getBackgroundFetchAfter()` Return the number of rows after which fetching should occur in a background thread.
`BeanCollectionTouched`	`getBeanCollectionTouched()` Return a listener that wants to be notified when the bean collection is first used.
`Class<T>`	`getBeanType()` Return the type of beans queries.
`BindParams`	`getBindParams()` Return the bind parameters.
`int`	`getBufferFetchSizeHint()` Return the hint for Statement.setFetchSize().
`ArrayList<EntityBean>`	`getContextAdditions()` Return the objects that should be added to the persistence context prior to executing the query.
`OrmQueryDetail`	`getDetail()` Return the query detail.
`int`	`getFirstRow()` Return the index of the first row to return in the query.
`SpiExpressionList<T>`	`getHavingExpressions()` Can return null if no expressions where added to the having clause.
`Object`	`getId()` Return the Id value.
`List<Object>`	`getIdList()` Return the list of Id's that is currently being fetched by a background thread.
`TableJoin`	`getIncludeTableJoin()`
`List<Object>`	`getLazyLoadForParentIds()` Return the list of parent Id's for lazy loading.
`BeanPropertyAssocMany<?>`	`getLazyLoadForParentsProperty()` Return the lazy loading 'many' property.
`String`	`getLazyLoadManyPath()` Return the lazy load path.
`String`	`getLazyLoadProperty()` Return the property that invoked lazy load.
`QueryListener<T>`	`getListener()` Return the queryListener.
`String`	`getLoadDescription()` Return a more detailed description of the lazy or query load.
`String`	`getLoadMode()` Return the load mode (+lazy or +query).
`ManyWhereJoins`	`getManyWhereJoins()` Return the joins required to support predicates on the many properties.
`String`	`getMapKey()` Return the property used to specify keys for a map.
`int`	`getMaxRows()` Return the maximum number of rows to return in the query.
`SpiQuery.Mode`	`getMode()` Return the query mode.
`String`	`getName()` Return the query name.
`NaturalKeyBindParam`	`getNaturalKeyBindParam()` Return a Natural Key bind parameter if supported by this query.
`OrderBy<T>`	`getOrderBy()` Return the Order By clause or null if there is none defined.
`ObjectGraphNode`	`getParentNode()` Used to hook back a lazy loading query to the original query (query point).
`PersistenceContext`	`getPersistenceContext()` Return the TransactionContext.
`String`	`getQuery()` Get the orm query as a String.
`String`	`getRawWhereClause()` Return the where clause from a parsed string query.
`int`	`getTimeout()` Return the query timeout.
`SpiQuery.Type`	`getType()` Return the type of query (List, Set, Map, Bean, rowCount etc).
`SpiExpressionList<T>`	`getWhereExpressions()` Can return null if no expressions where added to the where clause.
`boolean`	`hasMaxRowsOrFirstRow()` Returns true if either firstRow or maxRows has been set.
`boolean`	`initManyWhereJoins()` Initialise/determine the joins required to support 'many' where clause predicates.
`Boolean`	`isAutofetch()` Return explicit autoFetch setting or null.
`boolean`	`isCancelled()` Return true if this query has been cancelled.
`boolean`	`isDetailEmpty()` Return true if the query detail has neither select or joins specified.
`boolean`	`isDistinct()` return true if this query uses DISTINCT.
`boolean`	`isFutureFetch()` Return true if this is a query executing in the background.
`boolean`	`isLoadBeanCache()` Return true if the beans from this query should be loaded into the bean cache.
`boolean`	`isRawSql()` Return true if this is a RawSql query.
`Boolean`	`isReadOnly()` Return true if the beans returned by this query should be read only.
`boolean`	`isSqlSelect()` Return true if this is a query based on a SqlSelect rather than generated.
`boolean`	`isUsageProfiling()` Return false when this is a lazy load or refresh query for a bean.
`Boolean`	`isUseBeanCache()` Return true if this query should use/check the bean cache.
`boolean`	`isUseQueryCache()` Return true if this query should use/check the query cache.
`HashQueryPlan`	`queryAutofetchHash(HashQueryPlanBuilder builder)` Calculate a hash used by AutoFetch to identify when a query has changed (and hence potentially needs a new tuned query plan to be developed).
`int`	`queryBindHash()` Calculate a hash based on the bind values used in the query.
`HashQuery`	`queryHash()` Identifies queries that are exactly the same including bind variables.
`HashQueryPlan`	`queryPlanHash(BeanQueryRequest<?> request)` Identifies queries that are the same bar the bind variables.
`List<OrmQueryProperties>`	`removeLazyJoins()` Remove the lazy joins from query detail.
`List<OrmQueryProperties>`	`removeQueryJoins()` Remove the query joins from query detail.
`boolean`	`selectAllForLazyLoadProperty()` Return true if select all properties was used to ensure the property invoking a lazy load was included in the query.
`void`	`setAutoFetchManager(AutoFetchManager manager)` This has the effect of turning on autoFetch profiling for this query.
`void`	`setAutoFetchTuned(boolean autoFetchTuned)` Set to true if this query has been tuned by autoFetch.
`void`	`setBeanCollectionTouched(BeanCollectionTouched notify)` Set a listener to be notified when the bean collection has been touched (when the list/set/map is first used).
`void`	`setBeanDescriptor(BeanDescriptor<?> desc)` Set the BeanDescriptor for the root type of this query.
`void`	`setCancelableQuery(CancelableQuery cancelableQuery)` Set the underlying cancelable query (with the PreparedStatement).
`void`	`setDefaultSelectClause()` Set default select clauses where none have been explicitly defined.
`void`	`setDetail(OrmQueryDetail detail)` Replace the query detail.
`void`	`setFilterMany(String prop, ExpressionList<?> filterMany)` Set a filter to a join path.
`void`	`setFutureFetch(boolean futureFetch)` Set to true to indicate the query is executing in a background thread asynchronously.
`void`	`setGeneratedSql(String generatedSql)` Set the generated sql for debug purposes.
`void`	`setIdList(List<Object> ids)` Set the list of Id's that is being populated.
`void`	`setIncludeTableJoin(TableJoin includeTableJoin)`
`void`	`setLazyLoadForParents(List<Object> parentIds, BeanPropertyAssocMany<?> many)` This becomes a lazy loading query for a many relationship.
`void`	`setLazyLoadManyPath(String lazyLoadManyPath)` Set the path of the many when +query/+lazy loading query is executed.
`void`	`setLazyLoadProperty(String lazyLoadProperty)` Set the property that invoked the lazy load and MUST be included in the lazy loading query.
`void`	`setLoadDescription(String loadMode, String loadDescription)` Set the load mode (+lazy or +query) and the load description.
`void`	`setMode(SpiQuery.Mode m)` Set the query mode.
`ObjectGraphNode`	`setOrigin(CallStack callStack)` Return the origin point for the query.
`void`	`setParentNode(ObjectGraphNode node)` Set the profile point of the bean or collection that is lazy loading.
`void`	`setPersistenceContext(PersistenceContext transactionContext)` Set an explicit TransactionContext (typically for a refresh query).
`void`	`setSelectId()` Set the query to select the id property only.
`void`	`setType(SpiQuery.Type type)` Set the query type (List, Set etc).
`void`	`setUsageProfiling(boolean usageProfiling)` Set to false if this query should not be included in the autoFetch usage profiling information.
`boolean`	`tuneFetchProperties(OrmQueryDetail detail)` Autofetch tune the detail specifying properties to select on already defined joins and adding extra joins where they are missing.

Methods inherited from interface com.avaje.ebean.Query
cancel, fetch, fetch, fetch, fetch, filterMany, findFutureIds, findFutureList, findFutureRowCount, findIds, findIterate, findList, findMap, findMap, findPagingList, findRowCount, findSet, findUnique, findVisit, getExpressionFactory, getGeneratedSql, getRawSql, having, having, having, isAutofetchTuned, isForUpdate, order, order, orderBy, orderBy, select, setAutofetch, setBackgroundFetchAfter, setBufferFetchSizeHint, setDistinct, setFirstRow, setForUpdate, setId, setListener, setLoadBeanCache, setMapKey, setMaxRows, setOrder, setOrderBy, setParameter, setParameter, setRawSql, setReadOnly, setTimeout, setUseCache, setUseQueryCache, where, where, where

- Property Detail
  - selectAllForLazyLoad
    
    Return true if select all properties was used to ensure the property invoking a lazy load was included in the query.
- Method Detail
  - selectAllForLazyLoadProperty
```
boolean selectAllForLazyLoadProperty()
```
    Return true if select all properties was used to ensure the property invoking a lazy load was included in the query.
  - setMode
```
void setMode(SpiQuery.Mode m)
```
    Set the query mode.
  - getMode
```
SpiQuery.Mode getMode()
```
    Return the query mode.
  - getBeanCollectionTouched
```
BeanCollectionTouched getBeanCollectionTouched()
```
    Return a listener that wants to be notified when the bean collection is first used.
  - setBeanCollectionTouched
```
void setBeanCollectionTouched(BeanCollectionTouched notify)
```
    Set a listener to be notified when the bean collection has been touched (when the list/set/map is first used).
  - setIdList
```
void setIdList(List<Object> ids)
```
    Set the list of Id's that is being populated.
    This is a mutating list of id's and we are setting this so that other threads have access to the id's before the id query has finished.
  - getIdList
```
List<Object> getIdList()
```
    Return the list of Id's that is currently being fetched by a background thread.
  - copy
```
SpiQuery<T> copy()
```
    Return a copy of the query.
    
    Specified by:
    
    copy in interface Query<T>
  - getType
```
SpiQuery.Type getType()
```
    Return the type of query (List, Set, Map, Bean, rowCount etc).
  - setType
```
void setType(SpiQuery.Type type)
```
    Set the query type (List, Set etc).
  - getLoadDescription
```
String getLoadDescription()
```
    Return a more detailed description of the lazy or query load.
  - getLoadMode
```
String getLoadMode()
```
    Return the load mode (+lazy or +query).
  - setLazyLoadForParents
```
void setLazyLoadForParents(List<Object> parentIds,
                         BeanPropertyAssocMany<?> many)
```
    This becomes a lazy loading query for a many relationship.
  - getLazyLoadForParentsProperty
```
BeanPropertyAssocMany<?> getLazyLoadForParentsProperty()
```
    Return the lazy loading 'many' property.
  - getLazyLoadForParentIds
```
List<Object> getLazyLoadForParentIds()
```
    Return the list of parent Id's for lazy loading.
  - setLoadDescription
```
void setLoadDescription(String loadMode,
                      String loadDescription)
```
    Set the load mode (+lazy or +query) and the load description.
  - setBeanDescriptor
```
void setBeanDescriptor(BeanDescriptor<?> desc)
```
    Set the BeanDescriptor for the root type of this query.
  - initManyWhereJoins
```
boolean initManyWhereJoins()
```
    Initialise/determine the joins required to support 'many' where clause predicates.
  - getManyWhereJoins
```
ManyWhereJoins getManyWhereJoins()
```
    Return the joins required to support predicates on the many properties.
  - convertWhereNaturalKeyToId
```
void convertWhereNaturalKeyToId(Object idValue)
```
    Convert this natural key query into a find by id query.
  - getNaturalKeyBindParam
```
NaturalKeyBindParam getNaturalKeyBindParam()
```
    Return a Natural Key bind parameter if supported by this query.
  - setSelectId
```
void setSelectId()
```
    Set the query to select the id property only.
  - setFilterMany
```
void setFilterMany(String prop,
                 ExpressionList<?> filterMany)
```
    Set a filter to a join path.
  - removeQueryJoins
```
List<OrmQueryProperties> removeQueryJoins()
```
    Remove the query joins from query detail.
    These are registered with the Load Context.
  - removeLazyJoins
```
List<OrmQueryProperties> removeLazyJoins()
```
    Remove the lazy joins from query detail.
    These are registered with the Load Context.
  - setLazyLoadManyPath
```
void setLazyLoadManyPath(String lazyLoadManyPath)
```
    Set the path of the many when +query/+lazy loading query is executed.
  - convertManyFetchJoinsToQueryJoins
```
void convertManyFetchJoinsToQueryJoins(boolean allowOne,
                                     int queryBatch)
```
    Convert any many joins fetch joins to query joins.
  - getPersistenceContext
```
PersistenceContext getPersistenceContext()
```
    Return the TransactionContext.
    If no TransactionContext is present on the query then the TransactionContext from the Transaction is used (transaction scoped persistence context).
  - setPersistenceContext
```
void setPersistenceContext(PersistenceContext transactionContext)
```
    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).
  - isDetailEmpty
```
boolean isDetailEmpty()
```
    Return true if the query detail has neither select or joins specified.
  - isAutofetch
```
Boolean isAutofetch()
```
    Return explicit autoFetch setting or null. If null then not explicitly set so we use the default behaviour.
  - getAutoFetchManager
```
AutoFetchManager getAutoFetchManager()
```
    If return null then no autoFetch profiling for this query. If a AutoFetchManager is returned this implies that profiling is turned on for this query (and all the objects this query creates).
  - setAutoFetchManager
```
void setAutoFetchManager(AutoFetchManager manager)
```
    This has the effect of turning on autoFetch profiling for this query.
  - setOrigin
```
ObjectGraphNode setOrigin(CallStack callStack)
```
    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.
  - setParentNode
```
void setParentNode(ObjectGraphNode node)
```
    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.
  - setLazyLoadProperty
```
void setLazyLoadProperty(String lazyLoadProperty)
```
    Set the property that invoked the lazy load and MUST be included in the lazy loading query.
  - getLazyLoadProperty
```
String getLazyLoadProperty()
```
    Return the property that invoked lazy load.
  - getLazyLoadManyPath
```
String getLazyLoadManyPath()
```
    Return the lazy load path.
  - getParentNode
```
ObjectGraphNode getParentNode()
```
    Used to hook back a lazy loading query to the original query (query point).
    This will return null or an "original" query.
  - isUsageProfiling
```
boolean isUsageProfiling()
```
    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 autoFetch usage profiling on those lazy load or refresh beans.
  - setUsageProfiling
```
void setUsageProfiling(boolean usageProfiling)
```
    Set to false if this query should not be included in the autoFetch usage profiling information.
  - getName
```
String getName()
```
    Return the query name.
  - queryAutofetchHash
```
HashQueryPlan queryAutofetchHash(HashQueryPlanBuilder builder)
```
    Calculate a hash used by AutoFetch to identify when a query has changed (and hence potentially needs a new tuned query plan to be developed).
    Excludes bind values and occurs prior to AutoFetch potentially tuning/modifying the query.
  - queryPlanHash
```
HashQueryPlan queryPlanHash(BeanQueryRequest<?> request)
```
    Identifies queries that are the same bar the bind variables.
    This is used AFTER AutoFetch has potentially tuned the query. This is used to identify and reused query plans (the final SQL string and associated SqlTree object).
    
    Excludes the actual bind values (as they don't effect the query plan).
  - queryBindHash
```
int queryBindHash()
```
    Calculate a hash based on the bind values used in the query.
    Combined with queryPlanHash() to return getQueryHash (a unique hash for a query).
  - queryHash
```
HashQuery queryHash()
```
    Identifies queries that are exactly the same including bind variables.
  - isSqlSelect
```
boolean isSqlSelect()
```
    Return true if this is a query based on a SqlSelect rather than generated.
  - isRawSql
```
boolean isRawSql()
```
    Return true if this is a RawSql query.
  - getOrderBy
```
OrderBy<T> getOrderBy()
```
    Return the Order By clause or null if there is none defined.
  - getAdditionalWhere
```
String getAdditionalWhere()
```
    Return additional where clause. This should be added to any where clause that was part of the original query.
  - getWhereExpressions
```
SpiExpressionList<T> getWhereExpressions()
```
    Can return null if no expressions where added to the where clause.
  - getHavingExpressions
```
SpiExpressionList<T> getHavingExpressions()
```
    Can return null if no expressions where added to the having clause.
  - getAdditionalHaving
```
String getAdditionalHaving()
```
    Return additional having clause. Where raw String expressions are added to having clause rather than Expression objects.
  - hasMaxRowsOrFirstRow
```
boolean hasMaxRowsOrFirstRow()
```
    Returns true if either firstRow or maxRows has been set.
  - isUseBeanCache
```
Boolean isUseBeanCache()
```
    Return true if this query should use/check the bean cache.
  - isUseQueryCache
```
boolean isUseQueryCache()
```
    Return true if this query should use/check the query cache.
  - isLoadBeanCache
```
boolean isLoadBeanCache()
```
    Return true if the beans from this query should be loaded into the bean cache.
  - isReadOnly
```
Boolean isReadOnly()
```
    Return true if the beans returned by this query should be read only.
  - contextAdd
```
void contextAdd(EntityBean bean)
```
    Adds this bean to the persistence context prior to executing the query.
  - getBeanType
```
Class<T> getBeanType()
```
    Return the type of beans queries.
  - getTimeout
```
int getTimeout()
```
    Return the query timeout.
  - getContextAdditions
```
ArrayList<EntityBean> getContextAdditions()
```
    Return the objects that should be added to the persistence context prior to executing the query.
  - getBindParams
```
BindParams getBindParams()
```
    Return the bind parameters.
  - getQuery
```
String getQuery()
```
    Get the orm query as a String. Only available if the query was built from a string.
  - setDetail
```
void setDetail(OrmQueryDetail detail)
```
    Replace the query detail. This is used by the autoFetch 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.
  - tuneFetchProperties
```
boolean tuneFetchProperties(OrmQueryDetail detail)
```
    Autofetch tune the detail specifying properties to select on already defined joins and adding extra joins where they are missing.
  - setAutoFetchTuned
```
void setAutoFetchTuned(boolean autoFetchTuned)
```
    Set to true if this query has been tuned by autoFetch.
  - getDetail
```
OrmQueryDetail getDetail()
```
    Return the query detail.
  - getIncludeTableJoin
```
TableJoin getIncludeTableJoin()
```
  - setIncludeTableJoin
```
void setIncludeTableJoin(TableJoin includeTableJoin)
```
  - getMapKey
```
String getMapKey()
```
    Return the property used to specify keys for a map.
  - getBackgroundFetchAfter
```
int getBackgroundFetchAfter()
```
    Return the number of rows after which fetching should occur in a background thread.
  - getMaxRows
```
int getMaxRows()
```
    Return the maximum number of rows to return in the query.
    
    Specified by:
    
    getMaxRows in interface Query<T>
  - getFirstRow
```
int getFirstRow()
```
    Return the index of the first row to return in the query.
    
    Specified by:
    
    getFirstRow in interface Query<T>
  - isDistinct
```
boolean isDistinct()
```
    return true if this query uses DISTINCT.
  - setDefaultSelectClause
```
void setDefaultSelectClause()
```
    Set default select clauses where none have been explicitly defined.
  - getRawWhereClause
```
String getRawWhereClause()
```
    Return the where clause from a parsed string query.
  - getId
```
Object getId()
```
    Return the Id value.
  - getListener
```
QueryListener<T> getListener()
```
    Return the queryListener.
  - createOwnTransaction
```
boolean createOwnTransaction()
```
    Return true if this query should use its own transaction.
    This is true for background fetching and when using QueryListener.
  - setGeneratedSql
```
void setGeneratedSql(String generatedSql)
```
    Set the generated sql for debug purposes.
    
    Parameters:
    generatedSql -
  - getBufferFetchSizeHint
```
int getBufferFetchSizeHint()
```
    Return the hint for Statement.setFetchSize().
  - isFutureFetch
```
boolean isFutureFetch()
```
    Return true if this is a query executing in the background.
  - setFutureFetch
```
void setFutureFetch(boolean futureFetch)
```
    Set to true to indicate the query is executing in a background thread asynchronously.
  - setCancelableQuery
```
void setCancelableQuery(CancelableQuery cancelableQuery)
```
    Set the underlying cancelable query (with the PreparedStatement).
  - isCancelled
```
boolean isCancelled()
```
    Return true if this query has been cancelled.

Interface SpiQuery<T>

Property Summary

Nested Class Summary

Method Summary

Methods inherited from interface com.avaje.ebean.Query

Property Detail

selectAllForLazyLoad

Method Detail

selectAllForLazyLoadProperty

setMode

getMode

getBeanCollectionTouched

setBeanCollectionTouched

setIdList

getIdList

copy

getType

setType

getLoadDescription

getLoadMode

setLazyLoadForParents

getLazyLoadForParentsProperty

getLazyLoadForParentIds

setLoadDescription

setBeanDescriptor

initManyWhereJoins

getManyWhereJoins

convertWhereNaturalKeyToId

getNaturalKeyBindParam

setSelectId

setFilterMany

removeQueryJoins

removeLazyJoins

setLazyLoadManyPath

convertManyFetchJoinsToQueryJoins

getPersistenceContext

setPersistenceContext

isDetailEmpty

isAutofetch

getAutoFetchManager

setAutoFetchManager

setOrigin

setParentNode

setLazyLoadProperty

getLazyLoadProperty

getLazyLoadManyPath

getParentNode

isUsageProfiling

setUsageProfiling

getName

queryAutofetchHash

queryPlanHash

queryBindHash

queryHash

isSqlSelect

isRawSql

getOrderBy

getAdditionalWhere

getWhereExpressions

getHavingExpressions

getAdditionalHaving

hasMaxRowsOrFirstRow

isUseBeanCache

isUseQueryCache

isLoadBeanCache

isReadOnly

contextAdd

getBeanType

getTimeout

getContextAdditions

getBindParams

getQuery

setDetail

tuneFetchProperties

setAutoFetchTuned

getDetail

getIncludeTableJoin

setIncludeTableJoin

getMapKey

getBackgroundFetchAfter