org.mapdb

Class SerializerBase

java.lang.Object

org.mapdb.Serializer<Object>

org.mapdb.SerializerBase

Direct Known Subclasses:

SerializerPojo

public class SerializerBase
extends Serializer<Object>

Serializer which uses 'header byte' to serialize/deserialize most of classes from 'java.lang' and 'java.util' packages.

Author:

Jan Kotek

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SerializerBase.Deser<A>
protected static class	SerializerBase.DeserInt
protected static class	SerializerBase.DeserLong
protected static class	SerializerBase.DeserSerializer
protected class	SerializerBase.DeserSingleton always returns single object without reading anything
protected static class	SerializerBase.DeserStringLen
protected static class	SerializerBase.FastArrayList<K> Utility class similar to ArrayList, but with fast identity search.
protected static interface	SerializerBase.Header Header byte, is used at start of each record to indicate data type WARNING !!! values bellow must be unique !!!!!
protected static interface	SerializerBase.HeaderMapDB
protected static interface	SerializerBase.Ser<A>
protected class	SerializerBase.SerHeader writes single byte header
protected static class	SerializerBase.SerHeaderSerializer

Nested classes/interfaces inherited from class org.mapdb.Serializer

Serializer.Array<T>, Serializer.BooleanSer, Serializer.CompressionDeflateWrapper<E>, Serializer.CompressionWrapper<E>, Serializer.EightByteSerializer<E>, Serializer.FourByteSerializer<E>, Serializer.IntegerSerializer, Serializer.LongSerializer

Field Summary

Fields

Modifier and Type	Field and Description
protected SerializerBase.Deser[]	headerDeser
protected Map<Object,Integer>	mapdb_all
protected Store.LongObjectMap<Object>	mapdb_reverse
protected Map<Class,SerializerBase.Ser>	ser
protected static SerializerBase.Ser	SER_BOOLEAN
protected static SerializerBase.Ser	SER_BYTE
protected static SerializerBase.Ser<byte[]>	SER_BYTE_ARRAY
protected static SerializerBase.Ser	SER_CHAR
protected static SerializerBase.Ser	SER_DOUBLE
protected static SerializerBase.Ser	SER_FLOAT
protected static SerializerBase.Ser	SER_INT
protected static SerializerBase.Ser	SER_INT_ARRAY
protected static SerializerBase.Ser	SER_LONG
protected static SerializerBase.Ser	SER_LONG_ARRAY
protected static SerializerBase.Ser	SER_MA_BOOL
protected static SerializerBase.Ser	SER_MA_INT
protected static SerializerBase.Ser	SER_MA_LONG
protected static SerializerBase.Ser	SER_MA_STRING
protected SerializerBase.Ser	SER_MA_VAR
protected static SerializerBase.Ser	SER_SHORT
protected static SerializerBase.Ser	SER_STRING

Fields inherited from class org.mapdb.Serializer

BASIC, BIG_DECIMAL, BIG_INTEGER, BOOLEAN, BOOLEAN_ARRAY, BYTE, BYTE_ARRAY, BYTE_ARRAY_NOSIZE, CHAR, CHAR_ARRAY, CLASS, DATE, DOUBLE, DOUBLE_ARRAY, FLOAT, FLOAT_ARRAY, ILLEGAL_ACCESS, INT_ARRAY, INTEGER, INTEGER_PACKED, INTEGER_PACKED_ZIGZAG, JAVA, LONG, LONG_ARRAY, LONG_PACKED, LONG_PACKED_ZIGZAG, RECID, RECID_ARRAY, SHORT, SHORT_ARRAY, STRING, STRING_ASCII, STRING_INTERN, STRING_NOSIZE, STRING_XXHASH, UUID

Constructor Summary

Constructors

Constructor and Description
SerializerBase()

Method Summary

Methods

