com.pb.routing.gra.route

Class GetRouteRequest.Builder

java.lang.Object

com.pb.routing.gra.route.GetRouteRequest.Builder

Enclosing class:

GetRouteRequest

public static final class GetRouteRequest.Builder
extends Object

Builder class to create GetRouteRequest object.

Constructor Summary

Constructors

Constructor and Description
Builder(IPoint startPoint, IPoint endPoint) Creates the GetRouteRequest.Builder object.

Method Summary

Modifier and Type	Method and Description
GetRouteRequest.Builder	avoidTollRoad(boolean avoidTollRoad) Sets whether to calculate the route using only toll roads.
GetRouteRequest	build() Create the GetRouteRequest object.
GetRouteRequest.Builder	DBResource(String dbResource) Sets the Database resource to be used for this request.
GetRouteRequest.Builder	destinationSrs(CoordSys destinationSrs) Sets the Destination Coordinate System for points in response.
GetRouteRequest.Builder	distanceUnit(LinearUnit distanceUnit) Sets the Distance Unit in which route distance to be returned.
GetRouteRequest.Builder	historicSpeedBucket(HistoricSpeedBucket historicSpeedBucket) Sets the Historic Speed bucket to be used while processing this request.
GetRouteRequest.Builder	intermediatePoints(List<IPoint> intermediatePoints) Sets the list of Intermediate Points via which route is to be calculated.
GetRouteRequest.Builder	language(Language language) Sets the language in which turn by turn directions for route are to be returned.
GetRouteRequest.Builder	localRoadsLoadFactor(int localRoadsLoadFactor) Sets the localRoadsLoadFactor for this request.
GetRouteRequest.Builder	majorRoads(boolean majorRoads) Sets whether to calculate the route using only major roads.
GetRouteRequest.Builder	optimizeBy(OptimizeBy optimizeBy) Sets whether the fastest or shortest route is to be calculated.
GetRouteRequest.Builder	optimizeIntermediatePoints(boolean optimizeIntermediatePoints) Sets whether to optimize the sequence of intermediate points for route calculation if multiple intermediate points specified.
GetRouteRequest.Builder	returnDirectionGeometry(boolean returnDirectionGeometry) Returns whether to return direction geometry with RouteInstruction or not in route response.
GetRouteRequest.Builder	returnDirections(boolean returnDirections) Set whether to return turn by turn directions or not in route response.
GetRouteRequest.Builder	returnSegmentGeometry(boolean returnSegmentGeometry) Sets whether to return route geometry or not in route response.
GetRouteRequest.Builder	roadTypePreferences(Map<RoadType,RoadTypePriority> roadTypePreferences) Sets Map of RoadType and their RoadTypePriority.
GetRouteRequest.Builder	timeUnit(TimeUnit timeUnit) Sets the Time Unit in which route time is to be returned.
GetRouteRequest.Builder	updates(List<Update> updates) Sets the List of Update to be used for this request.
GetRouteRequest.Builder	vehicleAttr(VehicleAttributes vehicleAttr) Sets the Commercial Vehicle Restrictions value to be used while processing this request.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(IPoint startPoint,
               IPoint endPoint)
        throws RoutingException

Creates the GetRouteRequest.Builder object.

Parameters:

startPoint - Instance of IPoint containing the coordinates of the point from which the route needs to be calculated.

endPoint - Instance of IPoint containing the coordinates of the point to which the route needs to be calculated.

Throws:

RoutingException - If something goes wrong while processing the request.

Method Detail

build

public GetRouteRequest build()
                      throws RoutingException

Create the GetRouteRequest object.

Returns:

The GetRouteRequest object.

Throws:

RoutingException - If something goes wrong while processing the request.

distanceUnit

public GetRouteRequest.Builder distanceUnit(LinearUnit distanceUnit)

Sets the Distance Unit in which route distance to be returned.

Parameters:

distanceUnit - LinearUnit value in which route distance to be returned. Defaults to LinearUnit.METER.

timeUnit

public GetRouteRequest.Builder timeUnit(TimeUnit timeUnit)

Sets the Time Unit in which route time is to be returned.

Parameters:

timeUnit - TimeUnit value in which route time is to be returned. Defaults to TimeUnit.MINUTE.

intermediatePoints

public GetRouteRequest.Builder intermediatePoints(List<IPoint> intermediatePoints)

Sets the list of Intermediate Points via which route is to be calculated.

Parameters:

intermediatePoints - List of IPoint via which route is to be calculated.

optimizeBy

public GetRouteRequest.Builder optimizeBy(OptimizeBy optimizeBy)

Sets whether the fastest or shortest route is to be calculated. OptimizeBy.TIME means fastest and OptimizeBy.DISTANCE means shortest.

Parameters:

optimizeBy - The optimization parameter for route calculation. Defaults to OptimizeBy.TIME.

language

public GetRouteRequest.Builder language(Language language)

Sets the language in which turn by turn directions for route are to be returned.

Parameters:

language - A Language in which turn by turn directions for route are to be returned. Default is Language.ENGLISH.

returnDirections

public GetRouteRequest.Builder returnDirections(boolean returnDirections)

Set whether to return turn by turn directions or not in route response.

Parameters:

returnDirections - A boolean, true if turn by turn directions to return for route, false otherwise. Defaults to false.

returnSegmentGeometry

public GetRouteRequest.Builder returnSegmentGeometry(boolean returnSegmentGeometry)

Sets whether to return route geometry or not in route response.

Parameters:

returnSegmentGeometry - A boolean, true if route geometry to be returned or not in route response, false otherwise. Defaults to false.

optimizeIntermediatePoints

public GetRouteRequest.Builder optimizeIntermediatePoints(boolean optimizeIntermediatePoints)

Sets whether to optimize the sequence of intermediate points for route calculation if multiple intermediate points specified.

Parameters:

optimizeIntermediatePoints - A boolean, true if the sequence of intermediate points for route calculation to be optimized, false otherwise Defaults to false.

roadTypePreferences

public GetRouteRequest.Builder roadTypePreferences(Map<RoadType,RoadTypePriority> roadTypePreferences)

Sets Map of RoadType and their RoadTypePriority. Used to force usage or avoid certain type of roads while route calculation.

Parameters:

roadTypePreferences - Map of RoadType and their RoadTypePriority.

majorRoads

public GetRouteRequest.Builder majorRoads(boolean majorRoads)

Sets whether to calculate the route using only major roads.

Parameters:

majorRoads - A boolean, true value means boundary is calculated using major roads only, false means minor roads are also considered. Defaults to false.

avoidTollRoad

public GetRouteRequest.Builder avoidTollRoad(boolean avoidTollRoad)

Sets whether to calculate the route using only toll roads.

Parameters:

avoidTollRoad - A boolean, true = the request should avoid toll roads; false = the request should include toll roads

destinationSrs

public GetRouteRequest.Builder destinationSrs(CoordSys destinationSrs)

Sets the Destination Coordinate System for points in response.

Parameters:

destinationSrs - CoordSys, coordinate system for points in response. Default is CoordSysConstants.longLatWGS84

historicSpeedBucket

public GetRouteRequest.Builder historicSpeedBucket(HistoricSpeedBucket historicSpeedBucket)

Sets the Historic Speed bucket to be used while processing this request.

Parameters:

historicSpeedBucket - HistoricSpeedBucket to be used for request. Default is HistoricSpeedBucket.NONE.

vehicleAttr

public GetRouteRequest.Builder vehicleAttr(VehicleAttributes vehicleAttr)
                                    throws RoutingException

Sets the Commercial Vehicle Restrictions value to be used while processing this request.

Parameters:

vehicleAttr - VehicleAttributes to be used for request.

Throws:

RoutingException

DBResource

public GetRouteRequest.Builder DBResource(String dbResource)

Sets the Database resource to be used for this request.

Parameters:

dbResource - Database resource to be used for processing the request.

returnDirectionGeometry

public GetRouteRequest.Builder returnDirectionGeometry(boolean returnDirectionGeometry)

Returns whether to return direction geometry with RouteInstruction or not in route response.

Returns:

A boolean, true if direction geometry is to be returned with RouteInstruction for route, false otherwise. Defaults to false.

updates

public GetRouteRequest.Builder updates(List<Update> updates)

Sets the List of Update to be used for this request.

Parameters:

updates - list to be used while processing this request.

localRoadsLoadFactor

public GetRouteRequest.Builder localRoadsLoadFactor(int localRoadsLoadFactor)

Sets the localRoadsLoadFactor for this request. Higher values of this factor would mean more local roads will be loaded in memory for route calculation. This will increase the probability of more accurate routes but this has direct impact on performance. Higher the value more severe the impact will be on performance. So, use this parameter with caution in only those scenarios where you think engine is not returning optimal route.

Parameters:

localRoadsLoadFactor - - localRoadsLoadFactor used for loading minor roads in memory for route calculation. Value should be between 1 and 3 both inclusive.