org.flexiblepower.observation

Class Observation<T>

java.lang.Object

org.flexiblepower.observation.Observation<T>

Type Parameters:

T - The type of the value that is stored in the Observation.

public class Observation<T>
extends java.lang.Object

An Observation is a measurement that has been done at a certain time. It is a tuple with the observedAt date and the value (of dynamic type). This class provides a couple of helpful methods, like getting the value as a Map when you don't know the type (see getValueMap(). For the helper methods, it is assumed that the value is a Java bean with getters.

Constructor Summary

Constructors

Constructor and Description
Observation(java.util.Date observedAt, T value) Creates a new Observation for the given tuple.

Method Summary

Methods

Modifier and Type	Method and Description
static <T> Observation<T>	create(java.util.Date observedAt, T value) Creates a new Observation for the given tuple.
boolean	equals(java.lang.Object obj)
java.util.Date	getObservedAt()
T	getValue()
java.lang.Object	getValue(java.lang.String name) Tries to find a part of the value with the given name.
java.util.Map<java.lang.String,java.lang.Object>	getValueMap() Detects all the parts of the value, assuming a Java bean.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Observation

public Observation(java.util.Date observedAt,
           T value)

Creates a new Observation for the given tuple.

Parameters:

observedAt - The date at which the value has been observed.

value - The value

Throws:

java.lang.NullPointerException - When either the observedAt or the value is null.

Method Detail

create

public static <T> Observation<T> create(java.util.Date observedAt,
                        T value)

Creates a new Observation for the given tuple. This static helper method removes the need for specifying T explicitly in java. This is exactly the same as calling new Observation<T>(observedAt, value).

Type Parameters:

T - The type of the value that is stored in the Observation.

Parameters:

observedAt - The date at which the value has been observed.

value - The value

Returns:

The newly created Observation object.

getObservedAt

public java.util.Date getObservedAt()

Returns:

The date at which the value has been observed.

getValue

public T getValue()

Returns:

The value

getValue

public java.lang.Object getValue(java.lang.String name)

Tries to find a part of the value with the given name. It will assume a Java bean with getter methods. This is equal to calling getValueMap().get(name). Note: this is heavily dependent on reflection and therefore won't work on embedded Java versions.

Parameters:

name - The name that will be used to find the getter method.

Returns:

The object when such a value has been found, null otherwise.

getValueMap

public java.util.Map<java.lang.String,java.lang.Object> getValueMap()

Detects all the parts of the value, assuming a Java bean. This will detect all getter methods and return the corresponding sub-values.

Returns:

A Map with all the sub-values.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object