CacheableQuery (cayenne-doc: Cayenne Documentation 5.0-M2 API)
Description: declaration: package: org.apache.cayenne.query, class: CacheableQuery

# Class CacheableQuery

java.lang.Object
org.apache.cayenne.query.CacheableQuery

All Implemented Interfaces:
  `Serializable, Query`

Direct Known Subclasses:
  `AbstractQuery, EJBQLQuery`

public abstract class CacheableQuery extends Object implements Query
Shared functionality for cacheable queries.

Since:
  4.0
See Also:
  - Serialized Form

- ## Field Summary

  Fields
  Modifier and Type
  Field
  Description
  `protected static final org.slf4j.Logger`
  `logger`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `CacheableQuery()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `protected abstract org.apache.cayenne.query.BaseQueryMetadata`
  `getBaseMetaData()`
  `String`
  `getCacheGroup()`
  `QueryCacheStrategy`
  `getCacheStrategy()`
  `void`
  `setCacheGroup(String cacheGroup)`
  `void`
  `setCacheStrategy(QueryCacheStrategy strategy)`
  `void`
  `useLocalCache()`
  Instructs Cayenne to look for query results in the "local" cache when running the query.
  `void`
  `useLocalCache(String cacheGroup)`
  Instructs Cayenne to look for query results in the "local" cache when running the query.
  `void`
  `useSharedCache()`
  Instructs Cayenne to look for query results in the "shared" cache when running the query.
  `void`
  `useSharedCache(String cacheGroup)`
  Instructs Cayenne to look for query results in the "shared" cache when running the query.

  ### Methods inherited from class Object

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

  ### Methods inherited from interface Query

  `createSQLAction, getMetaData, route`
  Modifier and Type
  Method
  Description
  `SQLAction`
  `createSQLAction(SQLActionVisitor visitor)`
  A callback method invoked by Cayenne during the final execution phase of the query run.
  `QueryMetadata`
  `getMetaData(EntityResolver resolver)`
  Returns query runtime parameters.
  `void`
  `route(QueryRouter router, EntityResolver resolver, Query substitutedQuery)`
  A callback method invoked by Cayenne during the routing phase of the query execution.

- ## Field Details

  - ### logger

    protected static final org.slf4j.Logger logger

- ## Constructor Details

  - ### CacheableQuery

    public CacheableQuery()

- ## Method Details

  - ### getBaseMetaData

    protected abstract org.apache.cayenne.query.BaseQueryMetadata getBaseMetaData()

  - ### getCacheStrategy

    public QueryCacheStrategy getCacheStrategy()
    Since:
      3.0

  - ### setCacheStrategy

    public void setCacheStrategy(QueryCacheStrategy strategy)
    Since:
      3.0

  - ### getCacheGroup

    public String getCacheGroup()
    Since:
      4.0

  - ### setCacheGroup

    public void setCacheGroup(String cacheGroup)
    Since:
      4.0

  - ### useLocalCache

    public void useLocalCache()
    Instructs Cayenne to look for query results in the "local" cache when running the query. This is a short-hand notation for:

        query.setCacheStrategy(QueryCacheStrategy.LOCAL_CACHE);

    Since:
      4.0

  - ### useLocalCache

    public void useLocalCache(String cacheGroup)
    Instructs Cayenne to look for query results in the "local" cache when running the query. This is a short-hand notation for:

        query.setCacheStrategy(QueryCacheStrategy.LOCAL_CACHE);
        query.setCacheGroups("group1", "group2");

    Since:
      4.0

  - ### useSharedCache

    public void useSharedCache()
    Instructs Cayenne to look for query results in the "shared" cache when running the query. This is a short-hand notation for:

        query.setCacheStrategy(QueryCacheStrategy.SHARED_CACHE);

    Since:
      4.0

  - ### useSharedCache

    public void useSharedCache(String cacheGroup)
    Instructs Cayenne to look for query results in the "shared" cache when running the query. This is a short-hand notation for:

        query.setCacheStrategy(QueryCacheStrategy.SHARED_CACHE);
        query.setCacheGroups("group1", "group2");

    Since:
      4.0