com.pb.routing.gra.boundary

Class GetTravelBoundaryRequest.Builder

java.lang.Object

com.pb.routing.gra.boundary.GetTravelBoundaryRequest.Builder

Enclosing class:

GetTravelBoundaryRequest

public static final class GetTravelBoundaryRequest.Builder
extends Object

Builder class to create GetTravelBoundaryRequest object.

Constructor Summary

Constructors

Constructor and Description
Builder(IPoint point, double[] costs, LinearUnit linearUnit) Creates the GetTravelBoundaryRequest.Builder object for IsoDistance.
Builder(IPoint point, double[] costs, TimeUnit timeUnit) Creates the GetTravelBoundaryRequest.Builder object for IsoChrone.

Method Summary

Modifier and Type	Method and Description
GetTravelBoundaryRequest.Builder	ambientSpeeds(Map<RoadType,Double> ambientSpeeds) Sets the RoadType wise ambient speeds to be used while processing the request.
GetTravelBoundaryRequest.Builder	ambientSpeedUnit(VelocityUnit ambientSpeedUnit) Sets the Ambient Speed Unit for ambient speed for various RoadTypes.
GetTravelBoundaryRequest.Builder	avoidTollRoad(boolean avoidTollRoad) This method is used set whether toll road should be avoided or not.
GetTravelBoundaryRequest.Builder	bandingStyle(BandingStyle bandingStyle) Sets the Banding Style to be used while processing this request.
GetTravelBoundaryRequest	build() Create the GetTravelBoundaryRequest object.
GetTravelBoundaryRequest.Builder	DBResource(String dbResource) Sets the Database resource to be used while processing this request.
GetTravelBoundaryRequest.Builder	defaultAmbientSpeed(double defaultAmbientSpeed) Sets the default Ambient Speed to be used for all Road types.
GetTravelBoundaryRequest.Builder	destinationSrs(CoordSys destinationSrs) Sets the Destination Coordinate System for points in the response.
GetTravelBoundaryRequest.Builder	historicSpeedBucket(HistoricSpeedBucket historicSpeedBucket) Sets the Historic Traffic time bucket to be used while processing this request.
GetTravelBoundaryRequest.Builder	majorRoads(boolean majorRoads) Sets whether to calculate the boundary using only major roads or not.
GetTravelBoundaryRequest.Builder	maxOffRoadDistance(double maxOffRoadDistance) Sets the maximum Off-Road Distance for this request.
GetTravelBoundaryRequest.Builder	maxOffRoadDistanceUnit(LinearUnit maxOffRoadDistanceUnit) Sets the maximum Off-Road Distance Unit for this request.
GetTravelBoundaryRequest.Builder	propagationFactor(double defaultPropagationFactor) Sets the propagation factor used for the calculation of the iso.
GetTravelBoundaryRequest.Builder	propagationFactorOverride(Map<RoadType,Double> propagationFactorOverride) Overrides the propagation factor to be used in the calculation of the iso for a given RoadType Propagation factor applies only to isodistances, i.e.
GetTravelBoundaryRequest.Builder	returnHoles(boolean returnHoles) Sets whether to return holes as part of response while calculating the boundary.
GetTravelBoundaryRequest.Builder	returnIslands(boolean returnIslands) Sets whether to return islands as part of response while calculating the boundary.
GetTravelBoundaryRequest.Builder	simplificationFactor(double simplificationFactor) Sets the Simplification Factor.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(IPoint point,
               double[] costs,
               LinearUnit linearUnit)
        throws RoutingException

Creates the GetTravelBoundaryRequest.Builder object for IsoDistance.

Parameters:

point - Instance of IPoint containing the coordinates of the point for which you need to calculate the boundary.

costs - double array containing the cost value.

linearUnit - LinearUnit instance, unit for the cost values.

Throws:

RoutingException - If something goes wrong while processing the request.

Builder

public Builder(IPoint point,
               double[] costs,
               TimeUnit timeUnit)
        throws RoutingException

Creates the GetTravelBoundaryRequest.Builder object for IsoChrone.

Parameters:

point - Instance of IPoint containing the coordinates of the point for which you need to calculate the boundary.

costs - double array containing the cost value.

timeUnit - TimeUnit instance, unit for the cost values.

Throws:

RoutingException - If something goes wrong while processing the request.

Method Detail

build

public GetTravelBoundaryRequest build()
                               throws RoutingException

Create the GetTravelBoundaryRequest object.

Returns:

The GetTravelBoundaryRequest object.

Throws:

RoutingException - If something goes wrong while processing the request.

maxOffRoadDistance

public GetTravelBoundaryRequest.Builder maxOffRoadDistance(double maxOffRoadDistance)

