com.graphhopper.routing.util

Class EncodingManager

java.lang.Object

com.graphhopper.routing.util.EncodingManager

All Implemented Interfaces:

EncodedValueLookup

public class EncodingManager
extends Object
implements EncodedValueLookup

Manager class to register encoder, assign their flag values and check objects with all encoders during parsing. Create one via:

EncodingManager.start(4).add(new CarFlagEncoder()).build();

Author:

Peter Karich, Nop

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EncodingManager.AcceptWay
static class	EncodingManager.Access
static class	EncodingManager.Builder

Method Summary

Modifier and Type	Method and Description
boolean	acceptWay(ReaderWay way, EncodingManager.AcceptWay acceptWay) Determine whether a way is routable for one of the added encoders.
void	applyWayTags(ReaderWay way, EdgeIteratorState edge)
static EncodingManager	create(EncodedValueFactory evFactory, FlagEncoderFactory flagEncoderFactory, String ghLoc) Create the EncodingManager from the provided GraphHopper location.
static EncodingManager	create(FlagEncoder... flagEncoders) Instantiate manager with the given list of encoders.
static EncodingManager	create(FlagEncoderFactory factory, String flagEncodersStr)
static EncodingManager	create(List<? extends FlagEncoder> flagEncoders) Instantiate manager with the given list of encoders.
static EncodingManager	create(String flagEncodersStr) Instantiate manager with the given list of encoders.
IntsRef	createEdgeFlags()
IntsRef	createRelationFlags()
boolean	equals(Object o)
List<FlagEncoder>	fetchEdgeEncoders()
IntsRef	flagsDefault(boolean forward, boolean backward)
List<BooleanEncodedValue>	getAccessEncFromNodeFlags(long importNodeFlags)
List<EncodedValue>	getAllShared()
BooleanEncodedValue	getBooleanEncodedValue(String key)
DecimalEncodedValue	getDecimalEncodedValue(String key)
<T extends EncodedValue> T	getEncodedValue(String key, Class<T> encodedValueType)
FlagEncoder	getEncoder(String name)
<T extends Enum> EnumEncodedValue<T>	getEnumEncodedValue(String key, Class<T> type)
IntEncodedValue	getIntEncodedValue(String key)
int	getIntsForFlags()
static String	getKey(FlagEncoder encoder, String str) All EncodedValue names that are created from a FlagEncoder should use this method to mark them as "none-shared" across the other FlagEncoders.
static String	getKey(String prefix, String str)
long	handleNodeTags(ReaderNode node) Analyze tags on osm node.
IntsRef	handleRelationTags(ReaderRelation relation, IntsRef relFlags)
void	handleTurnRelationTags(OSMTurnRelation turnRelation, TurnCostParser.ExternalInternalMap map, Graph graph)
IntsRef	handleWayTags(ReaderWay way, EncodingManager.AcceptWay acceptWay, IntsRef relationFlags) Processes way properties of different kind to determine speed and direction.
boolean	hasEncodedValue(String key)
boolean	hasEncoder(String encoder)
int	hashCode()
boolean	isEnableInstructions()
boolean	needsTurnCostsSupport()
void	releaseParsers()
static EncodingManager.Builder	start() Starts the build process of an EncodingManager
String	toEncodedValuesAsString()
String	toFlagEncodersAsString()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static EncodingManager create(String flagEncodersStr)

Instantiate manager with the given list of encoders. The manager knows several default encoders ignoring case.

Parameters:

flagEncodersStr - comma delimited list of encoders. The order does not matter.

create

public static EncodingManager create(FlagEncoderFactory factory,
                                     String flagEncodersStr)

create

public static EncodingManager create(FlagEncoder... flagEncoders)

Instantiate manager with the given list of encoders.

Parameters:

flagEncoders - comma delimited list of encoders. The order does not matter.

create

public static EncodingManager create(List<? extends FlagEncoder> flagEncoders)

Instantiate manager with the given list of encoders.

Parameters:

flagEncoders - comma delimited list of encoders. The order does not matter.

create

