com.graphhopper.storage

Interface Graph

All Known Subinterfaces:

CHGraph

All Known Implementing Classes:

CHGraphImpl, GraphHopperStorage, QueryGraph

public interface Graph

An interface to represent a (geo) graph - suited for efficient storage as it can be requested via indices called node IDs. To get the lat,lon point you need to set up a LocationIndex instance.

Author:

Peter Karich

Method Summary

Modifier and Type	Method and Description
Graph	copyTo(Graph g) Copy this Graph into the specified Graph g.
EdgeExplorer	createEdgeExplorer()
EdgeExplorer	createEdgeExplorer(EdgeFilter filter) Returns an EdgeExplorer which makes it possible to traverse all filtered edges of a specific node.
EdgeIteratorState	edge(int a, int b) Creates an edge between the nodes a and b.
EdgeIteratorState	edge(int a, int b, double distance, boolean bothDirections) Use edge(a,b).setDistance().setFlags instead
AllEdgesIterator	getAllEdges()
Graph	getBaseGraph()
BBox	getBounds() Returns the implicit bounds of this graph calculated from the lat,lon input of setNode
EdgeIteratorState	getEdgeIteratorState(int edgeId, int adjNode) Returns a wrapper over the specified edgeId.
int	getEdges()
GraphExtension	getExtension()
NodeAccess	getNodeAccess() Creates a node explorer to access node properties.
int	getNodes()
int	getOtherNode(int edge, int node)
boolean	isAdjacentToNode(int edge, int node)

Method Detail

getBaseGraph

Graph getBaseGraph()

Returns:

a graph which behaves like an unprepared graph and e.g. the normal unidirectional Dijkstra or any graph traversal algorithm can be executed.

getNodes

int getNodes()

Returns:

the number of created locations - via setNode() or edge()

getEdges

int getEdges()

Returns:

the number of edges in this graph. equivalent to getAllEdges().length();

getNodeAccess

NodeAccess getNodeAccess()

Creates a node explorer to access node properties.

getBounds

BBox getBounds()

Returns the implicit bounds of this graph calculated from the lat,lon input of setNode

edge

EdgeIteratorState edge(int a,
                       int b)

Creates an edge between the nodes a and b. To set distance or access use the returned edge and e.g. edgeState.setDistance

Parameters:

a - the index of the starting (tower) node of the edge

b - the index of the ending (tower) node of the edge

Returns:

the newly created edge

edge

EdgeIteratorState edge(int a,
                       int b,
                       double distance,
                       boolean bothDirections)

Use edge(a,b).setDistance().setFlags instead

getEdgeIteratorState

EdgeIteratorState getEdgeIteratorState(int edgeId,
                                       int adjNode)

Returns a wrapper over the specified edgeId.

Parameters:

adjNode - is the node that will be returned via adjNode(). If adjNode is Integer.MIN_VALUE then the edge will be returned in the direction of how it is stored

Returns:

an edge iterator state or potentially null if adjNode does not match

Throws:

IllegalStateException - if edgeId is not valid

getOtherNode

int getOtherNode(int edge,
                 int node)

Returns:

the 'opposite' node of a given edge, so if there is an edge 3-2 and node =2 this returns 3

isAdjacentToNode

boolean isAdjacentToNode(int edge,
                         int node)

Returns:

true if the edge with id edge is adjacent to node, false otherwise

getAllEdges

AllEdgesIterator getAllEdges()

Returns:

all edges in this graph, where baseNode will be the smaller node.

createEdgeExplorer

EdgeExplorer createEdgeExplorer(EdgeFilter filter)

Returns an EdgeExplorer which makes it possible to traverse all filtered edges of a specific node. Reduce calling this method as much as possible, e.g. create an explorer before a for loop!

See Also:

EdgeExplorer, createEdgeExplorer()

createEdgeExplorer

EdgeExplorer createEdgeExplorer()

See Also:

createEdgeExplorer(com.graphhopper.routing.util.EdgeFilter)

copyTo

Graph copyTo(Graph g)

Copy this Graph into the specified Graph g.

Returns:

the specified Graph g

getExtension

GraphExtension getExtension()

Returns:

the graph extension like a TurnCostExtension