com.zynaptic.stash

Interface StashTimeSeriesEntry<T extends java.io.Serializable>

Type Parameters:

T - This is the generic type specifier which determines the class of objects which may be stored in the stash using this stash entry handle.

public interface StashTimeSeriesEntry<T extends java.io.Serializable>

Provides the interface for manipulating time series data in the persistent stash storage.

Method Summary

Methods

Modifier and Type	Method and Description
Deferred<T>	getCurrentValue() Accesses the data point in the time series which immediately precedes the current system time.
int	getDataBlockPeriod() Accesses the minimum data block period which is used by the stash time series entry.
int	getDataBlockSize() Accesses the minimum data block size which is used by the stash time series entry.
Deferred<java.util.NavigableMap<java.lang.Long,T>>	getDataPointSet() Gets the full set of time series data points for this time series entry.
Deferred<java.util.NavigableMap<java.lang.Long,T>>	getDataPointSet(long startTimestamp, long endTimestamp) Gets a set of time series data points over a given timestamp range.
Deferred<T>	getDataPointValue(long timestamp) Gets the time series data point associated with a given timestamp.
T	getDefaultValue() Accesses the default value for the stash time series entry.
java.lang.String	getStashId() Accesses the unique stash identifier which is associated with the stash time series entry.
java.lang.String	getStashName() Accesses the human readable stash entry name which is associated with the stash time series entry.
Deferred<java.lang.Boolean>	setCurrentValue(T newValue) Adds a new data point value to the time series, using the current system time to generate the associated timestamp.
Deferred<java.lang.Boolean>	setDataPointValue(long timestamp, T newValue) Adds a new data point value to the time series.

Method Detail

getStashId

java.lang.String getStashId()

Accesses the unique stash identifier which is associated with the stash time series entry.

Returns:

Returns the unique stash identifier for the stash time series entry.

getStashName

java.lang.String getStashName()

Accesses the human readable stash entry name which is associated with the stash time series entry.

Returns:

Returns the human readable stash entry name for the stash time series entry.

getDefaultValue

T getDefaultValue()

Accesses the default value for the stash time series entry. This is the default value which was specified when the stash entry was created and is used for run time type checking.

Returns:

Returns the default value for the stash time series entry.

getDataBlockPeriod

int getDataBlockPeriod()

Accesses the minimum data block period which is used by the stash time series entry.

Returns:

Returns the minimum data block period which is used by the stash time series entry, expressed as an integer number of milliseconds.

getDataBlockSize

int getDataBlockSize()

Accesses the minimum data block size which is used by the stash time series entry.

Returns:

Returns the minimum number of block entries which is used by the stash time series entry, expressed as an integer number of entries.

getCurrentValue

Deferred<T> getCurrentValue()

Accesses the data point in the time series which immediately precedes the current system time.

Returns:

Returns a deferred event object which will have its callbacks executed on completion. It will pass the current value for the time series data as the callback parameter.

getDataPointValue

Deferred<T> getDataPointValue(long timestamp)

Gets the time series data point associated with a given timestamp. If a data point does not exist for the specified timestamp, the data point immediately preceding the specified time will be used. If no such data point exists, the default value will be used instead.

Parameters:

timestamp - This is the timestamp for which the corresponding (or immediately preceding) data point will be accessed. This includes the default time series value which is stored with a timestamp of zero.

Returns:

Returns a deferred event object which will have its callbacks executed on completion. It will pass the value of the appropriate time series data point as the callback parameter.

getDataPointSet

Deferred<java.util.NavigableMap<java.lang.Long,T>> getDataPointSet()

Gets the full set of time series data points for this time series entry. These are collected into a navigable map which indexes data point values by their associated timestamps. This includes the default time series value which is included in the map with a timestamp index value of zero.

Returns:

Returns a deferred event object which will have its callbacks executed on completion. It will pass the appropriate set of time series data points as the callback parameter.

getDataPointSet

Deferred<java.util.NavigableMap<java.lang.Long,T>> getDataPointSet(long startTimestamp,
                                                                 long endTimestamp)

Gets a set of time series data points over a given timestamp range. These are collected into a navigable map which indexes data point values by their associated timestamps.

Parameters:

startTimestamp - This specifies the start of the timestamp range for which time series data points are being retrieved. The range is inclusive of this timestamp value. A starting timestamp value of zero will include the default time series value at the start of the sequence. Timestamp values less than zero are not supported.

endTimestamp - This specifies the end of the timestamp range for which time series data points are being retrieved. The range is inclusive of this timestamp value. The ending timestamp value must be greater than or equal to the starting timestamp value.

Returns:

Returns a deferred event object which will have its callbacks executed on completion. It will pass the appropriate set of time series data points as the callback parameter.

setCurrentValue

Deferred<java.lang.Boolean> setCurrentValue(T newValue)

Adds a new data point value to the time series, using the current system time to generate the associated timestamp.

Parameters:

newValue - This is the new data point value which is to be committed to the stash.

Returns:

Returns a deferred event object which will have its callbacks executed on completion, passing a boolean value which will normally be set to true.

setDataPointValue

Deferred<java.lang.Boolean> setDataPointValue(long timestamp,
                                            T newValue)

Adds a new data point value to the time series. This will commit the specified data point to the persistent store.

Parameters:

timestamp - This is the timestamp associated with the new data point value. It specifies the time at which the data point value was generated as the integer number of milliseconds since the Unix epoch.

newValue - This is the new data point value which is to be committed to the stash.

Returns:

Returns a deferred event object which will have its callbacks executed on completion, passing a boolean value which will normally be set to true.