Package org.rcsb.cif.binary.encoding

Interface Encoding<H extends EncodedData<?>,L extends EncodedData<?>>

Type Parameters:

H - the 'high'-level array of data (think StringArray)

L - the 'low'-level array of data (think ByteArray)

All Known Implementing Classes:

ByteArrayEncoding, DeltaEncoding, FixedPointEncoding, IntegerPackingEncoding, IntervalQuantizationEncoding, RunLengthEncoding, StringArrayEncoding

public interface Encoding<H extends EncodedData<?>,L extends EncodedData<?>>

Represents a single encoding or decoding step for a column.

Method Summary

Modifier and Type	Method	Description
H	decode(L data)	Move one step up the encoding deque.
L	encode(H data)	Move one step down the encoding deque.
Map<String,Object>	getMapRepresentation()	Converts this encoding to its map representation that can be serialized as BinaryCif.

Method Details

decode

H decode(L data)

Move one step up the encoding deque. One step closer to the original representation of the data.

Parameters:

data - the container to decode

Returns:

the decoded information

encode

L encode(H data)

Move one step down the encoding deque. One step closer to a ByteArray representation.

Parameters:

data - the container to encode

Returns:

the decoded information

getMapRepresentation

Map<String,Object> getMapRepresentation()

Converts this encoding to its map representation that can be serialized as BinaryCif.

Returns:

a Map that contains all encoding information