TSData (Mon-soon history module 2.3 API)

All Superinterfaces:

CollectHistory, Collection<TimeSeriesCollection>, Iterable<TimeSeriesCollection>

All Known Implementing Classes:

ReadonlyTableFile, RWListFile, SequenceTSData, TSDataFileChain, UnmappedReadonlyTSDataFile
```
public interface TSData
extends Collection<TimeSeriesCollection>, CollectHistory
```
Models a closeable collection of TimeSeriesValue.

Author:

ariane

Nested Class Summary
- Nested classes/interfaces inherited from interface com.groupon.lex.metrics.history.CollectHistory
  CollectHistory.ApplyExpressions, CollectHistory.NamedEvaluation

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`boolean`	`add(TimeSeriesCollection tsv)`
`default boolean`	`addAll(Collection<? extends TimeSeriesCollection> c)`
`default ColumnMajorTSData`	`asColumnMajorTSData()` Returns the data in column major format.
`boolean`	`canAddSingleRecord()` Returns true if the file is suitable for adding single records at a time.
`default void`	`clear()` Unsupported.
`default boolean`	`contains(Object o)` Test if the TSData contains the given value.
`default boolean`	`containsAll(Collection<?> c)` Test if the TSData contains all the given values.
`Compression`	`getAppendCompression()` Get the compression used for append files.
`org.joda.time.DateTime`	`getBegin()` Get the lowest timestamp covered by this TSData series.
`org.joda.time.DateTime`	`getEnd()` Get the highest timestamp covered by this TSData series.
`Optional<GCCloseable<FileChannel>>`	`getFileChannel()` Return the file channel used to read this file, if it is uses a file descriptor.
`long`	`getFileSize()` Retrieve the filesize used by the TSData.
`short`	`getMajor()` Returns the major version of the TSData file.
`short`	`getMinor()` Returns the minor version of the TSData file.
`Compression`	`getOptimizedCompression()` Get the compression used for optimized files.
`boolean`	`isEmpty()` Test if the TSData is empty.
`boolean`	`isOptimized()` Returns true if the file is optimized for access by (GroupPath, Tags, MetricName) tuple.
`Iterator<TimeSeriesCollection>`	`iterator()` Returns an iterator for this TSData.
`static SequenceTSData`	`readonly(Path file)` Open the given TSData file.
`default boolean`	`remove(Object o)` Unsupported.
`default boolean`	`removeAll(Collection<?> c)` Unsupported.
`default boolean`	`removeIf(Predicate<? super TimeSeriesCollection> p)` Unsupported.
`default boolean`	`retainAll(Collection<?> c)` Unsupported.
`void`	`setAppendCompression(Compression compression)` Set the compression used for append files.
`void`	`setOptimizedCompression(Compression compression)` Set the compression used for optimized files.
`int`	`size()` Returns the number of entries in the TSData.
`default Spliterator<TimeSeriesCollection>`	`spliterator()` Returns an iterator for this TSData.
`default Stream<TimeSeriesCollection>`	`stream()` Stream the TSData contents.
`default Stream<TimeSeriesCollection>`	`streamReversed()` Stream the TSData contents in reverse chronological order.
`default Object[]`	`toArray()`
`default <T> T[]`	`toArray(T[] a)`

Methods inherited from interface java.util.Collection
equals, hashCode, parallelStream

Methods inherited from interface java.lang.Iterable
forEach

Methods inherited from interface com.groupon.lex.metrics.history.CollectHistory
addAll, evaluate, evaluate, evaluate, getContext, getContext, getContext, stream, stream, stream, stream, stream, streamGroup

- Method Detail
  - getBegin
```
org.joda.time.DateTime getBegin()
```
    Get the lowest timestamp covered by this TSData series.
  - getEnd
```
org.joda.time.DateTime getEnd()
```
    Get the highest timestamp covered by this TSData series.
    
    Specified by:
    
    getEnd in interface CollectHistory
  - getFileSize
```
long getFileSize()
```
    Retrieve the filesize used by the TSData.
    
    Specified by:
    
    getFileSize in interface CollectHistory
  - getAppendCompression
```
Compression getAppendCompression()
```
    Get the compression used for append files.
    
    Returns:
    
    The compression used for append files.
  - setAppendCompression
```
void setAppendCompression(Compression compression)
```
    Set the compression used for append files.
    
    Parameters:
    
    compression - The compression used for append files.
  - getOptimizedCompression
```
Compression getOptimizedCompression()
```
    Get the compression used for optimized files.
    
    Returns:
    
    The compression used for optimized files.
  - setOptimizedCompression
```
void setOptimizedCompression(Compression compression)
```
    Set the compression used for optimized files.
    
    Parameters:
    
    compression - The compression used for optimized files.
  - getMajor
```
short getMajor()
```
    Returns the major version of the TSData file. Note that this is the file-data version, not the application version.
  - getMinor
```
short getMinor()
```
    Returns the minor version of the TSData file. Note that this is the file-data version, not the application version.
  - canAddSingleRecord
```
boolean canAddSingleRecord()
```
    Returns true if the file is suitable for adding single records at a time.
  - isOptimized
