fr.inria.atlanmod.neoemf.data.blueprints.config

Class BaseBlueprintsConfig<C extends BaseBlueprintsConfig<C>>

java.lang.Object

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

fr.inria.atlanmod.neoemf.data.blueprints.config.BaseBlueprintsConfig<C>

Type Parameters:

C - the "self"-type of this Config

All Implemented Interfaces:

Config, ImmutableConfig

Direct Known Subclasses:

BlueprintsNeo4jConfig, BlueprintsTinkerConfig

@ParametersAreNonnullByDefault
public class BaseBlueprintsConfig<C extends BaseBlueprintsConfig<C>>
extends BaseConfig<C>

The base Config that provides utility methods to create generic Blueprints 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	BLUEPRINTS_PREFIX The base prefix for all options related to Blueprints, whatever the implementation.

Fields inherited from class fr.inria.atlanmod.neoemf.config.BaseConfig

BASE_PREFIX

Constructor Summary

Constructors

Constructor and Description
BaseBlueprintsConfig() Constructs a new BaseBlueprintsConfig.

Method Summary

Modifier and Type	Method and Description
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.
protected void	setGraph(Class<? extends com.tinkerpop.blueprints.Graph> graph) Defines the graph implementation of the Blueprints database.
void	setLocation(Path directory) Defines the location of the Blueprints database.
protected C	withDefault() Defines the mapping to use for the created BlueprintsBackend.

Methods inherited from class fr.inria.atlanmod.neoemf.config.BaseConfig

addListener, addOption, addStore, autoSave, autoSave, cacheContainers, cacheFeatures, cacheMetaClasses, cacheSizes, createKey, getMapping, getName, getOptions, getStores, getVariant, log, log, merge, merge, readOnly, recordStats, save, setMapping, setMappingWithCheck, toMap

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

BLUEPRINTS_PREFIX

public static final String BLUEPRINTS_PREFIX

The base prefix for all options related to Blueprints, whatever the implementation.

See Also:

Constant Field Values

Constructor Detail

BaseBlueprintsConfig

public BaseBlueprintsConfig()

Constructs a new BaseBlueprintsConfig.

Method Detail

withDefault

@Nonnull
protected C withDefault()

Defines the mapping to use for the created BlueprintsBackend.

This mapping corresponds to a simple representation of multi-valued features, by using the AbstractFeatureBean.position().

NOTE: This is the default mapping.

Returns:

this configuration (for chaining)

setGraph

protected void setGraph(Class<? extends com.tinkerpop.blueprints.Graph> graph)

Defines the graph implementation of the Blueprints database.

Parameters:

graph - the fully qualified name of the class of the Blueprints graph

Throws:

InvalidConfigException - if the graph is already defined and its value is different from the given graph

setLocation

public void setLocation(Path directory)

Defines the location of the Blueprints database.

NOTE: This option is intended to be used internally by the BlueprintsBackendFactory.

Parameters:

directory - the location of the database

isPersistentKey

@Nonnull
protected Predicate<String> isPersistentKey()

Description copied from class: BaseConfig

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.

Overrides:

isPersistentKey in class BaseConfig<C extends BaseBlueprintsConfig<C>>

Returns:

a new predicate

See Also:

BaseConfig.save(Path)

isReadOnlyKey

@Nonnull
protected Predicate<String> isReadOnlyKey()

Description copied from class: BaseConfig

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

Overrides:

isReadOnlyKey in class BaseConfig<C extends BaseBlueprintsConfig<C>>

Returns:

a new predicate

See Also:

BaseConfig.addOption(String, Object)