public class RouteQueryBuilder extends java.lang.Object implements IRouteQuery
RouteQuery
object which is used to prepare the query for the Routing API.Constructor and Description |
---|
RouteQueryBuilder(LatLng origPosition,
LatLng destPosition) |
Modifier and Type | Method and Description |
---|---|
RouteQuery |
build()
Creates new instance of
RouteQuery |
static RouteQueryBuilder |
create(LatLng origPosition,
LatLng destPosition)
Creates an instance of
RouteQuery with given origin and destination. |
RouteQueryBuilder |
withAccelerationEfficiency(java.lang.Double accelerationEfficiency)
Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the
vehicle decelerates (i.e.
|
RouteQueryBuilder |
withAllowVignette(java.lang.String allowVignette) |
RouteQueryBuilder |
withAllowVignettes(java.util.List<java.lang.String> allowVignettes)
List of 3-character ISO 3166-1 alpha-3 country codes of countries in which all toll roads with vignettes are allowed.
|
RouteQueryBuilder |
withAlternativeType(AlternativeType alternativeType)
Controls the optimality, with respect to the given planning criteria, of the calculated alternatives compared to the reference route.
|
RouteQueryBuilder |
withArriveAt(java.util.Date arriveAt)
Specifies the desired arrival time for the route to calculation.
|
RouteQueryBuilder |
withAuxiliaryPowerInKW(java.lang.Double auxiliaryPowerInKW)
Specifies the amount of power consumed for sustaining auxiliary systems, in kilowatts (kW).
|
RouteQueryBuilder |
withAuxiliaryPowerInLitersPerHour(java.lang.Double auxiliaryPowerInLitersPerHour)
Specifies the amount of fuel consumed for sustaining auxiliary systems of the vehicle, in
liters per hour.
|
RouteQueryBuilder |
withAvoidArea(com.tomtom.online.sdk.common.location.BoundingBox avoidArea) |
RouteQueryBuilder |
withAvoidAreas(java.util.List<com.tomtom.online.sdk.common.location.BoundingBox> avoidAreas)
A list of rectangles that define areas that are to be avoided during route calculation.
|
RouteQueryBuilder |
withAvoidType(Avoid avoidType)
Specifies what the route calculation should try to avoid when determining the route.Can be specified multiple times.
|
RouteQueryBuilder |
withAvoidVignette(java.lang.String avoidVignette) |
RouteQueryBuilder |
withAvoidVignettes(java.util.List<java.lang.String> avoidVignettes)
List of 3-character ISO 3166-1 alpha-3 country codes of countries in which all toll roads with vignettes are to be avoided.
|
RouteQueryBuilder |
withComputeBestOrder(java.lang.Boolean computeBestOrder)
Specifies if the best order of waypoints should be used to compute route.
|
RouteQueryBuilder |
withComputeTravelTimeFor(TravelTimeType computeTravelTimeFor)
Specifies whether to return additional travel times using different types of traffic information (none, historic, live)
as well as the default best-estimate travel time.
|
RouteQueryBuilder |
withConsiderTraffic(java.lang.Boolean considerTraffic)
Specifies if all available traffic information should be considered during routing.
|
RouteQueryBuilder |
withConstantSpeedConsumptionInKWhPerHundredKm(SpeedToConsumptionMap constantSpeedConsumptionInKWhPerHundredKm)
Specifies the speed-dependent component of consumption.
|
RouteQueryBuilder |
withConstantSpeedConsumptionInLitersPerHundredKm(SpeedToConsumptionMap constantSpeedConsumptionInLitersPerHundredKm)
Specifies the speed-dependent component of consumption.
|
RouteQueryBuilder |
withCurrentChargeInKWh(java.lang.Double currentChargeInKWh)
Specifies the current electric energy supply in kilowatt hours (kWh).
|
RouteQueryBuilder |
withCurrentFuelInLiters(java.lang.Double currentFuelInLiters)
Specifies the current supply of fuel in liters.
|
RouteQueryBuilder |
withDecelerationEfficiency(java.lang.Double decelerationEfficiency)
Specifies the efficiency of converting chemical energy stored in fuel to potential energy
when the vehicle gains elevation (i.e.
|
RouteQueryBuilder |
withDepartAt(java.util.Date departAt)
Specifies the departure time.
|
RouteQueryBuilder |
withDownhillEfficiency(java.lang.Double downhillEfficiency)
Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the
vehicle loses elevation (i.e.
|
RouteQueryBuilder |
withFuelEnergyDensityInMJoulesPerLiter(java.lang.Double fuelEnergyDensityInMJoulesPerLiter)
Specifies the amount of chemical energy stored in one liter of fuel in megajoules (MJ).
|
RouteQueryBuilder |
withHilliness(Hilliness hilliness)
Specifies the hilliness type for route calculation.
|
RouteQueryBuilder |
withInstructionsType(InstructionsType instructionsType)
Specifies the instructions type for the route calculation.
|
RouteQueryBuilder |
withLanguage(java.lang.String language)
Specifies the language used for route calculation.
|
RouteQueryBuilder |
withMaxAlternatives(java.lang.Integer maxAlternatives)
Specifies the maximal number of route alternatives to be calculated by service.
|
RouteQueryBuilder |
withMaxChargeInKWh(java.lang.Double maxChargeInKWh)
Specifies the capacity of the vehicle's battery in kilowatt hours (kWh).
|
RouteQueryBuilder |
withMinDeviationDistance(java.lang.Integer minDeviationDistance)
All alternative routes returned will follow the reference route from the origin
point of the calculateRoute request for at least this number of meters.
|
RouteQueryBuilder |
withMinDeviationTime(java.lang.Integer minDeviationTime)
All alternative routes returned will follow the reference route from the origin
point of the calculateRoute request for at least this number of seconds.
|
RouteQueryBuilder |
withReport(Report report)
Specifies if the report should be provided on route query response.
|
RouteQueryBuilder |
withRouteRepresentation(RouteRepresentation routeRepresentation)
Specifies the route representation for the route calculation.
|
RouteQueryBuilder |
withRouteType(RouteType routeType)
Specifies the route type.
|
RouteQueryBuilder |
withSectionType(SectionType sectionType)
Specifies which of the section types is reported in the route response.
|
RouteQueryBuilder |
withSupportingPoint(LatLng supportingPoint) |
RouteQueryBuilder |
withSupportingPoints(java.util.List<LatLng> supportingPoints)
A list of base route points to be used as input for route reconstruction.
|
RouteQueryBuilder |
withTravelMode(TravelMode travelMode)
Specifies the travel mode for route calculation.
|
RouteQueryBuilder |
withUphillEfficiency(java.lang.Double uphillEfficiency)
Specifies the efficiency of converting chemical energy stored in fuel to potential energy
when the vehicle gains elevation (i.e.
|
RouteQueryBuilder |
withVehicleAxleWeightInKg(java.lang.Integer vehicleAxleWeightInKg)
Specifies the vehicle axle weight for route calculation.
|
RouteQueryBuilder |
withVehicleCommercial(java.lang.Boolean vehicleCommercial)
Specifies if the vehicle is used for commercial to calculate route.
|
RouteQueryBuilder |
withVehicleEngineType(VehicleEngineType vehicleEngineType)
Specifies the vehicle engine type for route query.
|
RouteQueryBuilder |
withVehicleHeading(java.lang.Integer vehicleHeading)
Specifies the vehicle heading for route calculation.
|
RouteQueryBuilder |
withVehicleHeightInMeters(java.lang.Double vehicleHeightInMeters)
Specifies the vehicle height for route calculation.
|
RouteQueryBuilder |
withVehicleLengthInMeters(java.lang.Double vehicleLengthInMeters)
Specifies the vehicle length for route calculation.
|
RouteQueryBuilder |
withVehicleLoadType(VehicleLoadType vehicleLoadType)
Specifies the vehicle load type for route calculation.
|
RouteQueryBuilder |
withVehicleMaxSpeedInKph(java.lang.Integer vehicleMaxSpeedInKph)
Specifies the vehicle max speed for route calculation.
|
RouteQueryBuilder |
withVehicleWeightInKg(java.lang.Integer vehicleWeightInKg)
Specifies the vehicle weight in kilograms for route calculation.
|
RouteQueryBuilder |
withVehicleWidthInMeters(java.lang.Double vehicleWidthInMeters)
Specifies the vehicle width for route calculation.
|
RouteQueryBuilder |
withWayPoints(LatLng[] wayPoints)
Specifies the array of map coordinate whose geographical information your waypoints for the route calculation.
|
RouteQueryBuilder |
withWayPointsList(java.util.List<LatLng> wayPointsList)
Specifies the array of map coordinate whose geographical information your waypoints for the route calculation.
|
RouteQueryBuilder |
withWayPointsWithAcc(java.util.List<com.tomtom.online.sdk.common.location.LatLngAcc> wayPointsWithAcc)
Specifies the array of map coordinate whose geographical information your waypoints with radius for the route calculation.
|
RouteQueryBuilder |
withWindingness(Windingness windingness)
Specifies the windingness type for route calculation.
|
public RouteQueryBuilder withWayPoints(LatLng[] wayPoints)
IRouteQuery
withWayPoints
in interface IRouteQuery
public RouteQueryBuilder withWayPointsList(java.util.List<LatLng> wayPointsList)
IRouteQuery
withWayPointsList
in interface IRouteQuery
public RouteQueryBuilder withWayPointsWithAcc(java.util.List<com.tomtom.online.sdk.common.location.LatLngAcc> wayPointsWithAcc)
IRouteQuery
withWayPointsWithAcc
in interface IRouteQuery
public RouteQueryBuilder withMaxAlternatives(java.lang.Integer maxAlternatives)
IRouteQuery
withMaxAlternatives
in interface IRouteQuery
public RouteQueryBuilder withAlternativeType(AlternativeType alternativeType)
IRouteQuery
withAlternativeType
in interface IRouteQuery
public RouteQueryBuilder withMinDeviationDistance(java.lang.Integer minDeviationDistance)
IRouteQuery
withMinDeviationDistance
in interface IRouteQuery
public RouteQueryBuilder withMinDeviationTime(java.lang.Integer minDeviationTime)
IRouteQuery
withMinDeviationTime
in interface IRouteQuery
public RouteQueryBuilder withInstructionsType(InstructionsType instructionsType)
IRouteQuery
withInstructionsType
in interface IRouteQuery
public RouteQueryBuilder withLanguage(java.lang.String language)
IRouteQuery
withLanguage
in interface IRouteQuery
public RouteQueryBuilder withComputeBestOrder(java.lang.Boolean computeBestOrder)
IRouteQuery
withComputeBestOrder
in interface IRouteQuery
public RouteQueryBuilder withRouteRepresentation(RouteRepresentation routeRepresentation)
IRouteQuery
withRouteRepresentation
in interface IRouteQuery
public RouteQueryBuilder withComputeTravelTimeFor(TravelTimeType computeTravelTimeFor)
IRouteQuery
withComputeTravelTimeFor
in interface IRouteQuery
public RouteQueryBuilder withVehicleHeading(java.lang.Integer vehicleHeading)
IRouteQuery
withVehicleHeading
in interface IRouteQuery
public RouteQueryBuilder withSectionType(SectionType sectionType)
IRouteQuery
withSectionType
in interface IRouteQuery
public RouteQueryBuilder withReport(Report report)
IRouteQuery
withReport
in interface IRouteQuery
public RouteQueryBuilder withSupportingPoint(LatLng supportingPoint)
public RouteQueryBuilder withSupportingPoints(java.util.List<LatLng> supportingPoints)
IRouteQuery
withSupportingPoints
in interface IRouteQuery
public RouteQueryBuilder withAvoidVignette(java.lang.String avoidVignette)
public RouteQueryBuilder withAvoidVignettes(java.util.List<java.lang.String> avoidVignettes)
IRouteQuery
withAvoidVignettes
in interface IRouteQuery
public RouteQueryBuilder withAllowVignette(java.lang.String allowVignette)
public RouteQueryBuilder withAllowVignettes(java.util.List<java.lang.String> allowVignettes)
IRouteQuery
withAllowVignettes
in interface IRouteQuery
public RouteQueryBuilder withArriveAt(java.util.Date arriveAt)
IRouteQuery
withArriveAt
in interface IRouteQuery
public RouteQueryBuilder withAvoidArea(com.tomtom.online.sdk.common.location.BoundingBox avoidArea)
public RouteQueryBuilder withAvoidAreas(java.util.List<com.tomtom.online.sdk.common.location.BoundingBox> avoidAreas)
IRouteQuery
withAvoidAreas
in interface IRouteQuery
public RouteQueryBuilder withDepartAt(java.util.Date departAt)
withDepartAt
in interface IRouteQuery
departAt
- public RouteQueryBuilder withRouteType(RouteType routeType)
withRouteType
in interface IRouteQuery
routeType
- public RouteQueryBuilder withConsiderTraffic(java.lang.Boolean considerTraffic)
withConsiderTraffic
in interface IRouteQuery
considerTraffic
- public RouteQueryBuilder withAvoidType(Avoid avoidType)
withAvoidType
in interface IRouteQuery
avoidType
- public RouteQueryBuilder withTravelMode(TravelMode travelMode)
withTravelMode
in interface IRouteQuery
travelMode
- public RouteQueryBuilder withHilliness(Hilliness hilliness)
withHilliness
in interface IRouteQuery
hilliness
- public RouteQueryBuilder withWindingness(Windingness windingness)
withWindingness
in interface IRouteQuery
windingness
- public RouteQueryBuilder withVehicleMaxSpeedInKph(java.lang.Integer vehicleMaxSpeedInKph)
withVehicleMaxSpeedInKph
in interface IRouteQuery
vehicleMaxSpeedInKph
- public RouteQueryBuilder withVehicleWeightInKg(java.lang.Integer vehicleWeightInKg)
withVehicleWeightInKg
in interface IRouteQuery
vehicleWeightInKg
- public RouteQueryBuilder withVehicleAxleWeightInKg(java.lang.Integer vehicleAxleWeightInKg)
withVehicleAxleWeightInKg
in interface IRouteQuery
vehicleAxleWeightInKg
- public RouteQueryBuilder withVehicleLengthInMeters(java.lang.Double vehicleLengthInMeters)
withVehicleLengthInMeters
in interface IRouteQuery
vehicleLengthInMeters
- public RouteQueryBuilder withVehicleWidthInMeters(java.lang.Double vehicleWidthInMeters)
withVehicleWidthInMeters
in interface IRouteQuery
vehicleWidthInMeters
- public RouteQueryBuilder withVehicleHeightInMeters(java.lang.Double vehicleHeightInMeters)
withVehicleHeightInMeters
in interface IRouteQuery
vehicleHeightInMeters
- public RouteQueryBuilder withVehicleCommercial(java.lang.Boolean vehicleCommercial)
withVehicleCommercial
in interface IRouteQuery
isVehicleCommercial
- public RouteQueryBuilder withVehicleLoadType(VehicleLoadType vehicleLoadType)
withVehicleLoadType
in interface IRouteQuery
vehicleLoadType
- public RouteQueryBuilder withVehicleEngineType(VehicleEngineType vehicleEngineType)
withVehicleEngineType
in interface IRouteQuery
vehicleEngineType
- public RouteQueryBuilder withConstantSpeedConsumptionInLitersPerHundredKm(SpeedToConsumptionMap constantSpeedConsumptionInLitersPerHundredKm)
withConstantSpeedConsumptionInLitersPerHundredKm
in interface IRouteQuery
constantSpeedConsumptionInLitersPerHundredKm
- constraints: size - [1, 25], consumption value - [0.01, 100000.0]public RouteQueryBuilder withCurrentFuelInLiters(java.lang.Double currentFuelInLiters)
withCurrentFuelInLiters
in interface IRouteQuery
currentFuelInLiters
- public RouteQueryBuilder withAuxiliaryPowerInLitersPerHour(java.lang.Double auxiliaryPowerInLitersPerHour)
withAuxiliaryPowerInLitersPerHour
in interface IRouteQuery
auxiliaryPowerInLitersPerHour
- public RouteQueryBuilder withFuelEnergyDensityInMJoulesPerLiter(java.lang.Double fuelEnergyDensityInMJoulesPerLiter)
withFuelEnergyDensityInMJoulesPerLiter
in interface IRouteQuery
fuelEnergyDensityInMJoulesPerLiter
- public RouteQueryBuilder withAccelerationEfficiency(java.lang.Double accelerationEfficiency)
#withAccelerationEfficiency(double)
.
If used, #withVehicleWeightInKg(int)
has to be used as well.withAccelerationEfficiency
in interface IRouteQuery
decelerationEfficiency
- valid values: [0.0, 1/accelerationEfficiency]public RouteQueryBuilder withDecelerationEfficiency(java.lang.Double decelerationEfficiency)
#withDownhillEfficiency(double)
.
If used, #withVehicleWeightInKg(int)
has to be used as well.withDecelerationEfficiency
in interface IRouteQuery
uphillEfficiency
- valid values: [0.0, 1/downhillEfficiency]public RouteQueryBuilder withUphillEfficiency(java.lang.Double uphillEfficiency)
#withDownhillEfficiency(double)
.
If used, #withVehicleWeightInKg(int)
has to be used as well.withUphillEfficiency
in interface IRouteQuery
uphillEfficiency
- valid values: [0.0, 1/downhillEfficiency]public RouteQueryBuilder withDownhillEfficiency(java.lang.Double downhillEfficiency)
#withUphillEfficiency(double)
.
If used, #withVehicleWeightInKg(int)
has to be used as well.withDownhillEfficiency
in interface IRouteQuery
downhillEfficiency
- valid values: [0.0, 1/uphillEfficiency]public RouteQueryBuilder withConstantSpeedConsumptionInKWhPerHundredKm(SpeedToConsumptionMap constantSpeedConsumptionInKWhPerHundredKm)
withConstantSpeedConsumptionInKWhPerHundredKm
in interface IRouteQuery
constantSpeedConsumptionInKWhPerHundredKm
- constraints: size - [1, 25], consumption value - [0.01, 100000.0]public RouteQueryBuilder withCurrentChargeInKWh(java.lang.Double currentChargeInKWh)
#withMaxChargeInKWh(double)
.withCurrentChargeInKWh
in interface IRouteQuery
currentChargeInKWh
- public RouteQueryBuilder withMaxChargeInKWh(java.lang.Double maxChargeInKWh)
#withCurrentChargeInKWh(double)
.withMaxChargeInKWh
in interface IRouteQuery
maxChargeInKWh
- public RouteQueryBuilder withAuxiliaryPowerInKW(java.lang.Double auxiliaryPowerInKW)
withAuxiliaryPowerInKW
in interface IRouteQuery
auxiliaryPowerInKW
- public static RouteQueryBuilder create(LatLng origPosition, LatLng destPosition)
RouteQuery
with given origin and destination.RouteQuery
to be used for further processingpublic RouteQuery build()
RouteQuery