com.graphhopper.storage

Class GraphHopperStorage

java.lang.Object

com.graphhopper.storage.GraphHopperStorage

All Implemented Interfaces:

Graph, GraphStorage, Storable<GraphStorage>, Closeable, AutoCloseable

public final class GraphHopperStorage
extends Object
implements GraphStorage, Graph

This class manages all storage related methods and delegates the calls to the associated graphs. The associated graphs manage their own necessary data structures and are used to provide e.g. different traversal methods. By default this class implements the graph interface and results in identical behavior as the Graph instance from getBaseGraph()

Author:

Peter Karich

See Also:

to create a (CH)Graph easier

Constructor Summary

Constructors

Constructor and Description
GraphHopperStorage(Directory dir, EncodingManager encodingManager, boolean withElevation)
GraphHopperStorage(Directory dir, EncodingManager encodingManager, boolean withElevation, boolean withTurnCosts)
GraphHopperStorage(Directory dir, EncodingManager encodingManager, boolean withElevation, boolean withTurnCosts, int segmentSize)

Method Summary

Modifier and Type	Method and Description
GraphHopperStorage	addCHGraph(CHProfile chProfile) Adds a CHGraph for the given CHProfile.
GraphHopperStorage	addCHGraphs(List<CHProfile> chProfiles)
void	close() This method makes sure that the underlying used resources are released.
Graph	copyTo(Graph g) Copy this Graph into the specified Graph g.
GraphHopperStorage	create(long byteCount) After configuring this storage you need to create it explicitly.
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
void	flush() This method makes sure that the underlying data is written to the storage.
void	flushAndCloseEarly() Flush and close resources like wayGeometry that are not needed for CH preparation.
void	freeze() Avoid that edges and nodes of the base graph are further modified.
AllEdgesIterator	getAllEdges()
Graph	getBaseGraph()
BBox	getBounds() Returns the implicit bounds of this graph calculated from the lat,lon input of setNode
long	getCapacity()
CHGraph	getCHGraph()
CHGraph	getCHGraph(CHProfile chProfile)
CHGraph	getCHGraph(String profileName)
List<CHProfile>	getCHProfiles()
List<CHProfile>	getCHProfiles(boolean edgeBased)
Directory	getDirectory()
EdgeIteratorState	getEdgeIteratorState(int edgeId, int adjNode) Returns a wrapper over the specified edgeId.
int	getEdges()
EncodingManager	getEncodingManager()
NodeAccess	getNodeAccess() Creates a node explorer to access node properties.
int	getNodes()
int	getOtherNode(int edge, int node)
StorableProperties	getProperties()
TurnCostStorage	getTurnCostStorage()
boolean	isAdjacentToNode(int edge, int node)
boolean	isCHPossible()
boolean	isClosed()
boolean	isNodeRemoved(int index) Checks if the specified node is marked as removed.
boolean	loadExisting()
void	markNodeRemoved(int index) Schedule the deletion of the specified node until an optimize() call happens
void	optimize() Performs optimization routines like deletion or node rearrangements.
String	toDetailsString()
String	toString()
Weighting	wrapWeighting(Weighting weighting) Wraps the given weighting into a weighting that can be used by this graph

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphHopperStorage

public GraphHopperStorage(Directory dir,
                          EncodingManager encodingManager,
                          boolean withElevation)

GraphHopperStorage

public GraphHopperStorage(Directory dir,
                          EncodingManager encodingManager,
                          boolean withElevation,
                          boolean withTurnCosts)

GraphHopperStorage

public GraphHopperStorage(Directory dir,
                          EncodingManager encodingManager,
                          boolean withElevation,
                          boolean withTurnCosts,
                          int segmentSize)

Method Detail

addCHGraph

public GraphHopperStorage addCHGraph(CHProfile chProfile)

Adds a CHGraph for the given CHProfile. You need to call this method before calling create(long) or loadExisting().

addCHGraphs

public GraphHopperStorage addCHGraphs(List<CHProfile> chProfiles)

See Also:

addCHGraph(CHProfile)

getCHGraph

public CHGraph getCHGraph()

getCHGraph

public CHGraph getCHGraph(CHProfile chProfile)

getCHGraph

public CHGraph getCHGraph(String profileName)

Returns:

the CHGraph for the specified profile name

isCHPossible

public boolean isCHPossible()

getCHProfiles

public List<CHProfile> getCHProfiles()

getCHProfiles

public List<CHProfile> getCHProfiles(boolean edgeBased)

getDirectory

public Directory getDirectory()

Specified by:

getDirectory in interface GraphStorage

Returns:

the directory where this graph is stored.

create

public GraphHopperStorage create(long byteCount)

After configuring this storage you need to create it explicitly.

Specified by:

create in interface Storable<GraphStorage>

getEncodingManager

