public abstract class RoutingResource extends Object
Modifier and Type | Field and Description |
---|---|
protected Boolean |
arriveBy
Whether the trip should depart or arrive at the specified date and time.
|
protected String |
bannedAgencies
The comma-separated list of banned agencies.
|
protected String |
bannedRoutes
The comma-separated list of banned routes.
|
protected String |
bannedStops
A comma-separated list of banned stops.
|
protected String |
bannedStopsHard
A comma-separated list of banned stops.
|
protected String |
bannedTrips
The comma-separated list of banned trips.
|
protected Boolean |
batch
If true, goal direction is turned off and a full path tree is built (specify only once)
|
protected Integer |
bikeBoardCost
Prevents unnecessary transfers by adding a cost for boarding a vehicle.
|
protected Double |
bikeSpeed
The user's biking speed in meters/second.
|
protected Integer |
bikeSwitchCost
The cost of the user fetching their bike and parking it again.
|
protected Integer |
bikeSwitchTime
The time it takes the user to fetch their bike and park it again in seconds.
|
protected Long |
clampInitialWait
When subtracting initial wait time, do not subtract more than this value, to prevent overly
optimistic trips.
|
protected String |
date
The date that the trip should depart (or arrive, for requests where arriveBy is true).
|
protected Boolean |
disableRemainingWeightHeuristic
If true, the remaining weight heuristic is disabled.
|
protected Double |
flexFlagStopBufferSize |
protected Boolean |
flexIgnoreDrtAdvanceBookMin
Whether to ignore DRT time limits.
|
protected Boolean |
flexUseEligibilityServices
Whether to use eligibility-based services
|
protected Boolean |
flexUseReservationServices
Whether to use reservation-based services
|
protected String |
fromPlace
The start location -- either latitude, longitude pair in degrees or a Vertex
label.
|
protected Boolean |
ignoreRealtimeUpdates
If true, realtime updates are ignored during this search.
|
protected List<String> |
intermediatePlaces
An ordered list of intermediate locations to be visited (see the fromPlace for format).
|
protected Integer |
maxPreTransitTime
The maximum time (in seconds) of pre-transit travel when using drive-to-transit (park and
ride or kiss and ride).
|
protected Integer |
maxTransfers
The maximum number of transfers (that is, one plus the maximum number of boardings)
that a trip will be allowed.
|
protected Double |
maxWalkDistance
The maximum distance (in meters) the user is willing to walk.
|
protected Integer |
minTransferTime
The minimum time, in seconds, between successive trips on different vehicles.
|
protected QualifiedModeSet |
modes
The set of modes that a user is willing to use, with qualifiers stating whether vehicles should be parked, rented, etc.
|
protected Integer |
nonpreferredTransferPenalty
An additional penalty added to boardings after the first when the transfer is not
preferred.
|
protected Integer |
numItineraries
The maximum number of possible itineraries to return.
|
protected OptimizeType |
optimize
The set of characteristics that the user wants to optimize for.
|
protected Integer |
otherThanPreferredRoutesPenalty
Penalty added for using every route that is not preferred if user set any route as preferred, i.e.
|
protected OTPServer |
otpServer |
protected String |
preferredAgencies
The comma-separated list of preferred agencies.
|
protected String |
preferredRoutes
The list of preferred routes.
|
protected Boolean |
reverseOptimizeOnTheFly
If true, this trip will be reverse-optimized on the fly.
|
String |
routerId
The routerId selects between several graphs on the same server.
|
protected Boolean |
showIntermediateStops
Whether intermediate stops -- those that the itinerary passes in a vehicle, but
does not board or alight at -- should be returned in the response.
|
protected String |
startTransitStopId
A transit stop required to be the first stop in the search (AgencyId_StopId)
|
protected String |
startTransitTripId
A transit trip acting as a starting "state" for depart-onboard routing (AgencyId_TripId)
|
protected String |
time
The time that the trip should depart (or arrive, for requests where arriveBy is true).
|
protected String |
toPlace
The end location (see fromPlace for format).
|
protected Integer |
transferPenalty
An additional penalty added to boardings after the first.
|
protected Double |
triangleSafetyFactor
For bike triangle routing, how much safety matters (range 0-1).
|
protected Double |
triangleSlopeFactor
For bike triangle routing, how much slope matters (range 0-1).
|
protected Double |
triangleTimeFactor
For bike triangle routing, how much time matters (range 0-1).
|
protected String |
unpreferredAgencies
The comma-separated list of unpreferred agencies.
|
protected String |
unpreferredRoutes
The list of unpreferred routes.
|
protected Double |
waitAtBeginningFactor
How much less bad is waiting at the beginning of the trip (replaces waitReluctance)
|
protected Double |
waitReluctance
How much worse is waiting for a transit vehicle than being on a transit vehicle, as a
multiplier.
|
protected Integer |
walkBoardCost
Prevents unnecessary transfers by adding a cost for boarding a vehicle.
|
protected Double |
walkReluctance
A multiplier for how bad walking is, compared to being in transit for equal lengths of time.
|
protected Double |
walkSpeed
The user's walking speed in meters/second.
|
protected Boolean |
wheelchair
Whether the trip must be wheelchair accessible.
|
protected String |
whiteListedAgencies
Functions the same as banned agencies, except only the listed agencies are allowed.
|
protected String |
whiteListedRoutes
Functions the same as bannnedRoutes, except only the listed routes are allowed.
|
Constructor and Description |
---|
RoutingResource() |
Modifier and Type | Method and Description |
---|---|
protected RoutingRequest |
buildRequest()
Range/sanity check the query parameter fields and build a Request object from them.
|
@PathParam(value="routerId") public String routerId
@QueryParam(value="fromPlace") protected String fromPlace
40.714476,-74.005966
or
mtanyctsubway_A27_S
.@QueryParam(value="toPlace") protected String toPlace
@QueryParam(value="intermediatePlaces") protected List<String> intermediatePlaces
@QueryParam(value="date") protected String date
@QueryParam(value="time") protected String time
@QueryParam(value="arriveBy") protected Boolean arriveBy
@QueryParam(value="wheelchair") protected Boolean wheelchair
@QueryParam(value="maxWalkDistance") protected Double maxWalkDistance
@QueryParam(value="maxPreTransitTime") protected Integer maxPreTransitTime
@QueryParam(value="walkReluctance") protected Double walkReluctance
@QueryParam(value="waitReluctance") protected Double waitReluctance
@QueryParam(value="waitAtBeginningFactor") protected Double waitAtBeginningFactor
@QueryParam(value="walkSpeed") protected Double walkSpeed
@QueryParam(value="bikeSpeed") protected Double bikeSpeed
@QueryParam(value="bikeSwitchTime") protected Integer bikeSwitchTime
@QueryParam(value="bikeSwitchCost") protected Integer bikeSwitchCost
@QueryParam(value="triangleSafetyFactor") protected Double triangleSafetyFactor
@QueryParam(value="triangleSlopeFactor") protected Double triangleSlopeFactor
@QueryParam(value="triangleTimeFactor") protected Double triangleTimeFactor
@QueryParam(value="optimize") protected OptimizeType optimize
@QueryParam(value="mode") protected QualifiedModeSet modes
@QueryParam(value="minTransferTime") protected Integer minTransferTime
@QueryParam(value="numItineraries") protected Integer numItineraries
@QueryParam(value="preferredRoutes") protected String preferredRoutes
@QueryParam(value="otherThanPreferredRoutesPenalty") protected Integer otherThanPreferredRoutesPenalty
@QueryParam(value="preferredAgencies") protected String preferredAgencies
@QueryParam(value="unpreferredRoutes") protected String unpreferredRoutes
@QueryParam(value="unpreferredAgencies") protected String unpreferredAgencies
@QueryParam(value="showIntermediateStops") protected Boolean showIntermediateStops
@QueryParam(value="walkBoardCost") protected Integer walkBoardCost
@QueryParam(value="bikeBoardCost") protected Integer bikeBoardCost
@QueryParam(value="bannedRoutes") protected String bannedRoutes
@QueryParam(value="whiteListedRoutes") protected String whiteListedRoutes
@QueryParam(value="bannedAgencies") protected String bannedAgencies
@QueryParam(value="whiteListedAgencies") protected String whiteListedAgencies
@QueryParam(value="bannedTrips") protected String bannedTrips
@QueryParam(value="bannedStops") protected String bannedStops
@QueryParam(value="bannedStopsHard") protected String bannedStopsHard
@QueryParam(value="transferPenalty") protected Integer transferPenalty
@QueryParam(value="nonpreferredTransferPenalty") protected Integer nonpreferredTransferPenalty
@QueryParam(value="maxTransfers") protected Integer maxTransfers
@QueryParam(value="batch") protected Boolean batch
@QueryParam(value="startTransitStopId") protected String startTransitStopId
@QueryParam(value="startTransitTripId") protected String startTransitTripId
@QueryParam(value="clampInitialWait") protected Long clampInitialWait
@QueryParam(value="reverseOptimizeOnTheFly") protected Boolean reverseOptimizeOnTheFly
@QueryParam(value="ignoreRealtimeUpdates") protected Boolean ignoreRealtimeUpdates
@QueryParam(value="disableRemainingWeightHeuristic") protected Boolean disableRemainingWeightHeuristic
@QueryParam(value="flexFlagStopBufferSize") protected Double flexFlagStopBufferSize
@QueryParam(value="flexUseReservationServices") protected Boolean flexUseReservationServices
@QueryParam(value="flexUseEligibilityServices") protected Boolean flexUseEligibilityServices
@QueryParam(value="flexIgnoreDrtAdvanceBookMin") protected Boolean flexIgnoreDrtAdvanceBookMin
@Context protected OTPServer otpServer
protected RoutingRequest buildRequest() throws ParameterException
ParameterException
- when there is a problem interpreting a query parameterCopyright © 2019. All rights reserved.