SeriesImpl (CrNiCKL database 2.0.0 API)

java.lang.Object
- ch.agent.crnickl.impl.DBObjectImpl
- - ch.agent.crnickl.impl.SeriesImpl<T>

Type Parameters:

T - the class of the elements of the underlying time series

All Implemented Interfaces:

DBObject, Series<T>

Direct Known Subclasses:

UpdatableSeriesImpl
```
public class SeriesImpl<T>
extends DBObjectImpl
implements Series<T>
```
Default implementation of Series.

Author:

Jean-Paul Vetterli

Constructor Summary

Constructors
Constructor and Description

SeriesImpl(Chronicle chronicle, String name, int number, Surrogate surrogate)
Construct a Series.

Constructors
Constructor and Description
`SeriesImpl(Chronicle chronicle, String name, int number, Surrogate surrogate)` Construct a `Series`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UpdatableSeries<T>`	`edit()` Return an `UpdatableSeries` corresponding to this series.
`Attribute<?>`	`getAttribute(String name, boolean mustExist)` Return the attribute with the given name.
`Collection<Attribute<?>>`	`getAttributes()` Return all the series' attributes.
`Chronicle`	`getChronicle()` Return the chronicle to which this series belongs.
`SeriesDefinition`	`getDefinition()` Return the series' definition.
`String`	`getDescription(boolean full)` Return the description of the series.
`List<String>`	`getDescriptions()` Return the list of all descriptions along the chronicle chain and the series.
`ch.agent.t2.timeseries.Observation<T>`	`getFirstObservation(ch.agent.t2.time.TimeIndex time)` Return the observation at the given time index or the first following observation.
`ch.agent.t2.timeseries.Observation<T>`	`getLastObservation(ch.agent.t2.time.TimeIndex time)` Return the observation at the give time index or the last preceding observation.
`String`	`getName(boolean full)` Return the simple name or the full name of the series.
`List<String>`	`getNames()` Return the list of all names along the chronicle chain and the series.
`int`	`getNumber()` Return the series number within the chronicle.
`ch.agent.t2.time.Range`	`getRange()` Return the range of values.
`ch.agent.t2.time.TimeDomain`	`getTimeDomain()` Return the time domain of the series.
`T`	`getValue(ch.agent.t2.time.TimeIndex time)` Return the value of the time series at the time index specified.
`ch.agent.t2.timeseries.TimeAddressable<T>`	`getValues(ch.agent.t2.time.Range range)` Return the time series of values in the range specified.
`ch.agent.t2.timeseries.TimeAddressable<T>`	`getValues(ch.agent.t2.time.Range range, boolean forceSparse)` Return the time series of values in the range specified.
`ValueType<T>`	`getValueType()` Return the value type of the series.
`boolean`	`isSparse()` Return true if the series is forced to use sparse time series.
`String`	`toString()`
`<S> Series<S>`	`typeCheck(Class<S> type)` Cast the series to the type specified.
`protected void`	`update()` Refresh state.

Methods inherited from class ch.agent.crnickl.impl.DBObjectImpl
equals, getDatabase, getId, getSurrogate, hashCode, inConstruction, isValid

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ch.agent.crnickl.api.DBObject
getDatabase, getId, getSurrogate, inConstruction, isValid

- Constructor Detail
  - SeriesImpl
```
public SeriesImpl(Chronicle chronicle,
                  String name,
                  int number,
                  Surrogate surrogate)
```
    Construct a Series.
    
    Parameters:
    
    chronicle - a chronicle
    
    name - a string or null
    
    number - a positive number
    
    surrogate - a surrogate
- Method Detail
  - update
```
protected void update()
```
    Refresh state. More accurately, pretend to refresh, because there is no state to refresh in this implementation.
  - edit
```
public UpdatableSeries<T> edit()
```
    Return an UpdatableSeries corresponding to this series. Successfully getting an Updatable object does not imply that updates can be successfully applied.
    The new and old objects share internal data.
    
    Specified by:
    
    edit in interface Series<T>
    
    Returns:
    
    an updatable series corresponding to this series
  - getChronicle
```
public Chronicle getChronicle()
```
    Description copied from interface: Series
    
    Return the chronicle to which this series belongs.
    
    Specified by:
    
    getChronicle in interface Series<T>
    
    Returns:
    
    the chronicle
  - getDefinition
```
public SeriesDefinition getDefinition()
                               throws T2DBException
```
    Description copied from interface: Series
    
    Return the series' definition.
    
    Specified by:
    
    getDefinition in interface Series<T>
    
    Returns:
    
    the definition of the series
    
    Throws:
    
    T2DBException
  - getName
```
public String getName(boolean full)
               throws T2DBException
```
    Description copied from interface: Series
    
    Return the simple name or the full name of the series. The simple name is specified in the schema, so it is the same across a collection of chronicles with the same schema. The full name of a series is the full name of its chronicle plus its simple name.
    
    Specified by:
    
    getName in interface Series<T>
    
    Parameters:
    
    full - if true return the full name else the simple name
    
    Returns:
    
    the full name or the simple name
    
    Throws:
    
    T2DBException
  - getNumber
```
public int getNumber()
```
    Description copied from interface: Series
    
    Return the series number within the chronicle.
    
    Specified by:
    
    getNumber in interface Series<T>
    
    Returns:
    
    the series number
  - getNames
```
public List<String> getNames()
                      throws T2DBException
```
    Description copied from interface: Series
    
    Return the list of all names along the chronicle chain and the series. The last element is the simple name of the series. The previous element is the name of the chronicle. The element before that is the name of the chronicle's collection, and so on until the top chronicle.
    
    Specified by:
    
    getNames in interface Series<T>
    
    Returns:
    
    the list of names along the chronicle chain and the series
    
    Throws:
    
    T2DBException
  - getValueType
```
public ValueType<T> getValueType()
                          throws T2DBException
```
    Description copied from interface: Series
    
    Return the value type of the series. For a given series name and schema, the type is always the same.
    
    Specified by:
    
    getValueType in interface Series<T>
    
    Returns:
    
    the value type of the series
    
    Throws:
    
    T2DBException
  - getTimeDomain
```
public ch.agent.t2.time.TimeDomain getTimeDomain()
                                          throws T2DBException
```
    Description copied from interface: Series
    
    Return the time domain of the series. For a given series name and schema, the time domain is always the same.
    
    Specified by:
    
    getTimeDomain in interface Series<T>
    
    Returns:
    
    the time domain of the series
    
    Throws:
    
    T2DBException
  - isSparse
```
public boolean isSparse()
                 throws T2DBException
```
    Description copied from interface: Series
    
    Return true if the series is forced to use sparse time series. If true the method Series.getValues(Range) must return a sparse time series, else it can return a sparse or a regular time series.
    
    Specified by:
    
    isSparse in interface Series<T>
    
    Returns:
    
    true if the series is forced to use sparse time series
    
    Throws:
    
    T2DBException
  - getDescription
```
public String getDescription(boolean full)
                      throws T2DBException
```
    Description copied from interface: Series
    
    Return the description of the series. The full description includes the description of the chronicle. Like the simple name, the simple description is specified in the schema.
    
    Specified by:
    
    getDescription in interface Series<T>
    
    Parameters:
    
    full - if true return the full description, else the simple description
    
    Returns:
    
    the full or the simple description of the chronicle
    
    Throws:
    
    T2DBException
  - getDescriptions
```
public List<String> getDescriptions()
                             throws T2DBException
```
    Description copied from interface: Series
    
    Return the list of all descriptions along the chronicle chain and the series. The last element is this series description. The previous element is the description of the chronicle. The element before that is the description of the chronicle collection, and so on until the top chronicle.
    
    Specified by:
    
    getDescriptions in interface Series<T>
    
    Returns:
    
    the list of descriptions along the chronicle chain and the series
    
    Throws:
    
    T2DBException
  - getAttribute
```
public Attribute<?> getAttribute(String name,
                                 boolean mustExist)
                          throws T2DBException
```
    Description copied from interface: Series
    
    Return the attribute with the given name. When the parameter mustExist is set, the result is never null. The value of the attribute can always be null. When no attribute with the given name is defined, an exception is thrown.
    
    Specified by:
    
    getAttribute in interface Series<T>
    
    Parameters:
    
    name - the name of the attribute
    
    Returns:
    
    an attribute
    
    Throws:
    
    T2DBException
  - getAttributes
```
public Collection<Attribute<?>> getAttributes()
                                       throws T2DBException
```
    Description copied from interface: Series
    
    Return all the series' attributes.
    
    Specified by:
    
    getAttributes in interface Series<T>
    
    Returns:
    
    all the attributes of the series
    
    Throws:
    
    T2DBException
  - getValues
```
public ch.agent.t2.timeseries.TimeAddressable<T> getValues(ch.agent.t2.time.Range range)
                                                    throws ch.agent.t2.T2Exception,
                                                           T2DBException
