com.graphaware.runtime.module

Interface TimerDrivenModule<C extends TimerDrivenModuleContext>

Type Parameters:

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

All Superinterfaces:

RuntimeModule

All Known Subinterfaces:

TxAndTimerDrivenModule<T,C>

All Known Implementing Classes:

BaseTimerDrivenModule

public interface TimerDrivenModule<C extends TimerDrivenModuleContext>
extends RuntimeModule

Specialisation of RuntimeModule that can be driven by a timing strategy as opposed to a response to transaction events.

Method Summary

Modifier and Type	Method and Description
C	createInitialContext(org.neo4j.graphdb.GraphDatabaseService database) Create the initial context for this module, when no previously produced context is available.
C	doSomeWork(C lastContext, org.neo4j.graphdb.GraphDatabaseService database) Perform the work which is the reason for this module's existence.
TimerDrivenModuleConfiguration	getConfiguration() Return the configuration of this module.

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

getId, shutdown

Method Detail

createInitialContext

C createInitialContext(org.neo4j.graphdb.GraphDatabaseService database)

Create the initial context for this module, when no previously produced context is available.

Parameters:

database - against which the module is running.

Returns:

initial context.

doSomeWork

C doSomeWork(C lastContext,
             org.neo4j.graphdb.GraphDatabaseService database)

Perform the work which is the reason for this module's existence. Implementations can (and should) assume a running transaction.

Parameters:

lastContext - context produced by the last run of this method.

database - against which the module is running.

Returns:

context that will be presented next time the module is run.

getConfiguration

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.

Returns:

module configuration.