org.hibernate.stat

Interface CacheRegionStatistics

All Superinterfaces:

Serializable

All Known Subinterfaces:

SecondLevelCacheStatistics

All Known Implementing Classes:

CacheRegionStatisticsImpl

public interface CacheRegionStatistics
extends Serializable

Second level cache statistics of a specific region

Author:

Gavin King

Field Summary

Fields

Modifier and Type	Field and Description
static long	NO_EXTENDED_STAT_SUPPORT_RETURN The value returned from getElementCountInMemory(), getElementCountOnDisk() and getSizeInMemory() for cache providers that do not support such "extended" statistics.

Method Summary

Modifier and Type	Method and Description
long	getElementCountInMemory() The number of elements currently in memory within the cache provider.
long	getElementCountOnDisk() The number of elements currently stored to disk within the cache provider.
long	getHitCount() The number of successful cache look-ups against the region since the last Statistics clearing
long	getMissCount() The number of unsuccessful cache look-ups against the region since the last Statistics clearing
long	getPutCount() The number of cache puts into the region since the last Statistics clearing
String	getRegionName()
long	getSizeInMemory() The size that the in-memory elements take up within the cache provider.

Field Detail

NO_EXTENDED_STAT_SUPPORT_RETURN

static final long NO_EXTENDED_STAT_SUPPORT_RETURN

The value returned from getElementCountInMemory(), getElementCountOnDisk() and getSizeInMemory() for cache providers that do not support such "extended" statistics.

See Also:

Constant Field Values

Method Detail

getRegionName

String getRegionName()

getPutCount

long getPutCount()

The number of cache puts into the region since the last Statistics clearing

getHitCount

long getHitCount()

The number of successful cache look-ups against the region since the last Statistics clearing

getMissCount

long getMissCount()

The number of unsuccessful cache look-ups against the region since the last Statistics clearing

getElementCountInMemory

long getElementCountInMemory()

The number of elements currently in memory within the cache provider. This is an optional value contingent upon the underlying cache provider providing extended stats support via ExtendedStatisticsSupport. If the provider does not support extended stats, NO_EXTENDED_STAT_SUPPORT_RETURN is returned instead.

getElementCountOnDisk

long getElementCountOnDisk()

The number of elements currently stored to disk within the cache provider. This is an optional value contingent upon the underlying cache provider providing extended stats support via ExtendedStatisticsSupport. If the provider does not support extended stats, NO_EXTENDED_STAT_SUPPORT_RETURN is returned instead.

getSizeInMemory

long getSizeInMemory()

The size that the in-memory elements take up within the cache provider. This is an optional value contingent upon the underlying cache provider providing extended stats support via ExtendedStatisticsSupport. If the provider does not support extended stats, NO_EXTENDED_STAT_SUPPORT_RETURN is returned instead.