com.sleepycat.je.utilint

Class DoubleExpMovingAvg

java.lang.Object

com.sleepycat.je.utilint.BaseStat<T>

com.sleepycat.je.utilint.MapStatComponent<Double,DoubleExpMovingAvg>

com.sleepycat.je.utilint.DoubleExpMovingAvg

All Implemented Interfaces:

Serializable

public class DoubleExpMovingAvg
extends MapStatComponent<Double,DoubleExpMovingAvg>

A double JE stat component generated from an exponential moving average over a specified time period of values supplied with associated times, to support averaging values that are generated at irregular intervals.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DoubleExpMovingAvg(String name, long periodMillis) Creates an instance of this class.

Method Summary

Modifier and Type	Method and Description
void	add(DoubleExpMovingAvg other) Add the values from another average.
void	add(double value, long time) Adds a new value to the average, ignoring values that are not newer than time of the previous call.
void	clear() Resets the statistic to its initial state.
DoubleExpMovingAvg	copy() Narrow the return type to the component type.
Double	get() Returns the current average, or 0 if no values have been added.
protected String	getFormattedValue(boolean useCommas) Returns the value of the statistic as a formatted string, either using or not using commas as requested.
String	getName() Returns the name of this stat.
boolean	isNotSet() Returns whether the statistic is in its initial state.
String	toString()

Methods inherited from class com.sleepycat.je.utilint.MapStatComponent

getFormattedValue

Methods inherited from class java.lang.Object

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

Constructor Detail

DoubleExpMovingAvg

public DoubleExpMovingAvg(String name,
                          long periodMillis)

Creates an instance of this class. The periodMillis represents the time period in milliseconds over which values will be averaged.

Parameters:

name - the name of this stat

periodMillis - the averaging period in milliseconds

Method Detail

getName

public String getName()

Returns the name of this stat.

Returns:

the name of this stat

add

public void add(double value,
                long time)

Adds a new value to the average, ignoring values that are not newer than time of the previous call.

Parameters:

value - the new value

time - the current time in milliseconds

add

public void add(DoubleExpMovingAvg other)

Add the values from another average.

Parameters:

other - the other average

get

public Double get()

Returns the current average, or 0 if no values have been added.

Specified by:

get in class BaseStat<Double>

Returns:

the value

clear

public void clear()

Description copied from class: BaseStat

Resets the statistic to its initial state.

Specified by:

clear in class BaseStat<Double>

copy

public DoubleExpMovingAvg copy()

Description copied from class: MapStatComponent

Narrow the return type to the component type.

Specified by:

copy in class MapStatComponent<Double,DoubleExpMovingAvg>

Returns:

a copy

getFormattedValue

protected String getFormattedValue(boolean useCommas)

Description copied from class: MapStatComponent

Returns the value of the statistic as a formatted string, either using or not using commas as requested. Implementations should make sure that the result does not contain commas when useCommas is false, because the value will be used in a comma-separated value file, where embedded commas would cause problems.

Specified by:

getFormattedValue in class MapStatComponent<Double,DoubleExpMovingAvg>

Parameters:

useCommas - whether to use commas

Returns:

the value as a formatted string

isNotSet

public boolean isNotSet()

Description copied from class: BaseStat

Returns whether the statistic is in its initial state.

Specified by:

isNotSet in class BaseStat<Double>

Returns:

if the statistic is in its initial state

toString

public String toString()

Overrides:

toString in class Object