com.sleepycat.persist.impl

Class PersistCatalog

java.lang.Object

com.sleepycat.persist.impl.PersistCatalog

All Implemented Interfaces:

Catalog

public class PersistCatalog
extends java.lang.Object
implements Catalog

The catalog of class formats for a store, along with its associated model and mutations.

Author:

Mark Hayes

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	expectNoClassChanges Used by unit tests.
static boolean	unevolvedFormatsEncountered

Fields inherited from interface com.sleepycat.persist.impl.Catalog

BETA_VERSION, CURRENT_VERSION

Constructor Summary

Constructors

Constructor and Description
PersistCatalog(Transaction txn, Environment env, java.lang.String storePrefix, java.lang.String dbName, DatabaseConfig dbConfig, EntityModel modelParam, Mutations mutationsParam, boolean rawAccess, Store store) Creates a new catalog, opening the database and reading it from a given catalog database if it already exists.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	close() Decrements the reference count and closes the catalog DB when it reaches zero.
java.lang.Object	convertRawObject(RawObject o, java.util.IdentityHashMap converted)
Format	createFormat(java.lang.Class type, java.util.Map<java.lang.String,Format> newFormats) If the given class format is not already present in the given map and a format for this class name does not already exist, creates an uninitialized format, adds it to the map, and also collects related formats in the map.
Format	createFormat(java.lang.String clsName, java.util.Map<java.lang.String,Format> newFormats) Convenience method that gets the class for the given class name and calls createFormat with the class object.
void	flush() Used to write the catalog when a format has been changed, for example, when Store.evolve has updated a Format's EvolveNeeded property.
java.util.List<RawType>	getAllRawTypes() Returns all formats as RawTypes.
void	getEntityFormats(java.util.Collection<Format> entityFormats)
Format	getFormat(java.lang.Class cls, boolean openEntitySubclassIndexes) Get a format for a given class, creating it if it does not exist.
Format	getFormat(int formatId) 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) When a format is intialized, this method is called to get the version of the serialized object to be initialized.
Format	getLatestVersion(java.lang.String className)
(package private) java.util.Set<java.lang.String>	getModelClasses() Returns a set of all persistent (non-simple type) class names.
Mutations	getMutations() Returns the current merged mutations.
EntityModel	getResolvedModel() Returns the model parameter, default model or stored model.
(package private) java.util.Map<Format,java.util.Set<Format>>	getSubclassMap() Returns a map from format to a set of its superclass formats.
boolean	isRawAccess()
void	openExisting() Increments the reference count for a catalog that is already open.
(package private) void	useExistingFormat(Format oldFormat) Installs an existing format when no evolution is needed, i.e, when the new and old formats are identical.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

expectNoClassChanges

public static boolean expectNoClassChanges

Used by unit tests.

unevolvedFormatsEncountered

public static boolean unevolvedFormatsEncountered

Constructor Detail

PersistCatalog

public PersistCatalog(Transaction txn,
              Environment env,
              java.lang.String storePrefix,
              java.lang.String dbName,
              DatabaseConfig dbConfig,
              EntityModel modelParam,
              Mutations mutationsParam,
              boolean rawAccess,
              Store store)
               throws DatabaseException

Creates a new catalog, opening the database and reading it from a given catalog database if it already exists. All predefined formats and formats for the given model are added. For modified classes, old formats are defined based on the rules for compatible class changes and the given mutations. If any format is changed or added, and the database is not read-only, write the initialized catalog to the database.

Throws:

DatabaseException

Method Detail

getEntityFormats

public void getEntityFormats(java.util.Collection<Format> entityFormats)

getSubclassMap

java.util.Map<Format,java.util.Set<Format>> getSubclassMap()

Returns a map from format to a set of its superclass formats. The format for simple types, enums and class Object are not included. Only complex types have superclass formats as defined by Format.getSuperFormat.

getResolvedModel

public EntityModel getResolvedModel()

Returns the model parameter, default model or stored model.

openExisting

public void openExisting()

Increments the reference count for a catalog that is already open.

close

public boolean close()
              throws DatabaseException

Decrements the reference count and closes the catalog DB when it reaches zero. Returns true if the database was closed or false if the reference count is still non-zero and the database was left open.

Throws:

DatabaseException

getMutations

public Mutations getMutations()

Returns the current merged mutations.

createFormat

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

Convenience method that gets the class for the given class name and calls createFormat with the class object.

Specified by:

createFormat in interface Catalog

See Also:

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

createFormat

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

If the given class format is not already present in the given map and a format for this class name does not already exist, creates an uninitialized format, adds it to the map, and also collects related formats in the map.

Specified by:

createFormat in interface Catalog

See Also:

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

useExistingFormat

void useExistingFormat(Format oldFormat)

Installs an existing format when no evolution is needed, i.e, when the new and old formats are identical.

getModelClasses

java.util.Set<java.lang.String> getModelClasses()

Returns a set of all persistent (non-simple type) class names.

getAllRawTypes

public java.util.List<RawType> getAllRawTypes()

Returns all formats as RawTypes.

getInitVersion

public int getInitVersion(Format format,
                 boolean forReader)

When a format is intialized, this method is called to get the version of the serialized object to be initialized. See Catalog.

Specified by:

getInitVersion in interface Catalog

getFormat

public Format getFormat(int formatId)

Description copied from interface: Catalog

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

Specified by:

getFormat in interface Catalog

getFormat

public Format getFormat(java.lang.Class cls,
               boolean openEntitySubclassIndexes)

Get a format for a given class, creating it if it does not exist.

This method is called for top level entity instances by PersistEntityBinding. When a new entity subclass format is added we call Store.openSecondaryIndexes so that previously unknown secondary databases can be created, before storing the entity. We do this here while not holding a synchronization mutex, not in addNewFormat, to avoid deadlocks. openSecondaryIndexes synchronizes on the Store. [#15247]

Specified by:

getFormat in interface Catalog

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

getFormat

public Format getFormat(java.lang.String className)

Description copied from interface: Catalog

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

Specified by:

getFormat in interface Catalog

getLatestVersion

public Format getLatestVersion(java.lang.String className)

flush

public void flush()
           throws DatabaseException

Used to write the catalog when a format has been changed, for example, when Store.evolve has updated a Format's EvolveNeeded property. Uses auto-commit.

Throws:

DatabaseException

isRawAccess

public boolean isRawAccess()

Specified by:

isRawAccess in interface Catalog

See Also:

isRawAccess()

convertRawObject

public java.lang.Object convertRawObject(RawObject o,
                                java.util.IdentityHashMap converted)

Specified by:

convertRawObject in interface Catalog

See Also:

convertRawObject(com.sleepycat.persist.raw.RawObject, java.util.IdentityHashMap)