org.hawkular.alerts.api.model.data

Class Data

java.lang.Object

org.hawkular.alerts.api.model.data.Data

All Implemented Interfaces:

Comparable<Data>

Direct Known Subclasses:

Availability, NumericData, StringData

public abstract class Data
extends Object
implements Comparable<Data>

A base class for incoming data into alerts subsystem. All Data has an Id and a timestamp. The timestamp is used to ensure that data is time-ordered when being sent into the alerting engine. If not assigned the timestamp will be assigned to current time.

This provides a default implementation of compareTo(Data). Subclasses must Override this if they are unhappy with the Natural Ordering provided: Id asc, Timestamp asc, Value asc

Author:

Jay Shaughnessy, Lucas Ponce

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Data.Type

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	context
protected String	id
protected long	timestamp
protected Data.Type	type
protected Object	value

Constructor Summary

Constructors

Constructor and Description
Data()
Data(String id, long timestamp, Object value, Data.Type type)
Data(String id, long timestamp, Object value, Data.Type type, Map<String,String> context)

Method Summary

Modifier and Type	Method and Description
void	addProperty(String name, String value)
int	compareTo(Data o)
boolean	equals(Object o)
Map<String,String>	getContext()
String	getId()
long	getTimestamp()
Data.Type	getType()
Object	getValue()
int	hashCode()
void	setContext(Map<String,String> context)
void	setId(String id)
void	setTimestamp(long timestamp)
void	setType(Data.Type type)
void	setValue(Object value)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

id

protected String id

timestamp

protected long timestamp

value

protected Object value

type

protected Data.Type type

context

protected Map<String,String> context

Constructor Detail

Data

public Data()

Data

public Data(String id,
            long timestamp,
            Object value,
            Data.Type type)

Parameters:

id - not null

timestamp - in millis, if less than 1 assigned currentTime.

value - the value

type - the type of data

Data

public Data(String id,
            long timestamp,
            Object value,
            Data.Type type,
            Map<String,String> context)

Parameters:

id - not null

timestamp - in millis, if less than 1 assigned currentTime.

value - the value

type - the type of data

context - optional, contextual name-value pairs to be stored with the data.

Method Detail

getId

public String getId()

setId

public void setId(String id)

getTimestamp

public long getTimestamp()

setTimestamp

public void setTimestamp(long timestamp)

Parameters:

timestamp - in millis, if less than 1 assigned currentTime.

getValue

public Object getValue()

setValue

public void setValue(Object value)

getType

public Data.Type getType()

setType

public void setType(Data.Type type)

getContext

public Map<String,String> getContext()

setContext

public void setContext(Map<String,String> context)

addProperty

public void addProperty(String name,
                        String value)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(Data o)

Specified by:

compareTo in interface Comparable<Data>