com.graphhopper.routing.querygraph

Class VirtualEdgeIteratorState

java.lang.Object

com.graphhopper.routing.querygraph.VirtualEdgeIteratorState

All Implemented Interfaces:

EdgeIteratorState

public class VirtualEdgeIteratorState
extends Object
implements EdgeIteratorState

Creates an edge state decoupled from a graph where nodes, pointList, etc are kept in memory.

Note, this class is not suited for public use and can change with minor releases unexpectedly or even gets removed.

Field Summary

Fields inherited from interface com.graphhopper.util.EdgeIteratorState

REVERSE_STATE, UNFAVORED_EDGE

Constructor Summary

Constructors

Constructor and Description
VirtualEdgeIteratorState(int originalEdgeKey, int edgeKey, int baseNode, int adjNode, double distance, IntsRef edgeFlags, List<EdgeKVStorage.KeyValue> keyValues, PointList pointList, boolean reverse)

Method Summary

Modifier and Type	Method and Description
EdgeIteratorState	copyPropertiesFrom(EdgeIteratorState fromEdge) Copies the properties of the specified edge into this edge.
EdgeIteratorState	detach(boolean reverse) Clones this EdgeIteratorState.
PointList	fetchWayGeometry(FetchMode mode) For road network data like OSM a way is often not just a straight line.
boolean	get(BooleanEncodedValue property)
double	get(DecimalEncodedValue property)
<T extends Enum<?>> T	get(EnumEncodedValue<T> property)
int	get(IntEncodedValue property)
String	get(StringEncodedValue property)
int	getAdjNode()
int	getBaseNode() Returns the node used to instantiate the EdgeIterator.
double	getDistance()
int	getEdge()
int	getEdgeKey() Returns the edge key of the current edge.
IntsRef	getFlags() Returns edge properties stored in direction of the raw database layout.
List<EdgeKVStorage.KeyValue>	getKeyValues() This method returns KeyValue pairs for both directions in contrast to EdgeIteratorState.getValue(String).
String	getName() Identical to calling getKeyValues().get("name") if name is stored for both directions.
int	getOriginalEdgeKey() This method returns the original (not virtual!) edge key.
boolean	getReverse(BooleanEncodedValue property)
double	getReverse(DecimalEncodedValue property)
<T extends Enum<?>> T	getReverse(EnumEncodedValue<T> property)
int	getReverse(IntEncodedValue property)
String	getReverse(StringEncodedValue property)
int	getReverseEdgeKey() Like #getEdgeKey, but returns the reverse key.
Object	getValue(String key) This method returns the *first* value for the specified key and only if stored for the direction of this EdgeIteratorState.
EdgeIteratorState	set(BooleanEncodedValue property, boolean value)
EdgeIteratorState	set(BooleanEncodedValue property, boolean fwd, boolean bwd)
EdgeIteratorState	set(DecimalEncodedValue property, double value)
EdgeIteratorState	set(DecimalEncodedValue property, double fwd, double bwd)
<T extends Enum<?>> EdgeIteratorState	set(EnumEncodedValue<T> property, T value)
<T extends Enum<?>> EdgeIteratorState	set(EnumEncodedValue<T> property, T fwd, T bwd)
EdgeIteratorState	set(IntEncodedValue property, int value)
EdgeIteratorState	set(IntEncodedValue property, int fwd, int bwd)
EdgeIteratorState	set(StringEncodedValue property, String value)
EdgeIteratorState	set(StringEncodedValue property, String fwd, String bwd)
EdgeIteratorState	setDistance(double dist)
EdgeIteratorState	setFlags(IntsRef flags) Stores the specified edgeFlags down to the DataAccess
EdgeIteratorState	setKeyValues(List<EdgeKVStorage.KeyValue> list) This stores the specified key-value pairs in the storage of this EdgeIteratorState.
EdgeIteratorState	setReverse(BooleanEncodedValue property, boolean value)
EdgeIteratorState	setReverse(DecimalEncodedValue property, double value)
<T extends Enum<?>> EdgeIteratorState	setReverse(EnumEncodedValue<T> property, T value)
EdgeIteratorState	setReverse(IntEncodedValue property, int value)
EdgeIteratorState	setReverse(StringEncodedValue property, String value)
void	setReverseEdge(EdgeIteratorState reverseEdge)
void	setUnfavored(boolean unfavored) This method sets edge to unfavored status for routing from the start or to the stop location.
EdgeIteratorState	setWayGeometry(PointList list)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

VirtualEdgeIteratorState

public VirtualEdgeIteratorState(int originalEdgeKey,
                                int edgeKey,
                                int baseNode,
                                int adjNode,
                                double distance,
                                IntsRef edgeFlags,
                                List<EdgeKVStorage.KeyValue> keyValues,
                                PointList pointList,
                                boolean reverse)

Method Detail

getOriginalEdgeKey

public int getOriginalEdgeKey()