```
    Return the time series of values in the range specified. Any pending update is merged into the result. When there is a backing store for the series, values are always fetched from the backing store (they are not cached). The result is never null. When there are no values, the result is a time series with an empty range.
    The usage of a sparse time series for the result depends on the series schema (SeriesDefinition.isSparse() or on heuristics.
    
    Specified by:
    
    getValues in interface Series<T>
    
    Parameters:
    
    range - the range of values wanted or null for the full range
    
    Returns:
    
    a time series
    
    Throws:
    
    T2DBException
    
    ch.agent.t2.T2Exception
  - getValues
```
public ch.agent.t2.timeseries.TimeAddressable<T> getValues(ch.agent.t2.time.Range range,
                                                           boolean forceSparse)
                                                    throws ch.agent.t2.T2Exception,
                                                           T2DBException
```
    Description copied from interface: Series
    
    Return the time series of values in the range specified. Any pending update is merged into the result. When there is a backing store for the series, values are always fetched from the backing store (they are not cached). The result is never null. When there are no values, the result is a time series with an empty range. If the forceSparse parameter is true, a sparse time series will be used. If the code is false but the sparsity setting of the schema for the series requires a sparse time series, then one will be used. In all other cases the software will decide whether to use a standard or a sparse time series using heuristics.
    
    Specified by:
    
    getValues in interface Series<T>
    
    Parameters:
    
    range - the range of values wanted or null to get the full range
    
    forceSparse - if true use a sparse time series
    
    Returns:
    
    a time series
    
    Throws:
    
    T2DBException
    
    ch.agent.t2.T2Exception
  - getLastObservation
```
public ch.agent.t2.timeseries.Observation<T> getLastObservation(ch.agent.t2.time.TimeIndex time)
                                                         throws ch.agent.t2.T2Exception,
                                                                T2DBException
```
    Description copied from interface: Series
    
    Return the observation at the give time index or the last preceding observation. If the time parameter is null return the last observation. Return null if there is nothing.
    
    Specified by:
    
    getLastObservation in interface Series<T>
    
    Parameters:
    
    time - a time index or null
    
    Returns:
    
    an observation or null
    
    Throws:
    
    T2DBException
    
    ch.agent.t2.T2Exception
  - getFirstObservation
```
public ch.agent.t2.timeseries.Observation<T> getFirstObservation(ch.agent.t2.time.TimeIndex time)
                                                          throws ch.agent.t2.T2Exception,
                                                                 T2DBException
```
    Description copied from interface: Series
    
    Return the observation at the given time index or the first following observation. If the time parameter is null return the first observation. Return null if there is nothing.
    
    Specified by:
    
    getFirstObservation in interface Series<T>
    
    Parameters:
    
    time - a time index or null
    
    Returns:
    
    an observation or null
    
    Throws:
    
    T2DBException
    
    ch.agent.t2.T2Exception
  - getValue
```
public T getValue(ch.agent.t2.time.TimeIndex time)
           throws ch.agent.t2.T2Exception,
                  T2DBException
```
    Description copied from interface: Series
    
    Return the value of the time series at the time index specified. When there is no value, the result is a missing value object.
    
    Specified by:
    
    getValue in interface Series<T>
    
    Parameters:
    
    time - a time index
    
    Returns:
    
    a value
    
    Throws:
    
    T2DBException
    
    ch.agent.t2.T2Exception
    
    See Also:
    
    TimeAddressable.getMissingValue()
  - getRange
```
public ch.agent.t2.time.Range getRange()
                                throws ch.agent.t2.T2Exception,
                                       T2DBException
```
    Description copied from interface: Series
    
    Return the range of values. The result is never null. When there are no values, the range is empty.
    
    Specified by:
    
    getRange in interface Series<T>
    
    Returns:
    
    the range of existing values
    
    Throws:
    
    ch.agent.t2.T2Exception
    
    T2DBException
  - typeCheck
```
public <S> Series<S> typeCheck(Class<S> type)
                        throws T2DBException
```
    Description copied from interface: Series
    
    Cast the series to the type specified. The method performs type checking at run time and allows to catch type errors in controlled fashion.
    
    Specified by:
    
    typeCheck in interface Series<T>
    
    Parameters:
    
    type - the underlying type required
    
    Returns:
    
    the series cast to the type specified
    
    Throws:
    
    T2DBException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SeriesImpl<T>

Constructor Summary

Method Summary

Methods inherited from class ch.agent.crnickl.impl.DBObjectImpl

Methods inherited from class java.lang.Object

Methods inherited from interface ch.agent.crnickl.api.DBObject

Constructor Detail

SeriesImpl

Method Detail

update

edit

getChronicle

getDefinition

getName

getNumber

getNames

getValueType

getTimeDomain

isSparse

getDescription

getDescriptions

getAttribute

getAttributes

getValues

getValues

getLastObservation

getFirstObservation

getValue

getRange

typeCheck

toString