CHGraphImpl (GraphHopper Core 0.13.0 API)

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

All Implemented Interfaces:

CHGraph, Graph, Storable<CHGraph>, Closeable, AutoCloseable
```
public class CHGraphImpl
extends Object
implements CHGraph, Storable<CHGraph>
```
A Graph implementation necessary for Contraction Hierarchies. This class enables the storage to hold the level of a node and shortcut edges per edge.

Author:

Peter Karich

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`CHGraph`	`create(long bytes)` Creates the underlying storage.
`CHEdgeExplorer`	`createEdgeExplorer()`
`CHEdgeExplorer`	`createEdgeExplorer(EdgeFilter filter)` Returns an EdgeExplorer which makes it possible to traverse all filtered edges of a specific node.
`EdgeExplorer`	`createOriginalEdgeExplorer()`
`EdgeExplorer`	`createOriginalEdgeExplorer(EdgeFilter filter)`
`void`	`debugPrint()`
`void`	`disconnect(CHEdgeExplorer explorer, EdgeIteratorState edgeState)` Disconnects the edges (higher to lower node) via the specified edgeState pointing from lower to higher node.
`CHEdgeIteratorState`	`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.
`AllCHEdgesIterator`	`getAllEdges()`
`Graph`	`getBaseGraph()`
`BBox`	`getBounds()` Returns the implicit bounds of this graph calculated from the lat,lon input of setNode
`long`	`getCapacity()`
`CHProfile`	`getCHProfile()` Returns the profile of this CH graph.
`CHEdgeIteratorState`	`getEdgeIteratorState(int edgeId, int endNode)` Returns a wrapper over the specified edgeId.
`int`	`getEdges()`
`GraphExtension`	`getExtension()`
`int`	`getLevel(int nodeIndex)`
`NodeAccess`	`getNodeAccess()` Creates a node explorer to access node properties.
`NodeOrderingProvider`	`getNodeOrderingProvider()`
`int`	`getNodes()`
`int`	`getOriginalEdges()`
`int`	`getOtherNode(int edge, int node)`
`boolean`	`isAdjacentToNode(int edge, int node)`
`boolean`	`isClosed()`
`boolean`	`isReadyForContraction()`
`boolean`	`isShortcut(int edgeId)`
`protected int`	`loadEdgesHeader()`
`boolean`	`loadExisting()`
`protected int`	`nextShortcutId()`
`protected int`	`setEdgesHeader()`
`void`	`setLevel(int nodeIndex, int level)` This methods sets the level of the specified node.
`int`	`shortcut(int a, int b, int accessFlags, double weight, int skippedEdge1, int skippedEdge2)` This method creates a shortcut between a to b which is nearly identical to creating an edge except that it can be excluded or included for certain traversals or algorithms.
`int`	`shortcutEdgeBased(int a, int b, int accessFlags, double weight, int skippedEdge1, int skippedEdge2, int origFirst, int origLast)` like shortcut(), but for edge-based CH
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - getCHProfile
```
public CHProfile getCHProfile()
```
    Description copied from interface: CHGraph
    
    Returns the profile of this CH graph. This is used to identify the CH graph.
    
    Specified by:
    
    getCHProfile in interface CHGraph
  - isShortcut
```
public boolean isShortcut(int edgeId)
```
    Specified by:
    
    isShortcut in interface CHGraph
  - setLevel
```
public final void setLevel(int nodeIndex,
                           int level)
```
    Description copied from interface: CHGraph
    
    This methods sets the level of the specified node.
    
    Specified by:
    
    setLevel in interface CHGraph
  - getLevel
```
public final int getLevel(int nodeIndex)
```
    Specified by:
    
    getLevel in interface CHGraph
    
    Returns:
    
    the level of the specified node. The higher the more important the node is. Virtual nodes have the biggest level associated.
  - shortcut
```
public int shortcut(int a,
                    int b,
                    int accessFlags,
                    double weight,
                    int skippedEdge1,
                    int skippedEdge2)
```
    Description copied from interface: CHGraph
    
    This method creates a shortcut between a to b which is nearly identical to creating an edge except that it can be excluded or included for certain traversals or algorithms.
    
    Specified by:
    
    shortcut in interface CHGraph
  - shortcutEdgeBased
```
public int shortcutEdgeBased(int a,
                             int b,
                             int accessFlags,
                             double weight,
                             int skippedEdge1,
                             int skippedEdge2,
                             int origFirst,
                             int origLast)
```
    Description copied from interface: CHGraph
    
    like shortcut(), but for edge-based CH
    
    Specified by:
    
    shortcutEdgeBased in interface CHGraph
  - nextShortcutId
```
protected int nextShortcutId()
```
  - 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
  - edge
```
public CHEdgeIteratorState 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
  - createEdgeExplorer