public EncodingManager getEncodingManager()

Specified by:

getEncodingManager in interface GraphStorage

getProperties

public StorableProperties getProperties()

Specified by:

getProperties in interface GraphStorage

markNodeRemoved

public void markNodeRemoved(int index)

Description copied from interface: GraphStorage

Schedule the deletion of the specified node until an optimize() call happens

Specified by:

markNodeRemoved in interface GraphStorage

isNodeRemoved

public boolean isNodeRemoved(int index)

Description copied from interface: GraphStorage

Checks if the specified node is marked as removed.

Specified by:

isNodeRemoved in interface GraphStorage

optimize

public void optimize()

Description copied from interface: GraphStorage

Performs optimization routines like deletion or node rearrangements.

Specified by:

optimize in interface GraphStorage

loadExisting

public boolean loadExisting()

Specified by:

loadExisting in interface Storable<GraphStorage>

Returns:

true if successfully loaded from persistent storage.

flush

public void flush()

Description copied from interface: Storable

This method makes sure that the underlying data is written to the storage. Keep in mind that a disc normally has an IO cache so that flush() is (less) probably not save against power loses.

Specified by:

flush in interface Storable<GraphStorage>

close

public void close()

Description copied from interface: Storable

This method makes sure that the underlying used resources are released. WARNING: it does NOT flush on close!

Specified by:

close in interface Storable<GraphStorage>

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

isClosed

public boolean isClosed()

Specified by:

isClosed in interface Storable<GraphStorage>

getCapacity

public long getCapacity()

Specified by:

getCapacity in interface Storable<GraphStorage>

Returns:

the allocated storage size in bytes

freeze

public void freeze()

Avoid that edges and nodes of the base graph are further modified. Necessary as hook for e.g. ch graphs on top to initialize themselves

toDetailsString

public String toDetailsString()

Specified by:

toDetailsString in interface GraphStorage

toString

public String toString()

Overrides:

toString in class Object

getBaseGraph

public Graph getBaseGraph()

Specified by:

getBaseGraph in interface Graph

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

public int getNodes()

Specified by:

getNodes in interface Graph

Returns:

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

getEdges

public int getEdges()

Specified by:

getEdges in interface Graph

Returns:

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

getNodeAccess

public NodeAccess getNodeAccess()

Description copied from interface: Graph

Creates a node explorer to access node properties.

Specified by:

getNodeAccess in interface Graph

getBounds

public BBox getBounds()

Description copied from interface: Graph

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

Specified by:

getBounds in interface Graph

edge

public EdgeIteratorState edge(int a,
                              int b)

Description copied from interface: Graph

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

Specified by:

edge in interface Graph

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

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

Description copied from interface: Graph

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

Specified by:

edge in interface Graph

getEdgeIteratorState

public EdgeIteratorState getEdgeIteratorState(int edgeId,
                                              int adjNode)

Description copied from interface: Graph

Returns a wrapper over the specified edgeId.

Specified by:

getEdgeIteratorState in interface Graph

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

Returns:

a new EdgeIteratorState object or potentially null if adjNode does not match

getAllEdges

public AllEdgesIterator getAllEdges()

Specified by:

getAllEdges in interface Graph

Returns:

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

createEdgeExplorer

public EdgeExplorer createEdgeExplorer(EdgeFilter filter)

Description copied from interface: Graph

Returns an EdgeExplorer which makes it possible to traverse all filtered edges of a specific node. Calling this method might be expensive, so e.g. create an explorer before a for loop!

Specified by:

createEdgeExplorer in interface Graph

See Also:

EdgeExplorer, Graph.createEdgeExplorer()

createEdgeExplorer

public EdgeExplorer createEdgeExplorer()

Specified by:

createEdgeExplorer in interface Graph

See Also:

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

copyTo

public Graph copyTo(Graph g)

Description copied from interface: Graph

Copy this Graph into the specified Graph g.

Specified by:

copyTo in interface Graph

Returns:

the specified Graph g

getTurnCostStorage

public TurnCostStorage getTurnCostStorage()

Specified by:

getTurnCostStorage in interface Graph

Returns:

the TurnCostStorage or null if not supported

wrapWeighting

public Weighting wrapWeighting(Weighting weighting)

Description copied from interface: Graph

Wraps the given weighting into a weighting that can be used by this graph

Specified by:

wrapWeighting in interface Graph

getOtherNode

public int getOtherNode(int edge,
                        int node)

Specified by:

getOtherNode in interface Graph

Returns:

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

isAdjacentToNode

public boolean isAdjacentToNode(int edge,
                                int node)

Specified by:

isAdjacentToNode in interface Graph

Returns:

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

flushAndCloseEarly

public void flushAndCloseEarly()

Flush and close resources like wayGeometry that are not needed for CH preparation.