Package one.microstream.storage.types
Class Database.Default
java.lang.Object
one.microstream.storage.types.Database.Default
- All Implemented Interfaces:
PersistenceStoring
,Persister
,ObjectSwizzling
,Database
,DatabasePart
- Enclosing interface:
- Database
public static final class Database.Default extends Object implements Database
-
Nested Class Summary
Nested classes/interfaces inherited from interface one.microstream.storage.types.Database
Database.Default
-
Constructor Summary
Constructors Constructor Description Default()
-
Method Summary
Modifier and Type Method Description Storer
createEagerStorer()
Creates a newStorer
instance with eager storing behavior.Storer
createLazyStorer()
Creates a newStorer
instance with lazy storing behavior.Storer
createStorer()
Creates a newStorer
instance with default storing behavior.String
databaseName()
Returns the identifying name of theDatabase
this part belongs to.Object
getObject(long objectId)
Retrieves the instance associated with the passed objectId.StorageManager
guaranteeActiveStorage()
Database
guaranteeNoActiveStorage()
StorageManager
setStorage(StorageManager storage)
StorageManager
storage()
long
store(Object instance)
Stores the passed instance in any case and all referenced instances of persistable references recursively, but stores referenced instances only if they are newly encountered (e.g.void
storeAll(Iterable<?> instances)
Convenience method toPersistenceStoring.store(Object)
all instances of anIterable
type, usually a collection.
The passed instance itself is NOT stored.
Note that this method does not return an array of objectIds, since the amount of instances supplied by the passedIterable
cannot be known until after all instances have been stored and the memory and performance overhead to collect them dynamically would not be worth it in most cases since the returned array is hardly ever needed.long[]
storeAll(Object... instances)
Convenience method toPersistenceStoring.store(Object)
multiple instances.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface one.microstream.storage.types.Database
hasStorage, toIdentifyingString
-
Constructor Details
-
Default
public Default()
-
-
Method Details
-
databaseName
Description copied from interface:DatabasePart
Returns the identifying name of theDatabase
this part belongs to.- Specified by:
databaseName
in interfaceDatabasePart
- Returns:
- the identifying name of the
Database
.
-
storage
-
guaranteeNoActiveStorage
- Specified by:
guaranteeNoActiveStorage
in interfaceDatabase
-
guaranteeActiveStorage
- Specified by:
guaranteeActiveStorage
in interfaceDatabase
-
setStorage
- Specified by:
setStorage
in interfaceDatabase
-
getObject
Description copied from interface:Persister
Retrieves the instance associated with the passed objectId. Retrieving means guaranteeing that the associated instance is returned. If it does not yet exist, it will be created from persisted data, including all non-lazily referenced objects it is connected to.- Specified by:
getObject
in interfaceObjectSwizzling
- Specified by:
getObject
in interfacePersister
- Parameters:
objectId
- the objectId defining which instance to return.- Returns:
- the instance associated with the passed objectId.
-
store
Description copied from interface:Persister
Stores the passed instance in any case and all referenced instances of persistable references recursively, but stores referenced instances only if they are newly encountered (e.g. don't have an id associated with them in the object registry, yet and are therefore required to be handled). This is useful for the common case of just storing an updated instance and potentially newly created instances along with it while skipping all existing (and normally unchanged) referenced instances.- Specified by:
store
in interfacePersistenceStoring
- Specified by:
store
in interfacePersister
- Parameters:
instance
- the root instance of the subgraph of required instances to be stored.- Returns:
- the object id representing the passed instance.
-
storeAll
Description copied from interface:Persister
Convenience method toPersistenceStoring.store(Object)
multiple instances. The passed array (maybe implicitely created by the compiler) itself is NOT stored.- Specified by:
storeAll
in interfacePersistenceStoring
- Specified by:
storeAll
in interfacePersister
- Parameters:
instances
- multiple root instances of the subgraphs of required instances to be stored.- Returns:
- an array containing the object ids representing the passed instances.
-
storeAll
Description copied from interface:Persister
Convenience method toPersistenceStoring.store(Object)
all instances of anIterable
type, usually a collection.
The passed instance itself is NOT stored.
Note that this method does not return an array of objectIds, since the amount of instances supplied by the passedIterable
cannot be known until after all instances have been stored and the memory and performance overhead to collect them dynamically would not be worth it in most cases since the returned array is hardly ever needed. If it should be needed, the desired behavior can be easily achieved with a tiny custom-made utility method.- Specified by:
storeAll
in interfacePersistenceStoring
- Specified by:
storeAll
in interfacePersister
- Parameters:
instances
- multiple root instances of the subgraphs of required instances to be stored.
-
createLazyStorer
Description copied from interface:Persister
Creates a newStorer
instance with lazy storing behavior. This means an entity instance encountered while traversing the entity graph is only stored if it is not yet known to the persistence context, i.e. does not have an objectId associated with it in the persistence context'sPersistenceObjectRegistry
.- Specified by:
createLazyStorer
in interfacePersister
- Returns:
- the newly created
Storer
instance.
-
createStorer
Description copied from interface:Persister
Creates a newStorer
instance with default storing behavior. The default is lazy storing. SeePersister.createLazyStorer()
.- Specified by:
createStorer
in interfacePersister
- Returns:
- the newly created
Storer
instance.
-
createEagerStorer
Description copied from interface:Persister
Creates a newStorer
instance with eager storing behavior. This means an entity instance encountered while traversing the entity graph is always stored, regardless of if it is already known to the persistence context or not, i.e. does have an objectId associated with it in the persistence context'sPersistenceObjectRegistry
.Note: Eager storing is a dangerous behavior since - depending on the entity graph's referential layout - it can cause the whole entity graph present in the heap to be stored. Therefore, it is stronly advised to instead use lazy storing logic (see
Persister.createLazyStorer()
) or some other kind of limiting storing logic.- Specified by:
createEagerStorer
in interfacePersister
- Returns:
- the newly created
Storer
instance.
-