com.pb.routing.gra.matrix

Class GetRouteCostMatrixRequest.Builder

java.lang.Object

com.pb.routing.gra.matrix.GetRouteCostMatrixRequest.Builder

Enclosing class:

GetRouteCostMatrixRequest

public static final class GetRouteCostMatrixRequest.Builder
extends Object

Builder class to create GetRouteCostMatrixRequest object.

Constructor Summary

Constructors

Constructor and Description
Builder(List<IPoint> startPoints, List<IPoint> endPoints) Creates the GetRouteCostMatrixRequest.Builder object.

Method Summary

Modifier and Type	Method and Description
GetRouteCostMatrixRequest.Builder	avoidTollRoad(boolean avoidTollRoad) Sets whether to calculate the route using only toll roads.
GetRouteCostMatrixRequest	build() Create the GetRouteCostMatrixRequest object.
GetRouteCostMatrixRequest.Builder	DBResource(String dbResource) Sets the Database resource to be used for this request.
GetRouteCostMatrixRequest.Builder	destinationSrs(CoordSys destinationSrs) Sets the Destination Coordinate System for points in response.
GetRouteCostMatrixRequest.Builder	distanceUnit(LinearUnit distanceUnit) Sets the Distance Unit in which the route distance is to be returned.
GetRouteCostMatrixRequest.Builder	historicSpeedBucket(HistoricSpeedBucket historicSpeedBucket) Sets the Historic Speed bucket to be used while processing this request.
GetRouteCostMatrixRequest.Builder	localRoadsLoadFactor(int localRoadsLoadFactor) Sets the localRoadsLoadFactor for this request.
GetRouteCostMatrixRequest.Builder	majorRoads(boolean majorRoads) Sets whether to calculate the route using only major roads.
GetRouteCostMatrixRequest.Builder	optimizeBy(OptimizeBy optimizeBy) Sets whether the fastest or shortest route is to be calculated.
GetRouteCostMatrixRequest.Builder	returnOptimalRoutesOnly(boolean returnOptimalRoutesOnly) Sets whether to return only optimal route costs or complete route cost matrix.
GetRouteCostMatrixRequest.Builder	roadTypePreferences(Map<RoadType,RoadTypePriority> roadTypePreferences) Sets Map of RoadType and their RoadTypePriority.
GetRouteCostMatrixRequest.Builder	timeUnit(TimeUnit timeUnit) Sets the Time Unit in which the route time is to be returned.
GetRouteCostMatrixRequest.Builder	updates(List<Update> updates) Sets the List of Update to be used for this request.
GetRouteCostMatrixRequest.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(List<IPoint> startPoints,
               List<IPoint> endPoints)
        throws RoutingException

Creates the GetRouteCostMatrixRequest.Builder object.

Parameters:

startPoints - List of IPoint containing the coordinates of the point from which route needs to be calculated.

endPoints - List of IPoint containing the coordinates of the point to which route needs to be calculated.

Throws:

RoutingException - If something goes wrong while processing the request.

Method Detail

build

public GetRouteCostMatrixRequest build()
                                throws RoutingException

Create the GetRouteCostMatrixRequest object.

Returns:

GetRouteCostMatrixRequest object.

Throws:

RoutingException - If something goes wrong while processing the request.

distanceUnit

public GetRouteCostMatrixRequest.Builder distanceUnit(LinearUnit distanceUnit)

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

Parameters:

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

timeUnit

public GetRouteCostMatrixRequest.Builder timeUnit(TimeUnit timeUnit)

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

Parameters:

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

optimizeBy

public GetRouteCostMatrixRequest.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.

returnOptimalRoutesOnly

public GetRouteCostMatrixRequest.Builder returnOptimalRoutesOnly(boolean returnOptimalRoutesOnly)

Sets whether to return only optimal route costs or complete route cost matrix.

Parameters:

returnOptimalRoutesOnly - A boolean, true value means only optimal route costs, false means return complete route cost matrix. Defaults to false.

roadTypePreferences

public GetRouteCostMatrixRequest.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 GetRouteCostMatrixRequest.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 GetRouteCostMatrixRequest.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 GetRouteCostMatrixRequest.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 GetRouteCostMatrixRequest.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 GetRouteCostMatrixRequest.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 GetRouteCostMatrixRequest.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.

updates

public GetRouteCostMatrixRequest.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 GetRouteCostMatrixRequest.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.