GraphHopper (GraphHopper Core 0.8.0 API)

java.lang.Object
- com.graphhopper.GraphHopper

All Implemented Interfaces:

GraphHopperAPI
```
public class GraphHopper
extends Object
implements GraphHopperAPI
```
Easy to use access point to configure import and (offline) routing.

Author:

Peter Karich

See Also:

GraphHopperAPI

Constructor Summary

Constructors
Constructor and Description

GraphHopper()

Constructors
Constructor and Description
`GraphHopper()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`GraphHopper`	`addAlgorithmFactoryDecorator(RoutingAlgorithmFactoryDecorator algoFactoryDecorator)`
`List<Path>`	`calcPaths(GHRequest request, GHResponse ghRsp)`
`void`	`clean()` Removes the on-disc routing files.
`protected void`	`cleanUp()` Internal method to clean up the graph.
`void`	`close()` Releases all associated resources like memory or files.
`protected void`	`createCHPreparations()` Deprecated. use getCHFactoryDecorator().createPreparations() instead. Will be removed in 0.8.
`protected LocationIndex`	`createLocationIndex(Directory dir)`
`protected DataReader`	`createReader(GraphHopperStorage ghStorage)`
`Weighting`	`createTurnWeighting(Graph graph, Weighting weighting, TraversalMode tMode)` Potentially wraps the specified weighting into a TurnWeighting instance.
`Weighting`	`createWeighting(HintsMap hintsMap, FlagEncoder encoder)` Based on the hintsMap and the specified encoder a Weighting instance can be created.
`protected void`	`ensureNotLoaded()`
`protected void`	`ensureWriteAccess()`
`protected void`	`flush()`
`GraphHopper`	`forDesktop()` Configures the underlying storage to be used on a Desktop computer or within another Java application with enough RAM but no network latency.
`GraphHopper`	`forMobile()` Configures the underlying storage to be used on a less powerful machine like Android or Raspberry Pi with only few MB of RAM.
`GraphHopper`	`forServer()` Configures the underlying storage and response to be used on a well equipped server.
`RoutingAlgorithmFactory`	`getAlgorithmFactory(HintsMap map)`
`CHAlgoFactoryDecorator`	`getCHFactoryDecorator()`
`int`	`getCHPrepareThreads()` Deprecated. Use getCHFactoryDecorator().getCHPrepareThreads() instead. Will be removed in 0.8.
`List<String>`	`getCHWeightings()` Deprecated. Use getCHFactoryDecorator().getWeightingsAsStrings() instead. Will be removed in 0.8.
`String`	`getDataReaderFile()`
`ElevationProvider`	`getElevationProvider()`
`EncodingManager`	`getEncodingManager()`
`String`	`getGraphHopperLocation()`
`GraphHopperStorage`	`getGraphHopperStorage()` The underlying graph used in algorithms.
`LocationIndex`	`getLocationIndex()` The location index created from the graph.
`int`	`getMaxVisitedNodes()`
`String`	`getPreferredLanguage()`
`TranslationMap`	`getTranslationMap()`
`TraversalMode`	`getTraversalMode()`
`protected double`	`getWayPointMaxDistance()` Return maximum distance (in meter) to reduce points via douglas peucker while OSM import.
`protected int`	`getWorkerThreads()` Threads for data reading.
`boolean`	`hasElevation()`
`protected DataReader`	`importData()`
`GraphHopper`	`importOrLoad()` Imports provided data from disc and creates graph.
`GraphHopper`	`init(CmdArgs args)` Reads configuration from a CmdArgs object.
`protected DataReader`	`initDataReader(DataReader reader)`
`protected void`	`initLocationIndex()` Initializes the location index after the import is done.
`boolean`	`isAllowWrites()`
`boolean`	`isCHEnabled()`
`boolean`	`isEnableInstructions()`
`boolean`	`load(String graphHopperFolder)` Opens existing graph.
`protected GraphHopper`	`loadGraph(GraphHopperStorage g)` For testing only
`void`	`postProcessing()` Does the preparation and creates the location index
`protected void`	`prepare()`
`GHResponse`	`route(GHRequest request)` Calculates the path from specified request visiting the specified locations.
`GraphHopper`	`setAllowWrites(boolean allowWrites)` Specifies if it is allowed for GraphHopper to write.
`GraphHopper`	`setCHEnable(boolean enable)` Deprecated. Use setEnabled() instead. Will be removed in 0.8.
`GraphHopper`	`setCHEnabled(boolean enable)` Enables or disables contraction hierarchies (CH).
`GraphHopper`	`setCHPrepareThreads(int prepareThreads)` Deprecated. Use getCHFactoryDecorator().setCHPrepareThreads() instead. Will be removed in 0.8.
`GraphHopper`	`setCHWeighting(String weightingName)` Deprecated. This method is used as a deprecated wrapper to not break the JavaApi. This will be removed in 0.7. Please use `setCHWeightings(List)` or `setCHWeightings(String...)`
`GraphHopper`	`setCHWeightings(List<String> weightingList)` Deprecated. Use getCHFactoryDecorator().setWeightingsAsStrings() instead. Will be removed in 0.8.
`GraphHopper`	`setCHWeightings(String... weightingNames)` Deprecated. Use getCHFactoryDecorator().setWeightingsAsStrings() instead. Will be removed in 0.8.
`GraphHopper`	`setDataReaderFile(String dataReaderFileStr)` This file can be any file type supported by the DataReader.
`GraphHopper`	`setElevation(boolean includeElevation)` Enable storing and fetching elevation data.
`GraphHopper`	`setElevationProvider(ElevationProvider eleProvider)`
`GraphHopper`	`setEnableCalcPoints(boolean b)` This methods enables gps point calculation.
`GraphHopper`	`setEnableInstructions(boolean b)` This method specifies if the import should include way names to be able to return instructions for a route.
`GraphHopper`	`setEncodingManager(EncodingManager em)` Specify which vehicles can be read by this GraphHopper instance.
`GraphHopper`	`setFlagEncoderFactory(FlagEncoderFactory factory)`
`GraphHopper`	`setGraphHopperLocation(String ghLocation)` Sets the graphhopper folder.
`void`	`setGraphHopperStorage(GraphHopperStorage ghStorage)`
`GraphHopper`	`setInMemory()` This method call results in an in-memory graph.
`protected void`	`setLocationIndex(LocationIndex locationIndex)`
`void`	`setMaxVisitedNodes(int maxVisitedNodes)` This methods stops the algorithm from searching further if the resulting path would go over the specified node count, important if none-CH routing is used.
`GraphHopper`	`setMemoryMapped()` Enable memory mapped configuration if not enough memory is available on the target platform.
`GraphHopper`	`setMinNetworkSize(int minNetworkSize, int minOneWayNetworkSize)`
`GraphHopper`	`setPreciseIndexResolution(int precision)` Precise location resolution index means also more space (disc/RAM) could be consumed and probably slower query times, which would be e.g.
`GraphHopper`	`setPreferredLanguage(String preferredLanguage)` This method specifies the preferred language for way names during import.
`GraphHopper`	`setSortGraph(boolean sortGraph)` Sorts the graph which requires more RAM while import.
`GraphHopper`	`setStoreOnFlush(boolean storeOnFlush)` Only valid option for in-memory graph and if you e.g.
`GraphHopper`	`setTraversalMode(TraversalMode traversalMode)` Sets the default traversal mode used for the algorithms and preparation.
`GraphHopper`	`setWayPointMaxDistance(double wayPointMaxDistance)` This parameter specifies how to reduce points via douglas peucker while OSM import.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GraphHopper
```
public GraphHopper()
```
- Method Detail
  - loadGraph
```
protected GraphHopper loadGraph(GraphHopperStorage g)
```
    For testing only
  - getEncodingManager
```
public EncodingManager getEncodingManager()
```
  - setEncodingManager
```
public GraphHopper setEncodingManager(EncodingManager em)
```
    Specify which vehicles can be read by this GraphHopper instance. An encoding manager defines how data from every vehicle is written (und read) into edges of the graph.
  - getElevationProvider
```
public ElevationProvider getElevationProvider()
```
  - setElevationProvider
```
public GraphHopper setElevationProvider(ElevationProvider eleProvider)
```
  - getWorkerThreads
```
protected int getWorkerThreads()
```
    Threads for data reading.
  - getWayPointMaxDistance
```
protected double getWayPointMaxDistance()
```
    Return maximum distance (in meter) to reduce points via douglas peucker while OSM import.
  - setWayPointMaxDistance
```
public GraphHopper setWayPointMaxDistance(double wayPointMaxDistance)
```
    This parameter specifies how to reduce points via douglas peucker while OSM import. Higher value means more details, unit is meter. Default is 1. Disable via 0.
  - getTraversalMode
```
public TraversalMode getTraversalMode()
```
  - setTraversalMode
```
public GraphHopper setTraversalMode(TraversalMode traversalMode)
```
    Sets the default traversal mode used for the algorithms and preparation.
  - forServer
```
public GraphHopper forServer()
```
    Configures the underlying storage and response to be used on a well equipped server. Result also optimized for usage in the web module i.e. try reduce network IO.
  - forDesktop
```
public GraphHopper forDesktop()
```
    Configures the underlying storage to be used on a Desktop computer or within another Java application with enough RAM but no network latency.
  - forMobile
```
public GraphHopper forMobile()
```
    Configures the underlying storage to be used on a less powerful machine like Android or Raspberry Pi with only few MB of RAM.
  - setPreciseIndexResolution
```
public GraphHopper setPreciseIndexResolution(int precision)
```
    Precise location resolution index means also more space (disc/RAM) could be consumed and probably slower query times, which would be e.g. not suitable for Android. The resolution specifies the tile width (in meter).
  - setMinNetworkSize
```
public GraphHopper setMinNetworkSize(int minNetworkSize,
                                     int minOneWayNetworkSize)
```
  - setInMemory
```
public GraphHopper setInMemory()
```
    This method call results in an in-memory graph.
  - setStoreOnFlush
```
public GraphHopper setStoreOnFlush(boolean storeOnFlush)
```
    Only valid option for in-memory graph and if you e.g. want to disable store on flush for unit tests. Specify storeOnFlush to true if you want that existing data will be loaded FROM disc and all in-memory data will be flushed TO disc after flush is called e.g. while OSM import.
    
    Parameters:
    
    storeOnFlush - true by default
  - setMemoryMapped
```
public GraphHopper setMemoryMapped()
```
    Enable memory mapped configuration if not enough memory is available on the target platform.
  - setCHWeighting
```
@Deprecated
public GraphHopper setCHWeighting(String weightingName)
```
    Deprecated. This method is used as a deprecated wrapper to not break the JavaApi. This will be removed in 0.7. Please use setCHWeightings(List) or setCHWeightings(String...)
    
    Wrapper method for setCHWeightings(List)
  - setCHWeightings
```
public GraphHopper setCHWeightings(String... weightingNames)
```
    Deprecated. Use getCHFactoryDecorator().setWeightingsAsStrings() instead. Will be removed in 0.8.
    
    Wrapper method for setCHWeightings(List)
  - getCHWeightings
```
public List<String> getCHWeightings()
```
    Deprecated. Use getCHFactoryDecorator().getWeightingsAsStrings() instead. Will be removed in 0.8.
    
    Returns all CHWeighting names
  - setCHWeightings
```
public GraphHopper setCHWeightings(List<String> weightingList)
```
    Deprecated. Use getCHFactoryDecorator().setWeightingsAsStrings() instead. Will be removed in 0.8.
    
    Enables the use of contraction hierarchies to reduce query times. Enabled by default.
    
    Parameters:
    
    weightingList - A list containing multiple weightings like: "fastest", "shortest" or your own weight-calculation type.
  - getCHPrepareThreads
```
public int getCHPrepareThreads()
```
    Deprecated. Use getCHFactoryDecorator().getCHPrepareThreads() instead. Will be removed in 0.8.
  - setCHPrepareThreads
```
public GraphHopper setCHPrepareThreads(int prepareThreads)
```
    Deprecated. Use getCHFactoryDecorator().setCHPrepareThreads() instead. Will be removed in 0.8.
    
    This method changes the number of threads used for preparation on import. Default is 1. Make sure that you have enough memory to increase this number!
  - setCHEnable
```
public GraphHopper setCHEnable(boolean enable)
```
    Deprecated. Use setEnabled() instead. Will be removed in 0.8.
  - isCHEnabled
```
public final boolean isCHEnabled()
```
  - setCHEnabled
```
public GraphHopper setCHEnabled(boolean enable)
```
    Enables or disables contraction hierarchies (CH). This speed-up mode is enabled by default.
  - getMaxVisitedNodes
```
public int getMaxVisitedNodes()
```
  - setMaxVisitedNodes
```
public void setMaxVisitedNodes(int maxVisitedNodes)
```
    This methods stops the algorithm from searching further if the resulting path would go over the specified node count, important if none-CH routing is used.
  - hasElevation
```
public boolean hasElevation()
```
    Returns:
    
    true if storing and fetching elevation data is enabled. Default is false
  - setElevation
```
public GraphHopper setElevation(boolean includeElevation)
```
    Enable storing and fetching elevation data. Default is false
  - isEnableInstructions
```
public boolean isEnableInstructions()
```
  - setEnableInstructions
```
public GraphHopper setEnableInstructions(boolean b)
```
    This method specifies if the import should include way names to be able to return instructions for a route.
  - getPreferredLanguage
```
public String getPreferredLanguage()
```
  - setPreferredLanguage
```
public GraphHopper setPreferredLanguage(String preferredLanguage)
```
    This method specifies the preferred language for way names during import.
    Language code as defined in ISO 639-1 or ISO 639-2.
    - If no preferred language is specified, only the default language with no tag will be imported.
    - If a language is specified, it will be imported if its tag is found, otherwise fall back to default language.
  - setEnableCalcPoints
```
public GraphHopper setEnableCalcPoints(boolean b)
```
    This methods enables gps point calculation. If disabled only distance will be calculated.
  - getGraphHopperLocation
```
public String getGraphHopperLocation()
```
  - setGraphHopperLocation
```
public GraphHopper setGraphHopperLocation(String ghLocation)
```
    Sets the graphhopper folder.
  - getDataReaderFile
```
public String getDataReaderFile()
```
  - setDataReaderFile
```
public GraphHopper setDataReaderFile(String dataReaderFileStr)
```
    This file can be any file type supported by the DataReader. E.g. for the OSMReader it is the OSM xml (.osm), a compressed xml (.osm.zip or .osm.gz) or a protobuf file (.pbf)
  - getGraphHopperStorage
```
public GraphHopperStorage getGraphHopperStorage()
```
    The underlying graph used in algorithms.
    
    Throws:
    
    IllegalStateException - if graph is not instantiated.
  - setGraphHopperStorage
```
public void setGraphHopperStorage(GraphHopperStorage ghStorage)
```
  - getLocationIndex
```
public LocationIndex getLocationIndex()
```
    The location index created from the graph.
    
    Throws:
    
    IllegalStateException - if index is not initialized
  - setLocationIndex
```
protected void setLocationIndex(LocationIndex locationIndex)
```
  - setSortGraph
```
public GraphHopper setSortGraph(boolean sortGraph)
```
    Sorts the graph which requires more RAM while import. See #12
  - isAllowWrites
```
public boolean isAllowWrites()
```
  - setAllowWrites
```
public GraphHopper setAllowWrites(boolean allowWrites)
```
    Specifies if it is allowed for GraphHopper to write. E.g. for read only filesystems it is not possible to create a lock file and so we can avoid write locks.
  - getTranslationMap
```
public TranslationMap getTranslationMap()
```
  - setFlagEncoderFactory
```
public GraphHopper setFlagEncoderFactory(FlagEncoderFactory factory)
```
  - init
```
public GraphHopper init(CmdArgs args)
```
    Reads configuration from a CmdArgs object. Which can be manually filled, or via main(String[] args) ala CmdArgs.read(args) or via configuration file ala CmdArgs.readFromConfig("config.properties", "graphhopper.config")
  - importOrLoad
```
public GraphHopper importOrLoad()
```
    Imports provided data from disc and creates graph. Depending on the settings the resulting graph will be stored to disc so on a second call this method will only load the graph from disc which is usually a lot faster.
  - importData
```
protected DataReader importData()
                         throws IOException
