org.opentripplanner.routing.services.notes

Class StreetNotesService

java.lang.Object

org.opentripplanner.routing.services.notes.StreetNotesService

All Implemented Interfaces:

Serializable

public class StreetNotesService
extends Object
implements Serializable

This service manage street edge notes. An edge note is an free-format alert (text) attached to an edge, which is returned in the itinerary when this edge is used, and which *does not have any impact on routing*. The last restriction is necessary as the edge do not know which notes it is attached to (this to prevent having to store note lists in the edge, which is memory consuming as only few edges will have notes). The service owns a list of StreetNotesSource, with a single static one used for graph building. "Dynamic" notes can be returned by classes implementing StreetNoteSource, added to this service during startup. Typical notes are: Toll (driving), unpaved surface (walk,bike), wheelchair notes... Each note is attached to a matcher, whose responsibility is to determine if the note is relevant for an edge, based on the itinerary state at this edge (the state after the edge has been traversed, ie "state back edge"). Usually matcher will match note based on the mode (cycling, driving) or if a wheelchair access is requested.

Author:

laurent

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static NoteMatcher	ALWAYS_MATCHER
static NoteMatcher	BICYCLE_MATCHER
static NoteMatcher	DRIVING_MATCHER
static NoteMatcher	WHEELCHAIR_MATCHER

Constructor Summary

Constructors

Constructor and Description
StreetNotesService()

Method Summary

Modifier and Type	Method and Description
void	addNotesSource(StreetNotesSource source) Add a new note source.
void	addStaticNote(Edge edge, Alert note, NoteMatcher matcher)
Set<Alert>	getNotes(State state) Return the set of notes applicable for this state / backedge pair.
void	removeStaticNotes(Edge edge)

Methods inherited from class java.lang.Object

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

Field Detail

WHEELCHAIR_MATCHER

public static final NoteMatcher WHEELCHAIR_MATCHER

DRIVING_MATCHER

public static final NoteMatcher DRIVING_MATCHER

BICYCLE_MATCHER

public static final NoteMatcher BICYCLE_MATCHER

ALWAYS_MATCHER

public static final NoteMatcher ALWAYS_MATCHER

Constructor Detail

StreetNotesService

public StreetNotesService()

Method Detail

addNotesSource

public void addNotesSource(StreetNotesSource source)

Add a new note source. The list is not transient so any source added before the graph is saved will be serialized!

Parameters:

source -

getNotes

public Set<Alert> getNotes(State state)

Return the set of notes applicable for this state / backedge pair.

Parameters:

state -

Returns:

The set of notes or null if empty.

addStaticNote

public void addStaticNote(Edge edge,
                          Alert note,
                          NoteMatcher matcher)

removeStaticNotes

public void removeStaticNotes(Edge edge)