-TupleSerialFactory (Oracle - Berkeley DB Java API) -

java.lang.Object
+
- com.sleepycat.collections.TupleSerialFactory
+

+
+
+
```
public class TupleSerialFactory
+extends java.lang.Object
```
+
Creates stored collections having tuple keys and serialized entity values. The entity classes must be Serializable and must implement the 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. -
- -
-
- -
- + classes. Underlying binding objects are created automatically.
+

- - - - - - - - - -

-Constructor Summary
`TupleSerialFactory(ClassCatalog catalog)` - - - Creates a tuple-serial factory for given environment and class catalog.

- +

+ + +
Constructor Summary
+ + + + + + + + +
Constructors
Constructor and Description
TupleSerialFactory(ClassCatalog catalog) +
Creates a tuple-serial factory for given environment and class catalog.
+
+

Constructors
Constructor and Description
`TupleSerialFactory(ClassCatalog catalog)` + Creates a tuple-serial factory for given environment and class catalog. +

- - - - - - - - - - - - - - - - - - - - - - - - - - -

-Method Summary

- ClassCatalog getCatalog() - -
- Returns the class catalog associated with this factory.


-
-
-
-
-
-<V extends MarshalledTupleKeyEntity> 
-

-TupleSerialMarshalledBinding<V>
-

getEntityBinding(Class<V> baseClass) - -
-


-
-
-
-
-
-<V extends MarshalledTupleKeyEntity> 
-

-TupleSerialMarshalledKeyCreator<V>
-

getKeyCreator(Class<V> valueBaseClass,
-              String keyName)

- -
- Creates a SecondaryKeyCreator object for use in configuring - a SecondaryDatabase.


-
-
-
-
-
-<K,V extends MarshalledTupleKeyEntity> 
-

-StoredMap<K,V>
-

newMap(Database db,
-       Class<K> keyClass,
-       Class<V> valueBaseClass,
-       boolean writeAllowed)

- -
- Creates a map from a previously opened Database object.


-
-
-
-
-
-<K,V extends MarshalledTupleKeyEntity> 
-

-StoredSortedMap<K,V>
-

newSortedMap(Database db,
-             Class<K> keyClass,
-             Class<V> valueBaseClass,
-             boolean writeAllowed)

- -
- Creates a sorted map from a previously opened Database object.

- - - - - - - - -

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- -

- +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + +

Methods
Modifier and Type	Method and Description
`ClassCatalog`	`getCatalog()` + Returns the class catalog associated with this factory. +
`<V extends MarshalledTupleKeyEntity> TupleSerialMarshalledBinding<V>`	`getEntityBinding(java.lang.Class<V> baseClass)`
`<V extends MarshalledTupleKeyEntity> TupleSerialMarshalledKeyCreator<V>`	`getKeyCreator(java.lang.Class<V> valueBaseClass, + java.lang.String keyName)` + Creates a `SecondaryKeyCreator` object for use in configuring + a `SecondaryDatabase`. +
`<K,V extends MarshalledTupleKeyEntity> StoredMap<K,V>`	`newMap(Database db, + java.lang.Class<K> keyClass, + java.lang.Class<V> valueBaseClass, + boolean writeAllowed)` + Creates a map from a previously opened Database object. +
`<K,V extends MarshalledTupleKeyEntity> StoredSortedMap<K,V>`	`newSortedMap(Database db, + java.lang.Class<K> keyClass, + java.lang.Class<V> valueBaseClass, + boolean writeAllowed)` + Creates a sorted map from a previously opened Database object. +

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- - - - - - -
-Constructor Detail
- -
-TupleSerialFactory
-
```
-public TupleSerialFactory(ClassCatalog catalog)
```
-
-
Creates a tuple-serial factory for given environment and class catalog. -
-
- +
- + + +
  Constructor Detail
  + + + +
  - +
    TupleSerialFactory
    +
```
public TupleSerialFactory(ClassCatalog catalog)
```
    +
    Creates a tuple-serial factory for given environment and class catalog.
    +
  +
