com.sleepycat.bdb.bind.serial
Class TupleSerialBinding

java.lang.Object
  |
  +--com.sleepycat.bdb.bind.serial.TupleSerialBinding

All Implemented Interfaces:

EntityBinding

Direct Known Subclasses:

TupleSerialMarshalledBinding

public abstract class TupleSerialBinding

extends Object

implements EntityBinding

A abstract entity binding that uses a tuple key and a serial value. This class takes care of serializing and deserializing the value data, and converting the key data to/from TupleInput and TupleOutput objects. Its three abstract methods must be implemented by a concrete subclass to convert these objects to/from an entity object.

• dataToObject(TupleInput,Object)
• objectToKey(Object,TupleOutput)
• objectToValue(Object)

Constructor Summary

TupleSerialBinding(TupleFormat keyFormat, SerialFormat valueFormat)
Creates a tuple-serial entity binding.

Method Summary

Object	dataToObject(DataBuffer key, DataBuffer value) Converts key and value data buffers into an entity Object.
abstract Object	dataToObject(TupleInput keyInput, Object valueInput) Constructs an entity object from TupleInput key data and deserialized value data objects.
DataFormat	getKeyFormat() Returns the format used for the key data of this binding.
DataFormat	getValueFormat() Returns the format used for the value data of this binding.
void	objectToKey(Object object, DataBuffer key) Extracts the key data from an entity Object.
abstract void	objectToKey(Object object, TupleOutput output) Extracts a key tuple from an entity object.
abstract Object	objectToValue(Object object) Extracts a value object from an entity object.
void	objectToValue(Object object, DataBuffer value) Extracts the value data from an entity Object.

Methods inherited from class java.lang.Object

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

Constructor Detail

TupleSerialBinding

public TupleSerialBinding(TupleFormat keyFormat,
                          SerialFormat valueFormat)

Creates a tuple-serial entity binding.

Parameters:

keyFormat - is the key format.

valueFormat - is the value format.

Method Detail

dataToObject

public Object dataToObject(DataBuffer key,
                           DataBuffer value)
                    throws IOException

Description copied from interface: EntityBinding

Converts key and value data buffers into an entity Object.

Specified by:

dataToObject in interface EntityBinding

Parameters:

key - is the source key data.

value - is the source value data.

Returns:

the resulting Object.

IOException

objectToKey

public void objectToKey(Object object,
                        DataBuffer key)
                 throws IOException

Description copied from interface: EntityBinding

Extracts the key data from an entity Object.

Specified by:

objectToKey in interface EntityBinding

Parameters:

object - is the source Object.

key - is the destination data buffer.

IOException

objectToValue

public void objectToValue(Object object,
                          DataBuffer value)
                   throws IOException

Description copied from interface: EntityBinding

Extracts the value data from an entity Object.

Specified by:

objectToValue in interface EntityBinding

Parameters:

object - is the source Object.

value - is the destination data buffer.

IOException

getKeyFormat

public DataFormat getKeyFormat()

Description copied from interface: EntityBinding

Returns the format used for the key data of this binding.

Specified by:

getKeyFormat in interface EntityBinding

Returns:

the key data format.

getValueFormat

public DataFormat getValueFormat()

Description copied from interface: EntityBinding

Returns the format used for the value data of this binding.

Specified by:

getValueFormat in interface EntityBinding

Returns:

the value data format.

dataToObject

public abstract Object dataToObject(TupleInput keyInput,
                                    Object valueInput)
                             throws IOException

Constructs an entity object from TupleInput key data and deserialized value data objects.

Parameters:

keyInput - is the TupleInput key data object.

valueInput - is the deserialized value data object.

Returns:

the entity object constructed from the key and value.

Throws:

IOException - if data cannot be read or written.

objectToKey

public abstract void objectToKey(Object object,
                                 TupleOutput output)
                          throws IOException

Extracts a key tuple from an entity object.

Parameters:

object - is the entity object.

output - is the TupleOutput to which the key should be written.

Throws:

IOException - if data cannot be read or written.

objectToValue

public abstract Object objectToValue(Object object)
                              throws IOException

Extracts a value object from an entity object.

Parameters:

object - is the entity object.

Returns:

the deserialized value data object.

Throws:

IOException - if data cannot be read or written.