Class CalendarDateSeries<N extends Comparable<N>>

java.lang.Object

org.ojalgo.series.TreeSeries<CalendarDate, N, CalendarDateSeries<N>>

org.ojalgo.series.CalendarDateSeries<N>

All Implemented Interfaces:

Map<CalendarDate, N>, NavigableMap<CalendarDate, N>, SequencedMap<CalendarDate, N>, SortedMap<CalendarDate, N>, BasicSeries<CalendarDate, N>, BasicSeries.NaturallySequenced<CalendarDate, N>

public final class CalendarDateSeries<N extends Comparable<N>>
extends TreeSeries<CalendarDate, N, CalendarDateSeries<N>>
implements BasicSeries.NaturallySequenced<CalendarDate, N>

Nested Class Summary

Nested classes/interfaces inherited from interface BasicSeries

BasicSeries.NaturallySequenced<K,V>, BasicSeries.TimeSeriesBuilder<K>

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
private final NavigableMap<CalendarDate, N>	myDelegate
private final CalendarDateUnit	myResolution

Fields inherited from interface BasicSeries

CALENDAR, CALENDAR_DATE, DATE, INSTANT, LOCAL_DATE, LOCAL_DATE_TIME, LOCAL_TIME, OFFSET_DATE_TIME, ZONED_DATE_TIME

Constructor Summary

Constructors

Constructor	Description
CalendarDateSeries()
CalendarDateSeries(NavigableMap<CalendarDate, N> delegate, CalendarDateUnit resolution)
CalendarDateSeries(CalendarDateUnit resolution)

Method Summary

Modifier and Type	Method	Description
void	complete()	Using the natural sequencing as the key incrementor.
N	get(CalendarDate key)
long	getAverageStepSize()
long[]	getPrimitiveKeys()
ExplicitTimeSeries	getPrimitiveTimeSeries()
CalendarDateUnit	getResolution()
CalendarDateSeries<N>	headMap(CalendarDate toKey)
CalendarDateSeries<N>	headMap(CalendarDate toKey, boolean inclusive)
CalendarDate	nextKey()
N	put(Calendar key, N value)
N	put(Date key, N value)
N	put(CalendarDate key, N value)
void	putAll(Map<? extends CalendarDate, ? extends N> data)
BasicSeries<CalendarDate, N>	resample(UnaryOperator<CalendarDate> keyTranslator)
BasicSeries<CalendarDate, N>	resample(CalendarDateUnit resolution)
private BasicSeries<CalendarDate, N>	resample(CalendarDateUnit resolution, Function<CalendarDate, CalendarDate> keyMapper)
CalendarDate	step(CalendarDate key)	Will step (increment) the key given to the next in the natural sequence.
CalendarDateSeries<N>	subMap(CalendarDate fromKey, boolean inclusiveFromKey, CalendarDate toKey, boolean inclusiveToKey)
CalendarDateSeries<N>	subMap(CalendarDate fromKey, CalendarDate toKey)
CalendarDateSeries<N>	tailMap(CalendarDate fromKey)
CalendarDateSeries<N>	tailMap(CalendarDate fromKey, boolean inclusive)
String	toString()

Methods inherited from class TreeSeries

appendLastPartToString, ceilingEntry, ceilingKey, clear, colour, comparator, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, descendingKeySet, descendingMap, entrySet, equals, firstEntry, firstKey, floorEntry, floorKey, forEach, get, getColour, getName, getOrDefault, hashCode, higherEntry, higherKey, isEmpty, keySet, lastEntry, lastKey, lowerEntry, lowerKey, merge, name, navigableKeySet, pollFirstEntry, pollLastEntry, putIfAbsent, remove, remove, replace, replace, replaceAll, setColour, setName, size, toStringFirstPart, values

Methods inherited from class Object

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

Methods inherited from interface BasicSeries

asPrimitive, colour, complete, doubleValue, firstValue, get, getColour, getName, lastValue, name, put, put, putAll, resample, setColour, setName

Methods inherited from interface Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, remove, replace, replace, replaceAll, size

Methods inherited from interface NavigableMap

reversed

Methods inherited from interface SequencedMap

sequencedEntrySet, sequencedKeySet, sequencedValues

Methods inherited from interface SortedMap

comparator, entrySet, firstKey, keySet, lastKey, putFirst, putLast, values

Field Details

myDelegate

private final NavigableMap<CalendarDate, N extends Comparable<N>> myDelegate

myResolution

private final CalendarDateUnit myResolution

Constructor Details

CalendarDateSeries

public CalendarDateSeries()

CalendarDateSeries

public CalendarDateSeries(CalendarDateUnit resolution)

CalendarDateSeries

CalendarDateSeries(NavigableMap<CalendarDate, N> delegate,
 CalendarDateUnit resolution)

Method Details

complete

public void complete()

Description copied from interface: BasicSeries.NaturallySequenced

Using the natural sequencing as the key incrementor.

Specified by:

