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

collections::ship::marshal::Shipment Class Reference

Inheritance diagram for collections::ship::marshal::Shipment:

collections::ship::marshal::MarshalledEnt

Public Member Functions

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

Package Functions

void setKey (String partNumber, String supplierNumber)

Detailed Description

A Shipment represents the combined key/data pair for a shipment entity.

In this sample, Shipment is bound to the stored key/data entry by implementing the MarshalledEnt interface, which is called by SampleViews.MarshalledEntityBinding.

The binding is "tricky" in that it uses this class for both the stored data entry and the combined entity object. To do this, the key field(s) are transient and are set by the binding after the data object has been deserialized. This avoids the use of a ShipmentData class completely.

Since this class is used directly for data storage, it must be Serializable.

Author:
Mark Hayes

Definition at line 34 of file Shipment.java.


Member Function Documentation

void collections::ship::marshal::Shipment::marshalPrimaryKey TupleOutput  keyOutput  )  [inline]
 

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

Implements collections::ship::marshal::MarshalledEnt.

Definition at line 96 of file Shipment.java.

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

boolean collections::ship::marshal::Shipment::marshalSecondaryKey String  keyName,
TupleOutput  keyOutput
[inline]
 

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

Implements collections::ship::marshal::MarshalledEnt.

Definition at line 102 of file Shipment.java.

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

void collections::ship::marshal::Shipment::setKey String  partNumber,
String  supplierNumber
[inline, package]
 

Set the transient key fields after deserializing. This method is only called by data bindings.

Definition at line 54 of file Shipment.java.

void collections::ship::marshal::Shipment::unmarshalPrimaryKey TupleInput  keyInput  )  [inline]
 

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

Implements collections::ship::marshal::MarshalledEnt.

Definition at line 90 of file Shipment.java.

References com::sleepycat::bind::tuple::TupleInput::readString().


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