This method returns the original (not virtual!) edge key. I.e. also the direction is already correctly encoded.

See Also:

EdgeIteratorState.getEdgeKey()

getEdge

public int getEdge()

Specified by:

getEdge in interface EdgeIteratorState

Returns:

the edge id of the current edge. Do not make any assumptions about the concrete values, except that for an implementation it is recommended that they'll be contiguous.

getEdgeKey

public int getEdgeKey()

Description copied from interface: EdgeIteratorState

Returns the edge key of the current edge. The edge id can be derived from the edge key by calling GHUtility.getEdgeFromEdgeKey(int), but the edge key also contains information about the direction of the edge. The edge key is even when the edge is oriented in storage direction and odd otherwise. You can use the edge key to retrieve an edge state in the associated direction using Graph.getEdgeIteratorStateForKey(int). Loop edges are always returned in 'forward' direction even when you use an odd edge key.

Specified by:

getEdgeKey in interface EdgeIteratorState

getReverseEdgeKey

public int getReverseEdgeKey()

Description copied from interface: EdgeIteratorState

Like #getEdgeKey, but returns the reverse key. For loops the reverse key is the same as the key.

Specified by:

getReverseEdgeKey in interface EdgeIteratorState

getBaseNode

public int getBaseNode()

Description copied from interface: EdgeIteratorState

Returns the node used to instantiate the EdgeIterator. Often only used for convenience reasons. Do not confuse this with a source node of a directed edge.

Specified by:

getBaseNode in interface EdgeIteratorState

Returns:

the requested node itself

See Also:

EdgeIterator

getAdjNode

public int getAdjNode()

Specified by:

getAdjNode in interface EdgeIteratorState

Returns:

the adjacent node of baseNode for the current edge.

See Also:

EdgeIterator

fetchWayGeometry

public PointList fetchWayGeometry(FetchMode mode)

Description copied from interface: EdgeIteratorState

