Class CoordinationSet<N extends Comparable<N>>

java.lang.Object

java.util.AbstractMap<String, CalendarDateSeries<N>>

java.util.HashMap<String, CalendarDateSeries<N>>

org.ojalgo.series.CoordinationSet<N>

All Implemented Interfaces:

Serializable, Cloneable, Map<String, CalendarDateSeries<N>>

public class CoordinationSet<N extends Comparable<N>>
extends HashMap<String, CalendarDateSeries<N>>

A CoordinationSet is used to coordinate a set of CalendarDateSeries instances.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class AbstractMap

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

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
private CalendarDateUnit	myResolution
private static final long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
CoordinationSet()
CoordinationSet(int initialCapacity)
CoordinationSet(int initialCapacity, float loadFactor)
CoordinationSet(Collection<CalendarDateSeries<N>> seriesCollection)
CoordinationSet(Collection<CalendarDateSeries<N>> seriesCollection, CalendarDateUnit resolution)
CoordinationSet(Map<? extends String, ? extends CalendarDateSeries<N>> members)
CoordinationSet(CalendarDateUnit resolution)

Method Summary

Modifier and Type	Method	Description
void	complete()	Will call CalendarDateSeries.complete() on each of the instances in this set.
CoordinationSet<N>	copy()
private CoordinationSet<N>	doPruneAndResample(CalendarDate firstKey, CalendarDate lastKey, CalendarDateUnit resolution)
CalendarDateSeries<N>	get(Object key)
CalendarDateSeries<N>	get(String seriesName)
List<CalendarDate>	getAllCalendarDates()
List<String>	getAllSeriesNames()
CalendarDate	getEarliestFirstKey()
CalendarDate	getEarliestLastKey()
CalendarDate	getLatestFirstKey()
CalendarDate	getLatestLastKey()
CalendarDateUnit	getResolution()
N	getValue(String series, CalendarDate date)
CoordinationSet<N>	prune()	Returns a new CoordinationSet where all series have the same first and last keys, as well as a common (the highest common) resolution.
CoordinationSet<N>	prune(CalendarDateUnit resolution)	Returns a new CoordinationSet where all series have the same first and last keys, as well as the specified resolution.
CalendarDateSeries<N>	put(CalendarDateSeries<N> series)	Vill use the series' name as the key.
CoordinationSet<N>	resample(CalendarDateUnit resolution)	Returns a new set of series each resampled to the supplied resolution.
String	toString()

Methods inherited from class HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, getOrDefault, isEmpty, keySet, merge, newHashMap, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class AbstractMap

equals, hashCode

Methods inherited from class Object

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

Methods inherited from interface Map

equals, hashCode

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

myResolution

private transient CalendarDateUnit myResolution

Constructor Details

CoordinationSet

public CoordinationSet()

CoordinationSet

public CoordinationSet(CalendarDateUnit resolution)

CoordinationSet

public CoordinationSet(Collection<CalendarDateSeries<N>> seriesCollection)

CoordinationSet

public CoordinationSet(Collection<CalendarDateSeries<N>> seriesCollection,
 CalendarDateUnit resolution)

CoordinationSet

public CoordinationSet(int initialCapacity)

CoordinationSet

public CoordinationSet(int initialCapacity,
 float loadFactor)

CoordinationSet

public CoordinationSet(Map<? extends String, ? extends CalendarDateSeries<N>> members)

Method Details

complete

public void complete()

Will call CalendarDateSeries.complete() on each of the instances in this set.

copy

public CoordinationSet<N> copy()

get

public CalendarDateSeries<N> get(Object key)

Specified by:

get in interface Map<String, CalendarDateSeries<N extends Comparable<N>>>

Overrides:

get in class HashMap<String, CalendarDateSeries<N extends Comparable<N>>>

get

public CalendarDateSeries<N> get(String seriesName)

getAllCalendarDates

public List<CalendarDate> getAllCalendarDates()

getAllSeriesNames

public List<String> getAllSeriesNames()

getEarliestFirstKey

public CalendarDate getEarliestFirstKey()

getEarliestLastKey

public CalendarDate getEarliestLastKey()

getLatestFirstKey

public CalendarDate getLatestFirstKey()

getLatestLastKey

public CalendarDate getLatestLastKey()

getResolution

public CalendarDateUnit getResolution()

getValue

public N getValue(String series,
 CalendarDate date)

prune

public CoordinationSet<N> prune()

Returns a new CoordinationSet where all series have the same first and last keys, as well as a common (the highest common) resolution.

prune

public CoordinationSet<N> prune(CalendarDateUnit resolution)

Returns a new CoordinationSet where all series have the same first and last keys, as well as the specified resolution.

put

public CalendarDateSeries<N> put(CalendarDateSeries<N> series)

Vill use the series' name as the key. Make sure you have set the name to something that uniquely identifies the series.

resample

public CoordinationSet<N> resample(CalendarDateUnit resolution)

Returns a new set of series each resampled to the supplied resolution. No pruning!

toString

public String toString()

Overrides:

toString in class AbstractMap<String, CalendarDateSeries<N extends Comparable<N>>>

doPruneAndResample

private CoordinationSet<N> doPruneAndResample(CalendarDate firstKey,
 CalendarDate lastKey,
 CalendarDateUnit resolution)