GraphHopperStorage (GraphHopper Core 4.0 API)

java.lang.Object
- com.graphhopper.storage.GraphHopperStorage

All Implemented Interfaces:

Graph, Closeable, AutoCloseable
```
public final class GraphHopperStorage
extends Object
implements Graph, Closeable
```
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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GraphHopperStorage`	`addCHGraph(CHConfig chConfig)` Adds a `CHStorage` for the given `CHConfig`.
`GraphHopperStorage`	`addCHGraphs(List<CHConfig> chConfigs)`
`void`	`close()`
`GraphHopperStorage`	`create(long byteCount)` After configuring this storage you need to create it explicitly.
`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.
`void`	`flush()`
`void`	`flushAndCloseEarly()` Flush and free base graph resources like way geometries and StringIndex
`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()`
`CHConfig`	`getCHConfig()`
`CHConfig`	`getCHConfig(String chName)`
`List<CHConfig>`	`getCHConfigs()`
`List<CHConfig>`	`getCHConfigs(boolean edgeBased)`
`com.graphhopper.storage.GraphHopperStorage.CHEntry`	`getCHEntry(String chName)`
`List<String>`	`getCHGraphNames()`
`CHStorage`	`getCHStore()`
`CHStorage`	`getCHStore(String chName)`
`Directory`	`getDirectory()`
`EdgeIteratorState`	`getEdgeIteratorState(int edgeId, int adjNode)` Returns a wrapper over the specified edgeId.
`EdgeIteratorState`	`getEdgeIteratorStateForKey(int edgeKey)` Returns the edge state for the given edge key
`int`	`getEdges()`
`EncodingManager`	`getEncodingManager()`
`NodeAccess`	`getNodeAccess()` Creates an object to access node properties.
`int`	`getNodes()`
`int`	`getOtherNode(int edge, int node)`
`StorableProperties`	`getProperties()`
`RoutingCHGraph`	`getRoutingCHGraph()`
`RoutingCHGraph`	`getRoutingCHGraph(String chName)`
`TurnCostStorage`	`getTurnCostStorage()`
`boolean`	`isAdjacentToNode(int edge, int node)`
`boolean`	`isCHPossible()`
`boolean`	`isClosed()`
`boolean`	`isFrozen()`
`boolean`	`loadExisting()`
`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

Methods inherited from interface com.graphhopper.storage.Graph
createEdgeExplorer

- 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(CHConfig chConfig)
```
    Adds a CHStorage for the given CHConfig. You need to call this method before calling create(long) or loadExisting().
  - addCHGraphs
```
public GraphHopperStorage addCHGraphs(List<CHConfig> chConfigs)
```
    See Also:
    
    addCHGraph(CHConfig)
  - getCHStore
```
public CHStorage getCHStore()
```
    Returns:
    
    the (only) CHStorage, or error if there are none or multiple ones
  - getCHStore
```
public CHStorage getCHStore(String chName)
```
    Returns:
    
    the CHStorage for the specified profile name, or null if it does not exist
  - getCHConfig
```
public CHConfig getCHConfig()
```
    Returns:
    
    the (only) CHConfig, or error if there are none or multiple ones
  - getCHConfig
```
public CHConfig getCHConfig(String chName)
```
    Returns:
    
    the CHConfig for the specified profile name, or null if it does not exist
  - getRoutingCHGraph
```
public RoutingCHGraph getRoutingCHGraph()
```
    Returns:
    
    the (only) RoutingCHGraph, or error if there are none or multiple ones
  - getRoutingCHGraph
```
public RoutingCHGraph getRoutingCHGraph(String chName)
```
    Returns:
    
    the RoutingCHGraph for the specified profile name, or null if it does not exist
  - getCHEntry
```
public com.graphhopper.storage.GraphHopperStorage.CHEntry getCHEntry(String chName)
```
  - getCHGraphNames
```
public List<String> getCHGraphNames()
```
  - isCHPossible
```
public boolean isCHPossible()
```
  - getCHConfigs
```
public List<CHConfig> getCHConfigs()
```
  - getCHConfigs
```
public List<CHConfig> getCHConfigs(boolean edgeBased)
```
  - getDirectory
```
public Directory getDirectory()
```
    Returns:
    
    the directory where this graph is stored.
  - create
```
public GraphHopperStorage create(long byteCount)
```
    After configuring this storage you need to create it explicitly.
  - getEncodingManager
```
public EncodingManager getEncodingManager()
```
  - getProperties
```
public StorableProperties getProperties()
```
  - loadExisting
```
public boolean loadExisting()
```
  - flush
```
public void flush()
```
  - close
```
public void close()
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
  - isClosed
```
public boolean isClosed()
```
  - getCapacity
```
public long getCapacity()
```
  - 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
  - isFrozen
```
public boolean isFrozen()
```
  - toDetailsString
```
public String toDetailsString()
```
  - 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 an object 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
  - 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
  - getEdgeIteratorStateForKey
```
public EdgeIteratorState getEdgeIteratorStateForKey(int edgeKey)
```
    Description copied from interface: Graph
    
    Returns the edge state for the given edge key
    
    Specified by:
    
    getEdgeIteratorStateForKey in interface Graph
    
    See Also:
    
    EdgeIteratorState.getEdgeKey()
  - 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
  - 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 free base graph resources like way geometries and StringIndex

Class GraphHopperStorage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.graphhopper.storage.Graph

Constructor Detail

GraphHopperStorage

GraphHopperStorage

GraphHopperStorage

Method Detail

addCHGraph

addCHGraphs

getCHStore

getCHStore

getCHConfig

getCHConfig

getRoutingCHGraph

getRoutingCHGraph

getCHEntry

getCHGraphNames

isCHPossible

getCHConfigs

getCHConfigs

getDirectory

create

getEncodingManager

getProperties

loadExisting

flush

close

isClosed

getCapacity

freeze

isFrozen

toDetailsString

toString

getBaseGraph

getNodes

getEdges

getNodeAccess

getBounds

edge

getEdgeIteratorState

getEdgeIteratorStateForKey

getAllEdges

createEdgeExplorer

getTurnCostStorage

wrapWeighting

getOtherNode

isAdjacentToNode

flushAndCloseEarly