org.ojalgo.series
Class CalendarSeries<N extends Number>

java.lang.Object
  java.util.AbstractMap<K,V>
      org.ojalgo.series.CalendarSeries<N>

All Implemented Interfaces:

Map<Calendar,N>, SortedMap<Calendar,N>, BasicSeries<Calendar,N>, BasicTimeSeries<Calendar,N>

public class CalendarSeries<N extends Number>
extends AbstractMap<K,V>

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

CalendarSeries(TimeUnit aResolution)

Method Summary

void	clear()
CalendarSeries<N>	colour(Color aPaint)
Comparator<? super K>	comparator()
boolean	containsKey(Object aKey)
boolean	containsValue(Object aValue)
Set<Map.Entry<K,V>>	entrySet()
K	firstKey()
V	firstValue()
V	get(Object aKey)
long	getAverageStepSize()
Color	getColour()
String	getName()
long[]	getPrimitiveKeys()
double[]	getPrimitiveValues()
TimeUnit	getResolution()
TimeInMillisSeries<V>	getTimeInMillisSeries()
CalendarSeries<N>	headMap(Calendar aToKey)
boolean	isEmpty()
K	lastKey()
V	lastValue()
void	modify(BinaryFunction<V> aFunc, V anArg)
void	modify(ParameterFunction<V> aFunc, int aParam)
void	modify(UnaryFunction<V> aFunc)
CalendarSeries<N>	name(String aName)
V	put(K aKey, V aValue)
CalendarSeries<N>	reconstruct(Calendar aFromKey, Calendar aToKey, TimeUnit aResolution)
V	remove(Object aKey)
CalendarSeries<N>	resample(TimeUnit aResolution)
void	setColour(Color aPaint)
void	setName(String aName)
int	size()
Calendar	step(Calendar anExternalKey) Will increment the input key to the next expected "value".
CalendarSeries<N>	subMap(Calendar aFromKey, Calendar aToKey)
CalendarSeries<N>	tailMap(Calendar aFromKey)
String	toString()

Methods inherited from class java.util.AbstractMap

equals, hashCode, keySet, putAll, values

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode, keySet, putAll, values

Constructor Detail

CalendarSeries

public CalendarSeries(TimeUnit aResolution)

Method Detail

colour

public CalendarSeries<N> colour(Color aPaint)

Specified by:

colour in interface BasicSeries<Calendar,N extends Number>

headMap

public CalendarSeries<N> headMap(Calendar aToKey)

name

public CalendarSeries<N> name(String aName)

Specified by:

name in interface BasicSeries<Calendar,N extends Number>

reconstruct

public CalendarSeries<N> reconstruct(Calendar aFromKey,
                                     Calendar aToKey,
                                     TimeUnit aResolution)

Specified by:

reconstruct in interface BasicTimeSeries<Calendar,N extends Number>

resample

public CalendarSeries<N> resample(TimeUnit aResolution)

Specified by:

resample in interface BasicTimeSeries<Calendar,N extends Number>

step

public Calendar step(Calendar anExternalKey)

Description copied from interface: BasicTimeSeries

Will increment the input key to the next expected "value".

subMap

public CalendarSeries<N> subMap(Calendar aFromKey,
                                Calendar aToKey)

tailMap

public CalendarSeries<N> tailMap(Calendar aFromKey)

clear

public final void clear()

Specified by:

clear in interface Map<K extends Comparable<K>,V extends Number>

Overrides:

clear in class AbstractMap<K extends Comparable<K>,V extends Number>

comparator

public final Comparator<? super K> comparator()

Specified by:

comparator in interface SortedMap<K extends Comparable<K>,V extends Number>

containsKey

public final boolean containsKey(Object aKey)

Specified by:

containsKey in interface Map<K extends Comparable<K>,V extends Number>

Overrides:

containsKey in class AbstractMap<K extends Comparable<K>,V extends Number>

containsValue

public final boolean containsValue(Object aValue)

Specified by:

