Graph (OpenTripPlanner 1.4.0 API)

java.lang.Object
- org.opentripplanner.routing.graph.Graph

All Implemented Interfaces:

Serializable
```
public class Graph
extends Object
implements Serializable
```
A graph is really just one or more indexes into a set of vertexes. It used to keep edgelists for each vertex, but those are in the vertex now.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`Map<TraverseMode,Integer>`	`alightTimes` Has information how much time alighting a vehicle takes.
`Map<TraverseMode,Integer>`	`boardTimes` Has information how much time boarding a vehicle takes.
`String`	`builderConfig` The config JSON used to build this graph.
`Date`	`buildTime`
`org.joda.time.DateTime`	`buildTimeJoda`
`Deduplicator`	`deduplicator`
`Double`	`ellipsoidToGeoidDifference` The difference in meters between the WGS84 ellipsoid height and geoid height at the graph's center
`Map<FeedScopedId,org.locationtech.jts.geom.Geometry>`	`flexAreasById` Areas for flex service
`FlexIndex`	`flexIndex`
`boolean`	`hasBikeRide`
`boolean`	`hasBikeSharing`
`boolean`	`hasDirectTransfers` True if direct single-edge transfers were generated between transit stops in this Graph.
`boolean`	`hasFrequencyService` True if frequency-based services exist in this Graph (GTFS frequencies with exact_times = 0).
`boolean`	`hasParkRide`
`boolean`	`hasScheduledService` True if schedule-based services exist in this Graph (including GTFS frequencies with exact_times = 1).
`boolean`	`hasStreets` True if OSM data was loaded into this Graph.
`boolean`	`hasTransit` True if GTFS data was loaded into this Graph.
`GraphIndex`	`index`
`Map<FeedScopedId,Stop>`	`parentStopById` Parent stops
`Preferences`	`preferences`
`String`	`routerConfig` Embed a router configuration inside the graph, for starting up with a single file.
`String`	`routerId`
`Map<FeedScopedId,Integer>`	`serviceCodes` Map from GTFS ServiceIds to integers close to 0.
`StopClusterMode`	`stopClusterMode` How should we cluster stops? By 'proximity' or 'ParentStation'
`StreetVertexIndexService`	`streetIndex`
`StreetNotesService`	`streetNotesService`
`TimetableSnapshotSource`	`timetableSnapshotSource`
`GraphUpdaterManager`	`updaterManager` Manages all updaters of this graph.
`boolean`	`useFlexService` Whether to use flex modes

Constructor Summary

Constructors
Constructor and Description

Graph()

Graph(Graph basedOn)

