agentgui.core.charts.timeseriesChart

Class TimeSeriesHelper

java.lang.Object

java.util.AbstractMap<K,V>

java.util.TreeMap<java.lang.Long,TimeSeriesValuePair>

agentgui.core.charts.timeseriesChart.TimeSeriesHelper

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Long,TimeSeriesValuePair>, java.util.NavigableMap<java.lang.Long,TimeSeriesValuePair>, java.util.SortedMap<java.lang.Long,TimeSeriesValuePair>

public class TimeSeriesHelper
extends java.util.TreeMap<java.lang.Long,TimeSeriesValuePair>

The Class TimeSeriesHelper provides some methods to work with TimeSeries.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors

Constructor and Description
TimeSeriesHelper() Instantiates a new time series helper.
TimeSeriesHelper(TimeSeries timeSeries) Instantiates a new time series helper.

Method Summary

Modifier and Type	Method and Description
void	addOrExchangeSeriesData(jade.util.leap.List listOfTimeSeriesValuePairs) Adds the or exchanges series data with the specified .
void	addOrExchangeSeriesData(TimeSeries additionalTimeSeries) Adds the or exchanges series data with the data of the specified TimeSeries.
TimeSeries	addSeriesData(jade.util.leap.List listOfTimeSeriesValuePairs) Adds new series data to the current TimeSeries, if the concrete data is new.
TimeSeriesValuePair	addSeriesData(long timeStamp, float value) Adds a specified TimeSeriesValuePair to the current TimeSeries.
TimeSeries	addSeriesData(TimeSeries additionalTimeSeries) Adds new series data to the current TimeSeries, if the concrete data is new.
TimeSeriesValuePair	addSeriesData(TimeSeriesValuePair tsvp) Adds a specified TimeSeriesValuePair to the current TimeSeries.
TimeSeries	exchangeSeriesData(jade.util.leap.List listOfTimeSeriesValuePairs) Exchanges series data, if the concrete time stamps are available.
TimeSeries	exchangeSeriesData(TimeSeries additionalTimeSeries) Exchanges series data, if the concrete time stamps are available.
TimeSeries	getTimeSeries() Gets the current time series.
TimeSeries	getTimeSeriesCopy() Returns a copy of the current TimeSeries.
void	removeSeriesData(jade.util.leap.List listOfTimeSeriesValuePairs) Removes the series data specified by the time stamps.
void	removeSeriesData(TimeSeries additionalTimeSeries) Removes the series data specified by the time stamps.
void	setTimeSeries(TimeSeries timeSeries) Sets the current time series.

Methods inherited from class java.util.TreeMap

ceilingEntry, ceilingKey, clear, clone, comparator, containsKey, containsValue, descendingKeySet, descendingMap, entrySet, firstEntry, firstKey, floorEntry, floorKey, forEach, get, headMap, headMap, higherEntry, higherKey, keySet, lastEntry, lastKey, lowerEntry, lowerKey, navigableKeySet, pollFirstEntry, pollLastEntry, put, putAll, remove, replace, replace, replaceAll, size, subMap, subMap, tailMap, tailMap, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, isEmpty, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove

Constructor Detail

TimeSeriesHelper

public TimeSeriesHelper()

Instantiates a new time series helper.

TimeSeriesHelper

public TimeSeriesHelper(TimeSeries timeSeries)

Instantiates a new time series helper.

Parameters:

timeSeries - the current time series

Method Detail

setTimeSeries

public void setTimeSeries(TimeSeries timeSeries)

Sets the current time series.

Parameters:

timeSeries - the new time series

getTimeSeries

public TimeSeries getTimeSeries()

Gets the current time series.

Returns:

the time series

getTimeSeriesCopy

public TimeSeries getTimeSeriesCopy()

Returns a copy of the current TimeSeries.

Returns:

the time series copy

addSeriesData

public TimeSeries addSeriesData(TimeSeries additionalTimeSeries)

Adds new series data to the current TimeSeries, if the concrete data is new. If the data (time stamp) is already there, it will not be overwritten.

Parameters:

additionalTimeSeries - the TimeSereis containing new data

Returns:

a TimeSeries containing the value pairs that were actually added

addSeriesData

public TimeSeries addSeriesData(jade.util.leap.List listOfTimeSeriesValuePairs)

Adds new series data to the current TimeSeries, if the concrete data is new. If the data (time stamp) is already there, it will not be overwritten.

Parameters:

listOfTimeSeriesValuePairs - the list of time series value pairs

Returns:

a TimeSeries containing the value pairs that were actually added

addSeriesData

public TimeSeriesValuePair addSeriesData(TimeSeriesValuePair tsvp)

Adds a specified TimeSeriesValuePair to the current TimeSeries.

Parameters:

tsvp - the TimeSeriesValuePair

Returns:

the added TimeSeriesValuePair or null

addSeriesData

public TimeSeriesValuePair addSeriesData(long timeStamp,
                                         float value)

Adds a specified TimeSeriesValuePair to the current TimeSeries.

Parameters:

timeStamp - the time stamp

value - the value

Returns:

the added TimeSeriesValuePair or null

addOrExchangeSeriesData

public void addOrExchangeSeriesData(TimeSeries additionalTimeSeries)

Adds the or exchanges series data with the data of the specified TimeSeries.

Parameters:

additionalTimeSeries - the additional time series

addOrExchangeSeriesData

public void addOrExchangeSeriesData(jade.util.leap.List listOfTimeSeriesValuePairs)

Adds the or exchanges series data with the specified .

Parameters:

listOfTimeSeriesValuePairs - the list of time series value pairs

exchangeSeriesData

public TimeSeries exchangeSeriesData(TimeSeries additionalTimeSeries)

Exchanges series data, if the concrete time stamps are available.

Parameters:

additionalTimeSeries - the additional time series

Returns:

the time series of value pairs that were exchanged

exchangeSeriesData

public TimeSeries exchangeSeriesData(jade.util.leap.List listOfTimeSeriesValuePairs)

Exchanges series data, if the concrete time stamps are available.

Parameters:

listOfTimeSeriesValuePairs - the list of time series value pairs

Returns:

the time series of value pairs that were exchanged

removeSeriesData

public void removeSeriesData(TimeSeries additionalTimeSeries)

Removes the series data specified by the time stamps.

Parameters:

additionalTimeSeries - the additional time series

removeSeriesData

public void removeSeriesData(jade.util.leap.List listOfTimeSeriesValuePairs)

Removes the series data specified by the time stamps.

Parameters:

listOfTimeSeriesValuePairs - the list of time series value pairs