com::sleepycat::bind::tuple::MarshalledTupleKeyEntity Interface Reference

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

Public Member Functions
void	marshalPrimaryKey (TupleOutput keyOutput)
Package Functions
void	unmarshalPrimaryKey (TupleInput keyInput)
boolean	marshalSecondaryKey (String keyName, TupleOutput keyOutput)
boolean	nullifyForeignKey (String keyName)

---

Detailed Description

A marshalling interface implemented by entity classes that represent keys as tuples. Since MarshalledTupleKeyEntity objects are instantiated using Java deserialization, no particular constructor is required by classes that implement this interface.

Note that a marshalled tuple key extractor is somewhat less efficient than a non-marshalled key tuple extractor because more conversions are needed. A marshalled key extractor must convert the entry to an object in order to extract the key fields, while an unmarshalled key extractor does not.

Author:

Mark Hayes

See also:

TupleTupleMarshalledBinding

com.sleepycat.bind.serial.TupleSerialMarshalledBinding

Definition at line 28 of file MarshalledTupleKeyEntity.java.

---

Member Function Documentation

void com::sleepycat::bind::tuple::MarshalledTupleKeyEntity::marshalPrimaryKey (  TupleOutput  keyOutput  )

Extracts the entity's primary key and writes it to the key output. Parameters: keyOutput  is the output tuple. Implemented in collections::ship::factory::Part, collections::ship::factory::Shipment, collections::ship::factory::Supplier, com::sleepycat::bind::serial::test::MarshalledObject, and com::sleepycat::bind::tuple::test::MarshalledObject. Referenced by com::sleepycat::bind::tuple::TupleTupleMarshalledBinding::objectToKey(), and com::sleepycat::bind::serial::TupleSerialMarshalledBinding::objectToKey().

boolean com::sleepycat::bind::tuple::MarshalledTupleKeyEntity::marshalSecondaryKey (  String  keyName, TupleOutput  keyOutput )  [package]

Extracts the entity's secondary key and writes it to the key output. Parameters: keyName  identifies the secondary key. keyOutput  is the output tuple. Returns: true if a key was created, or false to indicate that the key is not present. Implemented in collections::ship::factory::Part, collections::ship::factory::Shipment, collections::ship::factory::Supplier, com::sleepycat::bind::serial::test::MarshalledObject, and com::sleepycat::bind::tuple::test::MarshalledObject. Referenced by com::sleepycat::bind::tuple::TupleTupleMarshalledKeyCreator::createSecondaryKey(), and com::sleepycat::bind::serial::TupleSerialMarshalledKeyCreator::createSecondaryKey().

boolean com::sleepycat::bind::tuple::MarshalledTupleKeyEntity::nullifyForeignKey (  String  keyName  )  [package]

Clears the entity's secondary key fields for the given key name. The specified index key should be changed by this method such that marshalSecondaryKey for the same key name will return false. Other fields in the data object should remain unchanged. Parameters: keyName  identifies the secondary key. Returns: true if the key was cleared, or false to indicate that the key is not present and no change is necessary. Implemented in collections::ship::factory::Part, collections::ship::factory::Shipment, collections::ship::factory::Supplier, com::sleepycat::bind::serial::test::MarshalledObject, and com::sleepycat::bind::tuple::test::MarshalledObject. Referenced by com::sleepycat::bind::tuple::TupleTupleMarshalledKeyCreator::nullifyForeignKey(), and com::sleepycat::bind::serial::TupleSerialMarshalledKeyCreator::nullifyForeignKey().

void com::sleepycat::bind::tuple::MarshalledTupleKeyEntity::unmarshalPrimaryKey (  TupleInput  keyInput  )  [package]

Completes construction of the entity by setting its primary key from the stored primary key. Parameters: keyInput  is the input tuple. Implemented in collections::ship::factory::Part, collections::ship::factory::Shipment, collections::ship::factory::Supplier, com::sleepycat::bind::serial::test::MarshalledObject, and com::sleepycat::bind::tuple::test::MarshalledObject. Referenced by com::sleepycat::bind::tuple::TupleTupleMarshalledBinding::entryToObject(), and com::sleepycat::bind::serial::TupleSerialMarshalledBinding::entryToObject().

---

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

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

---