Package org.rcsb.cif.binary.encoding

Class StringArrayEncoding

java.lang.Object

org.rcsb.cif.binary.encoding.StringArrayEncoding

All Implemented Interfaces:

Encoding<StringArray,ByteArray>

public class StringArrayEncoding
extends Object
implements Encoding<StringArray,ByteArray>

Stores an array of strings as a concatenation of all unique strings, an array of offsets describing substrings, and indices into the offset array. Indices to corresponding substrings.

 StringArray {
     kind = "StringArray"
     dataEncoding: Encoding[]
     stringData: string
     offsetEncoding: Encoding[]
     offsets: Uint8Array
 }
 Example
 ['a','AB','a']
 ---StringArray--->
 { stringData = 'aAB', offsets = [0, 1, 3] } [0, 1, 0]
 

Constructor Summary

Constructors

Constructor	Description
StringArrayEncoding()
StringArrayEncoding(String stringData, byte[] offsets, Deque<Encoding<?,?>> outputEncoding, Deque<Encoding<?,?>> offsetEncoding)

Method Summary

Modifier and Type	Method	Description
StringArray	decode(ByteArray data)	Move one step up the encoding deque.
ByteArray	encode(StringArray 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.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

StringArrayEncoding

public StringArrayEncoding()

StringArrayEncoding

public StringArrayEncoding(String stringData, byte[] offsets, Deque<Encoding<?,?>> outputEncoding, Deque<Encoding<?,?>> offsetEncoding)

Method Details

getMapRepresentation

public Map<String,Object> getMapRepresentation()

Description copied from interface: Encoding

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

Specified by:

getMapRepresentation in interface Encoding<StringArray,ByteArray>

Returns:

a Map that contains all encoding information

decode

public StringArray decode(ByteArray data)

Description copied from interface: Encoding

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

Specified by:

decode in interface Encoding<StringArray,ByteArray>

Parameters:

data - the container to decode

Returns:

the decoded information

encode

public ByteArray encode(StringArray data)

Description copied from interface: Encoding

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

Specified by:

encode in interface Encoding<StringArray,ByteArray>

Parameters:

data - the container to encode

Returns:

the decoded information

toString

public String toString()

Overrides:

toString in class Object