IdMapping (core 1.7.1 API)

All Known Subinterfaces:

CSRGraph, Graph, NodeMapping

All Known Implementing Classes:

BitIdMap, CSRGraphAdapter, GraphAdapter, HugeGraph, IdMap, NodeFilteredGraph, UnionGraph
```
public interface IdMapping
```
Bi-directional mapping between two id spaces.

Field Summary

Fields
Modifier and Type Field Description

static long START_NODE_ID
Defines the lower bound of mapped ids TODO: function?

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default IdMapping`	`cloneIdMapping()`
`boolean`	`contains(long nodeId)`	Returns true iff the nodeId is mapped, otherwise false.
`long`	`highestNeoId()`
`long`	`nodeCount()`	Number of mapped nodeIds.
`long`	`rootNodeCount()`	Number of mapped node ids in the root mapping.
`long`	`toMappedNodeId(long nodeId)`	Map original nodeId to inner nodeId
`long`	`toOriginalNodeId(long nodeId)`	Map inner nodeId back to original nodeId
`long`	`toRootNodeId(long nodeId)`	Maps an internal id to its root internal node id.

- Field Detail
  - START_NODE_ID
```
static final long START_NODE_ID
```
    Defines the lower bound of mapped ids TODO: function?
    
    See Also:
    
    Constant Field Values
- Method Detail
  - toMappedNodeId
```
long toMappedNodeId(long nodeId)
```
    Map original nodeId to inner nodeId
  - toOriginalNodeId
```
long toOriginalNodeId(long nodeId)
```
    Map inner nodeId back to original nodeId
  - toRootNodeId
```
long toRootNodeId(long nodeId)
```
    Maps an internal id to its root internal node id. This is necessary for nested (filtered) id mappings. If this mapping is a nested mapping, this method returns the root node id of the parent mapping. For the root mapping this method returns the given node id.
  - contains
```
boolean contains(long nodeId)
```
    Returns true iff the nodeId is mapped, otherwise false.
  - nodeCount
```
long nodeCount()
```
    Number of mapped nodeIds.
  - rootNodeCount
```
long rootNodeCount()
```
    Number of mapped node ids in the root mapping. This is necessary for nested (filtered) id mappings.
  - highestNeoId
```
long highestNeoId()
```
  - cloneIdMapping
```
default IdMapping cloneIdMapping()
```