org.datanucleus.store.query

Class QueryManagerImpl

java.lang.Object

org.datanucleus.store.query.QueryManagerImpl

All Implemented Interfaces:

QueryManager

Direct Known Subclasses:

FederatedQueryManagerImpl

public class QueryManagerImpl
extends Object
implements QueryManager

Manages the creation, compilation and results of queries. Provides caching of query compilations (generic and datastore-specific) and results.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,InvocationEvaluator>	inmemoryQueryMethodEvaluatorByName Cache of InvocationEvaluator objects keyed by the "class:methodName", for use by in-memory querying.
protected NucleusContext	nucleusCtx
protected QueryCompilationCache	queryCompilationCache Cache for generic query compilations.
protected QueryDatastoreCompilationCache	queryCompilationCacheDatastore Cache for datastore query compilations.
protected Map<String,String>	queryMethodAliasByPrefix
protected QueryResultsCache	queryResultsCache Cache for query results.
protected StoreManager	storeMgr

Constructor Summary

Constructors

Constructor and Description
QueryManagerImpl(NucleusContext nucleusContext, StoreManager storeMgr)

Method Summary

Modifier and Type	Method and Description
void	addDatastoreQueryCompilation(String datastore, String language, String query, Object compilation) Method to store the datastore-specific compilation for a query.
void	addQueryCompilation(String language, String query, QueryCompilation compilation) Method to store the compilation for a query.
void	addQueryResult(Query query, Map params, List<Object> results) Method to store the results for a query.
void	close() Close the QueryManager, releasing all cached compilations and results.
void	evictQueryResultsForType(Class cls) Method to evict all query results for the specified candidate type.
Object	getDatastoreQueryCompilation(String datastore, String language, String query) Accessor for the datastore-specific compilation for a query.
InvocationEvaluator	getInMemoryEvaluatorForMethod(Class type, String methodName) Accessor for an evaluator for invocation of the specified method for the supplied type.
QueryCompilationCache	getQueryCompilationCache() Accessor for the generic compilation cache.
QueryCompilation	getQueryCompilationForQuery(String language, String query) Accessor for a Query compilation for the specified query and language.
QueryDatastoreCompilationCache	getQueryDatastoreCompilationCache() Accessor for the datastore compilation cache.
Map<String,String>	getQueryMethodAliasesByPrefix() Accessor for JDOQL/JPQL query method aliases keyed by the prefix.
List<Object>	getQueryResult(Query query, Map params) Accessor for the results for a query.
QueryResultsCache	getQueryResultsCache() Accessor for the query results cache.
void	removeDatastoreQueryCompilation(String datastore, String language, String query) Method to remove a cached datastore query compilation.
void	removeQueryCompilation(String language, String query) Method to remove a query compilation.

Methods inherited from class java.lang.Object

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

Field Detail

nucleusCtx

protected NucleusContext nucleusCtx

storeMgr

protected StoreManager storeMgr

queryCompilationCache

protected final QueryCompilationCache queryCompilationCache

Cache for generic query compilations.

queryCompilationCacheDatastore

protected final QueryDatastoreCompilationCache queryCompilationCacheDatastore

Cache for datastore query compilations.

queryResultsCache

protected final QueryResultsCache queryResultsCache

Cache for query results.

inmemoryQueryMethodEvaluatorByName

protected Map<String,InvocationEvaluator> inmemoryQueryMethodEvaluatorByName

Cache of InvocationEvaluator objects keyed by the "class:methodName", for use by in-memory querying.

queryMethodAliasByPrefix

protected Map<String,String> queryMethodAliasByPrefix

Constructor Detail

QueryManagerImpl

public QueryManagerImpl(NucleusContext nucleusContext,
                        StoreManager storeMgr)

Method Detail

close

public void close()

Description copied from interface: QueryManager

Close the QueryManager, releasing all cached compilations and results.

Specified by:

close in interface QueryManager

getQueryMethodAliasesByPrefix

public Map<String,String> getQueryMethodAliasesByPrefix()

Description copied from interface: QueryManager

Accessor for JDOQL/JPQL query method aliases keyed by the prefix.

Specified by:

getQueryMethodAliasesByPrefix in interface QueryManager

Returns:

The method aliases map

getQueryCompilationCache

