Package org.apache.openjpa.instrumentation

Class AbstractQueryCacheInstrument

java.lang.Object

org.apache.openjpa.lib.instrumentation.AbstractInstrument

org.apache.openjpa.instrumentation.AbstractQueryCacheInstrument

All Implemented Interfaces:

QueryCacheInstrument, Instrument

Direct Known Subclasses:

QueryCacheJMXInstrument

public abstract class AbstractQueryCacheInstrument
extends AbstractInstrument
implements QueryCacheInstrument

Provides a basic instrument implementation wrapper for the query cache. This class can be extended to create a provider specific instrument for the query cache.

Field Summary

Fields

Modifier and Type	Field	Description
static long	NO_STATS	Value indicating that cache statistics are not available.

Constructor Summary

Constructors

Constructor	Description
AbstractQueryCacheInstrument()

Method Summary

Modifier and Type	Method	Description
long	count()	Returns the number of total entries in the cache.
String	getConfigId()
String	getContextRef()
long	getEvictionCount()	Returns number of total evictions since last reset
long	getExecutionCount()	Returns number of total execution requests since last reset
long	getExecutionCount(String queryKey)	Returns number of total execution requests since last reset for the specified string-ified query key.
long	getHitCount()	Returns number of total read requests that have been found in cache since last reset.
long	getHitCount(String queryKey)	Returns number of total read requests that have been found in cache since last reset for the specified string-ified query key.
InstrumentationLevel	getLevel()	Gets the instrumentation level of this instrument.
long	getTotalEvictionCount()	Returns number of total eviction requests since start.
long	getTotalExecutionCount()	Returns number of total exec requests since start.
long	getTotalExecutionCount(String queryKey)	Returns number of total exec requests since start for the specified string-ified query key.
long	getTotalHitCount()	Returns number of total read requests that has been found since start.
long	getTotalHitCount(String queryKey)	Returns number of total read requests that has been found since start for the specified string-ified query key.
Set<String>	queryKeys()	Returns all query keys currently tracked in the cache.
void	reset()	Resets cache statistics
void	setConfigId(String cid)
void	setContextRef(String cref)
void	setPreparedQueryCache(QueryCache qc)
void	setQueryCache(QueryCache qc)
Date	sinceDate()	Returns date since cache statistics collection were last reset.
Date	startDate()	Returns date cache statistics collection started.

Methods inherited from class org.apache.openjpa.lib.instrumentation.AbstractInstrument

getContext, getName, getOptions, getProvider, initialize, isStarted, restart, setContext, setOptions, setProvider, setStarted

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.openjpa.lib.instrumentation.Instrument

start, stop

Field Detail

NO_STATS

public static final long NO_STATS

Value indicating that cache statistics are not available.

See Also:

Constant Field Values

Constructor Detail

AbstractQueryCacheInstrument

public AbstractQueryCacheInstrument()

Method Detail

setQueryCache

public void setQueryCache(QueryCache qc)

setConfigId

public void setConfigId(String cid)

setContextRef

public void setContextRef(String cref)

getConfigId

public String getConfigId()

getContextRef

public String getContextRef()

setPreparedQueryCache

public void setPreparedQueryCache(QueryCache qc)

getExecutionCount

public long getExecutionCount()

Description copied from interface: QueryCacheInstrument

Returns number of total execution requests since last reset

Specified by:

getExecutionCount in interface QueryCacheInstrument

getExecutionCount

public long getExecutionCount(String queryKey)

Description copied from interface: QueryCacheInstrument

Returns number of total execution requests since last reset for the specified string-ified query key.

Specified by:

getExecutionCount in interface QueryCacheInstrument

getTotalExecutionCount

public long getTotalExecutionCount()

Description copied from interface: QueryCacheInstrument

Returns number of total exec requests since start.

Specified by:

getTotalExecutionCount in interface QueryCacheInstrument

getTotalExecutionCount

public long getTotalExecutionCount(String queryKey)

Description copied from interface: QueryCacheInstrument

Returns number of total exec requests since start for the specified string-ified query key.

Specified by:

getTotalExecutionCount in interface QueryCacheInstrument

getHitCount

public long getHitCount()

Description copied from interface: QueryCacheInstrument

Returns number of total read requests that have been found in cache since last reset.

Specified by:

getHitCount in interface QueryCacheInstrument

getHitCount

public long getHitCount(String queryKey)

Description copied from interface: QueryCacheInstrument

Returns number of total read requests that have been found in cache since last reset for the specified string-ified query key.

Specified by:

getHitCount in interface QueryCacheInstrument

getTotalHitCount

public long getTotalHitCount()

Description copied from interface: QueryCacheInstrument

Returns number of total read requests that has been found since start.

Specified by:

getTotalHitCount in interface QueryCacheInstrument

getTotalHitCount

public long getTotalHitCount(String queryKey)

Description copied from interface: QueryCacheInstrument

Returns number of total read requests that has been found since start for the specified string-ified query key.

Specified by:

getTotalHitCount in interface QueryCacheInstrument

reset

public void reset()

Description copied from interface: QueryCacheInstrument

Resets cache statistics

Specified by:

reset in interface QueryCacheInstrument

sinceDate

public Date sinceDate()

Description copied from interface: QueryCacheInstrument

Returns date since cache statistics collection were last reset.

Specified by:

sinceDate in interface QueryCacheInstrument

startDate

public Date startDate()

Description copied from interface: QueryCacheInstrument

Returns date cache statistics collection started.

Specified by:

startDate in interface QueryCacheInstrument

getEvictionCount

public long getEvictionCount()

Returns number of total evictions since last reset

Specified by:

getEvictionCount in interface QueryCacheInstrument

getTotalEvictionCount

public long getTotalEvictionCount()

Returns number of total eviction requests since start.

Specified by:

getTotalEvictionCount in interface QueryCacheInstrument

queryKeys

public Set<String> queryKeys()

Returns all query keys currently tracked in the cache.

Specified by:

queryKeys in interface QueryCacheInstrument

count

public long count()

Description copied from interface: QueryCacheInstrument

Returns the number of total entries in the cache.

Specified by:

count in interface QueryCacheInstrument

Returns:

entries

getLevel

public InstrumentationLevel getLevel()

Description copied from interface: Instrument

Gets the instrumentation level of this instrument. The instrumentation level determines if and when the instrument will automatically start and stop.

Specified by:

getLevel in interface Instrument

Overrides:

getLevel in class AbstractInstrument

Returns:

the instrumentation level of the instrument