com.sleepycat.je.utilint

Class LongAvgRate

java.lang.Object

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

com.sleepycat.je.utilint.MapStatComponent<Long,LongAvgRate>

com.sleepycat.je.utilint.LongAvgRate

All Implemented Interfaces:

Serializable

public class LongAvgRate
extends MapStatComponent<Long,LongAvgRate>

A long JE stat component generated from an exponential moving average over a specified time period of the rate of change in a long value over time.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	MIN_PERIOD The minimum number of milliseconds for computing rate changes, to avoid quantizing errors.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	add(LongAvgRate other) Update with more recent values from another stat.
void	add(long value, long time) Adds a new value to the average, ignoring values that are less than MIN_PERIOD milliseconds older than the last entry.
void	clear() Resets the statistic to its initial state.
LongAvgRate	copy() Narrow the return type to the component type.
LongAvgRate	copyLatest(LongAvgRate other) Create and return a new stat that includes the most recent values from this stat and another stat.
Long	get() Returns the current average rate, or 0 if no rate has been computed.
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

Field Detail

MIN_PERIOD

public static final long MIN_PERIOD

The minimum number of milliseconds for computing rate changes, to avoid quantizing errors.

See Also:

Constant Field Values

Constructor Detail

LongAvgRate

public LongAvgRate(String name,
                   long periodMillis,
                   TimeUnit reportTimeUnit)

Creates an instance of this class.

Parameters:

name - the name of this stat

periodMillis - the averaging period in milliseconds

reportTimeUnit - the time unit for reporting the result

Method Detail

getName

public String getName()

Returns the name of this stat.

Returns:

the name of this stat

add

public void add(long value,
                long time)

Adds a new value to the average, ignoring values that are less than MIN_PERIOD milliseconds older than the last entry.

Parameters:

value - the new value

time - the current time in milliseconds

add

public void add(LongAvgRate other)

Update with more recent values from another stat.

Parameters:

other - the other stat

copyLatest

public LongAvgRate copyLatest(LongAvgRate other)

Create and return a new stat that includes the most recent values from this stat and another stat.

Parameters:

other - the other stat

Returns:

a copy containing all new values

get

public Long get()

Returns the current average rate, or 0 if no rate has been computed.

Specified by:

get in class BaseStat<Long>

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<Long>

copy

public LongAvgRate copy()

Description copied from class: MapStatComponent

Narrow the return type to the component type.

Specified by:

copy in class MapStatComponent<Long,LongAvgRate>

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<Long,LongAvgRate>

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<Long>

Returns:

if the statistic is in its initial state

toString

public String toString()

Overrides:

toString in class Object