```
public CHEdgeExplorer createEdgeExplorer()
```
    Specified by:
    
    createEdgeExplorer in interface CHGraph
    
    Specified by:
    
    createEdgeExplorer in interface Graph
    
    See Also:
    
    Graph.createEdgeExplorer(com.graphhopper.routing.util.EdgeFilter)
  - createEdgeExplorer
```
public CHEdgeExplorer createEdgeExplorer(EdgeFilter filter)
```
    Description copied from interface: Graph
    
    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!
    
    Specified by:
    
    createEdgeExplorer in interface CHGraph
    
    Specified by:
    
    createEdgeExplorer in interface Graph
    
    See Also:
    
    EdgeExplorer, Graph.createEdgeExplorer()
  - createOriginalEdgeExplorer
```
public EdgeExplorer createOriginalEdgeExplorer()
```
    Specified by:
    
    createOriginalEdgeExplorer in interface CHGraph
  - createOriginalEdgeExplorer
```
public EdgeExplorer createOriginalEdgeExplorer(EdgeFilter filter)
```
    Specified by:
    
    createOriginalEdgeExplorer in interface CHGraph
  - getEdgeIteratorState
```
public final CHEdgeIteratorState getEdgeIteratorState(int edgeId,
                                                      int endNode)
```
    Description copied from interface: Graph
    
    Returns a wrapper over the specified edgeId.
    
    Specified by:
    
    getEdgeIteratorState in interface CHGraph
    
    Specified by:
    
    getEdgeIteratorState in interface Graph
    
    endNode - 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
  - 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();
  - getOriginalEdges
```
public int getOriginalEdges()
```
    Specified by:
    
    getOriginalEdges in interface CHGraph
    
    Returns:
    
    the number of original edges in this graph (without shortcuts)
  - 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
  - isReadyForContraction
```
public boolean isReadyForContraction()
```
    Specified by:
    
    isReadyForContraction in interface CHGraph
    
    Returns:
    
    true if contraction can be started (add shortcuts and set levels), false otherwise
  - 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
  - disconnect
```
public void disconnect(CHEdgeExplorer explorer,
                       EdgeIteratorState edgeState)
```
    Description copied from interface: CHGraph
    
    Disconnects the edges (higher to lower node) via the specified edgeState pointing from lower to higher node.
    
    Specified by:
    
    disconnect in interface CHGraph
    
    edgeState - the edge from lower to higher
  - getAllEdges
```
public AllCHEdgesIterator getAllEdges()
```
    Specified by:
    
    getAllEdges in interface CHGraph
    
    Specified by:
    
    getAllEdges in interface Graph
    
    Returns:
    
    all edges in this graph, where baseNode will be the smaller node.
  - loadEdgesHeader
```
protected int loadEdgesHeader()
```
  - setEdgesHeader
```
protected int setEdgesHeader()
```
  - getExtension
```
public GraphExtension getExtension()
```
    Specified by:
    
    getExtension in interface Graph
    
    Returns:
    
    the graph extension like a TurnCostExtension
  - 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.
  - 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
  - create
```
public CHGraph create(long bytes)
```
    Description copied from interface: Storable
    
    Creates the underlying storage. First operation if it cannot be loaded.
    
    Specified by:
    
    create in interface Storable<CHGraph>
  - loadExisting
```
public boolean loadExisting()
```
    Specified by:
    
    loadExisting in interface Storable<CHGraph>
    
    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<CHGraph>
  - 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<CHGraph>
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
  - isClosed
```
public boolean isClosed()
```
    Specified by:
    
    isClosed in interface Storable<CHGraph>
  - getCapacity
```
public long getCapacity()
```
    Specified by:
    
    getCapacity in interface Storable<CHGraph>
    
    Returns:
    
    the allocated storage size in bytes
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - debugPrint
```
public void debugPrint()
```
  - getNodeOrderingProvider
```
public NodeOrderingProvider getNodeOrderingProvider()
```
    Specified by:
    
    getNodeOrderingProvider in interface CHGraph

Class CHGraphImpl

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getCHProfile

isShortcut

setLevel

getLevel

shortcut

shortcutEdgeBased

nextShortcutId

edge

edge

createEdgeExplorer

createEdgeExplorer

createOriginalEdgeExplorer

createOriginalEdgeExplorer

getEdgeIteratorState

getNodes

getEdges

getOriginalEdges

getNodeAccess

getBounds

isReadyForContraction

getOtherNode

isAdjacentToNode

disconnect

getAllEdges

loadEdgesHeader

setEdgesHeader

getExtension

getBaseGraph

copyTo

create

loadExisting

flush

close

isClosed

getCapacity

toString

debugPrint

getNodeOrderingProvider