org.datanucleus.store.query.cache

Class AbstractQueryCompilationCache

java.lang.Object

org.datanucleus.store.query.cache.AbstractQueryCompilationCache

All Implemented Interfaces:

QueryCompilationCache

Direct Known Subclasses:

SoftQueryCompilationCache, StrongQueryCompilationCache, WeakQueryCompilationCache

public abstract class AbstractQueryCompilationCache
extends Object
implements QueryCompilationCache

Abstract representation of a cache of generic query compilations.

Constructor Summary

Constructors

Constructor and Description
AbstractQueryCompilationCache()

Method Summary

Modifier and Type	Method and Description
void	clear() Method to clear the cache.
void	close() Method to close the cache when no longer needed.
boolean	contains(String queryKey) Accessor for whether the specified query is in the cache
void	evict(String queryKey) Evict the query from the compilation cache.
QueryCompilation	get(String queryKey) Accessor for a (generic) compilation from the cache.
boolean	isEmpty() Accessor for whether the cache is empty.
QueryCompilation	put(String queryKey, QueryCompilation compilation) Method to put an object in the cache.
int	size() Accessor for the total number of compilations in the query cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractQueryCompilationCache

public AbstractQueryCompilationCache()

Method Detail

clear

public void clear()

Description copied from interface: QueryCompilationCache

Method to clear the cache.

Specified by:

clear in interface QueryCompilationCache

close

public void close()

Description copied from interface: QueryCompilationCache

Method to close the cache when no longer needed. Provides a hook to release resources etc.

Specified by:

close in interface QueryCompilationCache

contains

public boolean contains(String queryKey)

Description copied from interface: QueryCompilationCache

Accessor for whether the specified query is in the cache

Specified by:

contains in interface QueryCompilationCache

Parameters:

queryKey - The query key

Returns:

Whether it is in the cache

evict

public void evict(String queryKey)

Description copied from interface: QueryCompilationCache

Evict the query from the compilation cache.

Specified by:

evict in interface QueryCompilationCache

Parameters:

queryKey - Key for the query to evict.

get

public QueryCompilation get(String queryKey)

Description copied from interface: QueryCompilationCache

Accessor for a (generic) compilation from the cache.

Specified by:

get in interface QueryCompilationCache

Parameters:

queryKey - The query key

Returns:

The cached query compilation

isEmpty

public boolean isEmpty()

Description copied from interface: QueryCompilationCache

Accessor for whether the cache is empty.

Specified by:

isEmpty in interface QueryCompilationCache

Returns:

Whether it is empty.

put

public QueryCompilation put(String queryKey,
                            QueryCompilation compilation)

Description copied from interface: QueryCompilationCache

Method to put an object in the cache.

Specified by:

put in interface QueryCompilationCache

Parameters:

queryKey - The query key

compilation - The compilation to cache

Returns:

The cached query previously associated with this query

size

public int size()

Description copied from interface: QueryCompilationCache

Accessor for the total number of compilations in the query cache.

Specified by:

size in interface QueryCompilationCache

Returns:

Number of queries