fr.inria.atlanmod.neoemf.config

Class BaseConfig<C extends BaseConfig<C>>

java.lang.Object

fr.inria.atlanmod.neoemf.config.BaseConfig<C>

Type Parameters:

C - the "self"-type of this Config

All Implemented Interfaces:

Config, ImmutableConfig

Direct Known Subclasses:

BaseBlueprintsConfig, BerkeleyDbConfig, HBaseConfig, InMemoryConfig, MapDbConfig, MongoDbConfig

@ParametersAreNonnullByDefault
public class BaseConfig<C extends BaseConfig<C>>
extends Object
implements Config

The base Config that creates and manages common configuration that are available for all back-end implementations. It also provides all methods for building and querying a configuration.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_PREFIX The base prefix for all internal options key related to the NeoEMF behavior.

Constructor Summary

Constructors

Constructor and Description
BaseConfig() Constructs a new BaseConfig with default settings.

Method Summary

Modifier and Type	Method and Description
C	addListener(StoreListener listener) Adds a store listener in this configuration.
<T> C	addOption(String key, T value) Adds a key/value in this configuration.
C	addStore(Store store) Adds a feature defined by the given store in this configuration.
C	autoSave() Adds the autoSave feature in this configuration.
C	autoSave(long chunk) Adds the autoSave feature, with a defined chunk, in this configuration.
C	cacheContainers() Adds the cache-containers feature in this configuration.
C	cacheFeatures() Adds the cache-features feature in this configuration.
C	cacheMetaClasses() Adds the cache-metaclasses feature in this configuration.
C	cacheSizes() Adds the cache-sizes feature in this configuration.
protected static String	createKey(String... segments) Creates a new key from the given segments.
String	getMapping() Returns the defined mapping.
String	getName() Returns the name of the BackendFactory associated with this configuration.
Map<String,?>	getOptions() Returns all defined options.
Set<Store>	getStores() Returns a set of all defined Store.
String	getVariant() Returns the variant of the BackendFactory binding.
protected Predicate<String>	isPersistentKey() Returns a Predicate used to filter the options to be saved in a configuration file, in order to retrieve them in a future execution.
protected Predicate<String>	isReadOnlyKey() Returns a Predicate used to filter read-only keys.
C	log() Adds the log feature in this configuration.
C	log(Level level) Adds the log feature, with a defined level, in this configuration.
C	merge(ImmutableConfig config) Merges the given config in this configuration.
C	merge(Map<String,?> map) Merges the given map in this configuration.
C	readOnly() Adds the read-only feature in this configuration.
C	recordStats(StoreStats stats) Adds the stats feature in this configuration.
void	save(Path directory) Saves this configuration in the directory.
C	setMapping(String mappingType) Defines the mapping to use for the created Backend.
protected C	setMappingWithCheck(String mappingType, boolean checkConflict) Defines the mapping to use for the created Backend.
Map<String,?>	toMap() Returns a immutable map view of this configuration.

Methods inherited from class java.lang.Object

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

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

exists, forName, forScheme, load

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

getOption, getOptions, hasOption, isReadOnly

Field Detail

BASE_PREFIX

public static final String BASE_PREFIX

The base prefix for all internal options key related to the NeoEMF behavior.

See Also:

Constant Field Values

Constructor Detail

BaseConfig

public BaseConfig()

Constructs a new BaseConfig with default settings.

NOTE: This implementation is intended to configure a Store' chain. The created configuration is not associated with any BackendFactory, so it cannot be used to configure a Backend. Use the specific implementation for this.

Method Detail

createKey

@Nonnull
protected static String createKey(String... segments)

Creates a new key from the given segments. Each segment will be delimited by a dot.

Parameters:

segments - the segments of the key

Returns:

the created key

save

public void save(Path directory)
          throws IOException

Description copied from interface: ImmutableConfig

Saves this configuration in the directory.

Specified by:

save in interface ImmutableConfig

Parameters:

directory - the directory where to store the configuration

Throws:

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

toMap

@Nonnull
public final Map<String,?> toMap()

Description copied from interface: ImmutableConfig

Returns a immutable map view of this configuration.

Specified by:

toMap in interface ImmutableConfig

Returns:

an immutable map

See Also:

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

getName

@Nonnull
public String getName()

Description copied from interface: ImmutableConfig

Returns the name of the BackendFactory associated with this configuration.

Specified by:

getName in interface ImmutableConfig

Returns:

the name

See Also:

BackendFactory.name()

getVariant

@Nonnull
public String getVariant()

Description copied from interface: ImmutableConfig

Returns the variant of the BackendFactory binding.

Specified by:

getVariant in interface ImmutableConfig

Returns:

the variant

getMapping

@Nonnull
public String getMapping()

Description copied from interface: ImmutableConfig

Returns the defined mapping.

Specified by:

getMapping in interface ImmutableConfig

Returns:

the class name of the mapping

setMapping

@Nonnull
public C setMapping(String mappingType)

Description copied from interface: Config

