com.tomtom.online.sdk.routing.data

Class RouteQueryBuilder

java.lang.Object

com.tomtom.online.sdk.routing.data.RouteQueryBuilder

All Implemented Interfaces:

RouteQuery

public class RouteQueryBuilder
extends java.lang.Object
implements RouteQuery

The default implementation of RouteQuery object which is used to prepare the query to the Online Route service.

Constructor Summary

Constructors

Constructor and Description
RouteQueryBuilder(LatLng origPosition, LatLng destPosition)

Method Summary

Modifier and Type	Method and Description
void	dispose() Remove all internal references, clear memory.
RouteQueryBuilder	withAccelerationEfficiency(float accelerationEfficiency) Specifies the efficiency of converting chemical energy stored in fuel to kinetic energy when the vehicle accelerates (i.e.
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(float auxiliaryPowerInkW) Specifies the amount of power consumed for sustaining auxiliary systems, in kilowatts (kW).
RouteQueryBuilder	withAuxiliaryPowerInLitersPerHour(float auxiliaryPowerInLitersPerHour) Specifies the amount of fuel consumed for sustaining auxiliary systems of the vehicle, in liters per hour.
RouteQueryBuilder	withAvoidType(Avoid avoidType) Specifies what the route calculation should try to avoid when determining the route.
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(boolean isComputeBestOrder) 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	withConstantSpeedConsumptionInkWh(java.util.Map<java.lang.Integer,java.lang.Double> speedConsumptionInkWhPairs) Specifies the speed-dependent component of consumption.
RouteQueryBuilder	withConstantSpeedConsumptionInLiters(java.util.Map<java.lang.Integer,java.lang.Double> speedConsumptionInLitersPairs) Specifies the speed-dependent component of consumption.
RouteQueryBuilder	withCurrentChargeInkWh(float currentChargeInkWh) Specifies the current electric energy supply in kilowatt hours (kWh).
RouteQueryBuilder	withCurrentFuelInLiters(float currentFuelInLiters) Specifies the current supply of fuel in liters.
RouteQueryBuilder	withDecelerationEfficiency(float decelerationEfficiency) Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the vehicle decelerates (i.e.
RouteQueryBuilder	withDepartAt(java.util.Date departAt) Specifies the departure time for the route to calculation.
RouteQueryBuilder	withDownhillEfficiency(float downhillEfficiency) Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the vehicle loses elevation (i.e.
RouteQueryBuilder	withFuelEnergyDensityInMJoulesPerLiter(float 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(int maxAlternatives) Specifies the maximal number of route alternatives to be calculated by service.
RouteQueryBuilder	withMaxChargeInkWh(float maxChargeInkWh) Specifies the maximum electric energy supply in kilowatt hours (kWh) that may be stored in the vehicle's battery.
RouteQueryBuilder	withMinDeviationDistance(int 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(int 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 for the route calculation.
RouteQueryBuilder	withSectionType(SectionType sectionType) Specifies which of the section types is reported in the route response.
RouteQueryBuilder	withSupportingPoints(java.util.List<LatLng> supportingPoints) A list of base route points to be used as input for route reconstruction.
RouteQueryBuilder	withTraffic(boolean isWithTraffic) Specifies if it should consider all available traffic information during routing.
RouteQueryBuilder	withTravelMode(TravelMode travelMode) Specifies the travel mode for the route calculation.
RouteQueryBuilder	withUphillEfficiency(float uphillEfficiency) Specifies the efficiency of converting chemical energy stored in fuel to potential energy when the vehicle gains elevation (i.e.
RouteQueryBuilder	withVehicleAxleWeight(int vehicleAxleWeight) Specifies the vehicle axle weight for route calculation.
RouteQueryBuilder	withVehicleCommercial(boolean isVehicleCommercial) 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(int vehicleHeading) Specifies the vehicle heading for route calculation.
RouteQueryBuilder	withVehicleHeight(float vehicleHeight) Specifies the vehicle height for route calculation.
RouteQueryBuilder	withVehicleLength(float vehicleLength) Specifies the vehicle length for route calculation.
RouteQueryBuilder	withVehicleLoadType(VehicleLoadType vehicleLoadType) Specifies the vehicle load type for route calculation.
RouteQueryBuilder	withVehicleMaxSpeed(int vehicleMaxSpeed) Specifies the vehicle max speed for route calculation.
RouteQueryBuilder	withVehicleWeight(int vehicleWeight) Specifies the vehicle weight in kilograms for route calculation.
RouteQueryBuilder	withVehicleWidth(float vehicleWidth) 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	withWindingness(Windingness windingness) Specifies the windingness type for route calculation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tomtom.online.sdk.routing.data.RouteQuery

getNativeHandle

Constructor Detail

RouteQueryBuilder

public RouteQueryBuilder(LatLng origPosition,
                         LatLng destPosition)
                  throws java.lang.IllegalArgumentException

Parameters:

origPosition - A location of the origin defined as a latitude longitude pair.

destPosition - A location of the destination defined as a latitude longitude pair.

Throws:

java.lang.IllegalArgumentException

Method Detail

dispose

public void dispose()

Description copied from interface: RouteQuery

Remove all internal references, clear memory.

Specified by:

dispose in interface RouteQuery

withWayPoints

public RouteQueryBuilder withWayPoints(LatLng[] wayPoints)

Description copied from interface: RouteQuery

Specifies the array of map coordinate whose geographical information your waypoints for the route calculation.

Specified by:

withWayPoints in interface RouteQuery

Returns:

the route query

withMaxAlternatives

public RouteQueryBuilder withMaxAlternatives(int maxAlternatives)

Description copied from interface: RouteQuery

Specifies the maximal number of route alternatives to be calculated by service.

Specified by:

withMaxAlternatives in interface RouteQuery

Returns:

the route query

withAlternativeType

public RouteQueryBuilder withAlternativeType(AlternativeType alternativeType)

Description copied from interface: RouteQuery

Controls the optimality, with respect to the given planning criteria, of the calculated alternatives compared to the reference route.

Specified by:

withAlternativeType in interface RouteQuery

Returns:

the route query

withMinDeviationDistance

public RouteQueryBuilder withMinDeviationDistance(int minDeviationDistance)

Description copied from interface: RouteQuery

All alternative routes returned will follow the reference route from the origin point of the calculateRoute request for at least this number of meters. Can only be used when reconstructing a route. The minDeviationDistance parameter cannot be used in conjunction with arriveAt.

Specified by:

withMinDeviationDistance in interface RouteQuery

Returns:

the route query

withMinDeviationTime

public RouteQueryBuilder withMinDeviationTime(int minDeviationTime)

Description copied from interface: RouteQuery

All alternative routes returned will follow the reference route from the origin point of the calculateRoute request for at least this number of seconds. Can only be used when reconstructing a route. The minDeviationTime parameter cannot be used in conjunction with arriveAt.

Specified by:

withMinDeviationTime in interface RouteQuery

Returns:

the route query

withInstructionsType

public RouteQueryBuilder withInstructionsType(InstructionsType instructionsType)

Description copied from interface: RouteQuery

Specifies the instructions type for the route calculation.

Specified by:

withInstructionsType in interface RouteQuery

Returns:

the route query

withLanguage

public RouteQueryBuilder withLanguage(java.lang.String language)

Description copied from interface: RouteQuery

Specifies the language used for route calculation.

Specified by:

withLanguage in interface RouteQuery

Returns:

the route query

withComputeBestOrder

public RouteQueryBuilder withComputeBestOrder(boolean isComputeBestOrder)

Description copied from interface: RouteQuery

Specifies if the best order of waypoints should be used to compute route. In example: if the maximum allowed number of waypoints is 50 then it might be reduced to 20 in better order.

Specified by:

withComputeBestOrder in interface RouteQuery

Returns:

the route query

withRouteRepresentation

public RouteQueryBuilder withRouteRepresentation(RouteRepresentation routeRepresentation)

Description copied from interface: RouteQuery

Specifies the route representation for the route calculation.

Specified by:

withRouteRepresentation in interface RouteQuery

Returns:

the route query

withComputeTravelTimeFor

public RouteQueryBuilder withComputeTravelTimeFor(TravelTimeType computeTravelTimeFor)

Description copied from interface: RouteQuery

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.

Specified by:

withComputeTravelTimeFor in interface RouteQuery

Returns:

the route query

withVehicleHeading

public RouteQueryBuilder withVehicleHeading(int vehicleHeading)

Description copied from interface: RouteQuery

Specifies the vehicle heading for route calculation.

Specified by:

withVehicleHeading in interface RouteQuery

Returns:

the route query

withSectionType

public RouteQueryBuilder withSectionType(SectionType sectionType)

Description copied from interface: RouteQuery

Specifies which of the section types is reported in the route response.

Specified by:

withSectionType in interface RouteQuery

Returns:

the route query

withReport

public RouteQueryBuilder withReport(Report report)

Description copied from interface: RouteQuery

Specifies if the report should be provided on route query response.

Specified by:

withReport in interface RouteQuery

Returns:

the route query

withDepartAt

public RouteQueryBuilder withDepartAt(java.util.Date departAt)

Description copied from interface: RouteQuery

Specifies the departure time for the route to calculation.

Specified by:

withDepartAt in interface RouteQuery

Returns:

the route query

withArriveAt

public RouteQueryBuilder withArriveAt(java.util.Date arriveAt)

Description copied from interface: RouteQuery

Specifies the desired arrival time for the route to calculation.

Specified by:

withArriveAt in interface RouteQuery

Returns:

the route query

withRouteType

public RouteQueryBuilder withRouteType(RouteType routeType)

Description copied from interface: RouteQuery

Specifies the route type for the route calculation.

Specified by:

withRouteType in interface RouteQuery

Returns:

the route query

withTraffic

public RouteQueryBuilder withTraffic(boolean isWithTraffic)

Description copied from interface: RouteQuery

Specifies if it should consider all available traffic information during routing.

Specified by:

withTraffic in interface RouteQuery

Returns:

the route query

withAvoidType

public RouteQueryBuilder withAvoidType(Avoid avoidType)

Description copied from interface: RouteQuery

Specifies what the route calculation should try to avoid when determining the route. Can be specified multiple times.

Specified by:

withAvoidType in interface RouteQuery

Returns:

the route query

withTravelMode

public RouteQueryBuilder withTravelMode(TravelMode travelMode)

Description copied from interface: RouteQuery

Specifies the travel mode for the route calculation.

Specified by:

withTravelMode in interface RouteQuery

Returns:

the route query

withHilliness

public RouteQueryBuilder withHilliness(Hilliness hilliness)

Description copied from interface: RouteQuery

Specifies the hilliness type for route calculation.

Specified by:

withHilliness in interface RouteQuery

Returns:

the route query

withWindingness

public RouteQueryBuilder withWindingness(Windingness windingness)

Description copied from interface: RouteQuery

Specifies the windingness type for route calculation.

Specified by:

withWindingness in interface RouteQuery

Returns:

the route query

withVehicleMaxSpeed

public RouteQueryBuilder withVehicleMaxSpeed(int vehicleMaxSpeed)

Description copied from interface: RouteQuery

Specifies the vehicle max speed for route calculation.

Specified by:

withVehicleMaxSpeed in interface RouteQuery

Returns:

the route query

withVehicleWeight

public RouteQueryBuilder withVehicleWeight(int vehicleWeight)

Description copied from interface: RouteQuery

Specifies the vehicle weight in kilograms for route calculation.

Specified by:

withVehicleWeight in interface RouteQuery

Returns:

the route query

withVehicleAxleWeight

public RouteQueryBuilder withVehicleAxleWeight(int vehicleAxleWeight)

Description copied from interface: RouteQuery

Specifies the vehicle axle weight for route calculation.

Specified by:

withVehicleAxleWeight in interface RouteQuery

Returns:

the route query

withVehicleLength

public RouteQueryBuilder withVehicleLength(float vehicleLength)

Description copied from interface: RouteQuery

Specifies the vehicle length for route calculation.

Specified by:

withVehicleLength in interface RouteQuery

Returns:

the route query

withVehicleWidth

public RouteQueryBuilder withVehicleWidth(float vehicleWidth)

Description copied from interface: RouteQuery

Specifies the vehicle width for route calculation.

Specified by:

withVehicleWidth in interface RouteQuery

Returns:

the route query

withVehicleHeight

public RouteQueryBuilder withVehicleHeight(float vehicleHeight)

Description copied from interface: RouteQuery

Specifies the vehicle height for route calculation.

Specified by:

withVehicleHeight in interface RouteQuery

Returns:

the route query

withVehicleCommercial

public RouteQueryBuilder withVehicleCommercial(boolean isVehicleCommercial)

Description copied from interface: RouteQuery

Specifies if the vehicle is used for commercial to calculate route.

Specified by:

withVehicleCommercial in interface RouteQuery

Returns:

the route query

withVehicleLoadType

public RouteQueryBuilder withVehicleLoadType(VehicleLoadType vehicleLoadType)

Description copied from interface: RouteQuery

Specifies the vehicle load type for route calculation.

Specified by:

withVehicleLoadType in interface RouteQuery

Returns:

the route query

withVehicleEngineType

public RouteQueryBuilder withVehicleEngineType(VehicleEngineType vehicleEngineType)

Description copied from interface: RouteQuery

Specifies the vehicle engine type for route query. Possible values are: "combustion", "electric".

Specified by:

withVehicleEngineType in interface RouteQuery

Returns:

the route query

withConstantSpeedConsumptionInLiters

public RouteQueryBuilder withConstantSpeedConsumptionInLiters(java.util.Map<java.lang.Integer,java.lang.Double> speedConsumptionInLitersPairs)

Description copied from interface: RouteQuery

Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate in liters pairs.

Specified by:

withConstantSpeedConsumptionInLiters in interface RouteQuery

Returns:

the route query

withCurrentFuelInLiters

public RouteQueryBuilder withCurrentFuelInLiters(float currentFuelInLiters)

Description copied from interface: RouteQuery

Specifies the current supply of fuel in liters.

Specified by:

withCurrentFuelInLiters in interface RouteQuery

Returns:

the route query

withAuxiliaryPowerInLitersPerHour

public RouteQueryBuilder withAuxiliaryPowerInLitersPerHour(float auxiliaryPowerInLitersPerHour)

Description copied from interface: RouteQuery

Specifies the amount of fuel consumed for sustaining auxiliary systems of the vehicle, in liters per hour. It can be used to specify consumption due to devices and systems such as AC systems, radio, heating, etc.

Specified by:

withAuxiliaryPowerInLitersPerHour in interface RouteQuery

Returns:

the route query

withFuelEnergyDensityInMJoulesPerLiter

public RouteQueryBuilder withFuelEnergyDensityInMJoulesPerLiter(float fuelEnergyDensityInMJoulesPerLiter)

Description copied from interface: RouteQuery

Specifies the amount of chemical energy stored in one liter of fuel in megajoules (MJ). It is used in conjunction with the *Efficiency parameters for conversions between saved or consumed energy and fuel. For example, energy density is 34.2 MJ/l for gasoline, and 35.8 MJ/l for Diesel fuel.

Specified by:

withFuelEnergyDensityInMJoulesPerLiter in interface RouteQuery

Returns:

the route query

withAccelerationEfficiency

public RouteQueryBuilder withAccelerationEfficiency(float accelerationEfficiency)

Description copied from interface: RouteQuery

Specifies the efficiency of converting chemical energy stored in fuel to kinetic energy when the vehicle accelerates (i.e. KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed is obtained by converting consumed fuel to chemical energy using fuelEnergyDensityInMJoulesPerLiter.

Specified by:

withAccelerationEfficiency in interface RouteQuery

Returns:

the route query

withDecelerationEfficiency

public RouteQueryBuilder withDecelerationEfficiency(float decelerationEfficiency)

Description copied from interface: RouteQuery

Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the vehicle decelerates (i.e. ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved is obtained by converting saved (not consumed) fuel to energy using fuelEnergyDensityInMJoulesPerLiter.

Specified by:

withDecelerationEfficiency in interface RouteQuery

Returns:

the route query

withUphillEfficiency

public RouteQueryBuilder withUphillEfficiency(float uphillEfficiency)

Description copied from interface: RouteQuery

Specifies the efficiency of converting chemical energy stored in fuel to potential energy when the vehicle gains elevation (i.e. PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed is obtained by converting consumed fuel to chemical energy using fuelEnergyDensityInMJoulesPerLiter.

Specified by:

withUphillEfficiency in interface RouteQuery

Returns:

the route query

withDownhillEfficiency

public RouteQueryBuilder withDownhillEfficiency(float downhillEfficiency)

Description copied from interface: RouteQuery

Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the vehicle loses elevation (i.e. ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved is obtained by converting saved (not consumed) fuel to energy using fuelEnergyDensityInMJoulesPerLiter.

Specified by:

withDownhillEfficiency in interface RouteQuery

Returns:

the route query

withConstantSpeedConsumptionInkWh

public RouteQueryBuilder withConstantSpeedConsumptionInkWh(java.util.Map<java.lang.Integer,java.lang.Double> speedConsumptionInkWhPairs)

Description copied from interface: RouteQuery

Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate in kWh pairs.

Specified by:

withConstantSpeedConsumptionInkWh in interface RouteQuery

Returns:

the route query

withCurrentChargeInkWh

public RouteQueryBuilder withCurrentChargeInkWh(float currentChargeInkWh)

Description copied from interface: RouteQuery

Specifies the current electric energy supply in kilowatt hours (kWh).

Specified by:

withCurrentChargeInkWh in interface RouteQuery

Returns:

the route query

withMaxChargeInkWh

public RouteQueryBuilder withMaxChargeInkWh(float maxChargeInkWh)

Description copied from interface: RouteQuery

Specifies the maximum electric energy supply in kilowatt hours (kWh) that may be stored in the vehicle's battery.

Specified by:

withMaxChargeInkWh in interface RouteQuery

Returns:

the route query

withAuxiliaryPowerInkW

public RouteQueryBuilder withAuxiliaryPowerInkW(float auxiliaryPowerInkW)

Description copied from interface: RouteQuery

Specifies the amount of power consumed for sustaining auxiliary systems, in kilowatts (kW). It can be used to specify consumption due to devices and systems such as AC systems, radio, heating, etc.

Specified by:

withAuxiliaryPowerInkW in interface RouteQuery

Returns:

the route query

withSupportingPoints

public RouteQueryBuilder withSupportingPoints(java.util.List<LatLng> supportingPoints)

Description copied from interface: RouteQuery

A list of base route points to be used as input for route reconstruction.

Specified by:

withSupportingPoints in interface RouteQuery

Returns:

the route query

withAvoidVignettes

public RouteQueryBuilder withAvoidVignettes(@NonNull
                                            java.util.List<java.lang.String> avoidVignettes)

Description copied from interface: RouteQuery

List of 3-character ISO 3166-1 alpha-3 country codes of countries in which all toll roads with vignettes are to be avoided.

Specified by:

withAvoidVignettes in interface RouteQuery

Returns:

the route query