ch.agent.crnickl.impl

Interface ValueAccessMethods<T>

Type Parameters:

T - the data type of values

All Superinterfaces:

DatabaseMethods

public interface ValueAccessMethods<T>
extends DatabaseMethods

ValueAccessMethods is a generic interface for accessing and modifying series values.

Author:

Jean-Paul Vetterli

Method Summary

Modifier and Type	Method and Description
boolean	deleteValue(UpdatableSeries<T> series, ch.agent.t2.time.TimeIndex t, ChronicleUpdatePolicy policy) Delete the value at the time index, if the policy allows.
ch.agent.t2.timeseries.Observation<T>	getFirst(Series<T> series, ch.agent.t2.time.TimeIndex time) Return the observation at the time index or the first following one or null.
ch.agent.t2.timeseries.Observation<T>	getLast(Series<T> series, ch.agent.t2.time.TimeIndex time) Return the observation at the time index or the last preceding one or null.
ch.agent.t2.time.Range	getRange(Series<T> series) Return the range of values of a series.
long	getValues(Series<T> series, ch.agent.t2.time.Range range, ch.agent.t2.timeseries.TimeAddressable<T> ts) Load values into the time series in the range specified.
boolean	updateSeries(UpdatableSeries<T> series, ch.agent.t2.time.Range range, ChronicleUpdatePolicy policy) Reduce the range of the series, if the policy allows.
long	updateValues(UpdatableSeries<T> series, ch.agent.t2.timeseries.TimeAddressable<T> values, ChronicleUpdatePolicy policy) Update the series with the values in the time series, if the policy allows.

Methods inherited from interface ch.agent.crnickl.impl.DatabaseMethods

makeSurrogate, makeSurrogate

Method Detail

getRange

ch.agent.t2.time.Range getRange(Series<T> series)
                         throws T2DBException

Return the range of values of a series.

Parameters:

series - a series

Returns:

a range, never null, but possibly empty

Throws:

T2DBException

getValues

long getValues(Series<T> series,
               ch.agent.t2.time.Range range,
               ch.agent.t2.timeseries.TimeAddressable<T> ts)
        throws T2DBException

Load values into the time series in the range specified. To load all values, specify a null range. Return the number of values loaded. Existing values outside the range are not touched. Missing values inside the range do not delete existing values.

Parameters:

series - a series

range - a range or null

ts - a time series

Returns:

the number of values loaded

Throws:

T2DBException

getFirst

ch.agent.t2.timeseries.Observation<T> getFirst(Series<T> series,
                                               ch.agent.t2.time.TimeIndex time)
                                        throws T2DBException

Return the observation at the time index or the first following one or null. If the time index is null return the first observation.

Parameters:

series - a series

time - a time index

Returns:

an observation

Throws:

T2DBException

getLast

ch.agent.t2.timeseries.Observation<T> getLast(Series<T> series,
                                              ch.agent.t2.time.TimeIndex time)
                                       throws T2DBException

Return the observation at the time index or the last preceding one or null. If the time index is null return the last observation.

Parameters:

series - a series

time - a time index

Returns:

an observation

Throws:

T2DBException

deleteValue

boolean deleteValue(UpdatableSeries<T> series,
                    ch.agent.t2.time.TimeIndex t,
                    ChronicleUpdatePolicy policy)
             throws T2DBException

Delete the value at the time index, if the policy allows.

Parameters:

series - a series

t - a time index

policy - a policy

Returns:

true if a value was deleted

Throws:

T2DBException

updateSeries

boolean updateSeries(UpdatableSeries<T> series,
                     ch.agent.t2.time.Range range,
                     ChronicleUpdatePolicy policy)
              throws T2DBException

Reduce the range of the series, if the policy allows.

Parameters:

series - a series

range - a range

policy - a policy

Returns:

true if anything was done

Throws:

T2DBException

updateValues

long updateValues(UpdatableSeries<T> series,
                  ch.agent.t2.timeseries.TimeAddressable<T> values,
                  ChronicleUpdatePolicy policy)
           throws T2DBException

Update the series with the values in the time series, if the policy allows. Missing values in the time series delete values in the database.

Parameters:

series - a series

values - a time series of values

policy - a policy

Returns:

the number of values updated

Throws:

T2DBException