Package one.microstream.persistence.types

Class PersistenceManager.Default<D>

java.lang.Object

one.microstream.persistence.types.PersistenceManager.Default<D>

All Implemented Interfaces:

ByteOrderTargeting<PersistenceManager<D>>, PersistenceManager<D>, PersistenceObjectIdHolder, PersistenceObjectIdLookup, PersistenceObjectLookup, PersistenceObjectManager<D>, PersistenceRetrieving, PersistenceSourceSupplier<D>, PersistenceStoring, PersistenceSwizzlingLookup, Persister, Unpersistable, ObjectSwizzling, Cloneable<PersistenceObjectManager<D>>

Enclosing interface:

PersistenceManager<D>

public static final class PersistenceManager.Default<D>
extends Object
implements PersistenceManager<D>, Unpersistable

Nested Class Summary

Nested classes/interfaces inherited from interface one.microstream.persistence.types.ByteOrderTargeting

ByteOrderTargeting.Mutable<T extends ByteOrderTargeting.Mutable<?>>

Nested classes/interfaces inherited from interface one.microstream.persistence.types.PersistenceManager

PersistenceManager.Default<D>

Constructor Summary

Constructors

Constructor	Description
Default()

Method Summary

Modifier and Type	Method	Description
void	close()	Closes all ties to outside resources, if applicable.
<C extends Consumer<Object>> C	collect(C collector, long... objectIds)
void	consolidate()
PersistenceStorer	createEagerStorer()	Creates a new Storer instance with eager storing behavior.
PersistenceStorer	createLazyStorer()	Creates a new Storer instance with lazy storing behavior.
PersistenceLoader	createLoader()
PersistenceRegisterer	createRegisterer()
PersistenceStorer	createStorer()	Creates a new Storer instance with default storing behavior.
PersistenceStorer	createStorer(PersistenceStorer.Creator<D> storerCreator)
long	currentObjectId()
long	ensureObjectId(Object object)
<T> long	ensureObjectId(T object, PersistenceObjectIdRequestor<D> objectIdRequestor, PersistenceTypeHandler<D,T> optionalHandler)
<T> long	ensureObjectIdGuaranteedRegister(T object, PersistenceObjectIdRequestor<D> objectIdRequestor, PersistenceTypeHandler<D,T> optionalHandler)
Object	get()
Object	getObject(long objectId)	Retrieves the instance associated with the passed objectId.
ByteOrder	getTargetByteOrder()
Object	lookupObject(long objectId)
long	lookupObjectId(Object object)
void	mergeEntries(PersistenceLocalObjectIdRegistry<D> localRegistry)
PersistenceObjectRegistry	objectRegistry()
boolean	registerLocalRegistry(PersistenceLocalObjectIdRegistry<D> localRegistry)
PersistenceSource<D>	source()
long	store(Object object)	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 to PersistenceStoring.store(Object) all instances of an Iterable 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 passed Iterable 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 to PersistenceStoring.store(Object) multiple instances.
PersistenceTarget<D>	target()
PersistenceTypeDictionary	typeDictionary()
PersistenceManager.Default<D>	updateCurrentObjectId(long currentObjectId)
void	updateMetadata(PersistenceTypeDictionary typeDictionary, long highestTypeId, long highestObjectId)

Methods inherited from class java.lang.Object

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

Methods inherited from interface one.microstream.persistence.types.ByteOrderTargeting

isByteOrderMismatch

Methods inherited from interface one.microstream.persistence.types.PersistenceManager

updateMetadata

Methods inherited from interface one.microstream.persistence.types.PersistenceObjectManager

Clone

Constructor Details

Default

public Default()

Method Details

getTargetByteOrder

public final ByteOrder getTargetByteOrder()

Specified by:

getTargetByteOrder in interface ByteOrderTargeting<D>

objectRegistry

public final PersistenceObjectRegistry objectRegistry()

Specified by:

objectRegistry in interface PersistenceManager<D>

typeDictionary

public final PersistenceTypeDictionary typeDictionary()

Specified by:

typeDictionary in interface PersistenceManager<D>

consolidate

public final void consolidate()

Specified by:

consolidate in interface PersistenceObjectManager<D>

createLazyStorer

public final PersistenceStorer createLazyStorer()

Description copied from interface: Persister

Creates a new Storer 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's PersistenceObjectRegistry.

Specified by:

createLazyStorer in interface PersistenceManager<D>

Specified by:

createLazyStorer in interface Persister

Returns:

the newly created Storer instance.

createStorer

public final PersistenceStorer createStorer()

Description copied from interface: Persister

Creates a new Storer instance with default storing behavior. The default is lazy storing. See Persister.createLazyStorer().

Specified by:

createStorer in interface PersistenceManager<D>

Specified by:

createStorer in interface Persister

Returns:

the newly created Storer instance.