public QueryCompilationCache getQueryCompilationCache()

Description copied from interface: QueryManager

Accessor for the generic compilation cache.

Specified by:

getQueryCompilationCache in interface QueryManager

Returns:

The cache of generic compilations

addQueryCompilation

public void addQueryCompilation(String language,
                                String query,
                                QueryCompilation compilation)

Description copied from interface: QueryManager

Method to store the compilation for a query.

Specified by:

addQueryCompilation in interface QueryManager

Parameters:

language - Language of the query

query - The query string

compilation - The compilation of this query

removeQueryCompilation

public void removeQueryCompilation(String language,
                                   String query)

Description copied from interface: QueryManager

Method to remove a query compilation.

Specified by:

removeQueryCompilation in interface QueryManager

Parameters:

language - The query language

query - The query string

getQueryCompilationForQuery

public QueryCompilation getQueryCompilationForQuery(String language,
                                                    String query)

Description copied from interface: QueryManager

Accessor for a Query compilation for the specified query and language.

Specified by:

getQueryCompilationForQuery in interface QueryManager

Parameters:

language - Language of the query

query - Query string

Returns:

The compilation (if present)

getQueryDatastoreCompilationCache

public QueryDatastoreCompilationCache getQueryDatastoreCompilationCache()

Description copied from interface: QueryManager

Accessor for the datastore compilation cache.

Specified by:

getQueryDatastoreCompilationCache in interface QueryManager

Returns:

The cache of datastore compilations

addDatastoreQueryCompilation

public void addDatastoreQueryCompilation(String datastore,
                                         String language,
                                         String query,
                                         Object compilation)

Description copied from interface: QueryManager

Method to store the datastore-specific compilation for a query.

Specified by:

addDatastoreQueryCompilation in interface QueryManager

Parameters:

datastore - The datastore identifier

language - The query language

query - The query (string form)

compilation - The compiled information

removeDatastoreQueryCompilation

public void removeDatastoreQueryCompilation(String datastore,
                                            String language,
                                            String query)

Description copied from interface: QueryManager

Method to remove a cached datastore query compilation.

Specified by:

removeDatastoreQueryCompilation in interface QueryManager

Parameters:

datastore - The datastore

language - The language

query - The query (string form)

getDatastoreQueryCompilation

public Object getDatastoreQueryCompilation(String datastore,
                                           String language,
                                           String query)

Description copied from interface: QueryManager

Accessor for the datastore-specific compilation for a query.

Specified by:

getDatastoreQueryCompilation in interface QueryManager

Parameters:

datastore - The datastore identifier

language - The query language

query - The query (string form)

Returns:

The compiled information (if available)

getQueryResultsCache

public QueryResultsCache getQueryResultsCache()

Description copied from interface: QueryManager

Accessor for the query results cache.

Specified by:

getQueryResultsCache in interface QueryManager

Returns:

Query results cache (if present)

evictQueryResultsForType

public void evictQueryResultsForType(Class cls)

Description copied from interface: QueryManager

Method to evict all query results for the specified candidate type.

Specified by:

evictQueryResultsForType in interface QueryManager

Parameters:

cls - Candidate type

addQueryResult

public void addQueryResult(Query query,
                           Map params,
                           List<Object> results)

Description copied from interface: QueryManager

Method to store the results for a query.

Specified by:

addQueryResult in interface QueryManager

Parameters:

query - The query

params - Map of parameter values keyed by param name

results - The results (List of object identities)

getQueryResult

public List<Object> getQueryResult(Query query,
                                   Map params)

Description copied from interface: QueryManager

Accessor for the results for a query.

Specified by:

getQueryResult in interface QueryManager

Parameters:

query - The query

params - Map of parameter values keyed by param name

Returns:

The results (List of object identities)

getInMemoryEvaluatorForMethod

public InvocationEvaluator getInMemoryEvaluatorForMethod(Class type,
                                                         String methodName)

Description copied from interface: QueryManager

Accessor for an evaluator for invocation of the specified method for the supplied type. If it is not a supported method for that type then returns null.

Specified by:

getInMemoryEvaluatorForMethod in interface QueryManager

Parameters:

type - The class name

methodName - Name of the method

Returns:

Evaluator suitable for this type with this method name