Package one.microstream.storage.types

Class EmbeddedStorage

java.lang.Object

one.microstream.storage.types.EmbeddedStorage

public final class EmbeddedStorage
extends Object

Static utility class containing static pseudo-constructor methods (indicated by a capital first letter) and various utility methods to setup and start a database.

In the simplest case, the following call is enough to setup and start an embedded object graph database:
EmbeddedStorageManager storage = EmbeddedStorage.start();
Anything beyond that is optimization and customization. As it should be.

Constructor Summary

Constructors

Constructor	Description
EmbeddedStorage()

Method Summary

Modifier and Type	Method	Description
static EmbeddedStorageConnectionFoundation<?>	ConnectionFoundation(File directory)	Pseudo-constructor method to create a new EmbeddedStorageConnectionFoundation instance using the passed directory and default method references provided by Persistence.
static EmbeddedStorageConnectionFoundation<?>	ConnectionFoundation(PersistenceTypeDictionaryIoHandler typeDictionaryIoHandler)	Pseudo-constructor method to create a new EmbeddedStorageConnectionFoundation instance using the passed PersistenceTypeDictionaryIoHandler and default method references provided by Persistence.
static EmbeddedStorageConnectionFoundation<?>	ConnectionFoundation(PersistenceTypeDictionaryIoHandler typeDictionaryIoHandler, PersistenceTypeEvaluator typeEvaluatorPersistable)	Pseudo-constructor method to create a new EmbeddedStorageConnectionFoundation instance using the passed logic instances as its essential parts.
static EmbeddedStorageFoundation<?>	createFoundation()	Creates an instance of an EmbeddedStorageFoundation default implementation without any assembly parts set.
static File	defaultStorageDirectory()	Returns the default storage directory in the current working directory and with a filename defined by StorageFileProvider.Defaults.defaultStorageDirectory().
static EmbeddedStorageFoundation<?>	Foundation()	Pseudo-constructor method to create a new EmbeddedStorageFoundation instance using defaultStorageDirectory() as its storage directory and default values for its StorageConfiguration.
static EmbeddedStorageFoundation<?>	Foundation(File directory)	Pseudo-constructor method to create a new EmbeddedStorageFoundation instance using the passed directory and default values for the remaining parts of its StorageConfiguration.
static EmbeddedStorageFoundation<?>	Foundation(StorageConfiguration configuration)	Pseudo-constructor method to create a new EmbeddedStorageFoundation instance using the passed StorageConfiguration.
static EmbeddedStorageFoundation<?>	Foundation(StorageConfiguration.Builder<?> configuration)	Pseudo-constructor method to create a new EmbeddedStorageFoundation instance using the passed StorageConfiguration.Builder to build its StorageConfiguration.
static EmbeddedStorageFoundation<?>	Foundation(StorageConfiguration configuration, EmbeddedStorageConnectionFoundation<?> connectionFoundation)	Pseudo-constructor method to create a new EmbeddedStorageFoundation instance using the passed StorageConfiguration and EmbeddedStorageConnectionFoundation.
static EmbeddedStorageManager	start()	Convenience method to configure, create and start a EmbeddedStorageManager using purely default values.
static EmbeddedStorageManager	start(File directory)	Convenience method to configure, create and start a EmbeddedStorageManager using the passed directory as its storage location and defaults for the remainings values.
static EmbeddedStorageManager	start(Object root)	Convenience method to configure, create and start a EmbeddedStorageManager using the passed root as the persistent entity graph's root instance and defaults for the remainings values.
static EmbeddedStorageManager	start(Object root, File directory)	Convenience method to configure, create and start a EmbeddedStorageManager using the passed root as the persistent entity graph's root instance, the passed directory as its storage location and defaults for the remainings values.
static EmbeddedStorageManager	start(Object root, StorageConfiguration configuration)	Convenience method to configure, create and start a EmbeddedStorageManager using the passed root as the persistent entity graph's root instance and the passed StorageConfiguration.
static EmbeddedStorageManager	start(Object root, StorageConfiguration.Builder<?> configuration)	Convenience method to configure, create and start a EmbeddedStorageManager using the passed root as the persistent entity graph's root instance and the passed StorageConfiguration.Builder to build its StorageConfiguration.
static EmbeddedStorageManager	start(Object root, StorageConfiguration configuration, EmbeddedStorageConnectionFoundation<?> connectionFoundation)	Convenience method to configure, create and start a EmbeddedStorageManager using the passed root as the persistent entity graph's root instance,StorageConfiguration and EmbeddedStorageConnectionFoundation.
static EmbeddedStorageManager	start(StorageConfiguration configuration)	Convenience method to configure, create and start a EmbeddedStorageManager using the passed StorageConfiguration.
static EmbeddedStorageManager	start(StorageConfiguration.Builder<?> configuration)	Convenience method to configure, create and start a EmbeddedStorageManager using the passed StorageConfiguration.Builder to build its StorageConfiguration.
static EmbeddedStorageManager	start(StorageConfiguration configuration, EmbeddedStorageConnectionFoundation<?> connectionFoundation)	Convenience method to configure, create and start a EmbeddedStorageManager using the passed StorageConfiguration and EmbeddedStorageConnectionFoundation.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmbeddedStorage

public EmbeddedStorage()

Method Detail

createFoundation

public static final EmbeddedStorageFoundation<?> createFoundation()

Creates an instance of an EmbeddedStorageFoundation default implementation without any assembly parts set.

Returns:

a new EmbeddedStorageFoundation instance.

ConnectionFoundation

public static final EmbeddedStorageConnectionFoundation<?> ConnectionFoundation(PersistenceTypeDictionaryIoHandler typeDictionaryIoHandler)

Pseudo-constructor method to create a new EmbeddedStorageConnectionFoundation instance using the passed PersistenceTypeDictionaryIoHandler and default method references provided by Persistence.

Calls ConnectionFoundation(PersistenceTypeDictionaryIoHandler,PersistenceTypeEvaluator)with Persistence.isPersistable(Class) method references as the other parameter.

For explanations and customizing values, see ConnectionFoundation(PersistenceTypeDictionaryIoHandler,PersistenceTypeEvaluator).

Parameters:

typeDictionaryIoHandler - a logic instance to handle a type dictionary's IO operations.

Returns:

a new EmbeddedStorageConnectionFoundation instance.

See Also:

ConnectionFoundation(File), ConnectionFoundation(PersistenceTypeDictionaryIoHandler,PersistenceTypeEvaluator), Persistence

ConnectionFoundation

public static final EmbeddedStorageConnectionFoundation<?> ConnectionFoundation(File directory)

Pseudo-constructor method to create a new EmbeddedStorageConnectionFoundation instance using the passed directory and default method references provided by Persistence.

Calls ConnectionFoundation(PersistenceTypeDictionaryIoHandler) with aPersistenceTypeDictionaryIoHandler instance constructed from the passed directory.

Parameters:

directory - the directory where the PersistenceTypeDictionary information will be stored.

Returns:

a new EmbeddedStorageConnectionFoundation instance.

See Also:

PersistenceTypeDictionaryFileHandler.NewInDirectory(File), ConnectionFoundation(PersistenceTypeDictionaryIoHandler), ConnectionFoundation(PersistenceTypeDictionaryIoHandler,PersistenceTypeEvaluator), Persistence

ConnectionFoundation

public static final EmbeddedStorageConnectionFoundation<?> ConnectionFoundation(PersistenceTypeDictionaryIoHandler typeDictionaryIoHandler,
                                                                                PersistenceTypeEvaluator typeEvaluatorPersistable)

Pseudo-constructor method to create a new EmbeddedStorageConnectionFoundation instance using the passed logic instances as its essential parts.

Parameters:

typeDictionaryIoHandler - a logic instance to handle a type dictionary's IO operations.

typeEvaluatorPersistable - evaluator function to determine if instances of a type are persistable.

Returns:

a new EmbeddedStorageConnectionFoundation instance.

See Also:

ConnectionFoundation(PersistenceTypeDictionaryIoHandler), ConnectionFoundation(File)

defaultStorageDirectory

public static File defaultStorageDirectory()

Returns the default storage directory in the current working directory and with a filename defined by StorageFileProvider.Defaults.defaultStorageDirectory().

Returns:

the default storage directory located in the current working directory.

Foundation

public static final EmbeddedStorageFoundation<?> Foundation()

Pseudo-constructor method to create a new EmbeddedStorageFoundation instance using defaultStorageDirectory() as its storage directory and default values for its StorageConfiguration.

Calls ConnectionFoundation(File) with defaultStorageDirectory().

Returns:

a new all-default EmbeddedStorageFoundation instance.

See Also:

Foundation(File), Foundation(StorageConfiguration), Foundation(StorageConfiguration.Builder), #Foundation(File,StorageConfiguration.Builder), Foundation(StorageConfiguration,EmbeddedStorageConnectionFoundation)

Foundation

public static final EmbeddedStorageFoundation<?> Foundation(File directory)