containsValue in interface Map<K extends Comparable<K>,V extends Number>

Overrides:

containsValue in class AbstractMap<K extends Comparable<K>,V extends Number>

entrySet

public final Set<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface Map<K extends Comparable<K>,V extends Number>

Specified by:

entrySet in class AbstractMap<K extends Comparable<K>,V extends Number>

firstKey

public final K firstKey()

Specified by:

firstKey in interface SortedMap<K extends Comparable<K>,V extends Number>

firstValue

public final V firstValue()

Specified by:

firstValue in interface BasicSeries<K extends Comparable<K>,V extends Number>

get

public final V get(Object aKey)

Specified by:

get in interface Map<K extends Comparable<K>,V extends Number>

Overrides:

get in class AbstractMap<K extends Comparable<K>,V extends Number>

getAverageStepSize

public final long getAverageStepSize()

Specified by:

getAverageStepSize in interface BasicTimeSeries<K extends Comparable<K>,V extends Number>

Returns:

The average number of millis between to subsequent keys in the series.

getColour

public final Color getColour()

Specified by:

getColour in interface BasicSeries<K extends Comparable<K>,V extends Number>

getName

public final String getName()

Specified by:

getName in interface BasicSeries<K extends Comparable<K>,V extends Number>

getPrimitiveKeys

public final long[] getPrimitiveKeys()

Specified by:

getPrimitiveKeys in interface BasicTimeSeries<K extends Comparable<K>,V extends Number>

getPrimitiveValues

public final double[] getPrimitiveValues()

Specified by:

getPrimitiveValues in interface BasicSeries<K extends Comparable<K>,V extends Number>

getResolution

public final TimeUnit getResolution()

Specified by:

getResolution in interface BasicTimeSeries<K extends Comparable<K>,V extends Number>

getTimeInMillisSeries

public final TimeInMillisSeries<V> getTimeInMillisSeries()

Specified by:

getTimeInMillisSeries in interface BasicTimeSeries<K extends Comparable<K>,V extends Number>

isEmpty

public final boolean isEmpty()

Specified by:

isEmpty in interface Map<K extends Comparable<K>,V extends Number>

Overrides:

isEmpty in class AbstractMap<K extends Comparable<K>,V extends Number>

lastKey

public final K lastKey()

Specified by:

lastKey in interface SortedMap<K extends Comparable<K>,V extends Number>

lastValue

public final V lastValue()

Specified by:

lastValue in interface BasicSeries<K extends Comparable<K>,V extends Number>

modify

public final void modify(BinaryFunction<V> aFunc,
                         V anArg)

Specified by:

modify in interface BasicSeries<K extends Comparable<K>,V extends Number>

modify

public final void modify(ParameterFunction<V> aFunc,
                         int aParam)

Specified by:

modify in interface BasicSeries<K extends Comparable<K>,V extends Number>

modify

public final void modify(UnaryFunction<V> aFunc)

Specified by:

modify in interface BasicSeries<K extends Comparable<K>,V extends Number>

put

public final V put(K aKey,
                   V aValue)

Specified by:

put in interface Map<K extends Comparable<K>,V extends Number>

Overrides:

put in class AbstractMap<K extends Comparable<K>,V extends Number>

remove

public final V remove(Object aKey)

Specified by:

remove in interface Map<K extends Comparable<K>,V extends Number>

Overrides:

remove in class AbstractMap<K extends Comparable<K>,V extends Number>

setColour

public final void setColour(Color aPaint)

Specified by:

setColour in interface BasicSeries<K extends Comparable<K>,V extends Number>

setName

public final void setName(String aName)

Specified by:

setName in interface BasicSeries<K extends Comparable<K>,V extends Number>

size

public final int size()

Specified by:

size in interface Map<K extends Comparable<K>,V extends Number>

Overrides:

size in class AbstractMap<K extends Comparable<K>,V extends Number>

toString

public final String toString()

Overrides:

toString in class AbstractMap<K extends Comparable<K>,V extends Number>