ch.agent.crnickl.api

Interface UpdatableSeries<T>

Type Parameters:

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

All Superinterfaces:

DBObject, Series<T>, Updatable

All Known Implementing Classes:

UpdatableSeriesImpl

public interface UpdatableSeries<T>
extends Series<T>, Updatable

An UpdatableSeries is a series which can be modified.

Author:

Jean-Paul Vetterli

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroy the series.
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 updatable series to the type specified.

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

edit, getAttribute, getAttributes, getChronicle, getDefinition, getDescription, getDescriptions, getFirstObservation, getLastObservation, getName, getNames, getNumber, getRange, getTimeDomain, getValue, getValues, getValues, getValueType, isSparse

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

getDatabase, getId, getSurrogate, inConstruction, isValid

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

applyUpdates

Method Detail

destroy

void destroy()
      throws T2DBException

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

Throws:

T2DBException

scanValue

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

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.

Parameters:

t - a time index

value - a value

Throws:

T2DBException

ch.agent.t2.T2Exception

setValue

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

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.

Parameters:

t - a time index

value - a value

Throws:

T2DBException

ch.agent.t2.T2Exception

setValues

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

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

Parameters:

values - a time series of values

Throws:

T2DBException

ch.agent.t2.T2Exception

setRange

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

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.

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

typeCheck

<S> UpdatableSeries<S> typeCheck(Class<S> type)
                          throws T2DBException

Cast the updatable 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 updatable series cast to the type specified

Throws:

T2DBException