com.metamatrix.common.pooling.impl
Class BasicPoolStatistic

java.lang.Object
  com.metamatrix.common.pooling.impl.BasicPoolStatistic

All Implemented Interfaces:

PoolStatistic, java.io.Serializable

Direct Known Subclasses:

AvgStat, CounterStat, HighestValueStat, LowestValueStat, SumStat

public abstract class BasicPoolStatistic
extends java.lang.Object
implements PoolStatistic, java.io.Serializable

See Also:

Serialized Form

Field Summary

static long	serialVersionUID
static int	TYPE_AVG
static int	TYPE_HIGHEST
static int	TYPE_LOWEST
static int	TYPE_SUM

Fields inherited from interface com.metamatrix.common.pooling.api.PoolStatistic

AVG_AGGREGATE_TYPE, COMMON_AGGREGATE_TYPE, LEAST_RESENT_AGGREGATE_TYPE, MAX_AGGREGATE_TYPE, MIN_AGGREGATE_TYPE, MOST_RESENT_AGGREGATE_TYPE, NO_AGGREGATE_TYPE, SUM_AGGREGATE_TYPE

Constructor Summary

protected

BasicPoolStatistic(java.lang.String statName, java.lang.String displayName, java.lang.String description, int aggregateType)

Method Summary

void	decrement() Decrement the statistic
void	decrement(long value)
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
long	getStartDateTime() Returns a long value repsenting when this statisic begain gathering information.
void	increment() Increment the statistic
void	increment(long value)
protected void	performReset()
abstract void	reset() Called to reset the statistic

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.metamatrix.common.pooling.api.PoolStatistic

getValue

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

TYPE_SUM

public static final int TYPE_SUM

See Also:

Constant Field Values

TYPE_AVG

public static final int TYPE_AVG

See Also:

Constant Field Values

TYPE_HIGHEST

public static final int TYPE_HIGHEST

See Also:

Constant Field Values

TYPE_LOWEST

public static final int TYPE_LOWEST

See Also:

Constant Field Values

Constructor Detail

BasicPoolStatistic

protected BasicPoolStatistic(java.lang.String statName,
                             java.lang.String displayName,
                             java.lang.String description,
                             int aggregateType)

Method Detail

getDisplayName

public java.lang.String getDisplayName()

Description copied from interface: PoolStatistic

Returns the display name of the statistic

Specified by:

getDisplayName in interface PoolStatistic

Returns:

String statistic display name

getDescription

public java.lang.String getDescription()

Returns the description of the statistic

Specified by:

getDescription in interface PoolStatistic

Returns:

String description of statistic

getName

public java.lang.String getName()

Returns the name of the statistic

Specified by:

getName in interface PoolStatistic

Returns:

String statistic name

getAggregationType

public int getAggregationType()

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

Specified by:

getAggregationType in interface PoolStatistic

Returns:

int aggregate type code

getStartDateTime

public long getStartDateTime()

Description copied from interface: PoolStatistic

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

Specified by:

getStartDateTime in interface PoolStatistic

Returns:

long date time value

performReset

protected void performReset()

increment

public void increment()

Increment the statistic

decrement

public void decrement()

Decrement the statistic

increment

public void increment(long value)

decrement

public void decrement(long value)

reset

public abstract void reset()

Called to reset the statistic