com.graphhopper

Class GraphHopper

java.lang.Object

com.graphhopper.GraphHopper

Direct Known Subclasses:

GraphHopperOSM

public class GraphHopper
extends Object

Easy to use access point to configure import and (offline) routing.

Author:

Peter Karich

Constructor Summary

Constructors

Constructor and Description
GraphHopper()

Method Summary

Modifier and Type	Method and Description
protected File	_getOSMFile() Currently we use this for a few tests where the dataReaderFile is loaded from the classpath
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	createBaseGraphAndProperties()
protected LocationIndex	createLocationIndex(Directory dir)
Weighting	createWeighting(Profile profile, PMap hints)
Weighting	createWeighting(Profile profile, PMap hints, boolean disableTurnCosts)
protected WeightingFactory	createWeightingFactory()
protected Router	doCreateRouter(BaseGraph baseGraph, EncodingManager encodingManager, LocationIndex locationIndex, Map<String,Profile> profilesByName, PathDetailsBuilderFactory pathBuilderFactory, TranslationMap trMap, RouterConfig routerConfig, WeightingFactory weightingFactory, Map<String,RoutingCHGraph> chGraphs, Map<String,LandmarkStorage> landmarks)
protected void	ensureNotLoaded()
protected void	ensureWriteAccess()
protected void	flush()
BaseGraph	getBaseGraph() The underlying graph used in algorithms.
Map<String,RoutingCHGraph>	getCHGraphs()
CHPreparationHandler	getCHPreparationHandler()
CountryRuleFactory	getCountryRuleFactory()
String	getCustomAreasDirectory()
ElevationProvider	getElevationProvider()
EncodedValueFactory	getEncodedValueFactory()
EncodingManager	getEncodingManager()
boolean	getFullyLoaded()
String	getGraphHopperLocation()
Map<String,LandmarkStorage>	getLandmarks()
LMPreparationHandler	getLMPreparationHandler()
LocationIndex	getLocationIndex() The location index created from the graph.
String	getOSMFile()
OSMParsers	getOSMParsers()
PathDetailsBuilderFactory	getPathDetailsBuilderFactory()
Profile	getProfile(String profileName) Returns the profile for the given profile name, or null if it does not exist
List<Profile>	getProfiles()
StorableProperties	getProperties()
OSMReaderConfig	getReaderConfig()
RouterConfig	getRouterConfig()
TagParserFactory	getTagParserFactory()
TranslationMap	getTranslationMap()
VehicleTagParserFactory	getVehicleTagParserFactory()
boolean	hasElevation()
void	importAndClose() Imports and processes data, storing it to disk when complete.
GraphHopper	importOrLoad() Imports provided data from disc and creates graph.
protected void	importOSM()
protected void	importPublicTransit()
GraphHopper	init(GraphHopperConfig ghConfig) Reads the configuration from a GraphHopperConfig object which can be manually filled, or more typically is read from `config.yml`.
protected void	initLocationIndex() Initializes the location index after the import is done.
boolean	isAllowWrites()
boolean	load() Load from existing graph folder.
protected void	loadOrPrepareCH(boolean closeEarly)
protected void	loadOrPrepareLM(boolean closeEarly) For landmarks it is required to always call this method: either it creates the landmark data or it loads it.
protected void	postImport()
protected void	postProcessing(boolean closeEarly) Runs both after the import and when loading an existing Graph
protected Map<String,PrepareContractionHierarchies.Result>	prepareCH(boolean closeEarly, List<CHConfig> configsToPrepare)
protected List<PrepareLandmarks>	prepareLM(boolean closeEarly, List<LMConfig> configsToPrepare)
GHResponse	route(GHRequest request)
GraphHopper	setAllowWrites(boolean allowWrites) Specifies if it is allowed for GraphHopper to write.
void	setBaseGraph(BaseGraph baseGraph)
GraphHopper	setCountryRuleFactory(CountryRuleFactory countryRuleFactory) Sets the factory used to create country rules.
GraphHopper	setCustomAreasDirectory(String customAreasDirectory)
GraphHopper	setElevation(boolean includeElevation) Enable storing and fetching elevation data.
GraphHopper	setElevationProvider(ElevationProvider eleProvider)
GraphHopper	setEncodedValueFactory(EncodedValueFactory factory)
GraphHopper	setEncodedValuesString(String encodedValuesString)
GraphHopper	setFlagEncodersString(String flagEncodersString)
GraphHopper	setGraphHopperLocation(String ghLocation) Sets the graphhopper folder.
protected void	setLocationIndex(LocationIndex locationIndex)
GraphHopper	setMinNetworkSize(int minNetworkSize)
GraphHopper	setOSMFile(String osmFile) This file can be an osm xml (.osm), a compressed xml (.osm.zip or .osm.gz) or a protobuf file (.pbf).
GraphHopper	setPathDetailsBuilderFactory(PathDetailsBuilderFactory pathBuilderFactory)
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	setProfiles(List<Profile> profiles)
GraphHopper	setProfiles(Profile... profiles) Sets the routing profiles that shall be supported by this GraphHopper instance.
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	setTagParserFactory(TagParserFactory factory)
GraphHopper	setUrbanDensityCalculation(double residentialAreaRadius, double residentialAreaSensitivity, double cityAreaRadius, double cityAreaSensitivity, int threads) Configures the urban density classification.
GraphHopper	setVehicleEncodedValuesFactory(VehicleEncodedValuesFactory factory)
GraphHopper	setVehicleTagParserFactory(VehicleTagParserFactory factory)
protected void	writeEncodingManagerToProperties()

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

