Package fr.inria.atlanmod.neoemf.data.blueprints.neo4j.option

Provides utility classes to define specific behaviors of Neo4j data persistence.

See: Description

Interface Summary

Interface	Description
BlueprintsNeo4jResourceOptions	PersistentResourceOptions that hold Blueprints Neo4j related resource-level features, such as cache type, usage of memory mapped files, or internal buffer sizes.

Class Summary

Class	Description
BlueprintsNeo4jOptions	A PersistenceOptions that holds Blueprints Neo4j specific options.
BlueprintsNeo4jOptionsBuilder	A specific AbstractBlueprintsOptionsBuilder that creates Blueprints Neo4j specific options.

Enum Summary

Enum	Description
BlueprintsNeo4jResourceOptions.CacheType	Possible values for BlueprintsNeo4jResourceOptions.CACHE_TYPE.

Package fr.inria.atlanmod.neoemf.data.blueprints.neo4j.option Description

Provides utility classes to define specific behaviors of Neo4j data persistence.

This package defines two APIs extending BlueprintsResourceOptions and BlueprintsOptionsBuilder:

• BlueprintsNeo4jResourceOptions: defines Neo4j-specific options, such as the database cache strategy (weak, soft, strong), the size of the internal buffers, or the usage of memory mapped files. Neo4j specific options can be combined with Blueprints and generic options defined in BlueprintsResourceOptions and PersistentResourceOptions
• BlueprintsNeo4jOptionsBuilder: a fluent API allowing to easily set Neo4j specific options in client applications. Since the builder extends BlueprintsOptionsBuilder it can be used to combine Neo4j, Blueprints, and generic options.

These classes are used to create option maps used in EMF save and load methods. For example, the following code creates a map that tells the framework to use a Neo4j backend with a database soft cache strategy and a generic cache storing accessed features to retrieve them efficiently. The database cache policy is a Neo4j specific option, while the feature caching behavior is defined at the core level. In addition, using BlueprintsNeo4jOptionsBuilder to create the option map automatically sets the graph backend type to "com.tinkerpop.blueprints.impls.neo4j.Neo4jGraph".

 // Create the option map
 Map<String, Object> options = BlueprintsNeo4jOptionsBuilder.newBuilder()
     .softCache()
     .cacheFeatures()
     .asMap();

 // Load the resource with the specified options
 myResource.load(options);

 // Manipulate the resource with a Neo4j backend using an internal soft cache and a feature cache
 myResource.getContents() [...]