Package org.redisson.api

Interface RTimeSeries<V,L>

Type Parameters:

V - value type

L - label type

All Superinterfaces:

Iterable<V>, RDestroyable, RExpirable, RExpirableAsync, RObject, RObjectAsync, RTimeSeriesAsync<V,L>

All Known Implementing Classes:

RedissonTimeSeries

public interface RTimeSeries<V,L>
extends RExpirable, Iterable<V>, RTimeSeriesAsync<V,L>, RDestroyable

Redis based time-series collection.

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method	Description
void	add(long timestamp, V object)	Adds element to this time-series collection by specified timestamp.
void	add(long timestamp, V object, long timeToLive, TimeUnit timeUnit)	Adds element to this time-series collection by specified timestamp.
void	add(long timestamp, V object, L label)	Adds element with label to this time-series collection by specified timestamp.
void	add(long timestamp, V object, L label, Duration timeToLive)	Adds element with label to this time-series collection by specified timestamp.
void	addAll(Collection<TimeSeriesEntry<V,L>> entries)	Adds all entries collection to this time-series collection.
void	addAll(Collection<TimeSeriesEntry<V,L>> entries, Duration timeToLive)	Adds all time series entries collection to this time-series collection.
void	addAll(Map<Long,V> objects)	Adds all elements contained in the specified map to this time-series collection.
void	addAll(Map<Long,V> objects, long timeToLive, TimeUnit timeUnit)	Adds all elements contained in the specified map to this time-series collection.
Collection<TimeSeriesEntry<V,L>>	entryRange(long startTimestamp, long endTimestamp)	Returns ordered entries of this time-series collection within timestamp range.
Collection<TimeSeriesEntry<V,L>>	entryRange(long startTimestamp, long endTimestamp, int limit)	Returns ordered entries of this time-series collection within timestamp range.
Collection<TimeSeriesEntry<V,L>>	entryRangeReversed(long startTimestamp, long endTimestamp)	Returns entries of this time-series collection in reverse order within timestamp range.
Collection<TimeSeriesEntry<V,L>>	entryRangeReversed(long startTimestamp, long endTimestamp, int limit)	Returns entries of this time-series collection in reverse order within timestamp range.
V	first()	Returns the head element or null if this time-series collection is empty.
Collection<V>	first(int count)	Returns the head elements of this time-series collection.
Collection<TimeSeriesEntry<V,L>>	firstEntries(int count)	Returns the head entries of this time-series collection.
TimeSeriesEntry<V,L>	firstEntry()	Returns the head entry or null if this time-series collection is empty.
Long	firstTimestamp()	Returns timestamp of the head timestamp or null if this time-series collection is empty.
V	get(long timestamp)	Returns object by specified timestamp or null if it doesn't exist.
V	getAndRemove(long timestamp)	Removes and returns object by specified timestamp.
TimeSeriesEntry<V,L>	getAndRemoveEntry(long timestamp)	Removes and returns entry by specified timestamp.
TimeSeriesEntry<V,L>	getEntry(long timestamp)	Returns time series entry by specified timestamp or null if it doesn't exist.
Iterator<V>	iterator(int count)	Returns an iterator over elements in this time-series collection.
V	last()	Returns the tail element or null if this time-series collection is empty.
Collection<V>	last(int count)	Returns the tail elements of this time-series collection.
Collection<TimeSeriesEntry<V,L>>	lastEntries(int count)	Returns the tail entries of this time-series collection.
TimeSeriesEntry<V,L>	lastEntry()	Returns the tail entry or null if this time-series collection is empty.
Long	lastTimestamp()	Returns timestamp of the tail element or null if this time-series collection is empty.
V	pollFirst()	Removes and returns the head element or null if this time-series collection is empty.
Collection<V>	pollFirst(int count)	Removes and returns the head elements
Collection<TimeSeriesEntry<V,L>>	pollFirstEntries(int count)	Removes and returns head entries
TimeSeriesEntry<V,L>	pollFirstEntry()	Removes and returns head entry or null if this time-series collection is empty.
V	pollLast()	Removes and returns the tail element or null if this time-series collection is empty.
Collection<V>	pollLast(int count)	Removes and returns the tail elements or null if this time-series collection is empty.
Collection<TimeSeriesEntry<V,L>>	pollLastEntries(int count)	Removes and returns tail entries
TimeSeriesEntry<V,L>	pollLastEntry()	Removes and returns the tail entry or null if this time-series collection is empty.
Collection<V>	range(long startTimestamp, long endTimestamp)	Returns ordered elements of this time-series collection within timestamp range.
Collection<V>	range(long startTimestamp, long endTimestamp, int limit)	Returns ordered elements of this time-series collection within timestamp range.
Collection<V>	rangeReversed(long startTimestamp, long endTimestamp)	Returns elements of this time-series collection in reverse order within timestamp range.
Collection<V>	rangeReversed(long startTimestamp, long endTimestamp, int limit)	Returns elements of this time-series collection in reverse order within timestamp range.
boolean	remove(long timestamp)	Removes object by specified timestamp.
int	removeRange(long startTimestamp, long endTimestamp)	Removes values within timestamp range.
int	size()	Returns size of this set.
Stream<V>	stream()	Returns stream of elements in this time-series collection.
Stream<V>	stream(int count)	Returns stream of elements in this time-series collection.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.redisson.api.RDestroyable

