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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROUNDABOUT

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(FlagEncoder... flagEncoders) Instantiate manager with the given list of encoders.
static EncodingManager	create(FlagEncoderFactory factory, String ghLoc) Create the EncodingManager from the provided GraphHopper location.
static EncodingManager	create(FlagEncoderFactory factory, String flagEncodersStr, int bytesForEdgeFlags)
static EncodingManager	create(List<? extends FlagEncoder> flagEncoders) Instantiate manager with the given list of encoders.
static EncodingManager	create(List<? extends FlagEncoder> flagEncoders, int bytesForEdgeFlags)
static EncodingManager	create(String flagEncodersStr) Instantiate manager with the given list of encoders.
static EncodingManager	create(String flagEncodersStr, int bytesForEdgeFlags)
static EncodingManager.Builder	createBuilder(FlagEncoderFactory factory, String flagEncodersStr, int bytesForEdgeFlags)
IntsRef	createEdgeFlags()
boolean	equals(Object obj)
List<FlagEncoder>	fetchEdgeEncoders() The returned list is never empty.
IntsRef	flagsDefault(boolean forward, boolean backward)
List<BooleanEncodedValue>	getAccessEncFromNodeFlags(long importNodeFlags)
BooleanEncodedValue	getBooleanEncodedValue(String key)
int	getBytesForFlags()
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)
static String	getKey(FlagEncoder encoder, String str) Until we have a proper key-string class we create all keys through this function
String	getPreferredLanguage()
long	handleNodeTags(ReaderNode node) Analyze tags on osm node.
long	handleRelationTags(long oldRelationFlags, ReaderRelation relation)
IntsRef	handleWayTags(ReaderWay way, EncodingManager.AcceptWay acceptWay, long relationFlags) Processes way properties of different kind to determine speed and direction.
boolean	hasEncoder(String encoder)
int	hashCode()
boolean	isEnableInstructions()
boolean	needsTurnCostsSupport()
static EncodingManager.Builder	start() Starts the build process of an EncodingManager
String	toDetailsString()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ROUNDABOUT

public static final String ROUNDABOUT

See Also:

Constant Field Values

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(String flagEncodersStr,
                                     int bytesForEdgeFlags)

create

public static EncodingManager create(FlagEncoderFactory factory,
                                     String flagEncodersStr,
                                     int bytesForEdgeFlags)

createBuilder

public static EncodingManager.Builder createBuilder(FlagEncoderFactory factory,
                                                    String flagEncodersStr,
                                                    int bytesForEdgeFlags)

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(List<? extends FlagEncoder> flagEncoders,
                                     int bytesForEdgeFlags)

create

public static EncodingManager create(FlagEncoderFactory factory,
                                     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

getBytesForFlags

public int getBytesForFlags()

isEnableInstructions

public boolean isEnableInstructions()

getPreferredLanguage

public String getPreferredLanguage()

hasEncoder

public boolean hasEncoder(String encoder)

Specified by:

hasEncoder in interface EncodedValueLookup

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 long handleRelationTags(long oldRelationFlags,
                               ReaderRelation relation)

handleWayTags

public IntsRef handleWayTags(ReaderWay way,
                             EncodingManager.AcceptWay acceptWay,
                             long 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

toDetailsString

public String toDetailsString()

createEdgeFlags

public IntsRef createEdgeFlags()

flagsDefault

public IntsRef flagsDefault(boolean forward,
                            boolean backward)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

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

The returned list is never empty.

needsTurnCostsSupport

public boolean needsTurnCostsSupport()

getAccessEncFromNodeFlags

public List<BooleanEncodedValue> getAccessEncFromNodeFlags(long importNodeFlags)

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 final String getKey(FlagEncoder encoder,
                                  String str)

Until we have a proper key-string class we create all keys through this function