ch.agent.crnickl.impl

Class UpdatableSeriesImpl<T>

java.lang.Object

ch.agent.crnickl.impl.DBObjectImpl

ch.agent.crnickl.impl.SeriesImpl<T>

ch.agent.crnickl.impl.UpdatableSeriesImpl<T>

Type Parameters:

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

All Implemented Interfaces:

DBObject, Series<T>, Updatable, UpdatableSeries<T>

public class UpdatableSeriesImpl<T>
extends SeriesImpl<T>
implements UpdatableSeries<T>

Default implementation of UpdatableSeries.

Author:

Jean-Paul Vetterli

Constructor Summary

Constructors

Constructor and Description
UpdatableSeriesImpl(Chronicle chronicle, String name, int number, Surrogate surrogate) Construct an UpdatableSeries.

Method Summary

Modifier and Type	Method and Description
void	applyUpdates() Apply pending updates.
void	destroy() Destroy the series.
UpdatableSeries<T>	edit() Return an UpdatableSeries corresponding to this 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.
ch.agent.t2.time.Range	getRange() Return the range of values.
ch.agent.t2.timeseries.TimeAddressable<T>	getValues(ch.agent.t2.time.Range reqRange) Return the time series of values in the range specified.
void	scanValue(ch.agent.t2.time.TimeIndex t, Object value) Add a value to the list of pending updates.
boolean	setRange(ch.agent.t2.time.Range range) Set the range of the series.
void	setValue(ch.agent.t2.time.TimeIndex t, T value) Add a value to the list of pending updates.
void	setValues(ch.agent.t2.timeseries.TimeAddressable<T> values) Set the time series to the list of pending updates.
<S> UpdatableSeries<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.SeriesImpl

getAttribute, getAttributes, getChronicle, getDefinition, getDescription, getDescriptions, getName, getNames, getNumber, getTimeDomain, getValue, getValues, getValueType, isSparse, toString

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.Series

getAttribute, getAttributes, getChronicle, getDefinition, getDescription, getDescriptions, getName, getNames, getNumber, getTimeDomain, getValue, getValues, getValueType, isSparse

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

getDatabase, getId, getSurrogate, inConstruction, isValid

Constructor Detail

UpdatableSeriesImpl

public UpdatableSeriesImpl(Chronicle chronicle,
                           String name,
                           int number,
                           Surrogate surrogate)

Construct an UpdatableSeries.

Parameters:

chronicle - a chronicle

name - a string

number - a positive number

surrogate - a surrogate

Method Detail

edit

public UpdatableSeries<T> edit()

Description copied from class: SeriesImpl

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>

Overrides:

edit in class SeriesImpl<T>

Returns:

an updatable series corresponding to this series

typeCheck

public <S> UpdatableSeries<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>

Specified by:

typeCheck in interface UpdatableSeries<T>

Overrides:

typeCheck in class SeriesImpl<T>

Parameters:

type - the underlying type required

Returns:

the series cast to the type specified

Throws:

T2DBException

getValues

public ch.agent.t2.timeseries.TimeAddressable<T> getValues(ch.agent.t2.time.Range reqRange)
                                                    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.

An updatable series always uses a sparse time series to ensure that arbitrary large gaps can be accommodated.

Specified by:

getValues in interface Series<T>

Overrides:

getValues in class SeriesImpl<T>

Parameters:

reqRange - the range of values wanted or null for the full range

Returns:

a time series

Throws:

T2DBException

ch.agent.t2.T2Exception

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>

Overrides:

getRange in class SeriesImpl<T>

Returns:

the range of existing values

Throws:

ch.agent.t2.T2Exception

T2DBException

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>

Overrides:

getLastObservation in class SeriesImpl<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>

Overrides:

getFirstObservation in class SeriesImpl<T>

Parameters:

time - a time index or null

Returns:

an observation or null

Throws:

T2DBException

ch.agent.t2.T2Exception

scanValue

public void scanValue(ch.agent.t2.time.TimeIndex t,
                      Object value)
               throws ch.agent.t2.T2Exception,
                      T2DBException

Description copied from interface: UpdatableSeries

Add a value to the list of pending updates. If there is already an update pending for the same time, it is replaced. A null value is interpreted as a request to delete the value at the given time, possibly reducing the range of the time series. The Object is converted using the value type of the series. If the value is converted to a null, the effect will be to delete the observation.

Specified by:

scanValue in interface UpdatableSeries<T>

Parameters:

t - a time index

value - a value

Throws:

T2DBException

ch.agent.t2.T2Exception

setValue

public void setValue(ch.agent.t2.time.TimeIndex t,
                     T value)
              throws ch.agent.t2.T2Exception,
                     T2DBException

Description copied from interface: UpdatableSeries

Add a value to the list of pending updates. If there is already an update pending for the same time, it is replaced. A null value is interpreted as a request to delete the value at the given time, possibly reducing the range of the time series.

Specified by:

setValue in interface UpdatableSeries<T>

Parameters:

t - a time index

value - a value

Throws:

T2DBException

ch.agent.t2.T2Exception

setValues

public void setValues(ch.agent.t2.timeseries.TimeAddressable<T> values)
               throws ch.agent.t2.T2Exception,
                      T2DBException

Description copied from interface: UpdatableSeries

Set the time series to the list of pending updates. If there are already updates pending for the same time, they are replaced.

Specified by:

setValues in interface UpdatableSeries<T>

Parameters:

values - a time series of values

Throws:

T2DBException

ch.agent.t2.T2Exception

setRange

public boolean setRange(ch.agent.t2.time.Range range)
                 throws ch.agent.t2.T2Exception,
                        T2DBException

Description copied from interface: UpdatableSeries

Set the range of the series. If the range specified is not within the current range, nothing is done. If it is null all values are cleared.

Specified by:

setRange in interface UpdatableSeries<T>

Parameters:

range - a range or null to clear the range

Returns:

true if the range parameter is within the current range

Throws:

ch.agent.t2.T2Exception

T2DBException

destroy

public void destroy()
             throws T2DBException

Description copied from interface: UpdatableSeries

Destroy the series. The operation fails if the range of the series is not empty.

Specified by:

destroy in interface UpdatableSeries<T>

Throws:

T2DBException

applyUpdates

public void applyUpdates()
                  throws T2DBException

Description copied from interface: Updatable

Apply pending updates. Any error, including lack of authorization, results in an exception being thrown. This method does not manage transactions nor does it impose transaction boundaries. The management of transactions using Database.commit() and Database.rollback() is the client's responsibility.

Specified by:

applyUpdates in interface Updatable

Throws:

T2DBException

update

protected void update()

Description copied from class: SeriesImpl

Refresh state. More accurately, pretend to refresh, because there is no state to refresh in this implementation.

Overrides:

update in class SeriesImpl<T>