GTSDecoder (warpscript 2.8.1-rc0 API)

java.lang.Object
- io.warp10.continuum.gts.GTSDecoder

```
public class GTSDecoder
extends java.lang.Object
```
Class for decoding an encoded time serie. WARNING: this class is NOT ThreadSafe as the underlying ByteBuffer could be advanced by another thread while in a decoding function. This is a known fact, we don't intend to make the methods synchronized so as not to undermine the performances.

Constructor Summary

Constructors
Constructor and Description
`GTSDecoder(long baseTimestamp, byte[] key, java.nio.ByteBuffer bb)`
`GTSDecoder(long baseTimestamp, java.nio.ByteBuffer bb)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GeoTimeSerie`	`decode()`
`GeoTimeSerie`	`decode(GeoTimeSerie.TYPE type)`
`GeoTimeSerie`	`decode(GeoTimeSerie.TYPE type, boolean strict)` Decode any remaining values into a GTS instance.
`GTSDecoder`	`dedup()` Returns a new instance of GTSDecoder with duplicates removed WARNING: the duplicates removal is done in the order in which the values are found in the decoder.
`void`	`dump(java.io.PrintWriter pw)`
`GTSDecoder`	`duplicate()` Duplicate the current GTSDecoder.
`static GTSDecoder`	`fromBlock(byte[] block, byte[] key)`
`long`	`getBaseTimestamp()`
`java.lang.Object`	`getBinaryValue()`
`java.nio.ByteBuffer`	`getBuffer()`
`long`	`getClassId()`
`GTSEncoder`	`getCompatibleEncoder(long basets)`
`long`	`getCount()`
`long`	`getElevation()`
`GTSEncoder`	`getEncoder()`
`GTSEncoder`	`getEncoder(boolean safeMetadata)` Return an encoder with all data from the last value retrieved (post call to next()) onwards
`java.util.Map<java.lang.String,java.lang.String>`	`getLabels()`
`long`	`getLabelsId()`
`long`	`getLocation()`
`Metadata`	`getMetadata()`
`java.lang.String`	`getName()`
`int`	`getRemainingSize()`
`long`	`getTimestamp()`
`java.lang.Object`	`getValue()`
`boolean`	`isBinary()`
`boolean`	`next()` Attempt to read the next measurement and associated metadata (timestamp, location, elevation)
`void`	`setClassId(long classId)`
`void`	`setLabel(java.lang.String key, java.lang.String value)`
`void`	`setLabels(java.util.Map<java.lang.String,java.lang.String> labels)`
`void`	`setLabelsId(long labelsId)`
`void`	`setMetadata(Metadata metadata)`
`void`	`setName(java.lang.String name)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GTSDecoder
```
public GTSDecoder(long baseTimestamp,
                  java.nio.ByteBuffer bb)
```
    Parameters:
    
    baseTimestamp - Base timestamp for computing deltas.
    
    bb - ByteBuffer containing the encoded GTS. Only remaining data will be read. Encrypted data will silently be skipped.
  - GTSDecoder
```
public GTSDecoder(long baseTimestamp,
                  byte[] key,
                  java.nio.ByteBuffer bb)
```
    Parameters:
    
    baseTimestamp - Base timestamp for computing deltas.
    
    key - AES Wrapping key to use for unwrapping encrypted data
    
    bb - ByteBuffer containing the encoded GTS. Only remaining data will be read. Encrypted data that cannot be decrypted will be silently ignored. If the buffer contains encrypted data which could be decrypted, reallocation will take place therefore 'bb' and the internal buffer used by this instance of GTSDecoder will differ after the first encrypted chunk is encountered.
- Method Detail
  - next
```
public boolean next()
```
    Attempt to read the next measurement and associated metadata (timestamp, location, elevation)
    
    Returns:
    
    true if a measurement was successfully read, false if none were left in the buffer.
  - getTimestamp
```
public long getTimestamp()
```
  - getLocation
```
public long getLocation()
```
  - getElevation
```
public long getElevation()
```
  - getValue
```
public java.lang.Object getValue()
```
  - isBinary
```
public boolean isBinary()
```
  - getBinaryValue
```
public java.lang.Object getBinaryValue()
```
  - decode
```
public GeoTimeSerie decode(GeoTimeSerie.TYPE type,
                           boolean strict)
```
    Decode any remaining values into a GTS instance.
    
    Parameters:
    
    type - TYPE to force for the resulting GTS
    
    strict - Set to true to force values to be of uniform types, will throw RuntimeException if not
    
    Returns:
    
    A GTS instance containing the remaining values.
  - decode
```
public GeoTimeSerie decode(GeoTimeSerie.TYPE type)
```
  - decode
```
public GeoTimeSerie decode()
```
  - getCompatibleEncoder
```
public GTSEncoder getCompatibleEncoder(long basets)
```
  - getBaseTimestamp
```
public long getBaseTimestamp()
```
  - getClassId
```
public long getClassId()
```
  - setClassId
```
public void setClassId(long classId)
```
  - getLabelsId
```
public long getLabelsId()
```
  - setLabelsId
```
public void setLabelsId(long labelsId)
```
  - getName
```
public java.lang.String getName()
```
  - setName
```
public void setName(java.lang.String name)
```
  - getLabels
```
public java.util.Map<java.lang.String,java.lang.String> getLabels()
```
  - setLabels
```
public void setLabels(java.util.Map<java.lang.String,java.lang.String> labels)
```
  - setLabel
```
public void setLabel(java.lang.String key,
                     java.lang.String value)
```
  - setMetadata
```
public void setMetadata(Metadata metadata)
```
  - getMetadata
```
public Metadata getMetadata()
```
  - getEncoder
```
public GTSEncoder getEncoder(boolean safeMetadata)
                      throws java.io.IOException
```
    Return an encoder with all data from the last value retrieved (post call to next()) onwards
    
    Parameters:
    
    safeMetadata - Is it safe to reuse the Metadata?
    
    Throws:
    
    java.io.IOException
  - getEncoder
```
public GTSEncoder getEncoder()
                      throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - getRemainingSize
```
public int getRemainingSize()
```
  - getCount
```
public long getCount()
```
  - dedup
```
public GTSDecoder dedup()
                 throws java.io.IOException
```
    Returns a new instance of GTSDecoder with duplicates removed WARNING: the duplicates removal is done in the order in which the values are found in the decoder. If timestamps are not in chronological or reverse chronological order then you might remove values you won't be able to reconstruct using FILLPREVIOUS/FILLNEXT/FILLVALUE
    
    Returns:
    
    A GTSDecoder instance with duplicates removed
    
    Throws:
    
    java.io.IOException
  - getBuffer
```
public java.nio.ByteBuffer getBuffer()
```
  - duplicate
```
public GTSDecoder duplicate()
```
    Duplicate the current GTSDecoder. The copy is backed by the same buffer.
  - dump
```
public void dump(java.io.PrintWriter pw)
```
  - fromBlock
```
public static GTSDecoder fromBlock(byte[] block,
                                   byte[] key)
                            throws java.io.IOException
```
    Throws:
    
    java.io.IOException

Class GTSDecoder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GTSDecoder

GTSDecoder

Method Detail

next

getTimestamp

getLocation

getElevation

getValue

isBinary

getBinaryValue

decode

decode

decode

getCompatibleEncoder

getBaseTimestamp

getClassId

setClassId

getLabelsId

setLabelsId

getName

setName

getLabels

setLabels

setLabel

setMetadata

getMetadata

getEncoder

getEncoder

getRemainingSize

getCount

dedup

getBuffer

duplicate

dump

fromBlock