destroy

Methods inherited from interface org.redisson.api.RExpirable

clearExpire, expire, expire, expire, expireAt, expireAt, expireIfGreater, expireIfGreater, expireIfLess, expireIfLess, expireIfNotSet, expireIfNotSet, expireIfSet, expireIfSet, getExpireTime, remainTimeToLive

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAsync, expireAsync, expireAtAsync, expireAtAsync, expireIfGreaterAsync, expireIfGreaterAsync, expireIfLessAsync, expireIfLessAsync, expireIfNotSetAsync, expireIfNotSetAsync, expireIfSetAsync, expireIfSetAsync, getExpireTimeAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObject

addListener, copy, delete, dump, getCodec, getIdleTime, getName, isExists, migrate, move, removeListener, rename, renamenx, restore, restore, restoreAndReplace, restoreAndReplace, sizeInMemory, touch, unlink

Methods inherited from interface org.redisson.api.RObjectAsync

addListenerAsync, copyAsync, deleteAsync, dumpAsync, getIdleTimeAsync, isExistsAsync, migrateAsync, moveAsync, removeListenerAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, sizeInMemoryAsync, touchAsync, unlinkAsync

Methods inherited from interface org.redisson.api.RTimeSeriesAsync

addAllAsync, addAllAsync, addAllAsync, addAllAsync, addAsync, addAsync, addAsync, addAsync, entryRangeAsync, entryRangeAsync, entryRangeReversedAsync, entryRangeReversedAsync, firstAsync, firstAsync, firstEntriesAsync, firstEntryAsync, firstTimestampAsync, getAndRemoveAsync, getAndRemoveEntryAsync, getAsync, getEntryAsync, lastAsync, lastAsync, lastEntriesAsync, lastEntryAsync, lastTimestampAsync, pollFirstAsync, pollFirstAsync, pollFirstEntriesAsync, pollFirstEntryAsync, pollLastAsync, pollLastAsync, pollLastEntriesAsync, pollLastEntryAsync, rangeAsync, rangeAsync, rangeReversedAsync, rangeReversedAsync, removeAsync, removeRangeAsync, sizeAsync

Method Details

add

void add(long timestamp,
 V object)

Adds element to this time-series collection by specified timestamp.

Parameters:

timestamp - object timestamp

object - object itself

add

void add(long timestamp,
 V object,
 L label)

Adds element with label to this time-series collection by specified timestamp.

Parameters:

timestamp - object timestamp

object - object itself

label - object label

addAll

void addAll(Map<Long,V> objects)

Adds all elements contained in the specified map to this time-series collection. Map contains of timestamp mapped by object.

Parameters:

objects - - map of elements to add

addAll

void addAll(Collection<TimeSeriesEntry<V,L>> entries)

Adds all entries collection to this time-series collection.

Parameters:

entries - collection of time series entries

add

void add(long timestamp,
 V object,
 long timeToLive,
 TimeUnit timeUnit)

Adds element to this time-series collection by specified timestamp.