Sets the maximum Off-Road Distance for this request.

Parameters:

maxOffRoadDistance - A double value for maxOffRoadDistance.

maxOffRoadDistanceUnit

public GetTravelBoundaryRequest.Builder maxOffRoadDistanceUnit(LinearUnit maxOffRoadDistanceUnit)

Sets the maximum Off-Road Distance Unit for this request.

Parameters:

maxOffRoadDistanceUnit - LinearUnit used as maxOffRoad distance unit.

returnHoles

public GetTravelBoundaryRequest.Builder returnHoles(boolean returnHoles)

Sets whether to return holes as part of response while calculating the boundary.

Parameters:

returnHoles - A boolean, true if holes are to be returned in response, false otherwise. Defaults to false.

returnIslands

public GetTravelBoundaryRequest.Builder returnIslands(boolean returnIslands)

Sets whether to return islands as part of response while calculating the boundary.

Parameters:

returnIslands - A boolean, true if islands are to be returned in response, false otherwise. Defaults to false.

simplificationFactor

public GetTravelBoundaryRequest.Builder simplificationFactor(double simplificationFactor)

Sets the Simplification Factor. Simplification Factor should be between 0 and 1 (0 ≤ simplificationFactor > 1)

Parameters:

simplificationFactor - A double value for simplification factor. If not specified, default of 0.5 will be used.

majorRoads

public GetTravelBoundaryRequest.Builder majorRoads(boolean majorRoads)

Sets whether to calculate the boundary using only major roads or not.

Parameters:

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

destinationSrs

public GetTravelBoundaryRequest.Builder destinationSrs(CoordSys destinationSrs)

Sets the Destination Coordinate System for points in the response.

Parameters:

destinationSrs - CoordSys, Destination Coordinate System for points in the response. Default is CoordSysConstants.longLatWGS84.

historicSpeedBucket

public GetTravelBoundaryRequest.Builder historicSpeedBucket(HistoricSpeedBucket historicSpeedBucket)

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

Parameters:

historicSpeedBucket - HistoricSpeedBucket, to be used while processing the request. Default is HistoricSpeedBucket.NONE.

bandingStyle

public GetTravelBoundaryRequest.Builder bandingStyle(BandingStyle bandingStyle)

Sets the Banding Style to be used while processing this request.

Parameters:

bandingStyle - BandingStyle value; Default is BandingStyle.DONUT.

ambientSpeeds

public GetTravelBoundaryRequest.Builder ambientSpeeds(Map<RoadType,Double> ambientSpeeds)

Sets the RoadType wise ambient speeds to be used while processing the request. Ambient Speed for each RoadType has to be set separately.

Parameters:

ambientSpeeds - HashMap of RoadType and speed corresponding to each type.

defaultAmbientSpeed

public GetTravelBoundaryRequest.Builder defaultAmbientSpeed(double defaultAmbientSpeed)

Sets the default Ambient Speed to be used for all Road types.

Parameters:

defaultAmbientSpeed - A double value for Default Ambient Speed.

ambientSpeedUnit

public GetTravelBoundaryRequest.Builder ambientSpeedUnit(VelocityUnit ambientSpeedUnit)

Sets the Ambient Speed Unit for ambient speed for various RoadTypes.

Parameters:

ambientSpeedUnit - VelocityUnit, speed unit to be used for Ambient speeds.

DBResource

public GetTravelBoundaryRequest.Builder DBResource(String dbResource)

Sets the Database resource to be used while processing this request.

Parameters:

dbResource - Name of Database resource to be used while processing this request.

propagationFactor

public GetTravelBoundaryRequest.Builder propagationFactor(double defaultPropagationFactor)

Sets the propagation factor used for the calculation of the iso. This propagation factor value is used for all the road types that do not have specific propagation factor overrides. Propagation factor is the percentage of the remaining cost for which off network travel is allowed. This property only applies to isodistances, i.e. an iso with a distance unit.
The default setting for this property is 0.16.
If this property is not specifically set the calculation will use the server setting. Values between 0.0 and 1.0 inclusive are valid.

propagationFactorOverride

public GetTravelBoundaryRequest.Builder propagationFactorOverride(Map<RoadType,Double> propagationFactorOverride)

Overrides the propagation factor to be used in the calculation of the iso for a given RoadType Propagation factor applies only to isodistances, i.e. an iso with a distance unit.

Parameters:

propagationFactorOverride - Map Propagation factor values between 0.0 and 1.0 inclusive are valid.

avoidTollRoad

public GetTravelBoundaryRequest.Builder avoidTollRoad(boolean avoidTollRoad)

This method is used set whether toll road should be avoided or not.

Parameters:

avoidTollRoad -

Returns: