de.lmu.ifi.dbs.elki.data.type

Class TypeInformationSerializer

java.lang.Object

de.lmu.ifi.dbs.elki.data.type.TypeInformationSerializer

All Implemented Interfaces:

ByteBufferSerializer<TypeInformation>

public class TypeInformationSerializer
extends Object
implements ByteBufferSerializer<TypeInformation>

Class to handle the serialization and deserialization of type information. The serialization format is custom, and not very extensible. However, the standard Java "serializable" API did not seem well suited for this task, and assumes an object stream context, while we intend to focus on Java NIO. TODO: on the long run, this code needs to be refactored, and a more extensible format needs to be created. Maybe, a protobuf based API would be possible.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	TypeInformationSerializer.SimpleTypeSerializer Serialization class for pure simple types.
(package private) static class	TypeInformationSerializer.VectorFieldTypeSerializer Serialization class for field vector types.
(package private) static class	TypeInformationSerializer.VectorTypeSerializer Serialization class for non-field vector types.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static ByteBufferSerializer<SimpleTypeInformation<?>>	SIMPLE_TYPE_SERIALIZER Serializer for simple types only.
static TypeInformationSerializer	STATIC Static instance.
private static byte	TAG_SIMPLE Tag for simple type.
private static byte	TAG_VECTOR Tag for non-field vector type.
private static byte	TAG_VECTOR_FIELD Tag for vector field type.
(package private) static ByteBufferSerializer<VectorFieldTypeInformation<?>>	VECTOR_FIELD_TYPE_SERIALIZER Serializer for vector fields.
(package private) static ByteBufferSerializer<VectorTypeInformation<?>>	VECTOR_TYPE_SERIALIZER Serializer for non-field vectors.

Constructor Summary

Constructors

Constructor and Description
TypeInformationSerializer()

Method Summary

Methods

Modifier and Type	Method and Description
TypeInformation	fromByteBuffer(ByteBuffer buffer) Deserialize an object from a byte buffer (e.g. disk)
int	getByteSize(TypeInformation object) Get the size of the object in bytes.
void	toByteBuffer(ByteBuffer buffer, TypeInformation object) Serialize the object to a byte array (e.g. disk)

Methods inherited from class java.lang.Object

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

Field Detail

STATIC

public static final TypeInformationSerializer STATIC

Static instance.

TAG_SIMPLE

private static final byte TAG_SIMPLE

Tag for simple type.

See Also:

Constant Field Values

TAG_VECTOR

private static final byte TAG_VECTOR

Tag for non-field vector type.

See Also:

Constant Field Values

TAG_VECTOR_FIELD

private static final byte TAG_VECTOR_FIELD

Tag for vector field type.

See Also:

Constant Field Values

SIMPLE_TYPE_SERIALIZER

static final ByteBufferSerializer<SimpleTypeInformation<?>> SIMPLE_TYPE_SERIALIZER

Serializer for simple types only.

VECTOR_TYPE_SERIALIZER

static final ByteBufferSerializer<VectorTypeInformation<?>> VECTOR_TYPE_SERIALIZER

Serializer for non-field vectors.

VECTOR_FIELD_TYPE_SERIALIZER

static final ByteBufferSerializer<VectorFieldTypeInformation<?>> VECTOR_FIELD_TYPE_SERIALIZER

Serializer for vector fields.

Constructor Detail

TypeInformationSerializer

public TypeInformationSerializer()

Method Detail

fromByteBuffer

public TypeInformation fromByteBuffer(ByteBuffer buffer)
                               throws IOException,
                                      UnsupportedOperationException

Description copied from interface: ByteBufferSerializer

Deserialize an object from a byte buffer (e.g. disk)

Specified by:

fromByteBuffer in interface ByteBufferSerializer<TypeInformation>

Parameters:

buffer - Data array to process

Returns:

Deserialized object

Throws:

IOException - on IO errors

UnsupportedOperationException - When functionality not implemented or available

toByteBuffer

public void toByteBuffer(ByteBuffer buffer,
                TypeInformation object)
                  throws IOException,
                         UnsupportedOperationException

Description copied from interface: ByteBufferSerializer

Serialize the object to a byte array (e.g. disk)

Specified by:

toByteBuffer in interface ByteBufferSerializer<TypeInformation>

Parameters:

buffer - Buffer to serialize to

object - Object to serialize

Throws:

IOException - on IO errors

UnsupportedOperationException - When functionality not implemented or available

getByteSize

public int getByteSize(TypeInformation object)
                throws IOException,
                       UnsupportedOperationException

Description copied from interface: ByteBufferSerializer

Get the size of the object in bytes.

Specified by:

getByteSize in interface ByteBufferSerializer<TypeInformation>

Parameters:

object - Object to serialize

Returns:

maximum size in serialized form

Throws:

IOException - on IO errors

UnsupportedOperationException - When functionality not implemented or available