com.haulmont.cuba.core.sys.entitycache

Class QueryCacheManager

java.lang.Object

com.haulmont.cuba.core.sys.entitycache.QueryCacheManager

@Component(value="cuba_QueryCacheManager")
public class QueryCacheManager
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Constructor Summary

Constructors

Constructor and Description
QueryCacheManager()

Method Summary

Modifier and Type	Method and Description
<T> java.util.List<T>	getResultListFromCache(QueryKey queryKey, java.util.List<View> views) Get query results from query cache by specified queryKey
<T> T	getSingleResultFromCache(QueryKey queryKey, java.util.List<View> views) Get single query results from query cache by specified queryKey If query is cached and no results found exception is thrown
void	init()
void	invalidate(java.lang.Class typeClass, boolean sendInCluster) Discards cached query results for java class (associated with metaClass) typeClass
void	invalidate(java.util.Set<java.lang.String> typeNames, boolean sendInCluster) Discards cached query results for metaClass names typeNames
void	invalidate(java.lang.String typeName, boolean sendInCluster) Discards cached query results for metaClass name typeName
void	invalidate(java.util.UUID queryId, boolean sendInCluster) Discards cached query results for query identifier queryId
void	invalidateAll(boolean sendInCluster) Discards all query results in the cache.
boolean	isEnabled() Returns true if query cache enabled
void	putResultToCache(QueryKey queryKey, java.util.List resultList, java.lang.String type, java.util.Set<java.lang.String> relatedTypes) Put query results into query cache for specified query queryKey.
<T> void	putResultToCache(QueryKey queryKey, T result, java.lang.String type, java.util.Set<java.lang.String> relatedTypes, java.lang.RuntimeException exception) Put query results into query cache for specified query queryKey.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

QueryCacheManager

public QueryCacheManager()

Method Detail

init

@PostConstruct
public void init()

isEnabled

public boolean isEnabled()

Returns true if query cache enabled

getResultListFromCache

public <T> java.util.List<T> getResultListFromCache(QueryKey queryKey,
                                                    java.util.List<View> views)

Get query results from query cache by specified queryKey

getSingleResultFromCache

public <T> T getSingleResultFromCache(QueryKey queryKey,
                                      java.util.List<View> views)

Get single query results from query cache by specified queryKey If query is cached and no results found exception is thrown

putResultToCache

public void putResultToCache(QueryKey queryKey,
                             java.util.List resultList,
                             java.lang.String type,
                             java.util.Set<java.lang.String> relatedTypes)

Put query results into query cache for specified query queryKey. Results are extracted as identifiers from resultList

Parameters:

type - - result entity type (metaClass name)

relatedTypes - - query dependent types (metaClass names). It's a list of entity types used in query

putResultToCache

public <T> void putResultToCache(QueryKey queryKey,
                                 T result,
                                 java.lang.String type,
                                 java.util.Set<java.lang.String> relatedTypes,
                                 java.lang.RuntimeException exception)

Put query results into query cache for specified query queryKey. Results are extracted as identifiers from entity result

Parameters:

type - - result entity type (metaClass name)

relatedTypes - - query dependent types (metaClass names). It's a list of entity types used in query

exception - - store exception in the query cache if TypedQuery.getSingleResult() throws exception

invalidate

public void invalidate(java.lang.Class typeClass,
                       boolean sendInCluster)

Discards cached query results for java class (associated with metaClass) typeClass

Parameters:

sendInCluster - - if true - discard queries results in all query caches in cluster

invalidate

public void invalidate(java.lang.String typeName,
                       boolean sendInCluster)

Discards cached query results for metaClass name typeName

Parameters:

sendInCluster - - if true - discard queries results in all query caches in cluster

invalidate

public void invalidate(java.util.Set<java.lang.String> typeNames,
                       boolean sendInCluster)

Discards cached query results for metaClass names typeNames

Parameters:

sendInCluster - - if true - discard queries results in all query caches in cluster

invalidate

public void invalidate(java.util.UUID queryId,
                       boolean sendInCluster)

Discards cached query results for query identifier queryId

Parameters:

sendInCluster - - if true - discard queries results in all query caches in cluster

invalidateAll

public void invalidateAll(boolean sendInCluster)

Discards all query results in the cache.

Parameters:

sendInCluster - - if true - discard queries results in all query caches in cluster