no.g9.message.metric

Class SimpleMetric

java.lang.Object

no.g9.message.metric.SimpleMetric

All Implemented Interfaces:

Serializable, Cloneable, IMetric

public class SimpleMetric
extends Object
implements IMetric, Serializable

This class contains simple metrics, as the name strongly suggests... Each metric is identified by a String key, and contains a number representing "number of" and a number representing "value of". Additionally, a timer is "started" (recorded) when the object is created.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected long	ended Timer end (in milliseconds since Epoch).
protected long	lNo Logs how many times the value is read (intermediate time #).
protected long	started The startup time (in milliseconds since Epoch).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SimpleMetric() Default constructor.
	SimpleMetric(String pkey) Constructor providing ID only.
	SimpleMetric(String s, long n, long v) Constructor setting all values.

Method Summary

Modifier and Type	Method and Description
void	add(long v) Add a value to a metric and increase the counter.
void	addMS() Adds the current elapsed time in milliseconds as if with add(long), and restarts the timer.
double	avg() Calculates average - value per number.
void	clear() Resets the metric.
Object	clone() Make a clone of this object.
boolean	equals(Object that)
long	getCount() Gets the count of updates to this metric.
String	getKey() Returns the metric key value.
long	getTimer() Returns the running time so far.
long	getValue() Gets the total value for this metric.
int	hashCode() Returns a hash code for this object.
void	reset() Resets the start time for the timer functions.
void	setCount(long n) Sets the counter value.
protected void	setEnd() Captures the current time in ended for internal operations.
void	setKey(String newVal) Sets the metric key value.
void	setValue(long n) Sets the new value without changing the count.
double	speed() Calculates speed - number per second.
IMetric	stopTimer() Sets the end value for the timer and returns a reference to this object.
String	toString()
double	volume() Calculates volume - value per second.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

started

protected long started

The startup time (in milliseconds since Epoch).

ended

protected long ended

Timer end (in milliseconds since Epoch).

See Also:

setEnd()

lNo

protected long lNo

Logs how many times the value is read (intermediate time #).

Constructor Detail

SimpleMetric

protected SimpleMetric()

Default constructor.

SimpleMetric

public SimpleMetric(String pkey)

Constructor providing ID only.

Parameters:

pkey - ID

SimpleMetric

public SimpleMetric(String s,
                    long n,
                    long v)

Constructor setting all values.

Parameters:

s - ID

n - Value of number of times called (normally 0)

v - Value so far (normally 0)

Method Detail

setEnd

protected void setEnd()

Captures the current time in ended for internal operations.

clone

public Object clone()
             throws CloneNotSupportedException

Description copied from interface: IMetric

Make a clone of this object.

Specified by:

clone in interface IMetric

Overrides:

clone in class Object

Returns:

a deep copy of this object

Throws:

CloneNotSupportedException - if it fails...

add

public void add(long v)

Add a value to a metric and increase the counter.

Specified by:

add in interface IMetric

Parameters:

v - Value to add

addMS

public void addMS()

Adds the current elapsed time in milliseconds as if with add(long), and restarts the timer.

clear

public void clear()

Resets the metric.

Specified by:

clear in interface IMetric

reset

public void reset()

Resets the start time for the timer functions.

getKey

public String getKey()

Returns the metric key value.

Specified by:

getKey in interface IMetric

Returns:

key value

See Also:

setKey(java.lang.String)

getCount

public long getCount()

Gets the count of updates to this metric.

Specified by:

getCount in interface IMetric

Returns:

count of updates

See Also:

setCount(long)

getValue

public long getValue()

Gets the total value for this metric.

Specified by:

getValue in interface IMetric

Returns:

total value

See Also:

setValue(long)

getTimer

public long getTimer()

Returns the running time so far.

Specified by:

getTimer in interface IMetric

Returns:

running time in millis

stopTimer

public IMetric stopTimer()

Sets the end value for the timer and returns a reference to this object.

Specified by:

stopTimer in interface IMetric

Returns:

this object

setKey

public void setKey(String newVal)

Sets the metric key value. Note: Should not be called after saving in e.g. a HashMap, since this changes the hash value of the object.

Specified by:

setKey in interface IMetric

Parameters:

newVal - New key value. Must not be null.

Throws:

IllegalArgumentException - If key is null.

See Also:

getKey()

setCount

public void setCount(long n)

Sets the counter value.

Specified by:

setCount in interface IMetric

Parameters:

n - New counter value

See Also:

getCount()

setValue

public void setValue(long n)

Sets the new value without changing the count.

Specified by:

setValue in interface IMetric

Parameters:

n - New value

See Also:

getValue()

avg

public double avg()

Calculates average - value per number.

Returns:

average value, or 0.0 if neither fields are set, or Double.MAX_VALUE if only number is unset.

speed

public double speed()

Calculates speed - number per second.

Returns:

speed in number per second, or 0.0 if the timer has not been stopped, or Double.MAX_VALUE if started==ended.

volume

public double volume()

Calculates volume - value per second.

Returns:

volume in number per second, or 0.0 if the timer has not been stopped, or Double.MAX_VALUE if started==ended.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Returns a hash code for this object.

Overrides:

hashCode in class Object

Returns:

hash code based on key

equals

public boolean equals(Object that)

Overrides:

equals in class Object