com.graphaware.runtime.module

Class BaseRuntimeModuleBootstrapper<C extends BaseTxDrivenModuleConfiguration<C>>

java.lang.Object

com.graphaware.runtime.module.BaseRuntimeModuleBootstrapper<C>

Type Parameters:

C - type of TxDrivenModuleConfiguration used to configure the module.

All Implemented Interfaces:

RuntimeModuleBootstrapper

public abstract class BaseRuntimeModuleBootstrapper<C extends BaseTxDrivenModuleConfiguration<C>>
extends Object
implements RuntimeModuleBootstrapper

Abstract base-class for RuntimeModuleBootstrapper implementations for TxDrivenModules.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	INITIALIZE_UNTIL
protected static String	NODE
protected static String	NODE_PROPERTY
protected static String	RELATIONSHIP
protected static String	RELATIONSHIP_PROPERTY

Constructor Summary

Constructors

Constructor and Description
BaseRuntimeModuleBootstrapper()

Method Summary

Modifier and Type	Method and Description
RuntimeModule	bootstrapModule(String moduleId, Map<String,String> config, org.neo4j.graphdb.GraphDatabaseService database) Create a new instance of a module.
protected boolean	configExists(Map<String,String> config, String key) Check if a configuration has been specified.
protected C	configureInclusionPolicies(Map<String,String> config, C configuration)
protected C	configureInitialization(String moduleId, Map<String,String> config, C configuration)
protected abstract C	defaultConfiguration() Produce default configuration for the module.
protected abstract RuntimeModule	doBootstrapModule(String moduleId, Map<String,String> config, org.neo4j.graphdb.GraphDatabaseService database, C configuration) Apply module-specific configuration to the provided configuration, which has already been configured with "initializeUntil" and all InclusionPolicies.

Methods inherited from class java.lang.Object

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

Field Detail

INITIALIZE_UNTIL

protected static final String INITIALIZE_UNTIL

See Also:

Constant Field Values

NODE

protected static final String NODE

See Also:

Constant Field Values

NODE_PROPERTY

protected static final String NODE_PROPERTY

See Also:

Constant Field Values

RELATIONSHIP

protected static final String RELATIONSHIP

See Also:

Constant Field Values

RELATIONSHIP_PROPERTY

protected static final String RELATIONSHIP_PROPERTY

See Also:

Constant Field Values

Constructor Detail

BaseRuntimeModuleBootstrapper

public BaseRuntimeModuleBootstrapper()

Method Detail

defaultConfiguration

protected abstract C defaultConfiguration()

Produce default configuration for the module.

Returns:

default config.

bootstrapModule

public RuntimeModule bootstrapModule(String moduleId,
                                     Map<String,String> config,
                                     org.neo4j.graphdb.GraphDatabaseService database)

Create a new instance of a module.

Specified by:

bootstrapModule in interface RuntimeModuleBootstrapper

Parameters:

moduleId - ID of the module.

config - for this module as key-value pairs.

database - which the module will run on.

Returns:

fully configured runtime module.

configureInitialization

protected C configureInitialization(String moduleId,
                                    Map<String,String> config,
                                    C configuration)

configureInclusionPolicies

protected C configureInclusionPolicies(Map<String,String> config,
                                       C configuration)

doBootstrapModule

protected abstract RuntimeModule doBootstrapModule(String moduleId,
                                                   Map<String,String> config,
                                                   org.neo4j.graphdb.GraphDatabaseService database,
                                                   C configuration)

Apply module-specific configuration to the provided configuration, which has already been configured with "initializeUntil" and all InclusionPolicies. Then bootstrap the module and return it.

Parameters:

moduleId - ID of the module.

config - for this module as key-value pairs.

database - which the module will run on.

configuration - pre-populated with configuration common for all modules, such as "initializeUntil" and all InclusionPolicies.

Returns:

fully configured runtime module.

configExists

protected final boolean configExists(Map<String,String> config,
                                     String key)

Check if a configuration has been specified.

Parameters:

config - config passed in to the bootstrapper.

key - to check for.

Returns:

true iff the passed in config contains the key and the value is not empty.