com.metamatrix.common.pooling.api
Interface PoolStatistic

All Known Implementing Classes:

AvgStat, BasicPoolStatistic, CounterStat, HighestValueStat, LowestValueStat, SumStat

public interface PoolStatistic

Created on May 9, 2002 A PoolStatistic represents one statistic contained in the ResourcePoolStatistics.

Field Summary

static int	AVG_AGGREGATE_TYPE The average aggregate type indicates the statistic value can be averaged in the context with other statistics of the same name.
static int	COMMON_AGGREGATE_TYPE The common aggregate type indicates the statistic value can be used in the context with other statistics of the same name to determine which value is most commonly used.
static int	LEAST_RESENT_AGGREGATE_TYPE The lset resent aggregate type indicates the statistic value can be used in the context with other statistics of the same name to determine the lest resently used.
static int	MAX_AGGREGATE_TYPE The max aggregate type indicates the statistic value can be used in the context with other statistics of the same name to determine the maximum statistic value.
static int	MIN_AGGREGATE_TYPE The min aggregate type indicates the statistic value can be used in the context with other statistics of the same name to determine the minimim statistic value.
static int	MOST_RESENT_AGGREGATE_TYPE The most resent aggregate type indicates the statistic value can be used in the context with other statistics of the same name to determine the most resently used.
static int	NO_AGGREGATE_TYPE The no aggregate type indicates the statistic value cannot be used with other statistic values regardless if the name is the same.
static int	SUM_AGGREGATE_TYPE The sum aggregate type indicates the statistic value can be summed in the context with other statistics of the same name.

Method Summary

int	getAggregationType() Returns the aggregate type code that indicates how the statistic value can be used with other statistics
java.lang.String	getDescription() Returns the description of the statistic
java.lang.String	getDisplayName() Returns the display name of the statistic
java.lang.String	getName() Returns the name of the statistic, this name should never change onec established so that coding can be done against it
long	getStartDateTime() Returns a long value repsenting when this statisic begain gathering information.
java.lang.Object	getValue() Returns the statistic value

Field Detail

AVG_AGGREGATE_TYPE

static final int AVG_AGGREGATE_TYPE

The average aggregate type indicates the statistic value can be averaged in the context with other statistics of the same name.

See Also:

Constant Field Values

SUM_AGGREGATE_TYPE

static final int SUM_AGGREGATE_TYPE

The sum aggregate type indicates the statistic value can be summed in the context with other statistics of the same name.

See Also:

Constant Field Values

MIN_AGGREGATE_TYPE

static final int MIN_AGGREGATE_TYPE

The min aggregate type indicates the statistic value can be used in the context with other statistics of the same name to determine the minimim statistic value.

See Also:

Constant Field Values

MAX_AGGREGATE_TYPE

static final int MAX_AGGREGATE_TYPE

The max aggregate type indicates the statistic value can be used in the context with other statistics of the same name to determine the maximum statistic value.

See Also:

Constant Field Values

MOST_RESENT_AGGREGATE_TYPE

static final int MOST_RESENT_AGGREGATE_TYPE

The most resent aggregate type indicates the statistic value can be used in the context with other statistics of the same name to determine the most resently used.

See Also:

Constant Field Values

LEAST_RESENT_AGGREGATE_TYPE

static final int LEAST_RESENT_AGGREGATE_TYPE

The lset resent aggregate type indicates the statistic value can be used in the context with other statistics of the same name to determine the lest resently used.

See Also:

Constant Field Values

COMMON_AGGREGATE_TYPE

static final int COMMON_AGGREGATE_TYPE

The common aggregate type indicates the statistic value can be used in the context with other statistics of the same name to determine which value is most commonly used.

See Also:

Constant Field Values

NO_AGGREGATE_TYPE

static final int NO_AGGREGATE_TYPE

The no aggregate type indicates the statistic value cannot be used with other statistic values regardless if the name is the same.

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Returns the name of the statistic, this name should never change onec established so that coding can be done against it

Returns:

String statistic name

getDisplayName

java.lang.String getDisplayName()

Returns the display name of the statistic

Returns:

String statistic display name

getDescription

java.lang.String getDescription()

Returns the description of the statistic

Returns:

String description of statistic

getValue

java.lang.Object getValue()

Returns the statistic value

Returns:

Number statistic value

getStartDateTime

long getStartDateTime()

Returns a long value repsenting when this statisic begain gathering information.

Returns:

long date time value

getAggregationType

int getAggregationType()

Returns the aggregate type code that indicates how the statistic value can be used with other statistics

Returns:

int aggregate type code