public interface QueryMetadata
| Modifier and Type | Field and Description |
|---|---|
static String |
CACHE_GROUPS_PROPERTY |
static String |
CACHE_STRATEGY_PROPERTY |
static int |
FETCH_LIMIT_DEFAULT
Defines default query fetch limit, which is zero, meaning that all matching rows
should be fetched.
|
static String |
FETCH_LIMIT_PROPERTY
Defines the name of the property for the query
fetch limit
. |
static int |
FETCH_OFFSET_DEFAULT
Defines default query fetch start index, which is 0, meaning that matching rows
selected starting from the first.
|
static String |
FETCH_OFFSET_PROPERTY
Defines the name of the property for the query
fetch
offset. |
static boolean |
FETCHING_DATA_ROWS_DEFAULT |
static String |
FETCHING_DATA_ROWS_PROPERTY |
static int |
PAGE_SIZE_DEFAULT
Defines default query page size, which is zero for no pagination.
|
static String |
PAGE_SIZE_PROPERTY
Defines the name of the property for the query
page size. |
static int |
STATEMENT_FETCH_SIZE_DEFAULT
Defines default query fetch start index, which is 0, meaning that matching rows
selected starting from the first.
|
static String |
STATEMENT_FETCH_SIZE_PROPERTY
Defines the name of the property for the query
fetch
size. |
| Modifier and Type | Method and Description |
|---|---|
String |
getCacheGroup()
Returns an optional cache "group".
|
String[] |
getCacheGroups()
Deprecated.
since 4.0 only single cache group supported, use
getCacheGroup() instead |
String |
getCacheKey()
Returns a String that uniquely identifies this query for the purposes of result
caching.
|
QueryCacheStrategy |
getCacheStrategy()
Returns a caching strategy for this query.
|
ClassDescriptor |
getClassDescriptor() |
DataMap |
getDataMap()
Returns a DataMap associated with a query or null if no such DataMap exists.
|
DbEntity |
getDbEntity()
Returns a DbEntity associated with a query or null if no such entity exists.
|
int |
getFetchLimit()
Returns the limit on the maximum number of records that can be returned by this
query.
|
int |
getFetchOffset()
Specifies a start of a range when fetching a subset of records.
|
ObjEntity |
getObjEntity()
Returns an ObjEntity associated with a query or null if no such entity exists.
|
Query |
getOrginatingQuery()
Deprecated.
since 4.0, use
getOriginatingQuery() |
Query |
getOriginatingQuery()
Returns a query that originated this query.
|
int |
getPageSize()
Returns query page size.
|
Map<String,String> |
getPathSplitAliases()
Returns a map of aliases vs.
|
PrefetchTreeNode |
getPrefetchTree()
Returns a root node of prefetch tree used by this query, or null of no prefetches
are configured.
|
Procedure |
getProcedure()
Returns a Procedure associated with a query or null if no such procedure exists.
|
List<Object> |
getResultSetMapping()
Returns an optional list of result set mapping hints.
|
int |
getStatementFetchSize() |
boolean |
isFetchingDataRows()
Returns
true if this query should produce a list of data rows as
opposed to DataObjects, false for DataObjects. |
boolean |
isRefreshingObjects()
Returns
true if the query results should replace any currently cached
values, returns false otherwise. |
boolean |
isSingleResultSetMapping() |
boolean |
isSuppressingDistinct() |
static final String FETCH_LIMIT_PROPERTY
fetch limit
.static final int FETCH_LIMIT_DEFAULT
static final String FETCH_OFFSET_PROPERTY
fetch
offset.static final int FETCH_OFFSET_DEFAULT
static final String PAGE_SIZE_PROPERTY
page size.static final int PAGE_SIZE_DEFAULT
static final String FETCHING_DATA_ROWS_PROPERTY
static final boolean FETCHING_DATA_ROWS_DEFAULT
static final String CACHE_STRATEGY_PROPERTY
static final String CACHE_GROUPS_PROPERTY
static final String STATEMENT_FETCH_SIZE_PROPERTY
fetch
size.static final int STATEMENT_FETCH_SIZE_DEFAULT
ClassDescriptor getClassDescriptor()
ObjEntity getObjEntity()
DbEntity getDbEntity()
Procedure getProcedure()
DataMap getDataMap()
QueryCacheStrategy getCacheStrategy()
String getCacheKey()
@Deprecated String[] getCacheGroups()
getCacheGroup() insteadgetCacheGroup()String getCacheGroup()
boolean isFetchingDataRows()
true if this query should produce a list of data rows as
opposed to DataObjects, false for DataObjects. This is a hint to
QueryEngine executing this query.boolean isRefreshingObjects()
true if the query results should replace any currently cached
values, returns false otherwise. If isFetchingDataRows()
returns true, this setting is not applicable and has no effect.int getPageSize()
int getFetchOffset()
int getFetchLimit()
@Deprecated Query getOrginatingQuery()
getOriginatingQuery()Query getOriginatingQuery()
PrefetchTreeNode getPrefetchTree()
Map<String,String> getPathSplitAliases()
List<Object> getResultSetMapping()
EntityResultSegment or ScalarResultSegment. The returned
list can be null.boolean isSingleResultSetMapping()
getResultSetMapping()int getStatementFetchSize()
boolean isSuppressingDistinct()
Copyright © 2001–2023 Apache Cayenne. All rights reserved.