com.graphaware.runtime.module

Class BaseTimerDrivenModule<C extends TimerDrivenModuleContext>

java.lang.Object

com.graphaware.runtime.module.BaseRuntimeModule

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

Type Parameters:

C - the type of context that the module persists in Neo4j between runs.

All Implemented Interfaces:

RuntimeModule, TimerDrivenModule<C>

public abstract class BaseTimerDrivenModule<C extends TimerDrivenModuleContext>
extends BaseRuntimeModule
implements TimerDrivenModule<C>

Base class for TimerDrivenModule implementations.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseTimerDrivenModule(String moduleId) Construct a new module.

Method Summary

Modifier and Type	Method and Description
TimerDrivenModuleConfiguration	getConfiguration() Return the configuration of this module.
void	shutdown()

Methods inherited from class com.graphaware.runtime.module.BaseRuntimeModule

getId

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.graphaware.runtime.module.TimerDrivenModule

createInitialContext, doSomeWork

Methods inherited from interface com.graphaware.runtime.module.RuntimeModule

getId

Constructor Detail

BaseTimerDrivenModule

protected BaseTimerDrivenModule(String moduleId)

Construct a new module.

Parameters:

moduleId - ID of this module. Must not be null.

Method Detail

getConfiguration

public TimerDrivenModuleConfiguration getConfiguration()

Return the configuration of this module. Each module must encapsulate its entire configuration in an instance of a TimerDrivenModuleConfiguration implementation. Use NullTimerDrivenModuleConfiguration if this module needs no configuration.

Specified by:

getConfiguration in interface TimerDrivenModule<C extends TimerDrivenModuleContext>

Returns:

module configuration.

shutdown

public void shutdown()

Note that the implementation in this base class doesn't do anything and can be safely overridden without calling super.

Specified by:

shutdown in interface RuntimeModule