com.bigdata.htree.data

Class DefaultDirectoryPageCoder

java.lang.Object

com.bigdata.htree.data.DefaultDirectoryPageCoder

All Implemented Interfaces:

IAbstractNodeDataCoder<IDirectoryData>, Externalizable, Serializable

public class DefaultDirectoryPageCoder
extends Object
implements IAbstractNodeDataCoder<IDirectoryData>, Externalizable

Default implementation for immutable IDirectoryData records.

Version:

$Id: DefaultNodeCoder.java 4585 2011-06-01 13:42:56Z thompsonbry $ TODO Support RWStore 4 byte native addrs. TODO Explicit test suite based on the B+Tree test suites.

Author:

Bryan Thompson

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefaultDirectoryPageCoder() De-serialization ctor.

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultDirectoryPageCoder

public DefaultDirectoryPageCoder()

De-serialization ctor.

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()

No.

Specified by:

isLeafDataCoder in interface IAbstractNodeDataCoder<IDirectoryData>

See Also:

ILeafData

isNodeDataCoder

public boolean isNodeDataCoder()

Yes.

Specified by:

isNodeDataCoder in interface IAbstractNodeDataCoder<IDirectoryData>

See Also:

INodeData

decode

public IDirectoryData decode(AbstractFixedByteArrayBuffer data)

Description copied from interface: IAbstractNodeDataCoder

Return an IAbstractNodeData instance which can access the coded data.

Specified by:

decode in interface IAbstractNodeDataCoder<IDirectoryData>

Parameters:

data - The record containing the coded data.

Returns:

A view of the coded data.

encodeLive

public IDirectoryData encodeLive(IDirectoryData node,
                        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<IDirectoryData>

Parameters:

node - 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(IDirectoryData node,
                                  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<IDirectoryData>

Parameters:

node - 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(IDirectoryData node,
                     StringBuilder sb)

Utility method formats the IDirectoryData.

Parameters:

node - A node data record.

sb - The representation will be written onto this object.

Returns:

The sb parameter.