org.datanucleus.store.query.cache
Interface QueryDatastoreCompilationCache

All Known Implementing Classes:
AbstractQueryDatastoreCompilationCache, SoftQueryDatastoreCompilationCache, StrongQueryDatastoreCompilationCache, WeakQueryDatastoreCompilationCache

public interface QueryDatastoreCompilationCache

Cache for query compilations (datastore-specific).


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

Method Detail

close

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


evict

void evict(java.lang.String queryKey)
Evict the query from the compilation cache.

Parameters:
queryKey - Key for the query to evict.

clear

void clear()
Method to clear the cache.


isEmpty

boolean isEmpty()
Accessor for whether the cache is empty.

Returns:
Whether it is empty.

size

int size()
Accessor for the total number of compilations in the query cache.

Returns:
Number of queries

get

java.lang.Object get(java.lang.String queryKey)
Accessor for a (generic) compilation from the cache.

Parameters:
queryKey - The query key
Returns:
The cached query compilation

put

java.lang.Object put(java.lang.String queryKey,
                     java.lang.Object compilation)
Method to put an object in the cache.

Parameters:
queryKey - The query key
compilation - The compilation for this datastore
Returns:
The cached compilation previously associated with this query (if any)

contains

boolean contains(java.lang.String queryKey)
Accessor for whether the specified query is in the cache

Parameters:
queryKey - The query key
Returns:
Whether it is in the cache


Copyright © 2011. All Rights Reserved.