complete in interface BasicSeries.NaturallySequenced<CalendarDate, N extends Comparable<N>>

See Also:

• BasicSeries.complete(UnaryOperator)

get

public N get(CalendarDate key)

Specified by:

get in interface BasicSeries<CalendarDate, N extends Comparable<N>>

Overrides:

get in class TreeSeries<CalendarDate, N extends Comparable<N>, CalendarDateSeries<N extends Comparable<N>>>

getAverageStepSize

public long getAverageStepSize()

getPrimitiveKeys

public long[] getPrimitiveKeys()

getPrimitiveTimeSeries

public ExplicitTimeSeries getPrimitiveTimeSeries()

getResolution

public CalendarDateUnit getResolution()

headMap

public CalendarDateSeries<N> headMap(CalendarDate toKey)

Specified by:

headMap in interface NavigableMap<CalendarDate, N extends Comparable<N>>

Specified by:

headMap in interface SortedMap<CalendarDate, N extends Comparable<N>>

Overrides:

headMap in class TreeSeries<CalendarDate, N extends Comparable<N>, CalendarDateSeries<N extends Comparable<N>>>

headMap

public CalendarDateSeries<N> headMap(CalendarDate toKey,
 boolean inclusive)

Specified by:

headMap in interface NavigableMap<CalendarDate, N extends Comparable<N>>

Overrides:

headMap in class TreeSeries<CalendarDate, N extends Comparable<N>, CalendarDateSeries<N extends Comparable<N>>>

nextKey

public CalendarDate nextKey()

Specified by:

nextKey in interface BasicSeries.NaturallySequenced<CalendarDate, N extends Comparable<N>>

Returns:

The next, after the SortedMap.lastKey(), key.

put

public N put(Calendar key,
 N value)

put

public N put(CalendarDate key,
 N value)

Specified by:

put in interface Map<CalendarDate, N extends Comparable<N>>

Overrides:

put in class TreeSeries<CalendarDate, N extends Comparable<N>, CalendarDateSeries<N extends Comparable<N>>>

put

public N put(Date key,
 N value)

putAll

public void putAll(Map<? extends CalendarDate, ? extends N> data)

Specified by:

putAll in interface Map<CalendarDate, N extends Comparable<N>>

Overrides:

putAll in class TreeSeries<CalendarDate, N extends Comparable<N>, CalendarDateSeries<N extends Comparable<N>>>

resample

public BasicSeries<CalendarDate, N> resample(CalendarDateUnit resolution)

resample

public BasicSeries<CalendarDate, N> resample(UnaryOperator<CalendarDate> keyTranslator)

Specified by:

resample in interface BasicSeries<CalendarDate, N extends Comparable<N>>

step

public CalendarDate step(CalendarDate key)

Description copied from interface: BasicSeries.NaturallySequenced

Will step (increment) the key given to the next in the natural sequence.

Specified by:

step in interface BasicSeries.NaturallySequenced<CalendarDate, N extends Comparable<N>>

subMap

public CalendarDateSeries<N> subMap(CalendarDate fromKey,
 boolean inclusiveFromKey,
 CalendarDate toKey,
 boolean inclusiveToKey)

Specified by:

subMap in interface NavigableMap<CalendarDate, N extends Comparable<N>>

Overrides:

subMap in class TreeSeries<CalendarDate, N extends Comparable<N>, CalendarDateSeries<N extends Comparable<N>>>

subMap

public CalendarDateSeries<N> subMap(CalendarDate fromKey,
 CalendarDate toKey)

Specified by:

subMap in interface NavigableMap<CalendarDate, N extends Comparable<N>>

Specified by:

subMap in interface SortedMap<CalendarDate, N extends Comparable<N>>

Overrides:

subMap in class TreeSeries<CalendarDate, N extends Comparable<N>, CalendarDateSeries<N extends Comparable<N>>>

tailMap

public CalendarDateSeries<N> tailMap(CalendarDate fromKey)

Specified by:

tailMap in interface NavigableMap<CalendarDate, N extends Comparable<N>>

Specified by:

tailMap in interface SortedMap<CalendarDate, N extends Comparable<N>>

Overrides:

tailMap in class TreeSeries<CalendarDate, N extends Comparable<N>, CalendarDateSeries<N extends Comparable<N>>>

tailMap

public CalendarDateSeries<N> tailMap(CalendarDate fromKey,
 boolean inclusive)

Specified by:

tailMap in interface NavigableMap<CalendarDate, N extends Comparable<N>>

Overrides:

tailMap in class TreeSeries<CalendarDate, N extends Comparable<N>, CalendarDateSeries<N extends Comparable<N>>>

toString

public String toString()

Overrides:

toString in class TreeSeries<CalendarDate, N extends Comparable<N>, CalendarDateSeries<N extends Comparable<N>>>

resample

private BasicSeries<CalendarDate, N> resample(CalendarDateUnit resolution,
 Function<CalendarDate, CalendarDate> keyMapper)