|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sleepycat.persist.impl.PersistCatalog
public class PersistCatalog
The catalog of class formats for a store, along with its associated model and mutations.
Field Summary | |
---|---|
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 | |
---|---|
PersistCatalog(Environment env,
String storePrefix,
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. |
|
PersistCatalog(PersistCatalog oldCatalog,
String storePrefix)
Creates a new catalog when a Replica refresh occurs. |
Method Summary | |
---|---|
(package private) void |
checkWriteInReplicaUpgradeMode()
Metadata needs refreshing when a Replica with stale metadata is elected master, and then a user write operation is attempted. |
boolean |
close()
Decrements the reference count and closes the catalog DB when it reaches zero. |
Object |
convertRawObject(RawObject o,
IdentityHashMap converted)
|
Format |
createFormat(Class type,
Map<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(String clsName,
Map<String,Format> newFormats)
Convenience method that gets the class for the given class name and calls createFormat with the class object. |
void |
flush(Transaction txn)
Used to write the catalog when a format has been changed, for example, when Store.evolve has updated a Format's EvolveNeeded property. |
List<RawType> |
getAllRawTypes()
Returns all formats as RawTypes. |
String |
getDatabaseClassName(String className)
Returns the name of an entity class to be used to form the database name. |
String |
getDatabaseKeyName(String className,
String keyName)
Similar to getDatabaseClassName but instead handles an earlier version of a renamed key. |
void |
getEntityFormats(Collection<Format> entityFormats)
|
Format |
getFormat(Class cls,
boolean checkEntitySubclassIndexes)
Get a format for a given class, creating it if it does not exist. |
Format |
getFormat(int formatId,
boolean expectStored)
Returns a format for a given ID, or throws an exception. |
Format |
getFormat(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(String className)
|
(package private) Set<String> |
getModelClasses()
Returns a set of all persistent (non-simple type) class names. |
Mutations |
getMutations()
Returns the current merged mutations. |
(package private) int |
getNFormats()
Returns the number of stored formats. |
EntityModel |
getResolvedModel()
Returns the model parameter, default model or stored model. |
(package private) Map<Format,Set<Format>> |
getSubclassMap()
Returns a map from format to a set of its superclass formats. |
(package private) boolean |
isMetadataStale(Transaction txn)
Metadata needs refreshing when a Replica with stale metadata is elected master, and then a user write operation is attempted that also requires a metadata update. |
boolean |
isRawAccess()
|
boolean |
isReadOnly()
Returns true if the user opened the store read-only, or we're running in Replica upgrade mode. |
(package private) boolean |
isReplicaUpgradeMode()
For unit testing. |
void |
openExisting()
Increments the reference count for a catalog that is already open. |
Class |
resolveClass(String clsName)
|
Class |
resolveKeyClass(String clsName)
|
(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 |
---|
public static boolean expectNoClassChanges
public static boolean unevolvedFormatsEncountered
Constructor Detail |
---|
public PersistCatalog(Environment env, String storePrefix, String dbName, DatabaseConfig dbConfig, EntityModel modelParam, Mutations mutationsParam, boolean rawAccess, Store store) throws StoreExistsException, StoreNotFoundException, IncompatibleClassException, DatabaseException
StoreExistsException
StoreNotFoundException
IncompatibleClassException
DatabaseException
PersistCatalog(PersistCatalog oldCatalog, String storePrefix) throws DatabaseException
DatabaseException
Method Detail |
---|
public void getEntityFormats(Collection<Format> entityFormats)
Map<Format,Set<Format>> getSubclassMap()
public EntityModel getResolvedModel()
public void openExisting()
public boolean isReadOnly()
public boolean close() throws DatabaseException
DatabaseException
public Mutations getMutations()
public Format createFormat(String clsName, Map<String,Format> newFormats)
createFormat
in interface Catalog
createFormat(java.lang.String, java.util.Map)
public Format createFormat(Class type, Map<String,Format> newFormats)
createFormat
in interface Catalog
createFormat(java.lang.String, java.util.Map)
void useExistingFormat(Format oldFormat)
Set<String> getModelClasses()
public List<RawType> getAllRawTypes()
public int getInitVersion(Format format, boolean forReader)
getInitVersion
in interface Catalog
public Format getFormat(int formatId, boolean expectStored) throws RefreshException
Catalog
getFormat
in interface Catalog
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.
RefreshException
public Format getFormat(Class cls, boolean checkEntitySubclassIndexes) throws RefreshException
This method is called for top level entity instances by PersistEntityBinding. When a new entity subclass format is added we call Store.checkEntitySubclassSecondaries to ensure that all secondary databases have been opened, before storing the entity. We do this here while not holding a synchronization mutex, not in addNewFormat, to avoid deadlocks. checkEntitySubclassSecondaries synchronizes on the Store. [#16399]
Historical note: At one time we opened / created the secondary databases rather than requiring the user to open them, see [#15247]. Later we found this to be problematic since a user txn may have locked primary records, see [#16399].
getFormat
in interface Catalog
checkEntitySubclassIndexes
- is true if we're expecting this format
to be an entity subclass and therefore subclass secondary indexes should
be opened.
RefreshException
public Format getFormat(String className)
Catalog
#getFormat(Class)
, the
format will not be created if it is not already known.
getFormat
in interface Catalog
public Format getLatestVersion(String className)
public String getDatabaseClassName(String className)
public String getDatabaseKeyName(String className, String keyName)
void checkWriteInReplicaUpgradeMode() throws RefreshException
RefreshException
boolean isReplicaUpgradeMode()
public void flush(Transaction txn) throws DatabaseException
DatabaseException
int getNFormats()
boolean isMetadataStale(Transaction txn) throws DatabaseException
DatabaseException
public boolean isRawAccess()
isRawAccess
in interface Catalog
isRawAccess()
public Object convertRawObject(RawObject o, IdentityHashMap converted) throws RefreshException
convertRawObject
in interface Catalog
RefreshException
convertRawObject(com.sleepycat.persist.raw.RawObject, com.sleepycat.je.utilint.IdentityHashMap)
public Class resolveClass(String clsName) throws ClassNotFoundException
resolveClass
in interface Catalog
ClassNotFoundException
resolveClass(java.lang.String)
public Class resolveKeyClass(String clsName)
resolveKeyClass
in interface Catalog
resolveKeyClass(java.lang.String)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |