com.graphhopper.api

Class GraphHopperWeb

java.lang.Object

com.graphhopper.api.GraphHopperWeb

All Implemented Interfaces:

com.graphhopper.GraphHopperAPI

public class GraphHopperWeb
extends Object
implements com.graphhopper.GraphHopperAPI

Main wrapper of the GraphHopper Directions API for a simple and efficient usage.

Author:

Peter Karich

Constructor Summary

Constructors

Constructor and Description
GraphHopperWeb()
GraphHopperWeb(String serviceUrl)

Method Summary

Modifier and Type	Method and Description
static com.graphhopper.PathWrapper	createAltResponse(org.json.JSONObject path, boolean tmpCalcPoints, boolean tmpInstructions, boolean tmpElevation)
okhttp3.Request	createRequest(com.graphhopper.GHRequest request)
String	export(com.graphhopper.GHRequest ghRequest)
okhttp3.OkHttpClient	getDownloader()
boolean	load(String serviceUrl)
static List<Throwable>	readErrors(org.json.JSONObject json)
com.graphhopper.GHResponse	route(com.graphhopper.GHRequest ghRequest)
GraphHopperWeb	setCalcPoints(boolean calcPoints) Enable or disable calculating points for the way.
GraphHopperWeb	setDownloader(okhttp3.OkHttpClient downloader)
GraphHopperWeb	setElevation(boolean withElevation) Enable or disable elevation.
GraphHopperWeb	setInstructions(boolean b) Enable or disable calculating and returning turn instructions.
GraphHopperWeb	setKey(String key)
GraphHopperWeb	setOptimize(String optimize)

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphHopperWeb

public GraphHopperWeb()

GraphHopperWeb

public GraphHopperWeb(String serviceUrl)

Method Detail

setDownloader

public GraphHopperWeb setDownloader(okhttp3.OkHttpClient downloader)

getDownloader

public okhttp3.OkHttpClient getDownloader()

load

public boolean load(String serviceUrl)

Specified by:

load in interface com.graphhopper.GraphHopperAPI

setKey

public GraphHopperWeb setKey(String key)

setCalcPoints

public GraphHopperWeb setCalcPoints(boolean calcPoints)

Enable or disable calculating points for the way. The default is true.

setInstructions

public GraphHopperWeb setInstructions(boolean b)

Enable or disable calculating and returning turn instructions. The default is true.

setElevation

public GraphHopperWeb setElevation(boolean withElevation)

Enable or disable elevation. The default is false.

setOptimize

public GraphHopperWeb setOptimize(String optimize)

Parameters:

optimize - "false" if the order of the locations should be left unchanged, this is the default. Or if "true" then the order of the location is optimized according to the overall best route and returned this way i.e. the traveling salesman problem is solved under the hood. Note that in this case the request takes longer and costs more credits. For more details see: https://github.com/graphhopper/directions-api/blob/master/FAQ.md#what-is-one-credit

route

public com.graphhopper.GHResponse route(com.graphhopper.GHRequest ghRequest)

Specified by:

route in interface com.graphhopper.GraphHopperAPI

export

public String export(com.graphhopper.GHRequest ghRequest)

createRequest

public okhttp3.Request createRequest(com.graphhopper.GHRequest request)

createAltResponse

public static com.graphhopper.PathWrapper createAltResponse(org.json.JSONObject path,
                                                            boolean tmpCalcPoints,
                                                            boolean tmpInstructions,
                                                            boolean tmpElevation)

readErrors

public static List<Throwable> readErrors(org.json.JSONObject json)