io.warp10.continuum.gts

Class GTSEncoder

java.lang.Object

io.warp10.continuum.gts.GTSEncoder

All Implemented Interfaces:

java.lang.Cloneable

public class GTSEncoder
extends java.lang.Object
implements java.lang.Cloneable

Utility class used to create Geo Time Series

Field Summary

Fields

Modifier and Type	Field and Description
static byte	FLAGS_ENCRYPTED Flag indicating encrypted data

Constructor Summary

Constructors

Constructor and Description
GTSEncoder()
GTSEncoder(long baseTimestamp) Create an encoder using the given timestamp as its base.
GTSEncoder(long baseTimestamp, byte[] key) Create an encoder using the given base and AES wrapping key.
GTSEncoder(long baseTimestamp, byte[] key, byte[] content)
GTSEncoder(long baseTimestamp, byte[] key, int size)

Method Summary

Modifier and Type	Method and Description
int	addValue(long timestamp, long location, long elevation, java.lang.Object value)
GTSEncoder	clone()
GTSEncoder	cloneEmpty()
void	encode(GeoTimeSerie gts) Encode the given GTS instance.
void	encodeOptimized(GeoTimeSerie gts) Encode the given GTS instance, converting doubles to BigDecimal to get a chance to store them more efficiently
void	flush() Empty the output stream and disable delta encoding
long	getBaseTimestamp()
byte[]	getBytes() Return the bytes currently in this encoder.
long	getClassId()
long	getCount() Return the number of values encoded by this encoder.
GTSDecoder	getDecoder()
GTSDecoder	getDecoder(boolean safeMetadata) Return a decoder instance capable of decoding the encoded content of this encoder.
java.util.Map<java.lang.String,java.lang.String>	getLabels()
long	getLabelsId()
long	getLastTimestamp()
Metadata	getMetadata()
java.lang.String	getName()
long	getPessimisticSize() Return an estimation of the 'exploded' size, i.e.
Metadata	getRawMetadata() Return the untouched Metadata associated with this encoder
GTSDecoder	getUnsafeDecoder(boolean blockWrites) Retrieve a GTSDecoder which uses the same metadata as this GTSEncoder and has a ByteBuffer which wraps the current byte array in this GTSEncoder's stream.
void	merge(GTSEncoder encoder) Merge data encoded in another encoder with this one.
static java.lang.Object	optimizeValue(java.lang.Object value)
void	reset(GTSEncoder encoder) Reset the state of this encoder with that of 'encoder'.
void	reset(long baseTS)
void	resize(int target) Resize the byte array backing 'stream'
void	safeDelta() Disable delta/identical encoding until the encoder has encountered a new ts/lat/lon/elev and value from each type.
void	safeSetMetadata(Metadata metadata) Package protected version of the above method which reuses the Metadata verbatim This version is targeted to GTSDecoder to speed up the call to getEncoder
void	setClassId(long classId)
void	setCount(long count)
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)
void	setWrappingKey(byte[] key)
int	size() Return the current size of the encoded data.
byte[]	toBlock(boolean compress) Transform the current encoder into a storable block.
void	writeTo(java.io.OutputStream out)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FLAGS_ENCRYPTED

public static final byte FLAGS_ENCRYPTED

Flag indicating encrypted data

See Also:

Constant Field Values

Constructor Detail

GTSEncoder

public GTSEncoder()

GTSEncoder

public GTSEncoder(long baseTimestamp,
                  byte[] key,
                  byte[] content)

GTSEncoder

public GTSEncoder(long baseTimestamp)

Create an encoder using the given timestamp as its base. Base timestamp may be used to encode value timestamps as deltas.

Parameters:

baseTimestamp - Timestamp to use as base.

GTSEncoder

public GTSEncoder(long baseTimestamp,
                  byte[] key)

Create an encoder using the given base and AES wrapping key.

Parameters:

baseTimestamp - Timestamp to use as base (to compute deltas)

key - AES Wrapping key to use to encrypt encoded values.

GTSEncoder

public GTSEncoder(long baseTimestamp,
                  byte[] key,
                  int size)