Parameters:

timestamp - - object timestamp

object - - object itself

timeToLive - - time to live interval

timeUnit - - unit of time to live interval

add

void add(long timestamp,
 V object,
 L label,
 Duration timeToLive)

Adds element with label to this time-series collection by specified timestamp.

Parameters:

timestamp - object timestamp

object - object itself

label - object label

timeToLive - time to live interval

addAll

void addAll(Map<Long,V> objects,
 long timeToLive,
 TimeUnit timeUnit)

Adds all elements contained in the specified map to this time-series collection. Map contains of timestamp mapped by object.

Parameters:

objects - - map of elements to add

timeToLive - - time to live interval

timeUnit - - unit of time to live interval

addAll

void addAll(Collection<TimeSeriesEntry<V,L>> entries,
 Duration timeToLive)

Adds all time series entries collection to this time-series collection. Specified time to live interval applied to all entries defined in collection.

Parameters:

entries - collection of time series entries

timeToLive - time to live interval

size

int size()

Returns size of this set.

Returns:

size

get

V get(long timestamp)

Returns object by specified timestamp or null if it doesn't exist.

Parameters:

timestamp - - object timestamp

Returns:

object

getEntry

TimeSeriesEntry<V,L> getEntry(long timestamp)

Returns time series entry by specified timestamp or null if it doesn't exist.

Parameters:

timestamp - object timestamp

Returns:

time series entry

remove

boolean remove(long timestamp)

Removes object by specified timestamp.

Parameters:

timestamp - - object timestamp

Returns:

true if an element was removed as a result of this call

getAndRemove

V getAndRemove(long timestamp)

Removes and returns object by specified timestamp.

Parameters:

timestamp - - object timestamp

Returns:

object or null if it doesn't exist

getAndRemoveEntry

TimeSeriesEntry<V,L> getAndRemoveEntry(long timestamp)

Removes and returns entry by specified timestamp.

Parameters:

timestamp - - object timestamp

Returns:

entry or null if it doesn't exist

pollFirst

Collection<V> pollFirst(int count)

Removes and returns the head elements

Parameters:

count - - elements amount

Returns:

collection of head elements

pollFirstEntries

Collection<TimeSeriesEntry<V,L>> pollFirstEntries(int count)

Removes and returns head entries

Parameters:

count - - entries amount

Returns:

collection of head entries

pollLast

Collection<V> pollLast(int count)

Removes and returns the tail elements or null if this time-series collection is empty.

Parameters:

count - - elements amount

Returns:

the tail element or null if this time-series collection is empty

pollLastEntries

Collection<TimeSeriesEntry<V,L>> pollLastEntries(int count)

Removes and returns tail entries

Parameters:

count - - entries amount

Returns:

collection of tail entries

pollFirst

V pollFirst()

Removes and returns the head element or null if this time-series collection is empty.

Returns:

the head element, or null if this time-series collection is empty

pollFirstEntry

TimeSeriesEntry<V,L> pollFirstEntry()

Removes and returns head entry or null if this time-series collection is empty.

Returns:

the head entry, or null if this time-series collection is empty

pollLast

V pollLast()

Removes and returns the tail element or null if this time-series collection is empty.

Returns:

the tail element or null if this time-series collection is empty

pollLastEntry

TimeSeriesEntry<V,L> pollLastEntry()

Removes and returns the tail entry or null if this time-series collection is empty.

Returns:

the tail entry or null if this time-series collection is empty

last

V last()

Returns the tail element or null if this time-series collection is empty.

Returns:

the tail element or null if this time-series collection is empty

lastEntry

TimeSeriesEntry<V,L> lastEntry()

Returns the tail entry or null if this time-series collection is empty.

Returns:

the tail entry or null if this time-series collection is empty

first

V first()

Returns the head element or null if this time-series collection is empty.

Returns:

the head element or null if this time-series collection is empty

firstEntry

TimeSeriesEntry<V,L> firstEntry()

Returns the head entry or null if this time-series collection is empty.

Returns:

the head entry or null if this time-series collection is empty

firstTimestamp

Long firstTimestamp()

Returns timestamp of the head timestamp or null if this time-series collection is empty.

Returns:

