org.ojalgo.series
Interface BasicSeries<K extends Comparable<K>,V extends Number>

All Superinterfaces:
Map<K,V>, SortedMap<K,V>
All Known Subinterfaces:
TimeSeries<K,V>
All Known Implementing Classes:
BigBigSeries, CalendarBigSeries, CalendarRandomSeries, DateBigSeries, DateRandomSeries

public interface BasicSeries<K extends Comparable<K>,V extends Number>
extends SortedMap<K,V>

A BasicSeries is a SortedMap with restricted type parameters, and the option to set a name and colour.

Author:
apete

Nested Class Summary
 
Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>
 
Method Summary
 BasicSeries<K,V> colour(Color aPaint)
           
 V firstValue()
           
 Color getColour()
           
 BasicSeries<K,V> getHeadSeries(K aToKey)
           
 K[] getKeys()
           
 String getName()
           
 BasicSeries<K,V> getSubSeries(K aFromKey, K aToKey)
           
 BasicSeries<K,V> getTailSeries(K aFromKey)
           
 V getValue(K aKey)
           
 V[] getValues()
           
 V lastValue()
           
 void modify(UnaryFunction<V> aFunc)
           
 BasicSeries<K,V> name(String aName)
           
 void normalise(K aKey, V aNormValue)
           
 void setColour(Color aPaint)
           
 void setName(String aName)
           
 void setValue(K aKey, V aValue)
           
 void setValues(Map<K,V> someValues)
           
 
Methods inherited from interface java.util.SortedMap
comparator, firstKey, headMap, lastKey, subMap, tailMap
 
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 

Method Detail

colour

BasicSeries<K,V> colour(Color aPaint)

firstValue

V firstValue()

getColour

Color getColour()

getHeadSeries

BasicSeries<K,V> getHeadSeries(K aToKey)

getKeys

K[] getKeys()

getName

String getName()

getSubSeries

BasicSeries<K,V> getSubSeries(K aFromKey,
                              K aToKey)

getTailSeries

BasicSeries<K,V> getTailSeries(K aFromKey)

getValue

V getValue(K aKey)

getValues

V[] getValues()

lastValue

V lastValue()

modify

void modify(UnaryFunction<V> aFunc)

name

BasicSeries<K,V> name(String aName)

normalise

void normalise(K aKey,
               V aNormValue)

setColour

void setColour(Color aPaint)

setName

void setName(String aName)

setValue

void setValue(K aKey,
              V aValue)

setValues

void setValues(Map<K,V> someValues)