```
    Throws:
    
    IOException
  - createReader
```
protected DataReader createReader(GraphHopperStorage ghStorage)
```
  - initDataReader
```
protected DataReader initDataReader(DataReader reader)
```
  - load
```
public boolean load(String graphHopperFolder)
```
    Opens existing graph.
    
    Specified by:
    
    load in interface GraphHopperAPI
    
    Parameters:
    
    graphHopperFolder - is the folder containing graphhopper files. Can be a compressed file too ala folder-content.ghz.
    
    Returns:
    
    true if successfully connected or loaded
  - getAlgorithmFactory
```
public RoutingAlgorithmFactory getAlgorithmFactory(HintsMap map)
```
  - addAlgorithmFactoryDecorator
```
public GraphHopper addAlgorithmFactoryDecorator(RoutingAlgorithmFactoryDecorator algoFactoryDecorator)
```
  - getCHFactoryDecorator
```
public final CHAlgoFactoryDecorator getCHFactoryDecorator()
```
  - createCHPreparations
```
protected void createCHPreparations()
```
    Deprecated. use getCHFactoryDecorator().createPreparations() instead. Will be removed in 0.8.
    
    This method creates prepations.
  - postProcessing
```
public void postProcessing()
```
    Does the preparation and creates the location index
  - createWeighting
```
public Weighting createWeighting(HintsMap hintsMap,
                                 FlagEncoder encoder)