setEncodedValuesString

public GraphHopper setEncodedValuesString(String encodedValuesString)

setFlagEncodersString

public GraphHopper setFlagEncodersString(String flagEncodersString)

getEncodingManager

public EncodingManager getEncodingManager()

getOSMParsers

public OSMParsers getOSMParsers()

getElevationProvider

public ElevationProvider getElevationProvider()

setElevationProvider

public GraphHopper setElevationProvider(ElevationProvider eleProvider)

setPathDetailsBuilderFactory

public GraphHopper setPathDetailsBuilderFactory(PathDetailsBuilderFactory pathBuilderFactory)

getPathDetailsBuilderFactory

public PathDetailsBuilderFactory getPathDetailsBuilderFactory()

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)

setUrbanDensityCalculation

public GraphHopper setUrbanDensityCalculation(double residentialAreaRadius,
                                              double residentialAreaSensitivity,
                                              double cityAreaRadius,
                                              double cityAreaSensitivity,
                                              int threads)

Configures the urban density classification. Each edge will be classified as 'rural','residential' or 'city', UrbanDensity

Parameters:

residentialAreaRadius - in meters. The higher this value the longer the calculation will take and the bigger the area for which the road density used to identify residential areas is calculated.

residentialAreaSensitivity - Use this to find a trade-off between too many roads being classified as residential (too high values) and not enough roads being classified as residential (too small values)

cityAreaRadius - in meters. The higher this value the longer the calculation will take and the bigger the area for which the road density used to identify city areas is calculated. Set this to zero to skip the city classification.

cityAreaSensitivity - Use this to find a trade-off between too many roads being classified as city (too high values) and not enough roads being classified as city (too small values)

threads - the number of threads used for the calculation. If this is zero the urban density calculation is skipped entirely

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

setProfiles

public GraphHopper setProfiles(Profile... profiles)

Sets the routing profiles that shall be supported by this GraphHopper instance. The (and only the) given profiles can be used for routing without preparation and for CH/LM preparation.

Here is an example how to setup two CH profiles and one LM profile (via the Java API)

 
   hopper.setProfiles(
     new Profile("my_car").setVehicle("car").setWeighting("shortest"),
     new Profile("your_bike").setVehicle("bike").setWeighting("fastest")
   );
   hopper.getCHPreparationHandler().setCHProfiles(
     new CHProfile("my_car"),
     new CHProfile("your_bike")
   );
   hopper.getLMPreparationHandler().setLMProfiles(
     new LMProfile("your_bike")
   );
 
 

See also https://github.com/graphhopper/graphhopper/pull/1922.

See Also:

CHPreparationHandler.setCHProfiles(com.graphhopper.config.CHProfile...), LMPreparationHandler.setLMProfiles(com.graphhopper.config.LMProfile...)

setProfiles

public GraphHopper setProfiles(List<Profile> profiles)

getProfiles

public List<Profile> getProfiles()

getProfile

public Profile getProfile(String profileName)

Returns the profile for the given profile name, or null if it does not exist

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

getGraphHopperLocation

public String getGraphHopperLocation()

setGraphHopperLocation

public GraphHopper setGraphHopperLocation(String ghLocation)

Sets the graphhopper folder.

getOSMFile

public String getOSMFile()

setOSMFile

public GraphHopper setOSMFile(String osmFile)

This file can be an osm xml (.osm), a compressed xml (.osm.zip or .osm.gz) or a protobuf file (.pbf).

getBaseGraph

public BaseGraph getBaseGraph()

The underlying graph used in algorithms.

Throws:

IllegalStateException - if graph is not instantiated.

setBaseGraph

public void setBaseGraph(BaseGraph baseGraph)

getProperties

public StorableProperties getProperties()