Defines the mapping to use for the created Backend.

Specified by:

setMapping in interface Config

Parameters:

mappingType - the class name of the mapping to use

Returns:

this configuration (for chaining)

addOption

@Nonnull
public <T> C addOption(String key,
                                 T value)

Description copied from interface: Config

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

Specified by:

addOption in interface Config

Type Parameters:

T - the type of the value

Parameters:

key - the key to add

value - the value of the key

Returns:

this configuration (for chaining)

addStore

@Nonnull
public C addStore(Store store)

Description copied from interface: Config

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

Specified by:

addStore in interface Config

Parameters:

store - the store declaration to add

Returns:

this configuration (for chaining)

cacheFeatures

@Nonnull
public C cacheFeatures()

Description copied from interface: Config

Adds the cache-features feature in this configuration.

Specified by:

cacheFeatures in interface Config

Returns:

this configuration (for chaining)

cacheContainers

@Nonnull
public C cacheContainers()

Description copied from interface: Config

Adds the cache-containers feature in this configuration.

Specified by:

cacheContainers in interface Config

Returns:

this configuration (for chaining)

cacheMetaClasses

@Nonnull
public C cacheMetaClasses()

Description copied from interface: Config

Adds the cache-metaclasses feature in this configuration.

Specified by:

cacheMetaClasses in interface Config

Returns:

this configuration (for chaining)

cacheSizes

@Nonnull
public C cacheSizes()

Description copied from interface: Config

Adds the cache-sizes feature in this configuration.

Specified by:

cacheSizes in interface Config

Returns:

this configuration (for chaining)

readOnly

@Nonnull
public C readOnly()

Description copied from interface: Config

Adds the read-only feature in this configuration.

Specified by:

readOnly in interface Config

Returns:

this configuration (for chaining)

autoSave

@Nonnull
public C autoSave()

Description copied from interface: Config

Adds the autoSave feature in this configuration.

Specified by:

autoSave in interface Config

Returns:

this configuration (for chaining)

autoSave

@Nonnull
public C autoSave(long chunk)

Description copied from interface: Config

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

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

Specified by:

autoSave in interface Config

Parameters:

chunk - the number of database operations between each save

Returns:

this configuration (for chaining)

addListener

@Nonnull
public C addListener(StoreListener listener)

Description copied from interface: Config

Adds a store listener in this configuration.

Specified by:

addListener in interface Config

Parameters:

listener - the sotre listener to add

Returns:

this configuration (for chaining)

log

@Nonnull
public C log()

Description copied from interface: Config

Adds the log feature in this configuration.

Specified by:

log in interface Config

Returns:

this configuration (for chaining)

log

@Nonnull
public C log(Level level)

Description copied from interface: Config

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

Specified by:

log in interface Config

Parameters:

level - the logging Level to use

Returns:

this configuration (for chaining)

recordStats

@Nonnull
public C recordStats(StoreStats stats)

Description copied from interface: Config

Adds the stats feature in this configuration.

Specified by:

recordStats in interface Config

Parameters:

stats - the stats that will be updated

Returns:

this configuration (for chaining)

getOptions

@Nonnull
public Map<String,?> getOptions()

Description copied from interface: ImmutableConfig

Returns all defined options.

Specified by:

getOptions in interface ImmutableConfig

Returns:

an immutable map

getStores

@Nonnull
public Set<Store> getStores()

Description copied from interface: ImmutableConfig

Returns a set of all defined Store.

Specified by:

getStores in interface ImmutableConfig

Returns:

an immutable collection of stores declaration

merge

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

Description copied from interface: Config

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

Specified by:

merge in interface Config

Parameters:

map - the map representation of this configuration

Returns:

this configuration (for chaining)

See Also:

ImmutableConfig.toMap()

merge

@Nonnull
public final C merge(ImmutableConfig config)

Description copied from interface: Config

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

Specified by:

merge in interface Config

Parameters:

config - the configuration to merge

Returns:

this configuration (for chaining)

isPersistentKey

@Nonnull
 @OverridingMethodsMustInvokeSuper
protected Predicate<String> isPersistentKey()

Returns a Predicate used to filter the options to be saved in a configuration file, in order to retrieve them in a future execution.

By default, only the options related to a back-end are saved.

Returns:

a new predicate

See Also:

save(Path)

isReadOnlyKey

@Nonnull
 @OverridingMethodsMustInvokeSuper
protected Predicate<String> isReadOnlyKey()

Returns a Predicate used to filter read-only keys. These keys can not be modified after their first declaration.

Returns:

a new predicate

See Also:

addOption(String, Object)

setMappingWithCheck

@Nonnull
protected final C setMappingWithCheck(String mappingType,
                                                boolean checkConflict)

Defines the mapping to use for the created Backend. If the mapping has already been defined and checkConflict == false, then it will be erased by the new.

Parameters:

mappingType - the type name of the mapping to use

checkConflict - true if the mappingType must be compared with the current mapping to check collision

Returns:

this configuration (for chaining)