- - - - - - -
-Method Detail
- -
-getCatalog
-
```
-public final ClassCatalog getCatalog()
```
-
-
Returns the class catalog associated with this factory. -
-
-
-
-
-
- -
-newMap
-
```
-public <K,V extends MarshalledTupleKeyEntity> StoredMap<K,V> newMap(Database db,
-                                                                    Class<K> keyClass,
-                                                                    Class<V> valueBaseClass,
-                                                                    boolean writeAllowed)
```
-
-
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 - 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 MarshalledTupleKeyEntity - interface.
writeAllowed - is true to create a read-write collection or false - to create a read-only collection.
-
-
-
- -
-newSortedMap
-
```
-public <K,V extends MarshalledTupleKeyEntity> StoredSortedMap<K,V> newSortedMap(Database db,
-                                                                                Class<K> keyClass,
-                                                                                Class<V> valueBaseClass,
-                                                                                boolean writeAllowed)
```
-
-
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 - 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 MarshalledTupleKeyEntity - interface.
writeAllowed - is true to create a read-write collection or false - to create a read-only collection.
-
-
-
- -
-getKeyCreator
-
```
-public <V extends MarshalledTupleKeyEntity> TupleSerialMarshalledKeyCreator<V> getKeyCreator(Class<V> valueBaseClass,
-                                                                                             String keyName)
```
-
-
Creates a SecondaryKeyCreator object for use in configuring +
- + + +
  Method Detail
  + + + +
  - +
    getCatalog
    +
    public final ClassCatalog getCatalog()
    +
    Returns the class catalog associated with this factory.
    +
  + + + +
  - +
    newMap
    +
    public <K,V extends MarshalledTupleKeyEntity> StoredMap<K,V> newMap(Database db, + java.lang.Class<K> keyClass, + java.lang.Class<V> valueBaseClass, + boolean writeAllowed)
    +
    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 + 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 MarshalledTupleKeyEntity + interface.
    writeAllowed - is true to create a read-write collection or false + to create a read-only collection.
    +
  + + + +
  - +
    newSortedMap
    +
    public <K,V extends MarshalledTupleKeyEntity> StoredSortedMap<K,V> newSortedMap(Database db, + java.lang.Class<K> keyClass, + java.lang.Class<V> valueBaseClass, + boolean writeAllowed)
    +
    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 + 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 MarshalledTupleKeyEntity + interface.
    writeAllowed - is true to create a read-write collection or false + to create a read-only collection.
    +
  + + + +
  - +
    getKeyCreator
    +
    public <V extends MarshalledTupleKeyEntity> TupleSerialMarshalledKeyCreator<V> getKeyCreator(java.lang.Class<V> valueBaseClass, + java.lang.String keyName)
    +
    Creates a SecondaryKeyCreator object for use in configuring a SecondaryDatabase. The returned object implements - the SecondaryKeyCreator interface. -
    -
    -
    Parameters:
    valueBaseClass - the base class of the entity values for this - store. It must implement the MarshalledTupleKeyEntity - interface.
    keyName - is the key name passed to the MarshalledTupleKeyEntity.marshalSecondaryKey(java.lang.String, com.sleepycat.bind.tuple.TupleOutput) method to identify the - secondary key.
    -
    -
-
- -
-getEntityBinding
-
```
-public <V extends MarshalledTupleKeyEntity> TupleSerialMarshalledBinding<V> getEntityBinding(Class<V> baseClass)
```
-
-
-
-
-
+ the SecondaryKeyCreator interface.

Parameters:: valueBaseClass - the base class of the entity values for this + store. It must implement the MarshalledTupleKeyEntity + interface.; keyName - is the key name passed to the MarshalledTupleKeyEntity.marshalSecondaryKey(java.lang.String, com.sleepycat.bind.tuple.TupleOutput) method to identify the + secondary key.

+ + + + + +

getEntityBinding

public <V extends MarshalledTupleKeyEntity> TupleSerialMarshalledBinding<V> getEntityBinding(java.lang.Class<V> baseClass)

+ + + + +

- -com.sleepycat.collections -
-Class TupleSerialFactory

Class TupleSerialFactory

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object