getCHGraphs

public Map<String,RoutingCHGraph> getCHGraphs()

Returns:

a mapping between profile names and according CH preparations. The map will be empty before loading or import.

getLandmarks

public Map<String,LandmarkStorage> getLandmarks()

Returns:

a mapping between profile names and according landmark preparations. The map will be empty before loading or import.

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()

setVehicleEncodedValuesFactory

public GraphHopper setVehicleEncodedValuesFactory(VehicleEncodedValuesFactory factory)

getEncodedValueFactory

public EncodedValueFactory getEncodedValueFactory()

setEncodedValueFactory

public GraphHopper setEncodedValueFactory(EncodedValueFactory factory)

getVehicleTagParserFactory

public VehicleTagParserFactory getVehicleTagParserFactory()

setVehicleTagParserFactory

public GraphHopper setVehicleTagParserFactory(VehicleTagParserFactory factory)

getTagParserFactory

public TagParserFactory getTagParserFactory()

setTagParserFactory

public GraphHopper setTagParserFactory(TagParserFactory factory)

setCustomAreasDirectory

public GraphHopper setCustomAreasDirectory(String customAreasDirectory)

getCustomAreasDirectory

public String getCustomAreasDirectory()

setCountryRuleFactory

public GraphHopper setCountryRuleFactory(CountryRuleFactory countryRuleFactory)

Sets the factory used to create country rules. Use `null` to disable country rules

getCountryRuleFactory

public CountryRuleFactory getCountryRuleFactory()

init

public GraphHopper init(GraphHopperConfig ghConfig)

Reads the configuration from a GraphHopperConfig object which can be manually filled, or more typically is read from `config.yml`.

Important note: Calling this method overwrites the configuration done in some of the setter methods of this class, so generally it is advised to either use this method to configure GraphHopper or the different setter methods, but not both. Unfortunately, this still does not cover all cases and sometimes you have to use both, but then you should make sure there are no conflicts. If you need both it might also help to call the init before calling the setters, because this way the init method won't apply defaults to configuration options you already chose using the setters.

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.

importAndClose

public void importAndClose()

Imports and processes data, storing it to disk when complete.

postImport

protected void postImport()

importOSM

protected void importOSM()

createBaseGraphAndProperties

protected void createBaseGraphAndProperties()

writeEncodingManagerToProperties

protected void writeEncodingManagerToProperties()

_getOSMFile

protected File _getOSMFile()

Currently we use this for a few tests where the dataReaderFile is loaded from the classpath

load

public boolean load()

Load from existing graph folder.

getCHPreparationHandler

public final CHPreparationHandler getCHPreparationHandler()

getLMPreparationHandler

public final LMPreparationHandler getLMPreparationHandler()

postProcessing

protected void postProcessing(boolean closeEarly)

Runs both after the import and when loading an existing Graph

Parameters:

closeEarly - release resources as early as possible

importPublicTransit

protected void importPublicTransit()

createWeighting

public final Weighting createWeighting(Profile profile,
                                       PMap hints)

createWeighting

public final Weighting createWeighting(Profile profile,
                                       PMap hints,
                                       boolean disableTurnCosts)

createWeightingFactory

protected WeightingFactory createWeightingFactory()

route

public GHResponse route(GHRequest request)

doCreateRouter

protected Router doCreateRouter(BaseGraph baseGraph,
                                EncodingManager encodingManager,
                                LocationIndex locationIndex,
                                Map<String,Profile> profilesByName,
                                PathDetailsBuilderFactory pathBuilderFactory,
                                TranslationMap trMap,
                                RouterConfig routerConfig,
                                WeightingFactory weightingFactory,
                                Map<String,RoutingCHGraph> chGraphs,
                                Map<String,LandmarkStorage> landmarks)

createLocationIndex

protected LocationIndex createLocationIndex(Directory dir)

initLocationIndex

protected void initLocationIndex()

Initializes the location index after the import is done.

loadOrPrepareCH

protected void loadOrPrepareCH(boolean closeEarly)

prepareCH

protected Map<String,PrepareContractionHierarchies.Result> prepareCH(boolean closeEarly,
                                                                     List<CHConfig> configsToPrepare)

loadOrPrepareLM

protected void loadOrPrepareLM(boolean closeEarly)

For landmarks it is required to always call this method: either it creates the landmark data or it loads it.

prepareLM

protected List<PrepareLandmarks> prepareLM(boolean closeEarly,
                                           List<LMConfig> configsToPrepare)

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()

getFullyLoaded

public boolean getFullyLoaded()

getRouterConfig

public RouterConfig getRouterConfig()

getReaderConfig

public OSMReaderConfig getReaderConfig()