com.graphhopper.routing.lm

Class LMAlgoFactoryDecorator

java.lang.Object

com.graphhopper.routing.lm.LMAlgoFactoryDecorator

All Implemented Interfaces:

RoutingAlgorithmFactoryDecorator

public class LMAlgoFactoryDecorator
extends Object
implements RoutingAlgorithmFactoryDecorator

This class implements the A*, landmark and triangulation (ALT) decorator.

Author:

Peter Karich

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LMAlgoFactoryDecorator.LMRAFactory TODO needs to be public to pick defaultAlgoFactory.weighting if the defaultAlgoFactory is a CH one.

Constructor Summary

Constructors

Constructor and Description
LMAlgoFactoryDecorator()

Method Summary

Modifier and Type	Method and Description
LMAlgoFactoryDecorator	addPreparation(PrepareLandmarks pch)
LMAlgoFactoryDecorator	addWeighting(String weighting)
LMAlgoFactoryDecorator	addWeighting(Weighting weighting) Decouple weightings from PrepareLandmarks as we need weightings for the graphstorage and the graphstorage for the preparation.
void	createPreparations(GraphHopperStorage ghStorage, LocationIndex locationIndex) This method creates the landmark storages ready for landmark creation.
RoutingAlgorithmFactory	getDecoratedAlgorithmFactory(RoutingAlgorithmFactory defaultAlgoFactory, HintsMap map) This method returns the specified algoFactory unchanged, decorates it or completely replaces it depending on the specified optionsMap.
int	getLandmarks()
List<PrepareLandmarks>	getPreparations()
int	getPreparationThreads()
List<Weighting>	getWeightings()
List<String>	getWeightingsAsStrings()
boolean	hasPreparations()
boolean	hasWeightings()
void	init(CmdArgs args)
boolean	isDisablingAllowed()
boolean	isEnabled()
boolean	loadOrDoWork(StorableProperties properties) This method calculates the landmark data for all weightings (optionally in parallel) or if already existent loads it.
LMAlgoFactoryDecorator	setDisablingAllowed(boolean disablingAllowed)
LMAlgoFactoryDecorator	setEnabled(boolean enabled) Enables or disables this decorator.
void	setPreparationThreads(int preparationThreads) This method changes the number of threads used for preparation on import.
LMAlgoFactoryDecorator	setWeightingsAsStrings(List<String> weightingList) Enables the use of contraction hierarchies to reduce query times.
int	size()

Methods inherited from class java.lang.Object

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

Constructor Detail

LMAlgoFactoryDecorator

public LMAlgoFactoryDecorator()

Method Detail

init

public void init(CmdArgs args)

Specified by:

init in interface RoutingAlgorithmFactoryDecorator

getLandmarks

public int getLandmarks()

setDisablingAllowed

public LMAlgoFactoryDecorator setDisablingAllowed(boolean disablingAllowed)

isDisablingAllowed

public final boolean isDisablingAllowed()

setEnabled

public final LMAlgoFactoryDecorator setEnabled(boolean enabled)

Enables or disables this decorator. This speed-up mode is disabled by default.

isEnabled

public final boolean isEnabled()

Specified by:

isEnabled in interface RoutingAlgorithmFactoryDecorator

getPreparationThreads

public int getPreparationThreads()

setPreparationThreads

public void setPreparationThreads(int preparationThreads)

This method changes the number of threads used for preparation on import. Default is 1. Make sure that you have enough memory when increasing this number!

setWeightingsAsStrings

public LMAlgoFactoryDecorator setWeightingsAsStrings(List<String> weightingList)

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.

getWeightingsAsStrings

public List<String> getWeightingsAsStrings()

addWeighting

public LMAlgoFactoryDecorator addWeighting(String weighting)

addWeighting

public LMAlgoFactoryDecorator addWeighting(Weighting weighting)

Decouple weightings from PrepareLandmarks as we need weightings for the graphstorage and the graphstorage for the preparation.

addPreparation

public LMAlgoFactoryDecorator addPreparation(PrepareLandmarks pch)

hasWeightings

public boolean hasWeightings()

hasPreparations

public boolean hasPreparations()

size

public int size()

getWeightings

public List<Weighting> getWeightings()

getPreparations

public List<PrepareLandmarks> getPreparations()

getDecoratedAlgorithmFactory

public RoutingAlgorithmFactory getDecoratedAlgorithmFactory(RoutingAlgorithmFactory defaultAlgoFactory,
                                                            HintsMap map)

Description copied from interface: RoutingAlgorithmFactoryDecorator

This method returns the specified algoFactory unchanged, decorates it or completely replaces it depending on the specified optionsMap.

Specified by:

getDecoratedAlgorithmFactory in interface RoutingAlgorithmFactoryDecorator

loadOrDoWork

public boolean loadOrDoWork(StorableProperties properties)

This method calculates the landmark data for all weightings (optionally in parallel) or if already existent loads it.

Returns:

true if the preparation data for at least one weighting was calculated.

See Also:

for a very similar method

createPreparations

public void createPreparations(GraphHopperStorage ghStorage,
                               LocationIndex locationIndex)

This method creates the landmark storages ready for landmark creation.