de.hawhamburg.reachability.tools.feeder

Class SensorDataFeederItem

java.lang.Object

de.hawhamburg.reachability.tools.feeder.SensorDataFeederItem

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<SensorDataFeederItem>

public class SensorDataFeederItem
extends java.lang.Object
implements java.lang.Comparable<SensorDataFeederItem>, java.lang.Cloneable

The representation of a simulated sensor event.

Objects of this class are representing simulated sensor events, which shall be send on the ActiveMQ. Each sensor event consists of a sensor type name, a time to which this event takes place and a measured value. Furthermore this class provides static methods to create objects of this class from String or file and to convert it into a JSON-message object. Objects of this class will be sorted by their event time.

Version:

"2013.42"

Author:

"Malte Kantak <malte.kantak@hotmail.de>"

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATA_SEPARATOR_CHAR The default separator char of data within an '*.sgs' coded file.
static java.lang.String	LINE_SEPARATOR_CHAR The default separator char of lines within an '*.sgs' coded file.
private int	time The time in minutes relative to the simulation start where this event happens.
private java.lang.String	type The simulated sensor type name.
private java.lang.String	value The simulated sensors measured value.

Constructor Summary

Constructors

Constructor and Description
SensorDataFeederItem(java.lang.String typeIn, java.lang.String valueIn, int timeIn) Initializes a new SensorDataFeederItem object.

Method Summary

Methods

Modifier and Type	Method and Description
SensorDataFeederItem	clone() Clones this object and returns a new object value but not object identically to this object.
int	compareTo(SensorDataFeederItem other) The method compares the current object with another SensorDataFeederItem object.
static java.util.Map<java.lang.Integer,SensorDataFeederItem>	fromFile(java.lang.String filePath) Creates all SensorDataFeederItem defined within a story file by parsing its content using LINE_SEPARATOR_CHAR and fromString(String) for each line.
static SensorDataFeederItem	fromString(java.lang.String storyLine) Create a new SensorDataFeederItem from a given string by parsing it using DATA_SEPARATOR_CHAR and NumericalConstants.DECIMAL_BASE.
private java.lang.String	getRealTime() Returns the simulation time to which this event happens as formatted String "hh:mm".
static java.lang.String	getStringTime(int timeInMinutes) Converts an amount of minutes to a simulation time String formatted as "hh:mm".
int	getTime() Returns the event time in simulation minutes.
java.lang.String	getType() Returns the events sensor type name as String.
java.lang.String	getValue() Returns the events simulated value as String.
JsonSensorDataFeederItem	toJsonObject() Converts the object to a JSON message representation to use in common with ActiveMQ publishing.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DATA_SEPARATOR_CHAR

public static final java.lang.String DATA_SEPARATOR_CHAR

The default separator char of data within an '*.sgs' coded file.

See Also:

Constant Field Values

LINE_SEPARATOR_CHAR

public static final java.lang.String LINE_SEPARATOR_CHAR

The default separator char of lines within an '*.sgs' coded file.

See Also:

Constant Field Values

type

private java.lang.String type

The simulated sensor type name.

value

private java.lang.String value

The simulated sensors measured value.

time

private int time

The time in minutes relative to the simulation start where this event happens.

Constructor Detail

SensorDataFeederItem

public SensorDataFeederItem(java.lang.String typeIn,
                    java.lang.String valueIn,
                    int timeIn)

Initializes a new SensorDataFeederItem object.

Parameters:

typeIn - The simulated sensors type name as String.

valueIn - The simulated sensors measured value as String.

timeIn - The time when the event happens as int.

Method Detail

fromString

public static SensorDataFeederItem fromString(java.lang.String storyLine)

Create a new SensorDataFeederItem from a given string by parsing it using DATA_SEPARATOR_CHAR and NumericalConstants.DECIMAL_BASE.

Parameters:

storyLine - The String line which contains the data for the simulated sensor event in "*.sgs" format.

Returns:

A new SensorDataFeederItem based on the supplied string.

fromFile

public static java.util.Map<java.lang.Integer,SensorDataFeederItem> fromFile(java.lang.String filePath)

Creates all SensorDataFeederItem defined within a story file by parsing its content using LINE_SEPARATOR_CHAR and fromString(String) for each line.

Parameters:

filePath - The path to the file where the story is defined as String.

Returns:

A Map of simulation time in minutes (Integer) to SensorDataFeederItem.

getType

public final java.lang.String getType()

Returns the events sensor type name as String.

Returns:

The events sensor type name as String.

getValue

public final java.lang.String getValue()

Returns the events simulated value as String.

Returns:

The events simulated value as String.

getTime

public final int getTime()

Returns the event time in simulation minutes.

Returns:

The event time in simulation minutes.

toJsonObject

public final JsonSensorDataFeederItem toJsonObject()

Converts the object to a JSON message representation to use in common with ActiveMQ publishing.

Returns:

A JsonSensorDataFeederItem representing the sensor event for the ActiveMQ.

getRealTime

private java.lang.String getRealTime()

Returns the simulation time to which this event happens as formatted String "hh:mm".

Returns:

The simulation time to which this event happens as "hh:mm" String.

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

The String representation of this object.

See Also:

Object.toString()

getStringTime

public static final java.lang.String getStringTime(int timeInMinutes)

Converts an amount of minutes to a simulation time String formatted as "hh:mm".

Parameters:

timeInMinutes - The daytime in minutes as int.

Returns:

The daytime as String formatted as "hh:mm".

compareTo

public final int compareTo(SensorDataFeederItem other)

The method compares the current object with another SensorDataFeederItem object. Both objects will be compared by their event time using Integer.compareTo(Integer).

Specified by:

compareTo in interface java.lang.Comparable<SensorDataFeederItem>

Parameters:

other - The other SensorDataFeederItem object with which this object shall be compared.

Returns:

0 means that these events are starting at the same time. A value less than 0 indicates that this event starts before the other. A value greater than 0 that this event starts after the other object.

See Also:

Integer.compareTo(Integer)

clone

public final SensorDataFeederItem clone()

Clones this object and returns a new object value but not object identically to this object.

Overrides:

clone in class java.lang.Object

Returns:

A value but not object identical SensorDataFeederItem.