|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface QueryMetadata
Provides a common interface for accessing query metadata.
Field Summary | |
---|---|
static String |
CACHE_GROUPS_PROPERTY
|
static String |
CACHE_POLICY_DEFAULT
Deprecated. since 3.0 use QueryCacheStrategy enum. |
static String |
CACHE_POLICY_PROPERTY
Deprecated. since 3.0 use "cayenne.GenericSelectQuery.cacheStrategy" |
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 boolean |
FETCHING_DATA_ROWS_DEFAULT
|
static String |
FETCHING_DATA_ROWS_PROPERTY
|
static String |
LOCAL_CACHE
Deprecated. since 3.0 use QueryCacheStrategy enum. |
static String |
LOCAL_CACHE_REFRESH
Deprecated. since 3.0 use QueryCacheStrategy enum. |
static String |
NO_CACHE
Deprecated. since 3.0 use QueryCacheStrategy enum. |
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 boolean |
REFRESHING_OBJECTS_DEFAULT
|
static String |
REFRESHING_OBJECTS_PROPERTY
|
static boolean |
RESOLVING_INHERITED_DEFAULT
|
static String |
RESOLVING_INHERITED_PROPERTY
|
static String |
SHARED_CACHE
Deprecated. since 3.0 use QueryCacheStrategy enum. |
static String |
SHARED_CACHE_REFRESH
Deprecated. since 3.0 use QueryCacheStrategy enum. |
Method Summary | |
---|---|
String[] |
getCacheGroups()
Returns an optional array of cache "groups". |
String |
getCacheKey()
Returns a String that uniquely identifies this query for the purposes of result caching. |
String |
getCachePolicy()
Deprecated. since 3.0 getCacheStrategy() replaces this method. |
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 |
getFetchStartIndex()
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()
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. |
SQLResultSetMapping |
getResultSetMapping()
Returns a mapping of the result set data rows. |
boolean |
isFetchingDataRows()
Returns true if this query should produce a list of data rows as
opposed to DataObjects, false for DataObjects. |
boolean |
isRefreshingObjects()
Deprecated. since 3.0. With introduction of the cache strategies this setting is redundant, although it is still being taken into account. It will be removed in the later versions of Cayenne. |
boolean |
isResolvingInherited()
Returns true if objects fetched via this query should be fully resolved according to the inheritance hierarchy. |
Field Detail |
---|
static final String NO_CACHE
QueryCacheStrategy
enum.
static final String LOCAL_CACHE
QueryCacheStrategy
enum.
static final String LOCAL_CACHE_REFRESH
QueryCacheStrategy
enum.LOCAL_CACHE
, only forcing any current cache expiration.
static final String SHARED_CACHE
QueryCacheStrategy
enum.
static final String SHARED_CACHE_REFRESH
QueryCacheStrategy
enum.SHARED_CACHE
, only forcing any current cache expiration.
static final String FETCH_LIMIT_PROPERTY
fetch limit
.
static final int FETCH_LIMIT_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 REFRESHING_OBJECTS_PROPERTY
static final boolean REFRESHING_OBJECTS_DEFAULT
static final String RESOLVING_INHERITED_PROPERTY
static final boolean RESOLVING_INHERITED_DEFAULT
static final String CACHE_POLICY_PROPERTY
static final String CACHE_STRATEGY_PROPERTY
static final String CACHE_GROUPS_PROPERTY
static final String CACHE_POLICY_DEFAULT
QueryCacheStrategy
enum.Method Detail |
---|
ClassDescriptor getClassDescriptor()
ObjEntity getObjEntity()
DbEntity getDbEntity()
Procedure getProcedure()
DataMap getDataMap()
String getCachePolicy()
getCacheStrategy()
replaces this method.
NO_CACHE
,
LOCAL_CACHE
, or SHARED_CACHE
. NO_CACHE is generally a default
policy.
QueryCacheStrategy getCacheStrategy()
String getCacheKey()
String[] getCacheGroups()
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.
boolean isResolvingInherited()
int getPageSize()
int getFetchStartIndex()
getFetchLimit()
.
int getFetchLimit()
Query getOrginatingQuery()
PrefetchTreeNode getPrefetchTree()
Map<String,String> getPathSplitAliases()
SQLResultSetMapping getResultSetMapping()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |