org.opentripplanner.updater.example

Class ExamplePollingGraphUpdater

java.lang.Object

org.opentripplanner.updater.PollingGraphUpdater

org.opentripplanner.updater.example.ExamplePollingGraphUpdater

All Implemented Interfaces:

GraphUpdater, JsonConfigurable

public class ExamplePollingGraphUpdater
extends PollingGraphUpdater

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

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

See Also:

ExampleGraphUpdater

Field Summary

Fields inherited from class org.opentripplanner.updater.PollingGraphUpdater

pollingPeriodSeconds

Constructor Summary

Constructors

Constructor and Description
ExamplePollingGraphUpdater()

Method Summary

Modifier and Type	Method and Description
protected void	configurePolling(Graph graph, com.fasterxml.jackson.databind.JsonNode config) Mirrors GraphUpdater.configure method.
protected void	runPolling() Mirrors GraphUpdater.run method.
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 org.opentripplanner.updater.PollingGraphUpdater

configure, run

Methods inherited from class java.lang.Object

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

Constructor Detail

ExamplePollingGraphUpdater

public ExamplePollingGraphUpdater()

Method Detail

configurePolling

protected void configurePolling(Graph graph,
                                com.fasterxml.jackson.databind.JsonNode config)
                         throws Exception

Description copied from class: PollingGraphUpdater

Mirrors GraphUpdater.configure method.

Specified by:

configurePolling in class PollingGraphUpdater

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.

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.

runPolling

protected void runPolling()

Description copied from class: PollingGraphUpdater

Mirrors GraphUpdater.run method. Only difference is that runPolling will be run multiple times with pauses in between. The length of the pause is defined in the preference frequencySec.

Specified by:

runPolling in class PollingGraphUpdater

teardown

public void teardown()

Description copied from interface: GraphUpdater

Here the updater can clean up after itself.