com.bigdata.btree.data

Class DefaultLeafCoder

java.lang.Object

com.bigdata.btree.data.DefaultLeafCoder

All Implemented Interfaces:

IAbstractNodeDataCoder<ILeafData>, Externalizable, Serializable

public class DefaultLeafCoder
extends Object
implements IAbstractNodeDataCoder<ILeafData>, Externalizable

Default implementation for immutable ILeafData records.

Version:

$Id$

Author:

Bryan Thompson

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefaultLeafCoder() De-serialization ctor.
DefaultLeafCoder(IRabaCoder keysCoder, IRabaCoder valsCoder)

Method Summary

Methods

Modifier and Type	Method and Description
ILeafData	decode(AbstractFixedByteArrayBuffer data) Return an IAbstractNodeData instance which can access the coded data.
AbstractFixedByteArrayBuffer	encode(ILeafData leaf, DataOutputBuffer buf) Encode the data, returning a slice containing the coded data.
ILeafData	encodeLive(ILeafData leaf, DataOutputBuffer buf) Encode the data, returning a reference to a coded instance of the data.
boolean	isLeafDataCoder() Yes.
boolean	isNodeDataCoder() No.
void	readExternal(ObjectInput in)
String	toString()
static StringBuilder	toString(ILeafData leaf, StringBuilder sb) Utility method formats the ILeafData.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultLeafCoder

public DefaultLeafCoder()

De-serialization ctor.

DefaultLeafCoder

public DefaultLeafCoder(IRabaCoder keysCoder,
                IRabaCoder valsCoder)

Parameters:

keysCoder - The IRabaCoder for the leaf's keys.

valsCoder - The IRabaCoder for the leaf's values.

Method Detail

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

isLeafDataCoder

public final boolean isLeafDataCoder()

Yes.

Specified by:

isLeafDataCoder in interface IAbstractNodeDataCoder<ILeafData>

See Also:

ILeafData

isNodeDataCoder

public boolean isNodeDataCoder()

No.

Specified by:

isNodeDataCoder in interface IAbstractNodeDataCoder<ILeafData>

See Also:

INodeData

toString

public String toString()

Overrides:

toString in class Object

decode

public ILeafData decode(AbstractFixedByteArrayBuffer data)

Description copied from interface: IAbstractNodeDataCoder

Return an IAbstractNodeData instance which can access the coded data.

Specified by:

decode in interface IAbstractNodeDataCoder<ILeafData>

Parameters:

data - The record containing the coded data.

Returns:

A view of the coded data.

encodeLive

public ILeafData encodeLive(ILeafData leaf,
                   DataOutputBuffer buf)

Description copied from interface: IAbstractNodeDataCoder

Encode the data, returning a reference to a coded instance of the data.

Note: Implementations of this method are typically heavy. While it is always valid to IAbstractNodeDataCoder.encode(IAbstractNodeData, DataOutputBuffer) an IAbstractNodeData, DO NOT invoke this arbitrarily on data which may already be coded. The IAbstractNodeCodedData interface will always be implemented for coded data.

Specified by:

encodeLive in interface IAbstractNodeDataCoder<ILeafData>

Parameters:

leaf - The node or leaf data.

buf - A buffer on which the coded data will be written.

Returns:

A reference to a coded instance of the data. IAbstractNodeData.data() is a slice onto the post-condition state of the caller's buffer whose view corresponds to the coded record. This may be written directly onto an output stream or the slice may be converted to an exact fit byte[].

encode

public AbstractFixedByteArrayBuffer encode(ILeafData leaf,
                                  DataOutputBuffer buf)

Description copied from interface: IAbstractNodeDataCoder

Encode the data, returning a slice containing the coded data.

Note: Implementations of this method are typically heavy. While it is always valid to IAbstractNodeDataCoder.encode(IAbstractNodeData, DataOutputBuffer) an IAbstractNodeData, DO NOT invoke this arbitrarily on data which may already be coded. The IAbstractNodeCodedData interface will always be implemented for coded data.

Specified by:

encode in interface IAbstractNodeDataCoder<ILeafData>

Parameters:

leaf - The node or leaf data.

buf - A buffer on which the coded data will be written.

Returns:

A slice onto the post-condition state of the caller's buffer whose view corresponds to the coded record. This may be written directly onto an output stream or the slice may be converted to an exact fit byte[].

toString

public static StringBuilder toString(ILeafData leaf,
                     StringBuilder sb)

Utility method formats the ILeafData.

Parameters:

leaf - A leaf data record.

sb - The representation will be written onto this object.

Returns:

The sb parameter.