com.ibm.websphere.objectgrid.stats
Interface StatsModule

All Known Subinterfaces:

AgentStatsModule, HashIndexStatsModule, MapStatsModule, OGStatsModule, QueryStatsModule, SessionStatsModule

public interface StatsModule

This interface represents a statistic module. This is a super class of all the statistic module interfaces.

Since:

WAS XD 6.0.1

See Also:

MapStatsModule, OGStatsModule, SessionStatsModule, HashIndexStatsModule, AgentStatsModule, QueryStatsModule

Field Summary

static int	MODULE_TYPE_AGENT Agent statistic module type
static int	MODULE_TYPE_HASHINDEX HashIndex statistic module type
static int	MODULE_TYPE_MAP Map statistic module type
static int	MODULE_TYPE_OBJECT_GRID ObjectGrid statistic module type
static int	MODULE_TYPE_QUERY Query statistic module type
static int	MODULE_TYPE_SESSION Session statistic module type
static int	MODULE_TYPE_UNDEFINED Undefined module type
static String	PATH_DELIMITER The path delimiter to separate the paths to a statistic module

Method Summary

void	combine(StatsModule m) Combines the stats in this stats module with stats from another stats module.
StatsModule	copy() Gets a copy of this object.
String	getPath() Gets the statistic path to this module.
StatsSpec	getStatsSpec() Gets the StatsSpec object associated with this stats module.
void	reset() Resets all the statistics in this module to zero.
void	setGroupModule(boolean isGroupModule) Sets whether this stats module belongs to a StatsFact or StatsGroup.
String	statsToString() Gets a string representation of this statistic module including all the statistics in it.
void	update() Updates the statistics in this stats module.

Field Detail

PATH_DELIMITER

static final String PATH_DELIMITER

The path delimiter to separate the paths to a statistic module

See Also:

Constant Field Values

MODULE_TYPE_UNDEFINED

static final int MODULE_TYPE_UNDEFINED

Undefined module type

See Also:

Constant Field Values

MODULE_TYPE_MAP

static final int MODULE_TYPE_MAP

Map statistic module type

See Also:

Constant Field Values

MODULE_TYPE_OBJECT_GRID

static final int MODULE_TYPE_OBJECT_GRID

ObjectGrid statistic module type

See Also:

Constant Field Values

MODULE_TYPE_SESSION

static final int MODULE_TYPE_SESSION

Session statistic module type

See Also:

Constant Field Values

MODULE_TYPE_HASHINDEX

static final int MODULE_TYPE_HASHINDEX

HashIndex statistic module type

See Also:

Constant Field Values

MODULE_TYPE_AGENT

static final int MODULE_TYPE_AGENT

Agent statistic module type

See Also:

Constant Field Values

MODULE_TYPE_QUERY

static final int MODULE_TYPE_QUERY

Query statistic module type

See Also:

Constant Field Values

Method Detail

getStatsSpec

StatsSpec getStatsSpec()

Gets the StatsSpec object associated with this stats module.

Users can know which statistics are enabled or disabled from this StatsSpec object.

Returns:

the StatsSpec object associated with this stats module

See Also:

StatsSpec

reset

void reset()

Resets all the statistics in this module to zero.

combine

void combine(StatsModule m)

Combines the stats in this stats module with stats from another stats module.

Parameters:

m - the stats module to be combined

setGroupModule

void setGroupModule(boolean isGroupModule)

Sets whether this stats module belongs to a StatsFact or StatsGroup.

If it belongs to a StatsGroup, a true value should be set; otherwise false will be returned.

Parameters:

isGroupModule - true if this module belongs to a StatsGroup; false if this module belongs to a StatsFact

statsToString

String statsToString()

Gets a string representation of this statistic module including all the statistics in it.

Returns:

the string representation of this module's statistics

update

void update()

Updates the statistics in this stats module. This will make all the statistics have the latest value.

copy

StatsModule copy()

Gets a copy of this object.

Returns:

a copy of this object.

getPath

String getPath()

Gets the statistic path to this module.

A statistic path is an identifier for the statistic module in the statistic repository. Each statistic module should define its own unique path.

Returns:

the stats path to this module.