com.sleepycat.bind.tuple

Class TupleTupleKeyCreator

public abstract class TupleTupleKeyCreator extends TupleBase implements SecondaryKeyCreator

An abstract key creator that uses a tuple key and a tuple data entry. This class takes care of converting the key and data entry to/from TupleInput and TupleOutput objects. The following abstract method must be implemented by a concrete subclass to create the index key using these objects
Constructor Summary
TupleTupleKeyCreator()
Creates a tuple-tuple key creator.
Method Summary
booleancreateSecondaryKey(SecondaryDatabase db, DatabaseEntry primaryKeyEntry, DatabaseEntry dataEntry, DatabaseEntry indexKeyEntry)
abstract booleancreateSecondaryKey(TupleInput primaryKeyInput, TupleInput dataInput, TupleOutput indexKeyOutput)
Creates the index key from primary key tuple and data tuple.
booleannullifyForeignKey(SecondaryDatabase db, DatabaseEntry dataEntry)
booleannullifyForeignKey(TupleInput dataInput, TupleOutput dataOutput)
Clears the index key in the tuple data entry.

Constructor Detail

TupleTupleKeyCreator

public TupleTupleKeyCreator()
Creates a tuple-tuple key creator.

Method Detail

createSecondaryKey

public boolean createSecondaryKey(SecondaryDatabase db, DatabaseEntry primaryKeyEntry, DatabaseEntry dataEntry, DatabaseEntry indexKeyEntry)

createSecondaryKey

public abstract boolean createSecondaryKey(TupleInput primaryKeyInput, TupleInput dataInput, TupleOutput indexKeyOutput)
Creates the index key from primary key tuple and data tuple.

Parameters: primaryKeyInput is the TupleInput for the primary key entry. dataInput is the TupleInput for the data entry. indexKeyOutput is the destination index key tuple.

Returns: true if a key was created, or false to indicate that the key is not present.

nullifyForeignKey

public boolean nullifyForeignKey(SecondaryDatabase db, DatabaseEntry dataEntry)

nullifyForeignKey

public boolean nullifyForeignKey(TupleInput dataInput, TupleOutput dataOutput)
Clears the index key in the tuple data entry. The dataInput should be read and then written to the dataOutput, clearing the index key in the process.

The secondary key should be output or removed by this method such that TupleTupleKeyCreator will return false. Other fields in the data object should remain unchanged.

Parameters: dataInput is the TupleInput for the data entry. dataOutput is the destination TupleOutput.

Returns: true if the key was cleared, or false to indicate that the key is not present and no change is necessary.