com.graphaware.runtime.metadata

Interface TimerDrivenModuleContext<T>

Type Parameters:

T - type of the position representation.

All Known Implementing Classes:

BaseTimerDrivenModuleContext, EmptyContext, NodeBasedContext

public interface TimerDrivenModuleContext<T>

Context of TimerDrivenModules encapsulating the position in the graph and additional data, such as weight carried around for certain iterative algorithms, etc.

The position in the graph could be a single node, a collection of nodes, a single relationship, a collection of relationships, a cluster of nodes and relationships, etc.

Field Summary

Fields

Modifier and Type	Field and Description
static long	ASAP

Method Summary

Modifier and Type	Method and Description
long	earliestNextCall() Get the earliest time the TimerDrivenModule wishes to be called again.
T	find(org.neo4j.graphdb.GraphDatabaseService database) Find the position in the database.

Field Detail

ASAP

static final long ASAP

See Also:

Constant Field Values

Method Detail

earliestNextCall

long earliestNextCall()

Get the earliest time the TimerDrivenModule wishes to be called again. Modules that want to be called as often as possible should return ASAP.

Returns:

earliest time (in ms since 1/1/1970) this module will be called again.

find

T find(org.neo4j.graphdb.GraphDatabaseService database)
throws PositionNotFoundException

Find the position in the database.

Parameters:

database - The GraphDatabaseService in which to find the position.

Returns:

A representation of the position.

Throws:

PositionNotFoundException - if the position could not be found. Callers must handle this.