org.opentripplanner.updater

Class PollingGraphUpdater

java.lang.Object

org.opentripplanner.updater.PollingGraphUpdater

All Implemented Interfaces:

GraphUpdater, JsonConfigurable

Direct Known Subclasses:

BikeParkUpdater, BikeRentalUpdater, ExamplePollingGraphUpdater, GtfsRealtimeAlertsUpdater, OpenTrafficUpdater, PollingStoptimeUpdater, WFSNotePollingGraphUpdater

public abstract class PollingGraphUpdater
extends Object
implements GraphUpdater

This abstract class implements logic that is shared between all polling updaters. Usage example ('polling' name is an example and 'polling-updater' should be the type of a concrete class derived from this abstract class):

 polling.type = polling-updater
 polling.frequencySec = 60
 

See Also:

GraphUpdater

Field Summary

Fields

Modifier and Type	Field and Description
protected Integer	pollingPeriodSeconds How long to wait after polling to poll again.

Constructor Summary

Constructors

Constructor and Description
PollingGraphUpdater()

Method Summary

Modifier and Type	Method and Description
void	configure(Graph graph, com.fasterxml.jackson.databind.JsonNode config) Shared configuration code for all polling graph updaters.
protected abstract void	configurePolling(Graph graph, com.fasterxml.jackson.databind.JsonNode config) Mirrors GraphUpdater.configure method.
void	run() This method will run in its own thread.
protected abstract void	runPolling() Mirrors GraphUpdater.run method.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opentripplanner.updater.GraphUpdater

setGraphUpdaterManager, setup, teardown

Field Detail

pollingPeriodSeconds

protected Integer pollingPeriodSeconds

How long to wait after polling to poll again.

Constructor Detail

PollingGraphUpdater

public PollingGraphUpdater()

Method Detail

runPolling

protected abstract void runPolling()
                            throws Exception

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.

Throws:

Exception

configurePolling

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

Mirrors GraphUpdater.configure method.

Throws:

Exception

run

public final 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

configure

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

Shared configuration code for all polling graph updaters.

Specified by:

configure in interface JsonConfigurable

Throws:

Exception