Modifier and Type	Method and Description
void	assertSerializable(Object o)
Object	deserialize(DataInput in, int capacity) Deserialize the content of an object from a DataInput.
Object	deserialize(DataInput in, SerializerBase.FastArrayList<Object> objectStack)
protected Class	deserializeClass(DataInput is)
protected Object	deserializeMapDB(DataInput is, SerializerBase.FastArrayList<Object> objectStack)
protected Object	deserializeUnknownHeader(DataInput is, int head, SerializerBase.FastArrayList<Object> objectStack) override this method to extend SerializerBase functionality
boolean	equalsBinary(Object a1, Object a2) Tries to serialize two object and return true if they are binary equal
protected Engine	getEngine()
protected void	initHeaderDeser()
protected void	initMapdb()
protected void	initSer()
boolean	isSerializable(Object o) return true if mapdb knows howto serialize given object
boolean	isTrusted() MapDB has relax record size boundary checking.
protected static boolean[]	readBooleanArray(int numBools, DataInput is) Unpacks boolean[], each value in array is represented by single bite
void	serialize(DataOutput out, Object obj) Serialize the content of an object into a ObjectOutput
void	serialize(DataOutput out, Object obj, SerializerBase.FastArrayList<Object> objectStack)
protected void	serializeClass(DataOutput out, Class clazz)
void	serializeObjectArray(DataOutput out, Object[] b, SerializerBase.FastArrayList objectStack)
protected void	serializeUnknownObject(DataOutput out, Object obj, SerializerBase.FastArrayList<Object> objectStack) override this method to extend SerializerBase functionality
protected static void	writeBooleanArray(DataOutput out, boolean[] bool) Writes boolean[] into output, each value in array is represented by single byte

Methods inherited from class org.mapdb.Serializer

equals, fixedSize, getBTreeKeySerializer, hashCode, valueArrayCopyOfRange, valueArrayDeleteValue, valueArrayDeserialize, valueArrayEmpty, valueArrayFromArray, valueArrayGet, valueArrayPut, valueArraySerialize, valueArraySize, valueArrayUpdateVal

Methods inherited from class java.lang.Object

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

Field Detail

ser

protected final Map<Class,SerializerBase.Ser> ser

headerDeser

protected final SerializerBase.Deser[] headerDeser

SER_STRING

protected static final SerializerBase.Ser SER_STRING

SER_LONG_ARRAY

protected static final SerializerBase.Ser SER_LONG_ARRAY

SER_INT_ARRAY

protected static final SerializerBase.Ser SER_INT_ARRAY

SER_DOUBLE

protected static final SerializerBase.Ser SER_DOUBLE

SER_FLOAT

protected static final SerializerBase.Ser SER_FLOAT

SER_SHORT

protected static final SerializerBase.Ser SER_SHORT

SER_CHAR

protected static final SerializerBase.Ser SER_CHAR

SER_BYTE

protected static final SerializerBase.Ser SER_BYTE

SER_BOOLEAN

protected static final SerializerBase.Ser SER_BOOLEAN

SER_LONG

protected static final SerializerBase.Ser SER_LONG

SER_INT

protected static final SerializerBase.Ser SER_INT

SER_MA_LONG

protected static final SerializerBase.Ser SER_MA_LONG

SER_MA_INT

protected static final SerializerBase.Ser SER_MA_INT

SER_MA_BOOL

protected static final SerializerBase.Ser SER_MA_BOOL

SER_MA_STRING

protected static final SerializerBase.Ser SER_MA_STRING

SER_MA_VAR

protected final SerializerBase.Ser SER_MA_VAR

SER_BYTE_ARRAY

protected static final SerializerBase.Ser<byte[]> SER_BYTE_ARRAY

mapdb_all

protected final Map<Object,Integer> mapdb_all

mapdb_reverse

protected final Store.LongObjectMap<Object> mapdb_reverse

Constructor Detail

SerializerBase

public SerializerBase()

Method Detail

initSer

protected void initSer()

