org.eth.cyril.telemetry.data

Class Data

java.lang.Object

org.eth.cyril.telemetry.data.Data

Direct Known Subclasses:

GraphLayoutReasonData, InteractiveModeData, LayoutInfo, RuleCount, SettingsInfo, UsageModeData

public abstract class Data
extends java.lang.Object

Represents a piece of gathered data from a DataGatherer instance. Any piece of gathered data must support being converted to JSON, which can then later be stored in some kind of database.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY
static java.lang.String	TIMESTAMP

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Data()

Method Summary

Modifier and Type	Method and Description
protected abstract javax.json.JsonObjectBuilder	convertToJson() Converts this piece of data to JSON, which is then suitable of being stored in a database.
javax.json.JsonObject	getAnnotatedJson() Gets the JSON object representing this data object, including a timestamp which represents when this data object was created and a key.
protected abstract java.lang.String	getKey() Returns a key with which data of this type can be identified.

Methods inherited from class java.lang.Object

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

Field Detail

TIMESTAMP

public static final java.lang.String TIMESTAMP

See Also:

Constant Field Values

KEY

public static final java.lang.String KEY

See Also:

Constant Field Values

Constructor Detail

Data

protected Data()

Method Detail

getAnnotatedJson

public final javax.json.JsonObject getAnnotatedJson()

Gets the JSON object representing this data object, including a timestamp which represents when this data object was created and a key. The timestamp is always added with the key TIMESTAMP to the resulting JSON object, in the form of an ISO-8601 String. The key is added with the key KEY to the resulting JSON object, and the value corresponds to getKey().

Returns:

A JSON object representing this data object, including a timestamp and key.

convertToJson

protected abstract javax.json.JsonObjectBuilder convertToJson()

Converts this piece of data to JSON, which is then suitable of being stored in a database. The JSON does not need to be capable of being converted back to a piece of data. However, care should be taken for the resulting JSON to be as simple as possible, such that it can be easily analyzed. The result of this method is used for getAnnotatedJson() and a time stamp is added to the object.

Returns:

The JsonObjectBuilder instance with which the final object to be returned may be generated.

getKey

protected abstract java.lang.String getKey()

Returns a key with which data of this type can be identified.

Returns:

The key to identify data of this type with.