For road network data like OSM a way is often not just a straight line. The nodes between the junction nodes are called pillar nodes. The junction nodes are called tower nodes and used for routing. The pillar nodes are necessary to have an exact geometry. See the docs for more information (docs/core/low-level-api.md#what-are-pillar-and-tower-nodes). Updates to the returned list are not reflected in the graph, for that you've to use setWayGeometry.

Specified by:

fetchWayGeometry in interface EdgeIteratorState

Parameters:

mode - FetchMode

Returns:

the pillar and/or tower nodes depending on the mode.

setWayGeometry

public EdgeIteratorState setWayGeometry(PointList list)

Specified by:

setWayGeometry in interface EdgeIteratorState

Parameters:

list - is a sorted collection of coordinates between the base node and the current adjacent node. Specify the list without the adjacent and base node. This method can be called multiple times, but if the distance changes, the setDistance method is not called automatically.

getDistance

public double getDistance()

Specified by:

getDistance in interface EdgeIteratorState

Returns:

the distance of the current edge in meter

setDistance

public EdgeIteratorState setDistance(double dist)

Specified by:

setDistance in interface EdgeIteratorState

getFlags

public IntsRef getFlags()

Description copied from interface: EdgeIteratorState

Returns edge properties stored in direction of the raw database layout. So do not use it directly, instead use the appropriate set/get methods with its EncodedValue object.

Specified by:

getFlags in interface EdgeIteratorState

setFlags

public EdgeIteratorState setFlags(IntsRef flags)

Description copied from interface: EdgeIteratorState

Stores the specified edgeFlags down to the DataAccess

Specified by:

setFlags in interface EdgeIteratorState

get

public boolean get(BooleanEncodedValue property)

Specified by:

get in interface EdgeIteratorState

set

public EdgeIteratorState set(BooleanEncodedValue property,
                             boolean value)

Specified by:

set in interface EdgeIteratorState

getReverse

public boolean getReverse(BooleanEncodedValue property)

Specified by:

getReverse in interface EdgeIteratorState

setReverse

public EdgeIteratorState setReverse(BooleanEncodedValue property,
                                    boolean value)

Specified by:

setReverse in interface EdgeIteratorState

set

public EdgeIteratorState set(BooleanEncodedValue property,
                             boolean fwd,
                             boolean bwd)

Specified by:

set in interface EdgeIteratorState

get

public int get(IntEncodedValue property)

Specified by:

get in interface EdgeIteratorState

set

public EdgeIteratorState set(IntEncodedValue property,
                             int value)

Specified by:

set in interface EdgeIteratorState

getReverse

public int getReverse(IntEncodedValue property)

Specified by:

getReverse in interface EdgeIteratorState

setReverse

public EdgeIteratorState setReverse(IntEncodedValue property,
                                    int value)

Specified by:

setReverse in interface EdgeIteratorState

set

public EdgeIteratorState set(IntEncodedValue property,
                             int fwd,
                             int bwd)

Specified by:

set in interface EdgeIteratorState

get

public double get(DecimalEncodedValue property)

Specified by:

get in interface EdgeIteratorState

set

public EdgeIteratorState set(DecimalEncodedValue property,
                             double value)

Specified by:

set in interface EdgeIteratorState

getReverse

public double getReverse(DecimalEncodedValue property)

Specified by:

getReverse in interface EdgeIteratorState

setReverse

public EdgeIteratorState setReverse(DecimalEncodedValue property,
                                    double value)

Specified by:

setReverse in interface EdgeIteratorState

set

public EdgeIteratorState set(DecimalEncodedValue property,
                             double fwd,
                             double bwd)

Specified by:

set in interface EdgeIteratorState

get

public <T extends Enum<?>> T get(EnumEncodedValue<T> property)

Specified by:

get in interface EdgeIteratorState

set

public <T extends Enum<?>> EdgeIteratorState set(EnumEncodedValue<T> property,
                                                 T value)

Specified by:

set in interface EdgeIteratorState

getReverse

public <T extends Enum<?>> T getReverse(EnumEncodedValue<T> property)

Specified by:

getReverse in interface EdgeIteratorState

setReverse

public <T extends Enum<?>> EdgeIteratorState setReverse(EnumEncodedValue<T> property,
                                                        T value)

Specified by:

setReverse in interface EdgeIteratorState

set

public <T extends Enum<?>> EdgeIteratorState set(EnumEncodedValue<T> property,
                                                 T fwd,
                                                 T bwd)

Specified by:

set in interface EdgeIteratorState

get

public String get(StringEncodedValue property)

Specified by:

get in interface EdgeIteratorState

set

public EdgeIteratorState set(StringEncodedValue property,
                             String value)

Specified by:

set in interface EdgeIteratorState

getReverse

public String getReverse(StringEncodedValue property)

Specified by:

getReverse in interface EdgeIteratorState

setReverse

public EdgeIteratorState setReverse(StringEncodedValue property,
                                    String value)

Specified by:

setReverse in interface EdgeIteratorState

set

public EdgeIteratorState set(StringEncodedValue property,
                             String fwd,
                             String bwd)

Specified by:

set in interface EdgeIteratorState

getName

public String getName()

Description copied from interface: EdgeIteratorState

Identical to calling getKeyValues().get("name") if name is stored for both directions. Note that for backward compatibility this method returns an empty String instead of null if there was no KeyPair with key==name stored.

Specified by:

getName in interface EdgeIteratorState

Returns:

the stored value for the key "name" in the KeyValue list of this EdgeIteratorState.

setKeyValues

public EdgeIteratorState setKeyValues(List<EdgeKVStorage.KeyValue> list)

Description copied from interface: EdgeIteratorState

This stores the specified key-value pairs in the storage of this EdgeIteratorState. This is more flexible compared to the mechanism of flags and EncodedValue and allows storing sparse key value pairs more efficient. But it might be slow and more inefficient on retrieval. Call this setKeyValues method only once per EdgeIteratorState as it allocates new space everytime this method is called.

Specified by:

setKeyValues in interface EdgeIteratorState

getKeyValues

public List<EdgeKVStorage.KeyValue> getKeyValues()

Description copied from interface: EdgeIteratorState

This method returns KeyValue pairs for both directions in contrast to EdgeIteratorState.getValue(String).

Specified by:

getKeyValues in interface EdgeIteratorState

See Also:

EdgeIteratorState.setKeyValues(List)

getValue

public Object getValue(String key)

Description copied from interface: EdgeIteratorState

This method returns the *first* value for the specified key and only if stored for the direction of this EdgeIteratorState. If you need more than one value see also EdgeIteratorState.getKeyValues(). Avoid storing KeyPairs with duplicate keys as only the first will be reachable with this method. Currently, there is no support to use this method in a custom_model, and you should use EncodedValues instead.

Specified by:

getValue in interface EdgeIteratorState

setUnfavored

public void setUnfavored(boolean unfavored)

This method sets edge to unfavored status for routing from the start or to the stop location.

toString

public String toString()

Overrides:

toString in class Object

detach

public EdgeIteratorState detach(boolean reverse)

Description copied from interface: EdgeIteratorState

Clones this EdgeIteratorState.

Specified by:

detach in interface EdgeIteratorState

Parameters:

reverse - if true a detached edgeState with reversed properties is created where base and adjacent nodes, flags and wayGeometry are in reversed order. See #162 for more details about why we need the reverse parameter.

copyPropertiesFrom

public EdgeIteratorState copyPropertiesFrom(EdgeIteratorState fromEdge)

Description copied from interface: EdgeIteratorState

Copies the properties of the specified edge into this edge. Does not change nodes!

Specified by:

copyPropertiesFrom in interface EdgeIteratorState

Returns:

the specified edge e

setReverseEdge

public void setReverseEdge(EdgeIteratorState reverseEdge)