com.graphhopper

Class GHRequest

java.lang.Object

com.graphhopper.GHRequest

public class GHRequest
extends Object

GraphHopper request wrapper to simplify requesting GraphHopper.

Author:

Peter Karich, ratrun

Constructor Summary

Constructors

Constructor and Description
GHRequest()
GHRequest(double fromLat, double fromLon, double toLat, double toLon) Set routing request from specified startPlace (fromLat, fromLon) to endPlace (toLat, toLon)
GHRequest(double fromLat, double fromLon, double toLat, double toLon, double startHeading, double endHeading) Set routing request from specified startPlace (fromLat, fromLon) to endPlace (toLat, toLon) with a preferred start and end heading.
GHRequest(GHPoint startPlace, GHPoint endPlace)
GHRequest(GHPoint startPlace, GHPoint endPlace, double startHeading, double endHeading) Set routing request from specified startPlace to endPlace with a preferred start and end heading.
GHRequest(int size)
GHRequest(List<GHPoint> points) Set routing request
GHRequest(List<GHPoint> points, List<Double> favoredHeadings) Set routing request

Method Summary

Modifier and Type	Method and Description
GHRequest	addPoint(GHPoint point) Add stopover point to routing request.
GHRequest	addPoint(GHPoint point, double favoredHeading) Add stopover point to routing request.
String	getAlgorithm()
List<String>	getCurbsides()
double	getFavoredHeading(int i)
HintsMap	getHints()
Locale	getLocale()
List<String>	getPathDetails()
List<String>	getPointHints()
List<GHPoint>	getPoints()
List<String>	getSnapPreventions()
String	getVehicle()
String	getWeighting()
boolean	hasCurbsides()
boolean	hasFavoredHeading(int i)
boolean	hasPointHints()
boolean	hasSnapPreventions()
GHRequest	putHint(String fieldName, Object value) This method sets a key value pair in the hints and is unrelated to the setPointHints method.
GHRequest	setAlgorithm(String algo) For possible values see AlgorithmOptions.*
GHRequest	setCurbsides(List<String> curbsides)
void	setHeadings(List<Double> favoredHeadings)
GHRequest	setLocale(Locale locale)
GHRequest	setLocale(String localeStr)
GHRequest	setPathDetails(List<String> pathDetails)
GHRequest	setPointHints(List<String> pointHints)
void	setPoints(List<GHPoint> points)
GHRequest	setSnapPreventions(List<String> snapPreventions)
GHRequest	setVehicle(String vehicle) Specify car, bike or foot.
GHRequest	setWeighting(String w) By default it supports fastest and shortest.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GHRequest

public GHRequest()

GHRequest

public GHRequest(int size)

GHRequest

public GHRequest(double fromLat,
                 double fromLon,
                 double toLat,
                 double toLon,
                 double startHeading,
                 double endHeading)

Set routing request from specified startPlace (fromLat, fromLon) to endPlace (toLat, toLon) with a preferred start and end heading. Headings are north based azimuth (clockwise) in (0, 360) or NaN for equal preference.

GHRequest

public GHRequest(double fromLat,
                 double fromLon,
                 double toLat,
                 double toLon)

Set routing request from specified startPlace (fromLat, fromLon) to endPlace (toLat, toLon)

GHRequest

public GHRequest(GHPoint startPlace,
                 GHPoint endPlace,
                 double startHeading,
                 double endHeading)

Set routing request from specified startPlace to endPlace with a preferred start and end heading. Headings are north based azimuth (clockwise) in (0, 360) or NaN for equal preference

GHRequest

public GHRequest(GHPoint startPlace,
                 GHPoint endPlace)

GHRequest

public GHRequest(List<GHPoint> points,
                 List<Double> favoredHeadings)

Set routing request

Parameters:

points - List of stopover points in order: start, 1st stop, 2nd stop, ..., end

favoredHeadings - List of favored headings for starting (start point) and arrival (via and end points) Headings are north based azimuth (clockwise) in (0, 360) or NaN for equal

GHRequest

public GHRequest(List<GHPoint> points)

Set routing request

Parameters:

points - List of stopover points in order: start, 1st stop, 2nd stop, ..., end

Method Detail

addPoint

public GHRequest addPoint(GHPoint point,
                          double favoredHeading)

Add stopover point to routing request.

Parameters:

point - geographical position (see GHPoint)

favoredHeading - north based azimuth (clockwise) in (0, 360) or NaN for equal preference

addPoint

public GHRequest addPoint(GHPoint point)

Add stopover point to routing request.

Parameters:

point - geographical position (see GHPoint)

setPoints

public void setPoints(List<GHPoint> points)

setHeadings

public void setHeadings(List<Double> favoredHeadings)

getFavoredHeading

public double getFavoredHeading(int i)

Returns:

north based azimuth (clockwise) in (0, 360) or NaN for equal preference

hasFavoredHeading

public boolean hasFavoredHeading(int i)

Returns:

if there exist a preferred heading for start/via/end point i

getPoints

public List<GHPoint> getPoints()

getAlgorithm

public String getAlgorithm()

setAlgorithm

public GHRequest setAlgorithm(String algo)

For possible values see AlgorithmOptions.*

getLocale

public Locale getLocale()

setLocale

public GHRequest setLocale(Locale locale)

setLocale

public GHRequest setLocale(String localeStr)

getWeighting

public String getWeighting()

setWeighting

public GHRequest setWeighting(String w)

By default it supports fastest and shortest. Or specify empty to use default.

getVehicle

public String getVehicle()

setVehicle

public GHRequest setVehicle(String vehicle)

Specify car, bike or foot. Or specify empty to use default.

getHints

public HintsMap getHints()

putHint

public GHRequest putHint(String fieldName,
                         Object value)

This method sets a key value pair in the hints and is unrelated to the setPointHints method. It is mainly used for deserialization with Jackson.

See Also:

setPointHints(List)

setPointHints

public GHRequest setPointHints(List<String> pointHints)

getPointHints

public List<String> getPointHints()

hasPointHints

public boolean hasPointHints()

setCurbsides

public GHRequest setCurbsides(List<String> curbsides)

getCurbsides

public List<String> getCurbsides()

hasCurbsides

public boolean hasCurbsides()

setSnapPreventions

public GHRequest setSnapPreventions(List<String> snapPreventions)

hasSnapPreventions

public boolean hasSnapPreventions()

getSnapPreventions

public List<String> getSnapPreventions()

setPathDetails

public GHRequest setPathDetails(List<String> pathDetails)

getPathDetails

public List<String> getPathDetails()

toString

public String toString()

Overrides:

toString in class Object