com.sleepycat.persist.impl

Interface Catalog

All Known Implementing Classes:

ComparatorCatalog, PersistCatalog, ReadOnlyCatalog, SimpleCatalog

interface Catalog

Catalog operation interface used by format classes.

Author:

Mark Hayes

See Also:

PersistCatalog, SimpleCatalog, ReadOnlyCatalog

Field Summary

Fields

Modifier and Type	Field and Description
static int	BETA_VERSION
static int	CURRENT_VERSION

Method Summary

Modifier and Type	Method and Description
java.lang.Object	convertRawObject(RawObject o, IdentityHashMap converted)
Format	createFormat(java.lang.Class type, java.util.Map<java.lang.String,Format> newFormats)
Format	createFormat(java.lang.String clsName, java.util.Map<java.lang.String,Format> newFormats)
Format	getFormat(java.lang.Class cls, boolean checkEntitySubclassIndexes) Returns a format for a given class, or throws an exception.
Format	getFormat(int formatId, boolean expectStored) Returns a format for a given ID, or throws an exception.
Format	getFormat(java.lang.String className) Returns a format by class name.
int	getInitVersion(Format format, boolean forReader) See above.
boolean	isRawAccess()
java.lang.Class	resolveClass(java.lang.String clsName)
java.lang.Class	resolveKeyClass(java.lang.String clsName)

Field Detail

BETA_VERSION

static final int BETA_VERSION

See Also:

Constant Field Values

CURRENT_VERSION

static final int CURRENT_VERSION

See Also:

Constant Field Values

Method Detail

getInitVersion

int getInitVersion(Format format,
                   boolean forReader)

See above.

getFormat

Format getFormat(int formatId,
                 boolean expectStored)
          throws RefreshException

Returns a format for a given ID, or throws an exception. This method is used when reading an object from the byte array format.

Parameters:

expectStored - is true if reading a record from a database, and therefore the format ID is expected to be stored also. If the format ID is not stored, a RefreshException is thrown.

Throws:

java.lang.IllegalStateException - if the formatId does not correspond to a persistent class. This is an internal consistency error.

RefreshException

getFormat

Format getFormat(java.lang.Class cls,
                 boolean checkEntitySubclassIndexes)
          throws RefreshException

Returns a format for a given class, or throws an exception. This method is used when writing an object that was passed in by the user.

Parameters:

checkEntitySubclassIndexes - is true if we're expecting this format to be an entity subclass and therefore subclass secondary indexes should be opened.

Throws:

java.lang.IllegalArgumentException - if the class is not persistent. This is a user error.

RefreshException

getFormat

Format getFormat(java.lang.String className)

Returns a format by class name. Unlike #getFormat(Class), the format will not be created if it is not already known.

createFormat

Format createFormat(java.lang.String clsName,
                    java.util.Map<java.lang.String,Format> newFormats)

See Also:

PersistCatalog.createFormat(java.lang.String, java.util.Map<java.lang.String, com.sleepycat.persist.impl.Format>)

createFormat

Format createFormat(java.lang.Class type,
                    java.util.Map<java.lang.String,Format> newFormats)

See Also:

PersistCatalog.createFormat(java.lang.String, java.util.Map<java.lang.String, com.sleepycat.persist.impl.Format>)

isRawAccess

boolean isRawAccess()

See Also:

PersistCatalog.isRawAccess()

convertRawObject

java.lang.Object convertRawObject(RawObject o,
                                  IdentityHashMap converted)
                           throws RefreshException

Throws:

RefreshException

See Also:

PersistCatalog.convertRawObject(com.sleepycat.persist.raw.RawObject, com.sleepycat.je.utilint.IdentityHashMap)

resolveClass

java.lang.Class resolveClass(java.lang.String clsName)
                      throws java.lang.ClassNotFoundException

Throws:

java.lang.ClassNotFoundException

See Also:

PersistCatalog.resolveClass(java.lang.String)

resolveKeyClass

java.lang.Class resolveKeyClass(java.lang.String clsName)

See Also:

PersistCatalog.resolveKeyClass(java.lang.String)