agentgui.core.charts.xyChart

Class XySeriesHelper

java.lang.Object

java.util.AbstractMap<K,V>

java.util.TreeMap<java.lang.Float,XyValuePair>

agentgui.core.charts.xyChart.XySeriesHelper

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Float,XyValuePair>, java.util.NavigableMap<java.lang.Float,XyValuePair>, java.util.SortedMap<java.lang.Float,XyValuePair>

public class XySeriesHelper
extends java.util.TreeMap<java.lang.Float,XyValuePair>

The Class XySeriesHelper provides some methods to work with XyDataSeries.

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
XySeriesHelper() Instantiates a new XySeriesHelper.
XySeriesHelper(XyDataSeries xySeries) Instantiates a new XySeriesHelper.

Method Summary

Modifier and Type	Method and Description
void	addOrExchangeSeriesData(jade.util.leap.List listOfXySeriesValuePairs) Adds or exchanges series data with the specified List of XyValuePairs.
void	addOrExchangeSeriesData(XyDataSeries additionalXySeries) Adds or exchanges series data with the data of the specified XyDataSeries.
XyDataSeries	addSeriesData(jade.util.leap.List listOfXySeriesValuePairs) Adds new series data to the current XyDataSeries, if the concrete data is new.
XyDataSeries	addSeriesData(XyDataSeries additionalXySeries) Adds new series data to the current XyDataSeries, if the concrete data is new.
XyDataSeries	exchangeSeriesData(jade.util.leap.List listOfXySeriesValuePairs) Exchanges series data, if the concrete x values are available and if duplicate x values are forbidden.
XyDataSeries	exchangeSeriesData(XyDataSeries additionalXySeries) Exchanges series data, if the concrete x values are available and if duplicate x values are forbidden.
java.util.Vector<XyValuePair>	getAllValuePairsContaining(java.lang.Float xValueToSearch, java.lang.Float yValueToSearch) Returns all value pairs that contain the specified x and y value.
XyDataSeries	getXySeries() Gets the current XyDataSeries.
XyDataSeries	getXySeriesCopy() Returns a copy of the current XyDataSeries.
void	removeSeriesData(jade.util.leap.List listOfXySeriesValuePairs) Removes the series data specified by the xy stamps.
void	removeSeriesData(XyDataSeries xyDataSeriesToRemove) Removes the series data specified by the list of XyValuePair.
void	setXySeries(XyDataSeries xySeries) Sets the current XyDataSeries.

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

XySeriesHelper

public XySeriesHelper()

Instantiates a new XySeriesHelper.

XySeriesHelper

public XySeriesHelper(XyDataSeries xySeries)

Instantiates a new XySeriesHelper.

Parameters:

xySeries - the current XyDataSeries

Method Detail

setXySeries

public void setXySeries(XyDataSeries xySeries)

Sets the current XyDataSeries.

Parameters:

xySeries - the new XyDataSeries

getXySeries

public XyDataSeries getXySeries()

Gets the current XyDataSeries.

Returns:

the XyDataSeries

getAllValuePairsContaining

public java.util.Vector<XyValuePair> getAllValuePairsContaining(java.lang.Float xValueToSearch,
                                                                java.lang.Float yValueToSearch)

Returns all value pairs that contain the specified x and y value.

Parameters:

xValueToSearch - the x value to search

yValueToSearch - the y value to search

Returns:

the Vector of XyValuePair with the specified x and y values

getXySeriesCopy

public XyDataSeries getXySeriesCopy()

Returns a copy of the current XyDataSeries.

Returns:

the time series copy

addSeriesData

public XyDataSeries addSeriesData(XyDataSeries additionalXySeries)

Adds new series data to the current XyDataSeries, if the concrete data is new. ATTENTION: If duplicate x values are allowed, all XyValuePair elements will just be added. If duplicate x values are NOT allowed only XyValuePair with new x values will be added.

Parameters:

additionalXySeries - the XySereis containing new data

Returns:

a XyDataSeries containing the value pairs that were actually added

addSeriesData

public XyDataSeries addSeriesData(jade.util.leap.List listOfXySeriesValuePairs)

Adds new series data to the current XyDataSeries, if the concrete data is new. ATTENTION: If duplicate x values are allowed, all XyValuePair elements will just be added. If duplicate x values are NOT allowed only XyValuePair with new x values will be added.

Parameters:

listOfXySeriesValuePairs - the list of xy series value pairs

Returns:

a XyDataSeries containing the value pairs that were actually added

addOrExchangeSeriesData

public void addOrExchangeSeriesData(XyDataSeries additionalXySeries)

Adds or exchanges series data with the data of the specified XyDataSeries. ATTENTION: If duplicate x values are allowed in the current series, the new data will be just added.

Parameters:

additionalXySeries - the additional xy series

addOrExchangeSeriesData

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

Adds or exchanges series data with the specified List of XyValuePairs. ATTENTION: If duplicate x values are allowed in the current series, the new data will be just added.

Parameters:

listOfXySeriesValuePairs - the list of xy series value pairs

exchangeSeriesData

public XyDataSeries exchangeSeriesData(XyDataSeries additionalXySeries)

Exchanges series data, if the concrete x values are available and if duplicate x values are forbidden. ATTENTION: If duplicate x values are allowed this method will simply exchange nothing.

Parameters:

additionalXySeries - the additional xy series

Returns:

the XyDataSeries of value pairs that were exchanged

exchangeSeriesData

public XyDataSeries exchangeSeriesData(jade.util.leap.List listOfXySeriesValuePairs)

Exchanges series data, if the concrete x values are available and if duplicate x values are forbidden. ATTENTION: If duplicate x values are allowed this method will exchange nothing.

Parameters:

listOfXySeriesValuePairs - the list of xy series value pairs

Returns:

the XyDataSeries of value pairs that were exchanged

removeSeriesData

public void removeSeriesData(XyDataSeries xyDataSeriesToRemove)

Removes the series data specified by the list of XyValuePair.

Parameters:

xyDataSeriesToRemove - the XyDataSeries that contains the value pairs to remove

removeSeriesData

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

Removes the series data specified by the xy stamps. ATTENTION: If duplicate x values are forbidden this method just searches for x values to remove. If duplicates are allowed, the method searches for a match of x and y value (which can be time consuming).

Parameters:

listOfXySeriesValuePairs - the list of XyValuePair