org.opentripplanner.updater

Interface GraphUpdater

All Superinterfaces:

JsonConfigurable

All Known Implementing Classes:

BikeParkUpdater, BikeRentalUpdater, ExampleGraphUpdater, ExamplePollingGraphUpdater, GtfsRealtimeAlertsUpdater, OpenTrafficUpdater, PollingGraphUpdater, PollingStoptimeUpdater, WebsocketGtfsRealtimeUpdater, WFSNotePollingGraphUpdater, WinkkiPollingGraphUpdater

public interface GraphUpdater
extends JsonConfigurable

Interface for graph updaters. Objects that implement this interface should always be configured via PreferencesConfigurable.configure after creating the object. GraphUpdaterConfigurator should take care of that. Beware that updaters run in separate threads at the same time. The only allowed way to make changes to the graph in an updater is by executing (anonymous) GraphWriterRunnable objects via GraphUpdaterManager.execute. Example implementations can be found in ExampleGraphUpdater and ExamplePollingGraphUpdater.

Method Summary

Modifier and Type	Method and Description
void	run() This method will run in its own thread.
void	setGraphUpdaterManager(GraphUpdaterManager updaterManager) Graph updaters must be aware of their manager to be able to execute GraphWriterRunnables.
void	setup(Graph graph) Here the updater can be initialized.
void	teardown() Here the updater can clean up after itself.

Methods inherited from interface org.opentripplanner.updater.JsonConfigurable

configure

Method Detail

setGraphUpdaterManager

void setGraphUpdaterManager(GraphUpdaterManager updaterManager)

Graph updaters must be aware of their manager to be able to execute GraphWriterRunnables. GraphUpdaterConfigurator should take care of calling this function.

setup

void setup(Graph graph)
    throws Exception

Here the updater can be initialized. If it throws, the updater won't be started (i.e. the run method won't be called). All updaters' setup methods will be run sequentially in a single-threaded manner before updates begin, in order to avoid concurrent reads/writes.

Throws:

Exception

run

void run()
  throws Exception

This method will run in its own thread. It pulls or receives updates and applies them to the graph. It must perform any writes to the graph by passing GraphWriterRunnables to GraphUpdaterManager.execute(). This queues up the write operations, ensuring that only one updater performs writes at a time.

Throws:

Exception

teardown

void teardown()

Here the updater can clean up after itself.