Method Detail

addValue

public int addValue(long timestamp,
                    long location,
                    long elevation,
                    java.lang.Object value)
             throws java.io.IOException

Throws:

java.io.IOException

setWrappingKey

public void setWrappingKey(byte[] key)

getBytes

public byte[] getBytes()

Return the bytes currently in this encoder. If 'wrappingKey' is non null, encrypt the bytes prior to returning them.

Returns:

The (possibly encrypted bytes) or null if an exception is raised while encrypting.

size

public int size()

Return the current size of the encoded data.

getCount

public long getCount()

Return the number of values encoded by this encoder.

getPessimisticSize

public long getPessimisticSize()

Return an estimation of the 'exploded' size, i.e. the size required to store all data points individually with no optimization. This is needed to ensure that we do not push to Kafka encoders which when exploded would lead to FDB transactions which would exceed 10M

encode

public void encode(GeoTimeSerie gts)
            throws java.io.IOException

Encode the given GTS instance.

Parameters:

gts -

Throws:

java.io.IOException

encodeOptimized

public void encodeOptimized(GeoTimeSerie gts)
                     throws java.io.IOException

Encode the given GTS instance, converting doubles to BigDecimal to get a chance to store them more efficiently

Parameters:

gts -

Throws:

java.io.IOException

optimizeValue

public static java.lang.Object optimizeValue(java.lang.Object value)

getDecoder

public GTSDecoder getDecoder(boolean safeMetadata)

Return a decoder instance capable of decoding the encoded content of this encoder.

Parameters:

safeMetadata - Is it safe to reuse the Metadata instance?

Returns:

A suitable GTSDecoder instance.

getDecoder

public GTSDecoder getDecoder()

getUnsafeDecoder

public GTSDecoder getUnsafeDecoder(boolean blockWrites)

Retrieve a GTSDecoder which uses the same metadata as this GTSEncoder and has a ByteBuffer which wraps the current byte array in this GTSEncoder's stream. Calling this method will render the GTSEncoder 'read-only'

reset

public void reset(GTSEncoder encoder)
           throws java.io.IOException

Reset the state of this encoder with that of 'encoder'.

Parameters:

encoder -

Throws:

java.io.IOException

reset

public void reset(long baseTS)
           throws java.io.IOException

Throws:

java.io.IOException

resize

public void resize(int target)
            throws java.io.IOException

Resize the byte array backing 'stream'

Throws:

java.io.IOException

merge

public void merge(GTSEncoder encoder)
           throws java.io.IOException

Merge data encoded in another encoder with this one. If the two encoders have different base timestamps or different encryption keys, the values will be fetched using a decoder and added individually. Otherwise a fastpath is taken and the encoded bytes are added.

Parameters:

encoder - GTSEncoder instance containing the data to merge

Throws:

java.io.IOException

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)

safeSetMetadata

public void safeSetMetadata(Metadata metadata)

Package protected version of the above method which reuses the Metadata verbatim This version is targeted to GTSDecoder to speed up the call to getEncoder

Parameters:

metadata -

getMetadata

public Metadata getMetadata()

getRawMetadata

public Metadata getRawMetadata()

Return the untouched Metadata associated with this encoder

getLastTimestamp

public long getLastTimestamp()

safeDelta

public void safeDelta()

Disable delta/identical encoding until the encoder has encountered a new ts/lat/lon/elev and value from each type. This is used when creating an encoder from the remaining of a decoder, in this case we don't know the 'last' value and thus cannot delta encode the new value

setCount

public void setCount(long count)

flush

public void flush()

Empty the output stream and disable delta encoding

toBlock

public byte[] toBlock(boolean compress)
               throws java.io.IOException

Transform the current encoder into a storable block.

Throws:

java.io.IOException

writeTo

public void writeTo(java.io.OutputStream out)
             throws java.io.IOException

Throws:

java.io.IOException

cloneEmpty

public GTSEncoder cloneEmpty()

clone

public GTSEncoder clone()

Overrides:

clone in class java.lang.Object