Main Page | Class Hierarchy | Data Structures | Directories | File List | Data Fields | Related Pages

com::sleepycat::bind::serial::test::MarshalledObject Class Reference

Inheritance diagram for com::sleepycat::bind::serial::test::MarshalledObject:

com::sleepycat::bind::tuple::MarshalledTupleKeyEntity

Public Member Functions

void marshalPrimaryKey (TupleOutput keyOutput)
void unmarshalPrimaryKey (TupleInput keyInput)
boolean marshalSecondaryKey (String keyName, TupleOutput keyOutput)
boolean nullifyForeignKey (String keyName)

Detailed Description

Author:
Mark Hayes

Definition at line 21 of file MarshalledObject.java.


Member Function Documentation

void com::sleepycat::bind::serial::test::MarshalledObject::marshalPrimaryKey TupleOutput  keyOutput  )  [inline]
 

Extracts the entity's primary key and writes it to the key output.

Parameters:
keyOutput is the output tuple.

Implements com::sleepycat::bind::tuple::MarshalledTupleKeyEntity.

Definition at line 76 of file MarshalledObject.java.

References com::sleepycat::bind::tuple::TupleOutput::writeString().

boolean com::sleepycat::bind::serial::test::MarshalledObject::marshalSecondaryKey String  keyName,
TupleOutput  keyOutput
[inline]
 

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.

Implements com::sleepycat::bind::tuple::MarshalledTupleKeyEntity.

Definition at line 86 of file MarshalledObject.java.

References com::sleepycat::bind::tuple::TupleOutput::writeString().

boolean com::sleepycat::bind::serial::test::MarshalledObject::nullifyForeignKey String  keyName  )  [inline]
 

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.

Implements com::sleepycat::bind::tuple::MarshalledTupleKeyEntity.

Definition at line 107 of file MarshalledObject.java.

void com::sleepycat::bind::serial::test::MarshalledObject::unmarshalPrimaryKey TupleInput  keyInput  )  [inline]
 

Completes construction of the entity by setting its primary key from the stored primary key.

Parameters:
keyInput is the input tuple.

Implements com::sleepycat::bind::tuple::MarshalledTupleKeyEntity.

Definition at line 81 of file MarshalledObject.java.


The documentation for this class was generated from the following file:
Generated on Sun Dec 25 12:14:59 2005 for Berkeley DB 4.4.16 by  doxygen 1.4.2