```
boolean isOptimized()
```
    Returns true if the file is optimized for access by (GroupPath, Tags, MetricName) tuple.
  - iterator
```
Iterator<TimeSeriesCollection> iterator()
```
    Returns an iterator for this TSData. Iterator is always ordered, without duplicate timestamps.
    
    Specified by:
    
    iterator in interface Collection<TimeSeriesCollection>
    
    Specified by:
    
    iterator in interface Iterable<TimeSeriesCollection>
  - spliterator
```
default Spliterator<TimeSeriesCollection> spliterator()
```
    Returns an iterator for this TSData. Iterator is always ordered, without duplicate timestamps.
    
    Specified by:
    
    spliterator in interface Collection<TimeSeriesCollection>
    
    Specified by:
    
    spliterator in interface Iterable<TimeSeriesCollection>
  - stream
```
default Stream<TimeSeriesCollection> stream()
```
    Stream the TSData contents. The stream iterates collection in chronological order, without duplicate timestamps.
    
    Specified by:
    
    stream in interface CollectHistory
    
    Specified by:
    
    stream in interface Collection<TimeSeriesCollection>
  - streamReversed
```
default Stream<TimeSeriesCollection> streamReversed()
```
    Stream the TSData contents in reverse chronological order. The stream iterates collection in reverse chronological order, without duplicate timestamps.
    
    Specified by:
    
    streamReversed in interface CollectHistory
  - isEmpty
```
boolean isEmpty()
```
    Test if the TSData is empty.
    
    Specified by:
    
    isEmpty in interface Collection<TimeSeriesCollection>
  - size
```
int size()
```
    Returns the number of entries in the TSData.
    
    Specified by:
    
    size in interface Collection<TimeSeriesCollection>
  - contains
```
default boolean contains(Object o)
```
    Test if the TSData contains the given value.
    
    Specified by:
    
    contains in interface Collection<TimeSeriesCollection>
  - containsAll
```
default boolean containsAll(Collection<?> c)
```
    Test if the TSData contains all the given values.
    
    Specified by:
    
    containsAll in interface Collection<TimeSeriesCollection>
  - toArray
```
default Object[] toArray()
```
    Specified by:
    
    toArray in interface Collection<TimeSeriesCollection>
  - toArray
```
default <T> T[] toArray(T[] a)
```
    Specified by:
    
    toArray in interface Collection<TimeSeriesCollection>
  - add
```
boolean add(TimeSeriesCollection tsv)
```
    Specified by:
    
    add in interface CollectHistory
    
    Specified by:
    
    add in interface Collection<TimeSeriesCollection>
  - addAll
```
default boolean addAll(Collection<? extends TimeSeriesCollection> c)
```
    Specified by:
    
    addAll in interface CollectHistory
    
    Specified by:
    
    addAll in interface Collection<TimeSeriesCollection>
  - clear
```
default void clear()
```
    Unsupported.
    
    Specified by:
    
    clear in interface Collection<TimeSeriesCollection>
  - retainAll
```
default boolean retainAll(Collection<?> c)
```
    Unsupported.
    
    Specified by:
    
    retainAll in interface Collection<TimeSeriesCollection>
  - removeAll
```
default boolean removeAll(Collection<?> c)
```
    Unsupported.
    
    Specified by:
    
    removeAll in interface Collection<TimeSeriesCollection>
  - remove
```
default boolean remove(Object o)
```
    Unsupported.
    
    Specified by:
    
    remove in interface Collection<TimeSeriesCollection>
  - removeIf
```
default boolean removeIf(Predicate<? super TimeSeriesCollection> p)
```
    Unsupported.
    
    Specified by:
    
    removeIf in interface Collection<TimeSeriesCollection>
  - readonly
```
static SequenceTSData readonly(Path file)
                        throws IOException
```
    Open the given TSData file.
    
    Parameters:
    
    file - The file to open.
    
    Returns:
    
    A TSData instance that will read the given file.
    
    Throws:
    
    IOException - If an IOException occurs, the file is not a valid TSData file or the version of the file is too new.
  - getFileChannel
```
Optional<GCCloseable<FileChannel>> getFileChannel()
```
    Return the file channel used to read this file, if it is uses a file descriptor. Returns Optional.empty() for memory mapped files.
  - asColumnMajorTSData
```
default ColumnMajorTSData asColumnMajorTSData()
                                       throws IOException
```
    Returns the data in column major format. The TSData instance may perform expensive computation to make this work.
    
    Returns:
    
    The data in column major format.
    
    Throws:
    
    IOException - if IO errors prevent the computation from succeeding.

Interface TSData

Nested Class Summary

Nested classes/interfaces inherited from interface com.groupon.lex.metrics.history.CollectHistory

Method Summary

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Methods inherited from interface com.groupon.lex.metrics.history.CollectHistory

Method Detail

getBegin

getEnd

getFileSize

getAppendCompression

setAppendCompression

getOptimizedCompression

setOptimizedCompression

getMajor

getMinor

canAddSingleRecord

isOptimized

iterator

spliterator

stream

streamReversed

isEmpty

size

contains

containsAll

toArray

toArray

add

addAll

clear

retainAll

removeAll

remove

removeIf

readonly

getFileChannel

asColumnMajorTSData