```
    Based on the hintsMap and the specified encoder a Weighting instance can be created. Note that all URL parameters are available in the hintsMap as String if you use the web module.
    
    Parameters:
    
    hintsMap - all parameters influencing the weighting. E.g. parameters coming via GHRequest.getHints or directly via "&api.xy=" from the URL of the web UI
    
    encoder - the required vehicle
    
    Returns:
    
    the weighting to be used for route calculation
    
    See Also:
    
    HintsMap
  - createTurnWeighting
```
public Weighting createTurnWeighting(Graph graph,
                                     Weighting weighting,
                                     TraversalMode tMode)
```
    Potentially wraps the specified weighting into a TurnWeighting instance.
  - route
```
public GHResponse route(GHRequest request)
```
    Description copied from interface: GraphHopperAPI
    
    Calculates the path from specified request visiting the specified locations.
    
    Specified by:
    
    route in interface GraphHopperAPI
    
    Returns:
    
    the response with the route and possible errors
  - calcPaths
```
public List<Path> calcPaths(GHRequest request,
                            GHResponse ghRsp)
```
  - createLocationIndex
```
protected LocationIndex createLocationIndex(Directory dir)
```
  - initLocationIndex
```
protected void initLocationIndex()
```
    Initializes the location index after the import is done.
  - prepare
```
protected void prepare()
```
  - cleanUp
```
protected void cleanUp()
```
    Internal method to clean up the graph.
  - flush
```
protected void flush()
```
  - close
```
public void close()
```
    Releases all associated resources like memory or files. But it does not remove them. To remove the files created in graphhopperLocation you have to call clean().
  - clean
```
public void clean()
```
    Removes the on-disc routing files. Call only after calling close or before importOrLoad or load
  - ensureNotLoaded
```
protected void ensureNotLoaded()
```
  - ensureWriteAccess
```
protected void ensureWriteAccess()
```

Class GraphHopper

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GraphHopper

Method Detail

loadGraph

getEncodingManager

setEncodingManager

getElevationProvider

setElevationProvider

getWorkerThreads

getWayPointMaxDistance

setWayPointMaxDistance

getTraversalMode

setTraversalMode

forServer

forDesktop

forMobile

setPreciseIndexResolution

setMinNetworkSize

setInMemory

setStoreOnFlush

setMemoryMapped

setCHWeighting

setCHWeightings

getCHWeightings

setCHWeightings

getCHPrepareThreads

setCHPrepareThreads

setCHEnable

isCHEnabled

setCHEnabled

getMaxVisitedNodes

setMaxVisitedNodes

hasElevation

setElevation

isEnableInstructions

setEnableInstructions

getPreferredLanguage

setPreferredLanguage

setEnableCalcPoints

getGraphHopperLocation

setGraphHopperLocation

getDataReaderFile

setDataReaderFile

getGraphHopperStorage

setGraphHopperStorage

getLocationIndex

setLocationIndex

setSortGraph

isAllowWrites

setAllowWrites

getTranslationMap

setFlagEncoderFactory

init

importOrLoad

importData

createReader

initDataReader

load

getAlgorithmFactory

addAlgorithmFactoryDecorator

getCHFactoryDecorator

createCHPreparations

postProcessing

createWeighting

createTurnWeighting

route

calcPaths

createLocationIndex

initLocationIndex

prepare

cleanUp

flush

close

clean

ensureNotLoaded

ensureWriteAccess