org.apache.jcs.engine.stats

Class CacheStats

java.lang.Object

org.apache.jcs.engine.stats.Stats

org.apache.jcs.engine.stats.CacheStats

All Implemented Interfaces:

java.io.Serializable, ICacheStats, IStats

public class CacheStats
extends Stats
implements ICacheStats

This class stores cache historical and statistics data for a region.

Only the composite cache knows what the hit count across all auxiliaries is.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CacheStats()

Method Summary

Methods

Modifier and Type	Method and Description
IStats[]	getAuxiliaryCacheStats()
java.lang.String	getRegionName() Stats are for a region, though auxiliary data may be for more.
IStatElement[]	getStatElements() This returns data about the auxiliaries, such as hit count.
void	setAuxiliaryCacheStats(IStats[] stats)
void	setRegionName(java.lang.String name) Stats are for a region, though auxiliary data may be for more.
void	setStatElements(IStatElement[] stats) Set the generic statistical or historical data.
java.lang.String	toString()

Methods inherited from class org.apache.jcs.engine.stats.Stats

getTypeName, setTypeName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.jcs.engine.stats.behavior.IStats

getTypeName, setTypeName

Constructor Detail

CacheStats

public CacheStats()

Method Detail

getRegionName

public java.lang.String getRegionName()

Stats are for a region, though auxiliary data may be for more.

Specified by:

getRegionName in interface ICacheStats

Returns:

The region name

setRegionName

public void setRegionName(java.lang.String name)

Stats are for a region, though auxiliary data may be for more.

Specified by:

setRegionName in interface ICacheStats

Parameters:

name - - The region name

getAuxiliaryCacheStats

public IStats[] getAuxiliaryCacheStats()

Specified by:

getAuxiliaryCacheStats in interface ICacheStats

Returns:

IStats[]

setAuxiliaryCacheStats

public void setAuxiliaryCacheStats(IStats[] stats)

Specified by:

setAuxiliaryCacheStats in interface ICacheStats

Parameters:

stats -

getStatElements

public IStatElement[] getStatElements()

This returns data about the auxiliaries, such as hit count. Only the composite cache knows what the hit count across all auxiliaries is.

Specified by:

getStatElements in interface IStats

Overrides:

getStatElements in class Stats

Returns:

IStatElement[]

setStatElements

public void setStatElements(IStatElement[] stats)

Description copied from interface: IStats

Set the generic statistical or historical data.

Specified by:

setStatElements in interface IStats

Overrides:

setStatElements in class Stats

Parameters:

stats -

toString

public java.lang.String toString()

Overrides:

toString in class Stats

Returns:

readable string that can be logged.