com.ibm.websphere.objectgrid.stats
Interface QueryStatsModule

All Superinterfaces:

StatsModule

public interface QueryStatsModule
extends StatsModule

This interface represents a statistic module for a Query. A Query statistic module contains 5 statistics:

1. plan creation time
2. execution count
3. execution time
4. failure count
5. result count

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

Since:

WAS XD 6.1.0.5

See Also:

QueryManagerMBean.retrieveStatsModule(String)

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

ActiveTimeStatistic	getPlanCreationTime(boolean copyMode) Gets the plan creation time statistic for this query.
ActiveCountStatistic	getQueryExecutionCount(boolean copyMode) Gets the execution count statistic for this query.
ActiveTimeStatistic	getQueryExecutionTime(boolean copyMode) Gets the execution time statistic for this query.
ActiveCountStatistic	getQueryFailureCount(boolean copyMode) Gets the failure count statistic for this query.
ActiveCountStatistic	getQueryResultCount(boolean copyMode) Gets the result count statistic for this query.

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

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

Method Detail

getPlanCreationTime

ActiveTimeStatistic getPlanCreationTime(boolean copyMode)

Gets the plan creation time statistic for this query.

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 plan creation time statistic

See Also:

ActiveTimeStatistic

getQueryExecutionTime

ActiveTimeStatistic getQueryExecutionTime(boolean copyMode)

Gets the execution time statistic for this query.

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 execution time statistic

See Also:

ActiveTimeStatistic

getQueryExecutionCount

ActiveCountStatistic getQueryExecutionCount(boolean copyMode)

Gets the execution count statistic for this query.

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 execution count statistic

See Also:

ActiveCountStatistic

getQueryResultCount

ActiveCountStatistic getQueryResultCount(boolean copyMode)

Gets the result count statistic for this query.

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

getQueryFailureCount

ActiveCountStatistic getQueryFailureCount(boolean copyMode)

Gets the failure count statistic for this query.

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