Pseudo-constructor method to create a new EmbeddedStorageFoundation instance using the passed directory and default values for the remaining parts of its StorageConfiguration.

Calls Foundation(StorageConfiguration) with a newly createdStorageConfiguration using the passed directory as its storage location.

Parameters:

directory -

Returns:

a new EmbeddedStorageFoundation instance using the passed storage directory.

See Also:

Foundation(), Foundation(StorageConfiguration), Foundation(StorageConfiguration.Builder), #Foundation(File,StorageConfiguration.Builder), Foundation(StorageConfiguration,EmbeddedStorageConnectionFoundation)

Foundation

public static final EmbeddedStorageFoundation<?> Foundation(StorageConfiguration configuration)

Pseudo-constructor method to create a new EmbeddedStorageFoundation instance using the passed StorageConfiguration.

Parameters:

configuration - the StorageConfiguration to be used.

Returns:

a new EmbeddedStorageFoundation instance using the passed configuration.

See Also:

Foundation(), Foundation(File), Foundation(StorageConfiguration.Builder), Foundation(StorageConfiguration,EmbeddedStorageConnectionFoundation)

Foundation

public static final EmbeddedStorageFoundation<?> Foundation(StorageConfiguration.Builder<?> configuration)

Pseudo-constructor method to create a new EmbeddedStorageFoundation instance using the passed StorageConfiguration.Builder to build its StorageConfiguration.

This is merely a convenience alias for Foundation(configuration.createConfiguration());

Parameters:

configuration - the StorageConfiguration.Builder to be used.

Returns:

a new EmbeddedStorageFoundation instance using the passed directory and configuration.

See Also:

Foundation(), Foundation(File), Foundation(StorageConfiguration), Foundation(StorageConfiguration,EmbeddedStorageConnectionFoundation)

Foundation

public static final EmbeddedStorageFoundation<?> Foundation(StorageConfiguration configuration,
                                                            EmbeddedStorageConnectionFoundation<?> connectionFoundation)

Pseudo-constructor method to create a new EmbeddedStorageFoundation instance using the passed StorageConfiguration and EmbeddedStorageConnectionFoundation.

Parameters:

configuration - the StorageConfiguration to be used.

connectionFoundation - the EmbeddedStorageConnectionFoundation instance to be used for creating new connections, i.e. the context for issuing commands and storing and loading data.

Returns:

a new EmbeddedStorageFoundation instance using the passed configuration.

See Also:

Foundation(), Foundation(File), Foundation(StorageConfiguration), Foundation(StorageConfiguration.Builder)

start

public static final EmbeddedStorageManager start()

Convenience method to configure, create and start a EmbeddedStorageManager using purely default values.

See Foundation() variants for more practical/configurable alternatives.

Returns:

an EmbeddedStorageManager instance connected to an actively running database.

See Also:

start(File), start(StorageConfiguration), start(StorageConfiguration.Builder), #start(File,StorageConfiguration.Builder), start(StorageConfiguration,EmbeddedStorageConnectionFoundation)

start

public static final EmbeddedStorageManager start(File directory)

Convenience method to configure, create and start a EmbeddedStorageManager using the passed directory as its storage location and defaults for the remainings values.

See Foundation() variants for more practical/configurable alternatives.

Parameters:

directory - the directory where the storage will be located.

Returns:

an EmbeddedStorageManager instance connected to an actively running database.

See Also:

start(), start(StorageConfiguration), start(StorageConfiguration.Builder), #start(File,StorageConfiguration.Builder), start(StorageConfiguration,EmbeddedStorageConnectionFoundation)

start

public static final EmbeddedStorageManager start(StorageConfiguration configuration)

Convenience method to configure, create and start a EmbeddedStorageManager using the passed StorageConfiguration.

See Foundation() variants for more practical/configurable alternatives.

Parameters:

configuration - the StorageConfiguration to be used.

Returns:

an EmbeddedStorageManager instance connected to an actively running database.

See Also:

start(), start(File), start(StorageConfiguration.Builder), #start(File,StorageConfiguration.Builder), start(StorageConfiguration,EmbeddedStorageConnectionFoundation)

start

public static final EmbeddedStorageManager start(StorageConfiguration.Builder<?> configuration)

Convenience method to configure, create and start a EmbeddedStorageManager using the passed StorageConfiguration.Builder to build its StorageConfiguration.

See Foundation() variants for more practical/configurable alternatives.

Parameters:

configuration - the StorageConfiguration.Builder to be used.

Returns:

an EmbeddedStorageManager instance connected to an actively running database.

See Also:

start(), start(File), start(StorageConfiguration), #start(File,StorageConfiguration.Builder), start(StorageConfiguration,EmbeddedStorageConnectionFoundation)

start

public static final EmbeddedStorageManager start(StorageConfiguration configuration,
                                                 EmbeddedStorageConnectionFoundation<?> connectionFoundation)

Convenience method to configure, create and start a EmbeddedStorageManager using the passed StorageConfiguration and EmbeddedStorageConnectionFoundation.

See Foundation() variants for more practical/configurable alternatives.

Parameters:

configuration - the StorageConfiguration to be used.

connectionFoundation - the EmbeddedStorageConnectionFoundation to be used instead of a generically created one.

Returns:

an EmbeddedStorageManager instance connected to an actively running database.

See Also:

start(), start(File), start(StorageConfiguration), start(StorageConfiguration.Builder), #start(File,StorageConfiguration.Builder)

start

public static final EmbeddedStorageManager start(Object root)

Convenience method to configure, create and start a EmbeddedStorageManager using the passed root as the persistent entity graph's root instance and defaults for the remainings values.

See Foundation() variants for more practical/configurable alternatives.

Parameters:

root - the explicitely defined root instance of the persistent entity graph.

Returns:

an EmbeddedStorageManager instance connected to an actively running database.

See Also:

start(Object,File), start(Object,StorageConfiguration), start(Object,StorageConfiguration.Builder), #start(Object,File,StorageConfiguration.Builder), start(Object,StorageConfiguration,EmbeddedStorageConnectionFoundation)

start

public static final EmbeddedStorageManager start(Object root,
                                                 File directory)

Convenience method to configure, create and start a EmbeddedStorageManager using the passed root as the persistent entity graph's root instance, the passed directory as its storage location and defaults for the remainings values.

See Foundation() variants for more practical/configurable alternatives.

Parameters:

root - the explicitely defined root instance of the persistent entity graph.

directory - the directory where the storage will be located.

Returns:

an EmbeddedStorageManager instance connected to an actively running database.

See Also:

start(Object), start(Object,StorageConfiguration), start(Object,StorageConfiguration.Builder), #start(Object,File,StorageConfiguration.Builder), start(Object,StorageConfiguration,EmbeddedStorageConnectionFoundation)

start

public static final EmbeddedStorageManager start(Object root,
                                                 StorageConfiguration configuration)

Convenience method to configure, create and start a EmbeddedStorageManager using the passed root as the persistent entity graph's root instance and the passed StorageConfiguration.

See Foundation() variants for more practical/configurable alternatives.

Parameters:

root - the explicitely defined root instance of the persistent entity graph.

configuration - the StorageConfiguration to be used.

Returns:

an EmbeddedStorageManager instance connected to an actively running database.

See Also:

start(Object), start(Object,File), start(Object,StorageConfiguration.Builder), #start(Object,File,StorageConfiguration.Builder), start(Object,StorageConfiguration,EmbeddedStorageConnectionFoundation)

start

public static final EmbeddedStorageManager start(Object root,
                                                 StorageConfiguration.Builder<?> configuration)

Convenience method to configure, create and start a EmbeddedStorageManager using the passed root as the persistent entity graph's root instance and the passed StorageConfiguration.Builder to build its StorageConfiguration.

See Foundation() variants for more practical/configurable alternatives.

Parameters:

root - the explicitely defined root instance of the persistent entity graph.

configuration - the StorageConfiguration.Builder to be used.

Returns:

an EmbeddedStorageManager instance connected to an actively running database.

See Also:

start(Object), start(Object,File), start(Object,StorageConfiguration), #start(Object,File,StorageConfiguration.Builder), start(Object,StorageConfiguration,EmbeddedStorageConnectionFoundation)

start

public static final EmbeddedStorageManager start(Object root,
                                                 StorageConfiguration configuration,
                                                 EmbeddedStorageConnectionFoundation<?> connectionFoundation)

Convenience method to configure, create and start a EmbeddedStorageManager using the passed root as the persistent entity graph's root instance,StorageConfiguration and EmbeddedStorageConnectionFoundation.

See Foundation() variants for more practical/configurable alternatives.

Parameters:

root - the explicitely defined root instance of the persistent entity graph.

configuration - the StorageConfiguration to be used.

connectionFoundation - the EmbeddedStorageConnectionFoundation to be used instead of agenerically created one.

Returns:

an EmbeddedStorageManager instance connected to an actively running database.

See Also:

start(Object), start(Object,File), start(Object,StorageConfiguration), start(Object,StorageConfiguration.Builder), #start(Object,File,StorageConfiguration.Builder)