public static EncodingManager create(EncodedValueFactory evFactory,
                                     FlagEncoderFactory flagEncoderFactory,
                                     String ghLoc)

Create the EncodingManager from the provided GraphHopper location. Throws an IllegalStateException if it fails. Used if no EncodingManager specified on load.

start

public static EncodingManager.Builder start()

Starts the build process of an EncodingManager

releaseParsers

public void releaseParsers()

getIntsForFlags

public int getIntsForFlags()

isEnableInstructions

public boolean isEnableInstructions()

hasEncodedValue

public boolean hasEncodedValue(String key)

Specified by:

hasEncodedValue in interface EncodedValueLookup

hasEncoder

public boolean hasEncoder(String encoder)

Returns:

true if the specified encoder is found

getEncoder

public FlagEncoder getEncoder(String name)

acceptWay

public boolean acceptWay(ReaderWay way,
                         EncodingManager.AcceptWay acceptWay)

Determine whether a way is routable for one of the added encoders.

Returns:

if at least one encoder consumes the specified way. Additionally the specified acceptWay is changed to provide more details.

handleRelationTags

public IntsRef handleRelationTags(ReaderRelation relation,
                                  IntsRef relFlags)

handleTurnRelationTags

public void handleTurnRelationTags(OSMTurnRelation turnRelation,
                                   TurnCostParser.ExternalInternalMap map,
                                   Graph graph)

handleWayTags

public IntsRef handleWayTags(ReaderWay way,
                             EncodingManager.AcceptWay acceptWay,
                             IntsRef relationFlags)

Processes way properties of different kind to determine speed and direction. Properties are directly encoded in 8 bytes.

Parameters:

relationFlags - The preprocessed relation flags is used to influence the way properties.

toString

public String toString()

Overrides:

toString in class Object

toFlagEncodersAsString

public String toFlagEncodersAsString()

toEncodedValuesAsString

public String toEncodedValuesAsString()

createEdgeFlags

public IntsRef createEdgeFlags()

createRelationFlags

public IntsRef createRelationFlags()

flagsDefault

public IntsRef flagsDefault(boolean forward,
                            boolean backward)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

handleNodeTags

public long handleNodeTags(ReaderNode node)

Analyze tags on osm node. Store node tags (barriers etc) for later usage while parsing way.

applyWayTags

public void applyWayTags(ReaderWay way,
                         EdgeIteratorState edge)

fetchEdgeEncoders

public List<FlagEncoder> fetchEdgeEncoders()

needsTurnCostsSupport

public boolean needsTurnCostsSupport()

getAccessEncFromNodeFlags

public List<BooleanEncodedValue> getAccessEncFromNodeFlags(long importNodeFlags)

getAllShared

public List<EncodedValue> getAllShared()

Specified by:

getAllShared in interface EncodedValueLookup

getBooleanEncodedValue

public BooleanEncodedValue getBooleanEncodedValue(String key)

Specified by:

getBooleanEncodedValue in interface EncodedValueLookup

getIntEncodedValue

public IntEncodedValue getIntEncodedValue(String key)

Specified by:

getIntEncodedValue in interface EncodedValueLookup

getDecimalEncodedValue

public DecimalEncodedValue getDecimalEncodedValue(String key)

Specified by:

getDecimalEncodedValue in interface EncodedValueLookup

getEnumEncodedValue

public <T extends Enum> EnumEncodedValue<T> getEnumEncodedValue(String key,
                                                                Class<T> type)

Specified by:

getEnumEncodedValue in interface EncodedValueLookup

getEncodedValue

public <T extends EncodedValue> T getEncodedValue(String key,
                                                  Class<T> encodedValueType)

Specified by:

getEncodedValue in interface EncodedValueLookup

getKey

public static String getKey(FlagEncoder encoder,
                            String str)

All EncodedValue names that are created from a FlagEncoder should use this method to mark them as "none-shared" across the other FlagEncoders. E.g. average_speed for the CarFlagEncoder will be named car.average_speed

getKey

public static String getKey(String prefix,
                            String str)