Package org.neo4j.gds.api
Interface FilteredIdMap
-
- All Superinterfaces:
BatchNodeIterable
,IdMap
,NodeIterator
,PartialIdMap
- All Known Implementing Classes:
FilteredLabeledIdMap
,NodeFilteredGraph
public interface FilteredIdMap extends IdMap
Extends the IdMap to support an additional filtered id mapping layer. The mapping layers are called the following: originalNodeId -- mappedNodeId (rootNodeId) -- filteredNodeId The first mapping layer (mappedNodeId) is also referred to as rootNodeId. Note that functions likeIdMap.toOriginalNodeId(long)
orPartialIdMap.toMappedNodeId(long)
will return the outermost or innermost mapped values respectively.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.neo4j.gds.api.BatchNodeIterable
BatchNodeIterable.BitSetIdIterator, BatchNodeIterable.IdIterable, BatchNodeIterable.IdIterator
-
Nested classes/interfaces inherited from interface org.neo4j.gds.api.IdMap
IdMap.NodeLabelConsumer
-
-
Field Summary
-
Fields inherited from interface org.neo4j.gds.api.IdMap
NO_TYPE, NOT_FOUND, START_NODE_ID
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
containsRootNodeId(long rootNodeId)
Checks if the rootNodeId (mappedNodeId) is present in the IdMaps mapping information.long
toFilteredNodeId(long rootNodeId)
Maps a root mapped node id to a filtered mapped node id.-
Methods inherited from interface org.neo4j.gds.api.BatchNodeIterable
batchIterables
-
Methods inherited from interface org.neo4j.gds.api.IdMap
addNodeIdToLabel, addNodeLabel, availableNodeLabels, containsOriginalId, forEachNodeLabel, hasLabel, highestOriginalId, nodeCount, nodeCount, nodeLabels, rootIdMap, safeToMappedNodeId, toOriginalNodeId, toRootNodeId, typeId, withFilteredLabels
-
Methods inherited from interface org.neo4j.gds.api.NodeIterator
forEachNode, nodeIterator, nodeIterator
-
Methods inherited from interface org.neo4j.gds.api.PartialIdMap
rootNodeCount, toMappedNodeId
-
-
-
-
Method Detail
-
toFilteredNodeId
long toFilteredNodeId(long rootNodeId)
Maps a root mapped node id to a filtered mapped node id. This is necessary for nested (filtered) id mappings. If this mapping is a nested mapping, this method returns the mapped id corresponding to the mapped id of the parent mapping. For the root mapping this method returns the given node id.
-
containsRootNodeId
boolean containsRootNodeId(long rootNodeId)
Checks if the rootNodeId (mappedNodeId) is present in the IdMaps mapping information.
-
-