serializeObjectArray

public void serializeObjectArray(DataOutput out,
                        Object[] b,
                        SerializerBase.FastArrayList objectStack)
                          throws IOException

Throws:

IOException

initHeaderDeser

protected void initHeaderDeser()

serialize

public void serialize(DataOutput out,
             Object obj)
               throws IOException

Description copied from class: Serializer

Serialize the content of an object into a ObjectOutput

Specified by:

serialize in class Serializer<Object>

Parameters:

out - ObjectOutput to save object into

obj - Object to serialize

Throws:

IOException - in case of IO error

serialize

public void serialize(DataOutput out,
             Object obj,
             SerializerBase.FastArrayList<Object> objectStack)
               throws IOException

Throws:

IOException

serializeClass

protected void serializeClass(DataOutput out,
                  Class clazz)
                       throws IOException

Throws:

IOException

deserialize

public Object deserialize(DataInput in,
                 int capacity)
                   throws IOException

Description copied from class: Serializer

Deserialize the content of an object from a DataInput.

Specified by:

deserialize in class Serializer<Object>

Parameters:

in - to read serialized data from

capacity - how many bytes are available in DataInput for reading, may be -1 (in streams) or 0 (null).

Returns:

deserialized object

Throws:

IOException - in case of IO error

deserialize

public Object deserialize(DataInput in,
                 SerializerBase.FastArrayList<Object> objectStack)
                   throws IOException

Throws:

IOException

initMapdb

protected void initMapdb()

assertSerializable

public void assertSerializable(Object o)

deserializeMapDB

protected Object deserializeMapDB(DataInput is,
                      SerializerBase.FastArrayList<Object> objectStack)
                           throws IOException

Throws:

IOException

getEngine

protected Engine getEngine()

deserializeClass

protected Class deserializeClass(DataInput is)
                          throws IOException

Throws:

IOException

serializeUnknownObject

protected void serializeUnknownObject(DataOutput out,
                          Object obj,
                          SerializerBase.FastArrayList<Object> objectStack)
                               throws IOException

override this method to extend SerializerBase functionality

Throws:

IOException

deserializeUnknownHeader

protected Object deserializeUnknownHeader(DataInput is,
                              int head,
                              SerializerBase.FastArrayList<Object> objectStack)
                                   throws IOException

override this method to extend SerializerBase functionality

Throws:

IOException

writeBooleanArray

protected static void writeBooleanArray(DataOutput out,
                     boolean[] bool)
                                 throws IOException

Writes boolean[] into output, each value in array is represented by single byte

Parameters:

bool - The booleans to be writen.

Throws:

IOException

readBooleanArray

protected static boolean[] readBooleanArray(int numBools,
                         DataInput is)
                                     throws IOException

Unpacks boolean[], each value in array is represented by single bite

Returns:

The boolean array decompressed from the bytes read in.

Throws:

IOException - If an error occurred while reading.

isTrusted

public boolean isTrusted()

Description copied from class: Serializer

MapDB has relax record size boundary checking. It expect deserializer to read exactly as many bytes as were writen during serialization. If deserializer reads more bytes it might start reading others record data in store.

Some serializers (Kryo) have problems with this. To prevent this we can not read data directly from store, but must copy them into separate byte[]. So zero copy optimalizations is disabled by default, and must be explicitly enabled here.

This flag indicates if this serializer was 'verified' to read as many bytes as it writes. It should be also much better tested etc.

Overrides:

isTrusted in class Serializer<Object>

Returns:

true if this serializer is well tested and writes as many bytes as it reads.

isSerializable

public boolean isSerializable(Object o)

return true if mapdb knows howto serialize given object

equalsBinary

public boolean equalsBinary(Object a1,
                   Object a2)

Tries to serialize two object and return true if they are binary equal

Parameters:

a1 - first object

a2 - second object

Returns:

true if objects are equal or binary equal, false if not equal or some failure happend