org.opentripplanner.api.resource

Class GraphPathToTripPlanConverter

java.lang.Object

org.opentripplanner.api.resource.GraphPathToTripPlanConverter

public abstract class GraphPathToTripPlanConverter
extends Object

A library class with only static methods used in converting internal GraphPaths to TripPlans, which are returned by the OTP "planner" web service. TripPlans are made up of Itineraries, so the functions to produce them are also bundled together here.

Constructor Summary

Constructors

Constructor and Description
GraphPathToTripPlanConverter()

Method Summary

Modifier and Type	Method and Description
static Itinerary	generateItinerary(GraphPath path, boolean showIntermediateStops, boolean disableAlertFiltering, Locale requestedLocale) Generate an itinerary from a GraphPath.
static TripPlan	generatePlan(List<GraphPath> paths, RoutingRequest request) Generates a TripPlan from a set of paths
static List<WalkStep>	generateWalkSteps(Graph graph, State[] states, WalkStep previous, Locale requestedLocale) Converts a list of street edges to a list of turn-by-turn directions.
static String	getBoardAlightMessage(int boardAlightType) This was originally in TransitUtils.handleBoardAlightType.

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphPathToTripPlanConverter

public GraphPathToTripPlanConverter()

Method Detail

generatePlan

public static TripPlan generatePlan(List<GraphPath> paths,
                                    RoutingRequest request)

Generates a TripPlan from a set of paths

generateItinerary

public static Itinerary generateItinerary(GraphPath path,
                                          boolean showIntermediateStops,
                                          boolean disableAlertFiltering,
                                          Locale requestedLocale)

Generate an itinerary from a GraphPath. This method first slices the list of states at the leg boundaries. These smaller state arrays are then used to generate legs. Finally the rest of the itinerary is generated based on the complete state array.

Parameters:

path - The graph path to base the itinerary on

showIntermediateStops - Whether to include intermediate stops in the itinerary or not

Returns:

The generated itinerary

getBoardAlightMessage

public static String getBoardAlightMessage(int boardAlightType)

This was originally in TransitUtils.handleBoardAlightType. Edges that always block traversal (forbidden pickups/dropoffs) are simply not ever created.

generateWalkSteps

public static List<WalkStep> generateWalkSteps(Graph graph,
                                               State[] states,
                                               WalkStep previous,
                                               Locale requestedLocale)

Converts a list of street edges to a list of turn-by-turn directions.

Parameters:

previous - a non-transit leg that immediately precedes this one (bike-walking, say), or null

Returns: