com::sleepycat::bind::tuple::TupleTupleKeyCreator Class Reference

Inheritance diagram for com::sleepycat::bind::tuple::TupleTupleKeyCreator:

Public Member Functions
	TupleTupleKeyCreator ()
abstract boolean	createSecondaryKey (TupleInput primaryKeyInput, TupleInput dataInput, TupleOutput indexKeyOutput)
boolean	nullifyForeignKey (TupleInput dataInput, TupleOutput dataOutput)

---

Detailed Description

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.

Author:

Mark Hayes

Definition at line 24 of file TupleTupleKeyCreator.java.

---

Constructor & Destructor Documentation

com::sleepycat::bind::tuple::TupleTupleKeyCreator::TupleTupleKeyCreator (   )  [inline]

Creates a tuple-tuple key creator. Definition at line 30 of file TupleTupleKeyCreator.java.

---

Member Function Documentation

abstract boolean com::sleepycat::bind::tuple::TupleTupleKeyCreator::createSecondaryKey (  TupleInput  primaryKeyInput, TupleInput  dataInput, TupleOutput  indexKeyOutput )  [pure virtual]

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. Implemented in com::sleepycat::bind::tuple::TupleTupleMarshalledKeyCreator.

boolean com::sleepycat::bind::tuple::TupleTupleKeyCreator::nullifyForeignKey (  TupleInput  dataInput, TupleOutput  dataOutput )  [inline]

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 createSecondaryKey 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. Reimplemented in com::sleepycat::bind::tuple::TupleTupleMarshalledKeyCreator. Definition at line 98 of file TupleTupleKeyCreator.java.

---

The documentation for this class was generated from the following file:

• /home/huihoo/src/db/db-4.4.16/java/src/com/sleepycat/bind/tuple/TupleTupleKeyCreator.java

---