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

com::sleepycat::collections::TupleSerialFactory Class Reference


Public Member Functions

 TupleSerialFactory (ClassCatalog catalog)
final ClassCatalog getCatalog ()
StoredMap newMap (Database db, Class keyClass, Class valueBaseClass, boolean writeAllowed)
StoredSortedMap newSortedMap (Database db, Class keyClass, Class valueBaseClass, boolean writeAllowed)
TupleSerialMarshalledKeyCreator getKeyCreator (Class valueBaseClass, String keyName)

Detailed Description

Creates stored collections having tuple keys and serialized entity values. The entity classes must implement the java.io.Serializable and MarshalledTupleKeyEntity interfaces. The key classes must either implement the MarshalledTupleEntry interface or be one of the Java primitive type classes. Underlying binding objects are created automatically.

Author:
Mark Hayes

Definition at line 29 of file TupleSerialFactory.java.


Constructor & Destructor Documentation

com::sleepycat::collections::TupleSerialFactory::TupleSerialFactory ClassCatalog  catalog  )  [inline]
 

Creates a tuple-serial factory for given environment and class catalog.

Definition at line 36 of file TupleSerialFactory.java.


Member Function Documentation

final ClassCatalog com::sleepycat::collections::TupleSerialFactory::getCatalog  )  [inline]
 

Returns the class catalog associated with this factory.

Definition at line 44 of file TupleSerialFactory.java.

TupleSerialMarshalledKeyCreator com::sleepycat::collections::TupleSerialFactory::getKeyCreator Class  valueBaseClass,
String  keyName
[inline]
 

Creates a SecondaryKeyCreator object for use in configuring a SecondaryDatabase. The returned object implements the com.sleepycat.db.SecondaryKeyCreator interface.

Parameters:
valueBaseClass the base class of the entity values for this store. It must implement the com.sleepycat.bind.tuple.MarshalledTupleKeyEntity interface.
keyName is the key name passed to the com.sleepycat.bind.tuple.MarshalledTupleKeyEntity#marshalSecondaryKey method to identify the secondary key.

Definition at line 113 of file TupleSerialFactory.java.

Referenced by collections::ship::factory::SampleDatabase::SampleDatabase().

StoredMap com::sleepycat::collections::TupleSerialFactory::newMap Database  db,
Class  keyClass,
Class  valueBaseClass,
boolean  writeAllowed
[inline]
 

Creates a map from a previously opened Database object.

Parameters:
db the previously opened Database object.
keyClass is the class used for map keys. It must implement the com.sleepycat.bind.tuple.MarshalledTupleEntry interface or be one of the Java primitive type classes.
valueBaseClass the base class of the entity values for this store. It must implement the com.sleepycat.bind.tuple.MarshalledTupleKeyEntity interface.
writeAllowed is true to create a read-write collection or false to create a read-only collection.

Definition at line 65 of file TupleSerialFactory.java.

StoredSortedMap com::sleepycat::collections::TupleSerialFactory::newSortedMap Database  db,
Class  keyClass,
Class  valueBaseClass,
boolean  writeAllowed
[inline]
 

Creates a sorted map from a previously opened Database object.

Parameters:
db the previously opened Database object.
keyClass is the class used for map keys. It must implement the com.sleepycat.bind.tuple.MarshalledTupleEntry interface or be one of the Java primitive type classes.
valueBaseClass the base class of the entity values for this store. It must implement the com.sleepycat.bind.tuple.MarshalledTupleKeyEntity interface.
writeAllowed is true to create a read-write collection or false to create a read-only collection.

Definition at line 90 of file TupleSerialFactory.java.

Referenced by collections::ship::factory::SampleViews::SampleViews().


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