com.ibm.websphere.objectgrid.stats
Interface HashIndexStatsModule

All Superinterfaces:

StatsModule

public interface HashIndexStatsModule
extends StatsModule

This interface represents a statistic module for a HashIndex. A HashIndex statistic module contains 6 statistics:

1. batch update count
2. collision count
3. find operation count
4. find operation duration time
5. failure count
6. find operation result count

The path to a map statistic module is the ObjectGrid name, concatenated with "/", map name, and then the index name. You can also use an array to represent the path, with the first element being the ObjectGrid name, the second element being the map name, and the third being the index name.

Since:

WAS XD 6.1.0.5

See Also:

HashIndexMBean.retrieveStatsModule()

Field Summary

Fields inherited from interface com.ibm.websphere.objectgrid.stats.StatsModule

MODULE_TYPE_AGENT, MODULE_TYPE_HASHINDEX, MODULE_TYPE_MAP, MODULE_TYPE_OBJECT_GRID, MODULE_TYPE_QUERY, MODULE_TYPE_SESSION, MODULE_TYPE_UNDEFINED, PATH_DELIMITER

Method Summary

ActiveCountStatistic	getBatchUpdateCount(boolean copyMode) Gets the batch update count statistic.
ActiveCountStatistic	getFindCollisionCount(boolean copyMode) Gets the collision count statistic for the find operation.
ActiveCountStatistic	getFindCount(boolean copyMode) Gets the find operation's invocation count statistic.
TimeStatistic	getFindDurationTime(boolean copyMode) Gets the duration time statistic for the find operation.
ActiveCountStatistic	getFindFailureCount(boolean copyMode) Gets the failure count statistic for the find operation.
ActiveCountStatistic	getFindResultCount(boolean copyMode) Gets the result set's count statistic for the find operation.

Methods inherited from interface com.ibm.websphere.objectgrid.stats.StatsModule

combine, copy, getPath, getStatsSpec, reset, setGroupModule, statsToString, update

Method Detail

getFindCount

ActiveCountStatistic getFindCount(boolean copyMode)

Gets the find operation's invocation count statistic.

If the copyMode is set to true, a copy is returned. It is recommended to set the copy mode to true when this method is called in the same JVM as the JVM in which the statistics are gathered.

Parameters:

copyMode - if set to true, a copy is returned.

Returns:

the find count statistic

See Also:

ActiveCountStatistic

getFindDurationTime

TimeStatistic getFindDurationTime(boolean copyMode)

Gets the duration time statistic for the find operation.

If the copyMode is set to true, a copy is returned. It is recommended to set the copy mode to true when this method is called in the same JVM as the JVM in which the statistics are gathered.

Parameters:

copyMode - if set to true, a copy is returned.

Returns:

the duration time statistic

See Also:

ActiveTimeStatistic

getFindResultCount

ActiveCountStatistic getFindResultCount(boolean copyMode)

Gets the result set's count statistic for the find operation.

If the copyMode is set to true, a copy is returned. It is recommended to set the copy mode to true when this method is called in the same JVM as the JVM in which the statistics are gathered.

Parameters:

copyMode - if set to true, a copy is returned.

Returns:

the result count statistic

See Also:

ActiveCountStatistic

getFindFailureCount

ActiveCountStatistic getFindFailureCount(boolean copyMode)

Gets the failure count statistic for the find operation.

If the copyMode is set to true, a copy is returned. It is recommended to set the copy mode to true when this method is called in the same JVM as the JVM in which the statistics are gathered.

Parameters:

copyMode - if set to true, a copy is returned.

Returns:

the failure count statistic

See Also:

ActiveCountStatistic

getFindCollisionCount

ActiveCountStatistic getFindCollisionCount(boolean copyMode)

Gets the collision count statistic for the find operation.

If the copyMode is set to true, a copy is returned. It is recommended to set the copy mode to true when this method is called in the same JVM as the JVM in which the statistics are gathered.

Parameters:

copyMode - if set to true, a copy is returned.

Returns:

the collision count statistic

See Also:

ActiveCountStatistic

getBatchUpdateCount

ActiveCountStatistic getBatchUpdateCount(boolean copyMode)

Gets the batch update count statistic.

If the copyMode is set to true, a copy is returned. It is recommended to set the copy mode to true when this method is called in the same JVM as the JVM in which the statistics are gathered.

Parameters:

copyMode - if set to true, a copy is returned.

Returns:

the doBatchUpdate method's invocation count statistic

See Also:

ActiveCountStatistic, MapIndexPlugin.doBatchUpdate(TxID txid, LogSequence sequence)