com.bigdata.rdf.sparql.ast.service.history

Class HistoryIndexTupleSerializer

java.lang.Object

com.bigdata.btree.DefaultTupleSerializer<HistoryChangeRecord,HistoryChangeRecord>

com.bigdata.rdf.sparql.ast.service.history.HistoryIndexTupleSerializer

All Implemented Interfaces:

ITupleSerializer<HistoryChangeRecord,HistoryChangeRecord>, IKeyBuilderFactory, Externalizable, Serializable

public class HistoryIndexTupleSerializer
extends DefaultTupleSerializer<HistoryChangeRecord,HistoryChangeRecord>

(De-)serializes IChangeRecords for the history index.

Version:

$Id: SPOTupleSerializer.java 5281 2011-10-03 14:00:39Z thompsonbry $

Author:

Bryan Thompson

See Also:

History Service, Serialized Form

Constructor Summary

Constructors

Constructor and Description
HistoryIndexTupleSerializer() De-serialization constructor.
HistoryIndexTupleSerializer(SPOKeyOrder keyOrder, boolean sids) Create an ITupleSerializer for the indicated access path.
HistoryIndexTupleSerializer(SPOKeyOrder keyOrder, boolean sids, IRabaCoder leafKeySer, IRabaCoder leafValSer) Create an ITupleSerializer for the indicated access path.

Method Summary

Methods

Modifier and Type	Method and Description
HistoryChangeRecord	deserialize(ITuple tuple) De-serializes an object from the value stored in the tuple (ignores the key stored in the tuple).
HistoryChangeRecord	deserializeKey(ITuple tuple) This is an unsupported operation.
void	readExternal(ObjectInput in)
byte[]	serializeKey(HistoryChangeRecord changeRecord)
byte[]	serializeKey(Object obj) Serialize a facet of an object's state that places the object into the total sort order for the index.
byte[]	serializeVal(HistoryChangeRecord changeRecord) Serializes the object as a byte[] using Java default serialization.
void	writeExternal(ObjectOutput out)

Methods inherited from class com.bigdata.btree.DefaultTupleSerializer

getDefaultKeyBuilderFactory, getDefaultLeafKeysCoder, getDefaultValuesCoder, getKeyBuilder, getLeafKeysCoder, getLeafValuesCoder, getPrimaryKeyBuilder, newInstance, setLeafKeysCoder, setLeafValuesCoder, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

HistoryIndexTupleSerializer

public HistoryIndexTupleSerializer()

De-serialization constructor.

HistoryIndexTupleSerializer

public HistoryIndexTupleSerializer(SPOKeyOrder keyOrder,
                           boolean sids)

Create an ITupleSerializer for the indicated access path.

Parameters:

keyOrder - The key order for the (s,p,o[,c]) component of the key.

HistoryIndexTupleSerializer

public HistoryIndexTupleSerializer(SPOKeyOrder keyOrder,
                           boolean sids,
                           IRabaCoder leafKeySer,
                           IRabaCoder leafValSer)

Create an ITupleSerializer for the indicated access path.

Parameters:

keyOrder - The access path.

sids - If true, attach sids to decoded SPOs where appropriate.

leafKeySer -

leafValSer -

Method Detail

serializeKey

public byte[] serializeKey(Object obj)

Description copied from interface: ITupleSerializer

Serialize a facet of an object's state that places the object into the total sort order for the index. This method is automatically applied by IAutoboxBTree.insert(Object, Object) and friends to convert the key object into an unsigned variable length byte[].

Note: This handles the conversion between an object and the unsigned variable length byte[] representation of that object which determines its place within the total index order. Since this transform imposes the total order of the index, different techniques are applied here than are applied to the serialization of the index values.

Specified by:

serializeKey in interface ITupleSerializer<HistoryChangeRecord,HistoryChangeRecord>

Overrides:

serializeKey in class DefaultTupleSerializer<HistoryChangeRecord,HistoryChangeRecord>

Parameters:

obj - A object (MAY NOT be null).

Returns:

An unsigned byte[] which places the object into the total sort order for the index and never null ( null keys are not allowed into an index).

serializeKey

public byte[] serializeKey(HistoryChangeRecord changeRecord)

serializeVal

public byte[] serializeVal(HistoryChangeRecord changeRecord)

Description copied from class: DefaultTupleSerializer

Serializes the object as a byte[] using Java default serialization.

Specified by:

serializeVal in interface ITupleSerializer<HistoryChangeRecord,HistoryChangeRecord>

Overrides:

serializeVal in class DefaultTupleSerializer<HistoryChangeRecord,HistoryChangeRecord>

Parameters:

changeRecord - The object to be serialized (MAY be null).

Returns:

The serialized representation of the object as a byte[] -or- null if the reference is null.

deserializeKey

public HistoryChangeRecord deserializeKey(ITuple tuple)

Description copied from class: DefaultTupleSerializer

This is an unsupported operation. Additional information is required to either decode the internal unsigned byte[] keys or to extract the key from the de-serialized value (if it is being stored in that value). You can either write your own ITupleSerializer or you can specialize this one so that it can de-serialize your keys using whichever approach makes the most sense for your data.

Specified by:

deserializeKey in interface ITupleSerializer<HistoryChangeRecord,HistoryChangeRecord>

Overrides:

deserializeKey in class DefaultTupleSerializer<HistoryChangeRecord,HistoryChangeRecord>

deserialize

public HistoryChangeRecord deserialize(ITuple tuple)

Description copied from class: DefaultTupleSerializer

De-serializes an object from the value stored in the tuple (ignores the key stored in the tuple).

Specified by:

deserialize in interface ITupleSerializer<HistoryChangeRecord,HistoryChangeRecord>

Overrides:

deserialize in class DefaultTupleSerializer<HistoryChangeRecord,HistoryChangeRecord>

Parameters:

tuple - The tuple.

Returns:

The de-serialized object.

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class DefaultTupleSerializer<HistoryChangeRecord,HistoryChangeRecord>

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class DefaultTupleSerializer<HistoryChangeRecord,HistoryChangeRecord>

Throws:

IOException