createEagerStorer

public final PersistenceStorer createEagerStorer()

Description copied from interface: Persister

Creates a new Storer 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's PersistenceObjectRegistry.

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 interface PersistenceManager<D>

Specified by:

createEagerStorer in interface Persister

Returns:

the newly created Storer instance.

createStorer

public final PersistenceStorer createStorer(PersistenceStorer.Creator<D> storerCreator)

Specified by:

createStorer in interface PersistenceManager<D>

createRegisterer

public final PersistenceRegisterer createRegisterer()

Specified by:

createRegisterer in interface PersistenceManager<D>

store

public final long store(Object object)

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 interface PersistenceStoring

Specified by:

store in interface Persister

Parameters:

object - the root instance of the subgraph of required instances to be stored.

Returns:

the object id representing the passed instance.

storeAll

public final long[] storeAll(Object... instances)

Description copied from interface: Persister

Convenience method to PersistenceStoring.store(Object) multiple instances. The passed array (maybe implicitely created by the compiler) itself is NOT stored.

Specified by:

storeAll in interface PersistenceStoring

Specified by:

storeAll in interface Persister

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

public void storeAll(Iterable<?> instances)

Description copied from interface: Persister

Convenience method to PersistenceStoring.store(Object) all instances of an Iterable 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 passed Iterable 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 interface PersistenceStoring

Specified by:

storeAll in interface Persister

Parameters:

instances - multiple root instances of the subgraphs of required instances to be stored.

ensureObjectId

public final long ensureObjectId(Object object)

Specified by:

ensureObjectId in interface PersistenceObjectManager<D>

ensureObjectId

public final <T> long ensureObjectId(T object, PersistenceObjectIdRequestor<D> objectIdRequestor, PersistenceTypeHandler<D,T> optionalHandler)

Specified by:

ensureObjectId in interface PersistenceObjectManager<D>

ensureObjectIdGuaranteedRegister

public final <T> long ensureObjectIdGuaranteedRegister(T object, PersistenceObjectIdRequestor<D> objectIdRequestor, PersistenceTypeHandler<D,T> optionalHandler)

Specified by:

ensureObjectIdGuaranteedRegister in interface PersistenceObjectManager<D>

currentObjectId

public long currentObjectId()

Specified by:

currentObjectId in interface PersistenceManager<D>

Specified by:

currentObjectId in interface PersistenceObjectIdHolder

Specified by:

currentObjectId in interface PersistenceObjectManager<D>

lookupObjectId

public final long lookupObjectId(Object object)

Specified by:

lookupObjectId in interface PersistenceObjectIdLookup

lookupObject

public final Object lookupObject(long objectId)

Specified by:

lookupObject in interface PersistenceObjectLookup

registerLocalRegistry

public final boolean registerLocalRegistry(PersistenceLocalObjectIdRegistry<D> localRegistry)

Specified by:

registerLocalRegistry in interface PersistenceObjectManager<D>

mergeEntries

public final void mergeEntries(PersistenceLocalObjectIdRegistry<D> localRegistry)

Specified by:

mergeEntries in interface PersistenceObjectManager<D>

get

public final Object get()

Specified by:

get in interface PersistenceRetrieving

collect

public final <C extends Consumer<Object>> C collect(C collector, long... objectIds)

Specified by:

collect in interface PersistenceRetrieving

getObject

public final Object getObject(long objectId)

Description copied from interface: ObjectSwizzling

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 interface ObjectSwizzling

Specified by:

getObject in interface PersistenceRetrieving

Specified by:

getObject in interface PersistenceSourceSupplier<D>

Specified by:

getObject in interface Persister

Parameters:

objectId - the objectId defining which instance to return.

Returns:

the instance associated with the passed objectId.

createLoader

public final PersistenceLoader createLoader()

Specified by:

createLoader in interface PersistenceManager<D>

source

public final PersistenceSource<D> source()

Specified by:

source in interface PersistenceManager<D>

Specified by:

source in interface PersistenceSourceSupplier<D>

target

public final PersistenceTarget<D> target()

Specified by:

target in interface PersistenceManager<D>

close

public void close()

Description copied from interface: PersistenceManager

Closes all ties to outside resources, if applicable. Typ

Specified by:

close in interface PersistenceManager<D>

updateCurrentObjectId

public PersistenceManager.Default<D> updateCurrentObjectId(long currentObjectId)

Specified by:

updateCurrentObjectId in interface PersistenceManager<D>

Specified by:

updateCurrentObjectId in interface PersistenceObjectIdHolder

Specified by:

updateCurrentObjectId in interface PersistenceObjectManager<D>

updateMetadata

public void updateMetadata(PersistenceTypeDictionary typeDictionary, long highestTypeId, long highestObjectId)

Specified by:

updateMetadata in interface PersistenceManager<D>