kieker.tools.tslib
Interface ITimeSeries<T>

Type Parameters:

T -

All Known Implementing Classes:

TimeSeries

public interface ITimeSeries<T>

Since:

1.9

Author:

Andre van Hoorn

Field Summary

static int

INFINITE_CAPACITY

Method Summary

ITimeSeriesPoint<T>	append(T value) Appends the given value to the time series.
List<ITimeSeriesPoint<T>>	appendAll(T[] values) Appends the given value to the time series.
int	getCapacity() Returns the maximum number of elements held in this time series.
long	getDeltaTime() Returns the temporal distance between to time series values with respect to the configured TimeUnit getDeltaTime().
TimeUnit	getDeltaTimeUnit() The TimeUnit used to specify the temporal distance between to values (getDeltaTime()).
long	getEndTime() Returns the time corresponding to the most recent value in the time series
List<ITimeSeriesPoint<T>>	getPoints() Returns the ITimeSeriesPoints of this time series.
long	getStartTime() Returns the start of the time series, i.e., the time of the first value.
List<T>	getValues() Returns a list of all getPoints()getValues()
int	size() Returns the number of value contained in the time series

Field Detail

INFINITE_CAPACITY

static final int INFINITE_CAPACITY

See Also:

Constant Field Values

Method Detail

getStartTime

long getStartTime()

Returns the start of the time series, i.e., the time of the first value.

Since:

1.9

getDeltaTime

long getDeltaTime()

Returns the temporal distance between to time series values with respect to the configured TimeUnit getDeltaTime().

Since:

1.9

getDeltaTimeUnit

TimeUnit getDeltaTimeUnit()

The TimeUnit used to specify the temporal distance between to values (getDeltaTime()).

Since:

1.9

append

ITimeSeriesPoint<T> append(T value)

Appends the given value to the time series.

Parameters:

value - the value to append

Since:

1.9

appendAll

List<ITimeSeriesPoint<T>> appendAll(T[] values)

Appends the given value to the time series.

Since:

1.9

getPoints

List<ITimeSeriesPoint<T>> getPoints()

Returns the ITimeSeriesPoints of this time series.

Since:

1.9

getValues

List<T> getValues()

Returns a list of all getPoints()getValues()

Since:

1.9

getCapacity

int getCapacity()

Returns the maximum number of elements held in this time series.

Returns:

the capacity; INFINITE_CAPACITY if the capacity is infinite

Since:

1.9

size

int size()

Returns the number of value contained in the time series

Since:

1.9

getEndTime

long getEndTime()

Returns the time corresponding to the most recent value in the time series

Since:

1.9