io.jmix.eclipselink.impl.entitycache

Class QueryCacheManager

java.lang.Object

io.jmix.eclipselink.impl.entitycache.QueryCacheManager

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	log
protected io.jmix.core.Metadata	metadata
protected io.jmix.core.MetadataTools	metadataTools
protected EclipselinkProperties	properties
protected QueryCache	queryCache
protected StoreAwareLocator	storeAwareLocator

Constructor Summary

Constructors

Constructor and Description
QueryCacheManager()

Method Summary

Modifier and Type	Method and Description
protected java.util.Set<java.lang.String>	getDescendants(java.util.Set<java.lang.String> relatedTypes)
<T> java.util.List<T>	getResultListFromCache(QueryKey queryKey, java.util.List<io.jmix.core.FetchPlan> fetchPlans) Get query results from query cache by specified queryKey
<T> T	getSingleResultFromCache(QueryKey queryKey, java.util.List<io.jmix.core.FetchPlan> fetchPlans) Get single query results from query cache by specified queryKey If query is cached and no results found exception is thrown
void	invalidate(java.lang.Class typeClass) Discards cached query results for java class (associated with metaClass) typeClass
void	invalidate(java.util.Set<java.lang.String> typeNames) Discards cached query results for metaClass names typeNames
void	invalidate(java.lang.String typeName) Discards cached query results for metaClass name typeName
void	invalidateAll()
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

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

Field Detail

properties

@Autowired
protected EclipselinkProperties properties

queryCache

@Autowired
protected QueryCache queryCache

metadata

@Autowired
protected io.jmix.core.Metadata metadata

metadataTools

@Autowired
protected io.jmix.core.MetadataTools metadataTools

storeAwareLocator

@Autowired
protected StoreAwareLocator storeAwareLocator

log

protected static final org.slf4j.Logger log

Constructor Detail

QueryCacheManager

public QueryCacheManager()

Method Detail

isEnabled

public boolean isEnabled()

Returns true if query cache enabled

getResultListFromCache

public <T> java.util.List<T> getResultListFromCache(QueryKey queryKey,
                                                    java.util.List<io.jmix.core.FetchPlan> fetchPlans)

Get query results from query cache by specified queryKey

getSingleResultFromCache

public <T> T getSingleResultFromCache(QueryKey queryKey,
                                      java.util.List<io.jmix.core.FetchPlan> fetchPlans)

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)

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

invalidate

public void invalidate(java.lang.String typeName)

Discards cached query results for metaClass name typeName

invalidate

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

Discards cached query results for metaClass names typeNames

invalidateAll

public void invalidateAll()

getDescendants

protected java.util.Set<java.lang.String> getDescendants(java.util.Set<java.lang.String> relatedTypes)