Constructors
Constructor and Description
`Graph()`
`Graph(Graph basedOn)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAgency(String feedId, Agency agency)`
`void`	`addAlertPatch(Edge edge, AlertPatch alertPatch)` Add an `AlertPatch` to the `AlertPatch` `Set` belonging to an `Edge`.
`String`	`addBuilderAnnotation(GraphBuilderAnnotation gba)` Add a graph builder annotation to this graph's list of graph builder annotations.
`void`	`addFeedInfo(FeedInfo info)`
`void`	`addFlexArea(String feedId, String areaId, org.locationtech.jts.geom.Polygon flexArea)`
`void`	`addTransitMode(TraverseMode mode)` Adds mode of transport to transit modes in graph
`void`	`addTurnRestriction(Edge edge, TurnRestriction turnRestriction)` Add a `TurnRestriction` to the `TurnRestriction` `List` belonging to an `Edge`.
`void`	`addVertex(Vertex v)` Add the given vertex to the graph.
`void`	`calculateConvexHull()` Calculates convexHull of all the vertices during build time
`void`	`calculateEnvelope()` Calculates envelope out of all OSM coordinates Transit stops are added to the envelope as they are added to the graph
`void`	`calculateTransitCenter()` Calculates Transit center from median of coordinates of all transitStops if graph has transit.
`void`	`clearTimeZone()` The timezone is cached by the graph.
`boolean`	`containsVertex(Vertex v)`
`int`	`countEdges()` Find the total number of edges in this Graph.
`int`	`countVertices()`
`void`	`expandToInclude(double x, double y)` Expands envelope to include given point If envelope is empty it creates it (This can happen with a graph without OSM data) Used when adding stops to OSM envelope
`Collection<Agency>`	`getAgencies(String feedId)`
`AlertPatch[]`	`getAlertPatches(Edge edge)` Get the `AlertPatch` `Set` that belongs to an `Edge` and build a new array.
`Collection<TimeZone>`	`getAllTimeZones()` Return all TimeZones for all agencies in the graph
`List<GraphBuilderAnnotation>`	`getBuilderAnnotations()`
`GraphBundle`	`getBundle()`
`CalendarService`	`getCalendarService()`
`Optional<org.locationtech.jts.geom.Coordinate>`	`getCenter()`
`org.locationtech.jts.geom.Geometry`	`getConvexHull()`
`Edge`	`getEdgeById(int id)` Returns the edge with the given ID or null if none is present.
`Collection<Edge>`	`getEdges()` Return all the edges in the graph.
`WorldEnvelope`	`getEnvelope()`
`org.locationtech.jts.geom.Envelope`	`getExtent()`
`Collection<String>`	`getFeedIds()`
`FeedInfo`	`getFeedInfo(String feedId)`
`GeometryIndex`	`getGeomIndex()`
`Integer`	`getIdForEdge(Edge edge)`
`SampleFactory`	`getSampleFactory()`
`<T> T`	`getService(Class<T> serviceType)`
`<T> T`	`getService(Class<T> serviceType, boolean autoCreate)`
`Collection<StreetEdge>`	`getStreetEdges()` Return only the StreetEdges in the graph.
`TimeZone`	`getTimeZone()` Returns the time zone for the first agency in this graph.
`TransferTable`	`getTransferTable()`
`HashSet<TraverseMode>`	`getTransitModes()`
`long`	`getTransitServiceEnds()`
`long`	`getTransitServiceStarts()`
`List<TurnRestriction>`	`getTurnRestrictions(Edge edge)` Get the `TurnRestriction` `List` that belongs to an `Edge` and return an immutable copy.
`Vertex`	`getVertex(String label)`
`Vertex`	`getVertexById(int id)` Returns the vertex with the given ID or null if none is present.
`Collection<Vertex>`	`getVertices()` Get all the vertices in the graph.
`boolean`	`hasService(Class<?> serviceType)`
`void`	`index(StreetVertexIndexFactory indexFactory)` Perform indexing on vertices, edges, and timetables, and create transient data structures.
`static Graph`	`load(File file)`
`static Graph`	`load(InputStream in)`
`static com.esotericsoftware.kryo.Kryo`	`makeKryo()` This method allows reproducibly creating Kryo (de)serializer instances with exactly the same configuration.
`<T> T`	`putService(Class<T> serviceType, T service)`
`void`	`rebuildVertexAndEdgeIndices()` Rebuilds any indices on the basis of current vertex and edge IDs.
`void`	`remove(Vertex vertex)`
`void`	`removeAlertPatch(Edge edge, AlertPatch alertPatch)` Remove an `AlertPatch` from the `AlertPatch` `Set` belonging to an `Edge`.
`void`	`removeEdge(Edge e)` Removes an edge from the graph.
`int`	`removeEdgelessVertices()`
`void`	`removeTurnRestriction(Edge edge, TurnRestriction turnRestriction)` Remove a `TurnRestriction` from the `TurnRestriction` `List` belonging to an `Edge`.
`void`	`removeVertex(Vertex v)` Removes a vertex from the graph.
`void`	`removeVertexAndEdges(Vertex vertex)`
`void`	`save(File file)`
`void`	`save(OutputStream outputStream)`
`void`	`setBundle(GraphBundle bundle)`
`void`	`setUseFlexService(boolean useFlexService)`
`void`	`summarizeBuilderAnnotations()`
`boolean`	`transitFeedCovers(long t)`
`void`	`updateTransitFeedValidity(CalendarServiceData data)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - routerId
```
public String routerId
```
  - streetNotesService
```
public final StreetNotesService streetNotesService
```
  - streetIndex
```
public transient StreetVertexIndexService streetIndex
```
  - index
```
public transient GraphIndex index
```
  - flexIndex
```
public transient FlexIndex flexIndex
```
  - deduplicator
```
public final transient Deduplicator deduplicator
```
  - serviceCodes
```
public final Map<FeedScopedId,Integer> serviceCodes
```
    Map from GTFS ServiceIds to integers close to 0. Allows using BitSets instead of Set
    . An empty Map is created before the Graph is built to allow registering IDs from multiple feeds.
    
    timetableSnapshotSource
    
    public transient TimetableSnapshotSource timetableSnapshotSource
    
    builderConfig
    
    public String builderConfig
    
    The config JSON used to build this graph. Allows checking whether the configuration has changed.
    
    routerConfig
    
    public String routerConfig
    
    Embed a router configuration inside the graph, for starting up with a single file.
    
    preferences
    
    public Preferences preferences
    
    buildTimeJoda
    
    public org.joda.time.DateTime buildTimeJoda
    
    hasBikeSharing
    
    public boolean hasBikeSharing
    
    hasParkRide
    
    public boolean hasParkRide
    
    hasBikeRide
    
    public boolean hasBikeRide
    
    updaterManager
    
    public transient GraphUpdaterManager updaterManager
    
    Manages all updaters of this graph. Is created by the GraphUpdaterConfigurator when there are graph updaters defined in the configuration.
    
    See Also:
    
    GraphUpdaterConfigurator
    
    buildTime
    
    public final Date buildTime
    
    hasStreets
    
    public boolean hasStreets
    
    True if OSM data was loaded into this Graph.
    
    hasTransit
    
    public boolean hasTransit
    
    True if GTFS data was loaded into this Graph.
    
    hasDirectTransfers
    
    public boolean hasDirectTransfers
    
    True if direct single-edge transfers were generated between transit stops in this Graph.
    
    hasFrequencyService
    
    public boolean hasFrequencyService
    
    True if frequency-based services exist in this Graph (GTFS frequencies with exact_times = 0).
    
    hasScheduledService
    
    public boolean hasScheduledService
    
    True if schedule-based services exist in this Graph (including GTFS frequencies with exact_times = 1).
    
    boardTimes
    
    public Map<TraverseMode,Integer> boardTimes
    
    Has information how much time boarding a vehicle takes. Can be significant eg in airplanes or ferries.
    
    alightTimes
    
    public Map<TraverseMode,Integer> alightTimes
    
    Has information how much time alighting a vehicle takes. Can be significant eg in airplanes or ferries.
    
    stopClusterMode
    
    public StopClusterMode stopClusterMode
    
    How should we cluster stops? By 'proximity' or 'ParentStation'
    
    ellipsoidToGeoidDifference
    
    public Double ellipsoidToGeoidDifference
    
    The difference in meters between the WGS84 ellipsoid height and geoid height at the graph's center
    
    parentStopById
    
    public Map<FeedScopedId,Stop> parentStopById
    
    Parent stops
    
    useFlexService
    
    public boolean useFlexService
    
    Whether to use flex modes
    
    flexAreasById
    
    public Map<FeedScopedId,org.locationtech.jts.geom.Geometry> flexAreasById
    
    Areas for flex service
    
    Constructor Detail
    
    Graph
    
    public Graph(Graph basedOn)
    
    Graph
    
    public Graph()
    
    Method Detail
    
    addVertex
    
    public void addVertex(Vertex v)
    
    Add the given vertex to the graph. Ideally, only vertices should add themselves to the graph, when they are constructed or deserialized.
    
    removeVertex
    
    public void removeVertex(Vertex v)
    
    Removes a vertex from the graph. Called from streetutils, must be public for now
    
    Parameters:
    
    v -
    
    removeEdge
    
    public void removeEdge(Edge e)
    
    Removes an edge from the graph. This method is not thread-safe.
    
    Parameters:
    
    e - The edge to be removed
    
    getVertex
    
    public Vertex getVertex(String label)
    
    getVertexById
    
    public Vertex getVertexById(int id)
    
    Returns the vertex with the given ID or null if none is present. NOTE: you may need to run rebuildVertexAndEdgeIndices() for the indices to be accurate.
    
    Parameters:
    
    id -
    
    Returns:
    
    getVertices
    
    public Collection<Vertex> getVertices()
    
    Get all the vertices in the graph.
    
    Returns:
    
    getEdgeById
    
    public Edge getEdgeById(int id)
    
    Returns the edge with the given ID or null if none is present. NOTE: you may need to run rebuildVertexAndEdgeIndices() for the indices to be accurate.
    
    Parameters:
    
    id -
    
    Returns:
    
    getEdges
    
    public Collection<Edge> getEdges()
    
    Return all the edges in the graph.
    
    Returns:
    
    addAlertPatch
    
    public void addAlertPatch(Edge edge, AlertPatch alertPatch)
    
    Add an AlertPatch to the AlertPatch Set belonging to an Edge.
    
    Parameters:
    
    edge -
    
    alertPatch -
    
    removeAlertPatch
    
    public void removeAlertPatch(Edge edge, AlertPatch alertPatch)
    
    Remove an AlertPatch from the AlertPatch Set belonging to an Edge.
    
    Parameters:
    
    edge -
    
    alertPatch -
    
    getAlertPatches
    
    public AlertPatch[] getAlertPatches(Edge edge)
    
    Get the AlertPatch Set that belongs to an Edge and build a new array.
    
    Parameters:
    
    edge -
    
    Returns:
    
    The AlertPatch array that belongs to the Edge
    
    addTurnRestriction
    
    public void addTurnRestriction(Edge edge, TurnRestriction turnRestriction)
    
    Add a TurnRestriction to the TurnRestriction List belonging to an Edge. This method is not thread-safe.
    
    Parameters:
    
    edge -
    
    turnRestriction -
    
    removeTurnRestriction
    
    public void removeTurnRestriction(Edge edge, TurnRestriction turnRestriction)
    
    Remove a TurnRestriction from the TurnRestriction List belonging to an Edge. This method is not thread-safe.
    
    Parameters:
    
    edge -
    
    turnRestriction -
    
    getTurnRestrictions
    
    public List<TurnRestriction> getTurnRestrictions(Edge edge)
    
    Get the TurnRestriction List that belongs to an Edge and return an immutable copy. This method is thread-safe when used by itself, but not if addTurnRestriction or removeTurnRestriction is called concurrently.
    
    Parameters:
    
    edge -
    
    Returns:
    
    The TurnRestriction List that belongs to the Edge
    
    getStreetEdges
    
    public Collection<StreetEdge> getStreetEdges()
    
    Return only the StreetEdges in the graph.
    
    Returns:
    
    containsVertex
    
    public boolean containsVertex(Vertex v)
    
    putService
    
    public <T> T putService(Class<T> serviceType, T service)
    
    hasService
    
    public boolean hasService(Class<?> serviceType)
    
    getService
    
    public <T> T getService(Class<T> serviceType)
    
    getService
    
    public <T> T getService(Class<T> serviceType, boolean autoCreate)
    
    remove
    
    public void remove(Vertex vertex)
    
    removeVertexAndEdges
    
    public void removeVertexAndEdges(Vertex vertex)
    
    getExtent
    
    public org.locationtech.jts.geom.Envelope getExtent()
    
    getTransferTable
    
    public TransferTable getTransferTable()
    
    updateTransitFeedValidity
    
    public void updateTransitFeedValidity(CalendarServiceData data)
    
    transitFeedCovers
    
    public boolean transitFeedCovers(long t)
    
    getBundle
    
    public GraphBundle getBundle()
    
    setBundle
    
    public void setBundle(GraphBundle bundle)
    
    countVertices
    
    public int countVertices()
    
    countEdges
    
    public int countEdges()
    
    Find the total number of edges in this Graph. There are assumed to be no Edges in an incoming edge list that are not in an outgoing edge list.
    
    Returns:
    
    number of outgoing edges in the graph
    
    rebuildVertexAndEdgeIndices
    
    public void rebuildVertexAndEdgeIndices()
    
    Rebuilds any indices on the basis of current vertex and edge IDs. If you want the index to be accurate, you must run this every time the vertex or edge set changes. TODO(flamholz): keep the indices up to date with changes to the graph. This is not simple because the Vertex constructor may add itself to the graph before the Vertex has any edges, so updating indices on addVertex is insufficient.
    
    addBuilderAnnotation
    
    public String addBuilderAnnotation(GraphBuilderAnnotation gba)
    
    Add a graph builder annotation to this graph's list of graph builder annotations. The return value of this method is the annotation's message, which allows for a single-line idiom that creates, registers, and logs a new graph builder annotation: log.warning(graph.addBuilderAnnotation(new SomeKindOfAnnotation(param1, param2))); If the graphBuilderAnnotations field of this graph is null, the annotation is not actually saved, but the message is still returned. This allows annotation registration to be turned off, saving memory and disk space when the user is not interested in annotations.
    
    getBuilderAnnotations
    
    public List<GraphBuilderAnnotation> getBuilderAnnotations()
    
    addTransitMode
    
    public void addTransitMode(TraverseMode mode)
    
    Adds mode of transport to transit modes in graph
    
    Parameters:
    
    mode -
    
    getTransitModes
    
    public HashSet<TraverseMode> getTransitModes()
    
    load
    
    public static Graph load(File file) throws IOException
    
    Throws:
    
    IOException
    
    index
    
    public void index(StreetVertexIndexFactory indexFactory)
    
    Perform indexing on vertices, edges, and timetables, and create transient data structures. This used to be done in readObject methods upon deserialization, but stand-alone mode now allows passing graphs from graphbuilder to server in memory, without a round trip through serialization. TODO: do we really need a factory for different street vertex indexes?
    
    load
    
    public static Graph load(InputStream in)
    
    makeKryo
    
    public static com.esotericsoftware.kryo.Kryo makeKryo()
    
    This method allows reproducibly creating Kryo (de)serializer instances with exactly the same configuration. This allows us to use identically configured instances for serialization and deserialization. When configuring serializers, there's a difference between kryo.register() and kryo.addDefaultSerializer(). The latter will set the default for a whole tree of classes. The former matches only the specified class. By default Kryo will serialize all the non-transient fields of an instance. If the class has its own overridden Java serialization methods Kryo will not automatically use those, a JavaSerializer must be registered.
    
    save
    
    public void save(File file) throws IOException
    
    Throws:
    
    IOException
    
    save
    
    public void save(OutputStream outputStream)
    
    getIdForEdge
    
    public Integer getIdForEdge(Edge edge)
    
    getCalendarService
    
    public CalendarService getCalendarService()
    
    removeEdgelessVertices
    
    public int removeEdgelessVertices()
    
    getFeedIds
    
    public Collection<String> getFeedIds()
    
    getAgencies
    
    public Collection<Agency> getAgencies(String feedId)
    
    getFeedInfo
    
    public FeedInfo getFeedInfo(String feedId)
    
    addAgency
    
    public void addAgency(String feedId, Agency agency)
    
    addFeedInfo
    
    public void addFeedInfo(FeedInfo info)
    
    addFlexArea
    
    public void addFlexArea(String feedId, String areaId, org.locationtech.jts.geom.Polygon flexArea)
    
    getTimeZone
    
    public TimeZone getTimeZone()
    
    Returns the time zone for the first agency in this graph. This is used to interpret times in API requests. The JVM default time zone cannot be used because we support multiple graphs on one server via the routerId. Ideally we would want to interpret times in the time zone of the geographic location where the origin/destination vertex or board/alight event is located. This may become necessary when we start making graphs with long distance train, boat, or air services.
    
    getAllTimeZones
    
    public Collection<TimeZone> getAllTimeZones()
    
    Return all TimeZones for all agencies in the graph
    
    Returns:
    
    collection of referenced timezones
    
    clearTimeZone
    
    public void clearTimeZone()
    
    The timezone is cached by the graph. If you've done something to the graph that has the potential to change the time zone, you should call this to ensure it is reset.
    
    summarizeBuilderAnnotations
    
    public void summarizeBuilderAnnotations()
    
    calculateEnvelope
    
    public void calculateEnvelope()
    
    Calculates envelope out of all OSM coordinates Transit stops are added to the envelope as they are added to the graph
    
    calculateConvexHull
    
    public void calculateConvexHull()
    
    Calculates convexHull of all the vertices during build time
    
    getConvexHull
    
    public org.locationtech.jts.geom.Geometry getConvexHull()
    
    Returns:
    
    calculated convexHull;
    
    expandToInclude
    
    public void expandToInclude(double x, double y)
    
    Expands envelope to include given point If envelope is empty it creates it (This can happen with a graph without OSM data) Used when adding stops to OSM envelope
    
    Parameters:
    
    x - the value to lower the minimum x to or to raise the maximum x to
    
    y - the value to lower the minimum y to or to raise the maximum y to
    
    getEnvelope
    
    public WorldEnvelope getEnvelope()
    
    getGeomIndex
    
    public GeometryIndex getGeomIndex()
    
    getSampleFactory
    
    public SampleFactory getSampleFactory()
    
    calculateTransitCenter
    
    public void calculateTransitCenter()
    
    Calculates Transit center from median of coordinates of all transitStops if graph has transit. If it doesn't it isn't calculated. (mean walue of min, max latitude and longitudes are used) Transit center is saved in center variable This speeds up calculation, but problem is that median needs to have all of latitudes/longitudes in memory, this can become problematic in large installations. It works without a problem on New York State.
    
    getCenter
    
    public Optional<org.locationtech.jts.geom.Coordinate> getCenter()
    
    getTransitServiceStarts
    
    public long getTransitServiceStarts()
    
    getTransitServiceEnds
    
    public long getTransitServiceEnds()
    
    setUseFlexService
    
    public void setUseFlexService(boolean useFlexService)
    
    Skip navigation links
    
    Overview
    
    Package
    
    Class
    
    Use
    
    Tree
    
    Deprecated
    
    Index
    
    Help
    
    Prev Class
    
    Next Class
    
    Frames
    
    No Frames
    
    All Classes
    
    Summary:
    
    Nested |
    
    Field |
    
    Constr |
    
    Method
    
    Detail:
    
    Field |
    
    Constr |
    
    Method
    
    Copyright © 2019. All rights reserved.

Class Graph

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

routerId

streetNotesService

streetIndex

index

flexIndex

deduplicator

serviceCodes

timetableSnapshotSource

builderConfig

routerConfig

preferences

buildTimeJoda

hasBikeSharing

hasParkRide

hasBikeRide

updaterManager

buildTime

hasStreets

hasTransit

hasDirectTransfers

hasFrequencyService

hasScheduledService

boardTimes

alightTimes

stopClusterMode

ellipsoidToGeoidDifference

parentStopById

useFlexService

flexAreasById

Constructor Detail

Graph

Graph

Method Detail

addVertex

removeVertex

removeEdge

getVertex

getVertexById

getVertices

getEdgeById

getEdges

addAlertPatch

removeAlertPatch

getAlertPatches

addTurnRestriction

removeTurnRestriction

getTurnRestrictions

getStreetEdges

containsVertex

putService

hasService

getService

getService

remove

removeVertexAndEdges

getExtent

getTransferTable

updateTransitFeedValidity

transitFeedCovers

getBundle

setBundle

countVertices

countEdges

rebuildVertexAndEdgeIndices

addBuilderAnnotation

getBuilderAnnotations

addTransitMode

getTransitModes

load

index

load

makeKryo

save

save