org.opentripplanner.updater.example

Class ExampleGraphUpdater

java.lang.Object

org.opentripplanner.updater.example.ExampleGraphUpdater

All Implemented Interfaces:

GraphUpdater, JsonConfigurable

public class ExampleGraphUpdater
extends Object
implements GraphUpdater

This class shows an example of how to implement a graph updater. Besides implementing the methods of the interface GraphUpdater, the updater also needs to be registered in the function GraphUpdaterConfigurator.applyConfigurationToGraph. This example is suited for streaming updaters. For polling updaters it is better to use the abstract base class PollingGraphUpdater. The class ExamplePollingGraphUpdater shows an example of this. Usage example ('example' name is an example) in the file 'Graph.properties':

 example.type = example-updater
 example.frequencySec = 60
 example.url = https://api.updater.com/example-updater
 

See Also:

ExamplePollingGraphUpdater, GraphUpdaterConfigurator.applyConfigurationToGraph

Constructor Summary

Constructors

Constructor and Description
ExampleGraphUpdater()

Method Summary

Modifier and Type	Method and Description
void	configure(Graph graph, com.fasterxml.jackson.databind.JsonNode config)
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 class java.lang.Object

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

Constructor Detail

ExampleGraphUpdater

public ExampleGraphUpdater()

Method Detail

configure

public void configure(Graph graph,
                      com.fasterxml.jackson.databind.JsonNode config)
               throws Exception

Specified by:

configure in interface JsonConfigurable

Throws:

Exception

setGraphUpdaterManager

public void setGraphUpdaterManager(GraphUpdaterManager updaterManager)

Description copied from interface: GraphUpdater

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

Specified by:

setGraphUpdaterManager in interface GraphUpdater

setup

public void setup(Graph graph)

Description copied from interface: GraphUpdater

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.

Specified by:

setup in interface GraphUpdater

run

public void run()

Description copied from interface: GraphUpdater

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.

Specified by:

run in interface GraphUpdater

teardown

public void teardown()

Description copied from interface: GraphUpdater

Here the updater can clean up after itself.

Specified by:

teardown in interface GraphUpdater