fr.inria.atlanmod.neoemf.config

Interface Config

All Superinterfaces:

ImmutableConfig

All Known Implementing Classes:

BaseBlueprintsConfig, BaseConfig, BerkeleyDbConfig, BlueprintsNeo4jConfig, BlueprintsTinkerConfig, HBaseConfig, InMemoryConfig, MapDbConfig, MongoDbConfig

@ParametersAreNonnullByDefault
public interface Config
extends ImmutableConfig

A configuration that builds the behavior of BackendFactories and StoreFactory.

All features are all optional: configuration can be created using all or none of them.

See Also:

Resource.load(Map), Resource.save(Map)

Method Summary

Modifier and Type	Method and Description
Config	addListener(StoreListener listener) Adds a store listener in this configuration.
<V> Config	addOption(String key, V value) Adds a key/value in this configuration.
Config	addStore(Store store) Adds a feature defined by the given store in this configuration.
Config	autoSave() Adds the autoSave feature in this configuration.
Config	autoSave(long chunk) Adds the autoSave feature, with a defined chunk, in this configuration.
Config	cacheContainers() Adds the cache-containers feature in this configuration.
Config	cacheFeatures() Adds the cache-features feature in this configuration.
Config	cacheMetaClasses() Adds the cache-metaclasses feature in this configuration.
Config	cacheSizes() Adds the cache-sizes feature in this configuration.
static boolean	exists(Path directory) Checks that a configuration file exists in the directory.
static <C extends Config> C	forName(String name, String variant) Retrieves the instance of Config that is associated to a BackendFactory wearing the specified name.
static <C extends Config> C	forScheme(String scheme) Retrieves the instance of Config that is associated to a UriFactory which use the specified scheme.
static <C extends Config> Optional<C>	load(Path directory) Loads a configuration from the directory.
Config	log() Adds the log feature in this configuration.
Config	log(Level level) Adds the log feature, with a defined level, in this configuration.
Config	merge(ImmutableConfig config) Merges the given config in this configuration.
Config	merge(Map<String,?> map) Merges the given map in this configuration.
Config	readOnly() Adds the read-only feature in this configuration.
Config	recordStats(StoreStats stats) Adds the stats feature in this configuration.
Config	setMapping(String mapping) Defines the mapping to use for the created Backend.

Methods inherited from interface fr.inria.atlanmod.neoemf.config.ImmutableConfig

getMapping, getName, getOption, getOptions, getOptions, getStores, getVariant, hasOption, isReadOnly, save, toMap

Method Detail

forName

@Nonnull
static <C extends Config> C forName(String name,
                                              @Nullable
                                              String variant)

Retrieves the instance of Config that is associated to a BackendFactory wearing the specified name.

Type Parameters:

C - the type of the configuration

Parameters:

name - the name of the factory

variant - the variant of the binding

Returns:

a new instance of Config

forScheme

@Nonnull
static <C extends Config> C forScheme(String scheme)

Retrieves the instance of Config that is associated to a UriFactory which use the specified scheme.

Type Parameters:

C - the type of the configuration

Parameters:

scheme - the scheme of the factory

Returns:

a new instance of Config

load

@Nonnull
static <C extends Config> Optional<C> load(Path directory)
                                              throws IOException

Loads a configuration from the directory.

Type Parameters:

C - the type of the configuration

Parameters:

directory - the directory of the configuration to load

Returns:

an Optional containing the configuration, or Optional.empty() if the directory does not contains any configuration

Throws:

IOException - if an I/O error occurs during the saving

See Also:

ConfigFile.exists(Path)

exists

static boolean exists(Path directory)

Checks that a configuration file exists in the directory.

Parameters:

directory - the directory where to look for a configuration

Returns:

true if the directory contains a configuration file

merge

@Nonnull
Config merge(Map<String,?> map)

Merges the given map in this configuration. All options defined in the map will be added to this configuration, with conflict checking.

Parameters:

map - the map representation of this configuration

Returns:

this configuration (for chaining)

See Also:

ImmutableConfig.toMap()

merge

@Nonnull
Config merge(ImmutableConfig config)

Merges the given config in this configuration. All options defined in the config will be added to this configuration, with conflict checking.

Parameters:

config - the configuration to merge

Returns:

this configuration (for chaining)

setMapping

@Nonnull
Config setMapping(String mapping)

Defines the mapping to use for the created Backend.

Parameters:

mapping - the class name of the mapping to use

Returns:

this configuration (for chaining)

Throws:

NullPointerException - if the mapping is null

InvalidConfigException - if the mapping does not represent a DataMapper instance, if the associated class cannot be found or if the mapping is already defined and different from mapping

addOption

@Nonnull
<V> Config addOption(String key,
                               V value)

Adds a key/value in this configuration. A custom configuration, which is not part of NeoEMF, can be added.

Type Parameters:

V - the type of the value

Parameters:

key - the key to add

value - the value of the key

Returns:

this configuration (for chaining)

Throws:

NullPointerException - if any parameter is null

addStore

@Nonnull
Config addStore(Store store)

Adds a feature defined by the given store in this configuration.

Parameters:

store - the store declaration to add

Returns:

this configuration (for chaining)

cacheFeatures

@Nonnull
Config cacheFeatures()

Adds the cache-features feature in this configuration.

Returns:

this configuration (for chaining)

cacheContainers

@Nonnull
Config cacheContainers()

Adds the cache-containers feature in this configuration.

Returns:

this configuration (for chaining)

cacheMetaClasses

@Nonnull
Config cacheMetaClasses()

Adds the cache-metaclasses feature in this configuration.

Returns:

this configuration (for chaining)

cacheSizes

@Nonnull
Config cacheSizes()

Adds the cache-sizes feature in this configuration.

Returns:

this configuration (for chaining)

readOnly

@Nonnull
Config readOnly()

Adds the read-only feature in this configuration.

Returns:

this configuration (for chaining)

autoSave

@Nonnull
Config autoSave()

Adds the autoSave feature in this configuration.

Returns:

this configuration (for chaining)

autoSave

@Nonnull
Config autoSave(@Nonnegative
                          long chunk)

Adds the autoSave feature, with a defined chunk, in this configuration.

WARNING: When chunk is zero, the store will be saved at each call.

Parameters:

chunk - the number of database operations between each save

Returns:

this configuration (for chaining)

Throws:

InvalidConfigException - if the chunk is < 0

addListener

@Nonnull
Config addListener(StoreListener listener)

Adds a store listener in this configuration.

Parameters:

listener - the sotre listener to add

Returns:

this configuration (for chaining)

log

@Nonnull
Config log()

Adds the log feature in this configuration.

Returns:

this configuration (for chaining)

log

@Nonnull
Config log(Level level)

Adds the log feature, with a defined level, in this configuration.

Parameters:

level - the logging Level to use

Returns:

this configuration (for chaining)

Throws:

NullPointerException - if the level is null

recordStats

@Nonnull
Config recordStats(StoreStats stats)

Adds the stats feature in this configuration.

Parameters:

stats - the stats that will be updated

Returns:

this configuration (for chaining)