timestamp or null if this time-series collection is empty

lastTimestamp

Long lastTimestamp()

Returns timestamp of the tail element or null if this time-series collection is empty.

Returns:

timestamp or null if this time-series collection is empty

last

Collection<V> last(int count)

Returns the tail elements of this time-series collection.

Parameters:

count - - elements amount

Returns:

the tail elements

lastEntries

Collection<TimeSeriesEntry<V,L>> lastEntries(int count)

Returns the tail entries of this time-series collection.

Parameters:

count - - entries amount

Returns:

the tail entries

first

Collection<V> first(int count)

Returns the head elements of this time-series collection.

Parameters:

count - - elements amount

Returns:

the head elements

firstEntries

Collection<TimeSeriesEntry<V,L>> firstEntries(int count)

Returns the head entries of this time-series collection.

Parameters:

count - - entries amount

Returns:

the head entries

removeRange

int removeRange(long startTimestamp,
 long endTimestamp)

Removes values within timestamp range. Including boundary values.

Parameters:

startTimestamp - - start timestamp

endTimestamp - - end timestamp

Returns:

number of removed elements

range

Collection<V> range(long startTimestamp,
 long endTimestamp)

Returns ordered elements of this time-series collection within timestamp range. Including boundary values.

Parameters:

startTimestamp - - start timestamp

endTimestamp - - end timestamp

Returns:

elements collection

range

Collection<V> range(long startTimestamp,
 long endTimestamp,
 int limit)

Returns ordered elements of this time-series collection within timestamp range. Including boundary values.

Parameters:

startTimestamp - start timestamp

endTimestamp - end timestamp

limit - result size limit

Returns:

elements collection

rangeReversed

Collection<V> rangeReversed(long startTimestamp,
 long endTimestamp)

Returns elements of this time-series collection in reverse order within timestamp range. Including boundary values.

Parameters:

startTimestamp - - start timestamp

endTimestamp - - end timestamp

Returns:

elements collection

rangeReversed

Collection<V> rangeReversed(long startTimestamp,
 long endTimestamp,
 int limit)

Returns elements of this time-series collection in reverse order within timestamp range. Including boundary values.

Parameters:

startTimestamp - start timestamp

endTimestamp - end timestamp

limit - result size limit

Returns:

elements collection

entryRange

Collection<TimeSeriesEntry<V,L>> entryRange(long startTimestamp,
 long endTimestamp)

Returns ordered entries of this time-series collection within timestamp range. Including boundary values.

Parameters:

startTimestamp - - start timestamp

endTimestamp - - end timestamp

Returns:

elements collection

entryRange

Collection<TimeSeriesEntry<V,L>> entryRange(long startTimestamp,
 long endTimestamp,
 int limit)

Returns ordered entries of this time-series collection within timestamp range. Including boundary values.

Parameters:

startTimestamp - start timestamp

endTimestamp - end timestamp

limit - result size limit

Returns:

elements collection

entryRangeReversed

Collection<TimeSeriesEntry<V,L>> entryRangeReversed(long startTimestamp,
 long endTimestamp)

Returns entries of this time-series collection in reverse order within timestamp range. Including boundary values.

Parameters:

startTimestamp - - start timestamp

endTimestamp - - end timestamp

Returns:

elements collection

entryRangeReversed

Collection<TimeSeriesEntry<V,L>> entryRangeReversed(long startTimestamp,
 long endTimestamp,
 int limit)

Returns entries of this time-series collection in reverse order within timestamp range. Including boundary values.

Parameters:

startTimestamp - start timestamp

endTimestamp - end timestamp

limit - result size limit

Returns:

elements collection

stream

Stream<V> stream()

Returns stream of elements in this time-series collection. Elements are loaded in batch. Batch size is 10.

Returns:

stream of elements

stream

Stream<V> stream(int count)

Returns stream of elements in this time-series collection. Elements are loaded in batch. Batch size is defined by count param.

Parameters:

count - - size of elements batch

Returns:

stream of elements

iterator

Iterator<V> iterator(int count)

Returns an iterator over elements in this time-series collection. Elements are loaded in batch. Batch size is defined by count param.

Parameters:

count - - size of elements batch

Returns:

iterator