Package org.neo4j.gds.core.huge
Class NodeFilteredGraph
- java.lang.Object
-
- org.neo4j.gds.api.GraphAdapter
-
- org.neo4j.gds.api.CSRGraphAdapter
-
- org.neo4j.gds.core.huge.NodeFilteredGraph
-
- All Implemented Interfaces:
BatchNodeIterable
,CSRGraph
,Degrees
,Graph
,IdMap
,NodeIterator
,PartialIdMap
,NodePropertyContainer
,RelationshipIterator
,RelationshipPredicate
,RelationshipProperties
public class NodeFilteredGraph extends CSRGraphAdapter
-
-
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 class org.neo4j.gds.api.CSRGraphAdapter
csrGraph
-
Fields inherited from class org.neo4j.gds.api.GraphAdapter
graph
-
Fields inherited from interface org.neo4j.gds.api.IdMap
NOT_FOUND, START_NODE_ID
-
-
Constructor Summary
Constructors Constructor Description NodeFilteredGraph(CSRGraph originalGraph, IdMap filteredIdMap)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Optional<NodeFilteredGraph>
asNodeFilteredGraph()
If this graph is created using a node label filter, this will return a NodeFilteredGraph that represents the node set used in this graph.java.util.Set<org.neo4j.gds.NodeLabel>
availableNodeLabels()
java.util.Collection<PrimitiveLongIterable>
batchIterables(long batchSize)
CSRGraph
concurrentCopy()
boolean
contains(long nodeId)
Returns true iff the nodeId is mapped, otherwise false.int
degree(long nodeId)
int
degreeWithoutParallelRelationships(long nodeId)
Much slower than just degree() because it may have to look up all relationships.boolean
exists(long sourceNodeId, long targetNodeId)
void
forEachNode(java.util.function.LongPredicate consumer)
Iterate over each nodeIdvoid
forEachNodeLabel(long nodeId, IdMap.NodeLabelConsumer consumer)
void
forEachRelationship(long nodeId, double fallbackValue, RelationshipWithPropertyConsumer consumer)
Calls the given consumer function for every relationship of a given node.void
forEachRelationship(long nodeId, RelationshipConsumer consumer)
Calls the given consumer function for every relationship of a given node.long
getFilteredMappedNodeId(long nodeId)
boolean
hasLabel(long nodeId, org.neo4j.gds.NodeLabel label)
long
highestNeoId()
long
nodeCount()
Number of mapped nodeIds.java.util.PrimitiveIterator.OfLong
nodeIterator()
java.util.PrimitiveIterator.OfLong
nodeIterator(java.util.Set<org.neo4j.gds.NodeLabel> labels)
java.util.List<org.neo4j.gds.NodeLabel>
nodeLabels(long nodeId)
NodePropertyValues
nodeProperties(java.lang.String propertyKey)
Return the property values for a property key NOTE: Avoid using this on the hot path, favor caching the NodeProperties object when possiblelong
relationshipCount()
double
relationshipProperty(long sourceNodeId, long targetNodeId)
Returns the property value for a relationship defined by its source and target nodes.double
relationshipProperty(long sourceNodeId, long targetNodeId, double fallbackValue)
get value of property on relationship between source and target node idvoid
release()
Release all resources which are not part of the result or IdMapjava.util.OptionalLong
rootNodeCount()
Number of mapped node ids in the root mapping.org.neo4j.gds.api.schema.GraphSchema
schema()
java.util.stream.Stream<RelationshipCursor>
streamRelationships(long nodeId, double fallbackValue)
long
toMappedNodeId(long neoNodeId)
Map original nodeId to inner nodeIdlong
toOriginalNodeId(long nodeId)
Map inner nodeId back to original nodeIdlong
toRootNodeId(long nodeId)
Maps an internal id to its root internal node id.-
Methods inherited from class org.neo4j.gds.api.CSRGraphAdapter
relationshipTopologies
-
Methods inherited from class org.neo4j.gds.api.GraphAdapter
availableNodeProperties, canRelease, graph, hasRelationshipProperty, isMultiGraph, relationshipTypeFilteredGraph, releaseProperties, releaseTopology, rootIdMap
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.neo4j.gds.api.Graph
canRelease, hasRelationshipProperty, isEmpty, isMultiGraph, relationshipTypeFilteredGraph, releaseProperties, releaseTopology
-
Methods inherited from interface org.neo4j.gds.api.IdMap
rootIdMap, safeToMappedNodeId, withFilteredLabels
-
Methods inherited from interface org.neo4j.gds.api.properties.nodes.NodePropertyContainer
availableNodeProperties
-
-
-
-
Method Detail
-
schema
public org.neo4j.gds.api.schema.GraphSchema schema()
- Specified by:
schema
in interfaceGraph
- Overrides:
schema
in classGraphAdapter
-
nodeIterator
public java.util.PrimitiveIterator.OfLong nodeIterator()
- Specified by:
nodeIterator
in interfaceNodeIterator
- Overrides:
nodeIterator
in classGraphAdapter
-
nodeIterator
public java.util.PrimitiveIterator.OfLong nodeIterator(java.util.Set<org.neo4j.gds.NodeLabel> labels)
- Specified by:
nodeIterator
in interfaceNodeIterator
- Overrides:
nodeIterator
in classGraphAdapter
-
batchIterables
public java.util.Collection<PrimitiveLongIterable> batchIterables(long batchSize)
- Specified by:
batchIterables
in interfaceBatchNodeIterable
- Overrides:
batchIterables
in classGraphAdapter
- Returns:
- a collection of iterables over every node, partitioned by the given batch size.
-
forEachNode
public void forEachNode(java.util.function.LongPredicate consumer)
Description copied from interface:NodeIterator
Iterate over each nodeId- Specified by:
forEachNode
in interfaceNodeIterator
- Overrides:
forEachNode
in classGraphAdapter
-
degree
public int degree(long nodeId)
- Specified by:
degree
in interfaceDegrees
- Overrides:
degree
in classGraphAdapter
-
degreeWithoutParallelRelationships
public int degreeWithoutParallelRelationships(long nodeId)
Description copied from interface:Degrees
Much slower than just degree() because it may have to look up all relationships.
This is not thread-safe, so if this is called concurrently please useRelationshipIterator.concurrentCopy()
.- Specified by:
degreeWithoutParallelRelationships
in interfaceDegrees
- Overrides:
degreeWithoutParallelRelationships
in classGraphAdapter
- See Also:
Graph.isMultiGraph()
-
nodeCount
public long nodeCount()
Description copied from interface:IdMap
Number of mapped nodeIds.- Specified by:
nodeCount
in interfaceIdMap
- Overrides:
nodeCount
in classGraphAdapter
-
rootNodeCount
public java.util.OptionalLong rootNodeCount()
Description copied from interface:PartialIdMap
Number of mapped node ids in the root mapping. This is necessary for nested (filtered) id mappings.- Specified by:
rootNodeCount
in interfacePartialIdMap
- Overrides:
rootNodeCount
in classGraphAdapter
-
relationshipCount
public long relationshipCount()
- Specified by:
relationshipCount
in interfaceGraph
- Overrides:
relationshipCount
in classGraphAdapter
- Returns:
- returns the total number of relationships in the graph.
-
highestNeoId
public long highestNeoId()
- Specified by:
highestNeoId
in interfaceIdMap
- Overrides:
highestNeoId
in classGraphAdapter
-
toMappedNodeId
public long toMappedNodeId(long neoNodeId)
Description copied from interface:PartialIdMap
Map original nodeId to inner nodeId- Specified by:
toMappedNodeId
in interfacePartialIdMap
- Overrides:
toMappedNodeId
in classGraphAdapter
- Parameters:
neoNodeId
- must be smaller or equal to the id returned byIdMap.highestNeoId()
-
toRootNodeId
public long toRootNodeId(long nodeId)
Description copied from interface:IdMap
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.- Specified by:
toRootNodeId
in interfaceIdMap
- Overrides:
toRootNodeId
in classGraphAdapter
-
contains
public boolean contains(long nodeId)
Description copied from interface:IdMap
Returns true iff the nodeId is mapped, otherwise false.- Specified by:
contains
in interfaceIdMap
- Overrides:
contains
in classGraphAdapter
-
toOriginalNodeId
public long toOriginalNodeId(long nodeId)
Description copied from interface:IdMap
Map inner nodeId back to original nodeId- Specified by:
toOriginalNodeId
in interfaceIdMap
- Overrides:
toOriginalNodeId
in classGraphAdapter
-
forEachRelationship
public void forEachRelationship(long nodeId, RelationshipConsumer consumer)
Description copied from interface:RelationshipIterator
Calls the given consumer function for every relationship of a given node.- Specified by:
forEachRelationship
in interfaceRelationshipIterator
- Overrides:
forEachRelationship
in classGraphAdapter
- Parameters:
nodeId
- id of the node for which to iterate relationshipsconsumer
- relationship consumer function
-
forEachRelationship
public void forEachRelationship(long nodeId, double fallbackValue, RelationshipWithPropertyConsumer consumer)
Description copied from interface:RelationshipIterator
Calls the given consumer function for every relationship of a given node. If the graph was loaded with a relationship property, the property value of the relationship will be passed into the consumer. Otherwise the given fallback value will be used.- Specified by:
forEachRelationship
in interfaceRelationshipIterator
- Overrides:
forEachRelationship
in classGraphAdapter
- Parameters:
nodeId
- id of the node for which to iterate relationshipsfallbackValue
- value used as relationship property if no properties were loadedconsumer
- relationship consumer function
-
streamRelationships
public java.util.stream.Stream<RelationshipCursor> streamRelationships(long nodeId, double fallbackValue)
- Specified by:
streamRelationships
in interfaceRelationshipIterator
- Overrides:
streamRelationships
in classGraphAdapter
-
getFilteredMappedNodeId
public long getFilteredMappedNodeId(long nodeId)
-
asNodeFilteredGraph
public java.util.Optional<NodeFilteredGraph> asNodeFilteredGraph()
Description copied from interface:Graph
If this graph is created using a node label filter, this will return a NodeFilteredGraph that represents the node set used in this graph. Be aware that it is not guaranteed to contain all relationships of the graph. Otherwise, it will return an empty Optional.- Specified by:
asNodeFilteredGraph
in interfaceGraph
- Overrides:
asNodeFilteredGraph
in classGraphAdapter
-
exists
public boolean exists(long sourceNodeId, long targetNodeId)
- Specified by:
exists
in interfaceRelationshipPredicate
- Overrides:
exists
in classGraphAdapter
-
relationshipProperty
public double relationshipProperty(long sourceNodeId, long targetNodeId, double fallbackValue)
Description copied from interface:RelationshipProperties
get value of property on relationship between source and target node id- Specified by:
relationshipProperty
in interfaceRelationshipProperties
- Overrides:
relationshipProperty
in classGraphAdapter
- Parameters:
sourceNodeId
- source nodetargetNodeId
- target nodefallbackValue
- value to use if relationship has no property value- Returns:
- the property value
-
relationshipProperty
public double relationshipProperty(long sourceNodeId, long targetNodeId)
Description copied from interface:RelationshipProperties
Returns the property value for a relationship defined by its source and target nodes.- Specified by:
relationshipProperty
in interfaceRelationshipProperties
- Overrides:
relationshipProperty
in classGraphAdapter
-
concurrentCopy
public CSRGraph concurrentCopy()
- Specified by:
concurrentCopy
in interfaceCSRGraph
- Specified by:
concurrentCopy
in interfaceGraph
- Specified by:
concurrentCopy
in interfaceRelationshipIterator
- Overrides:
concurrentCopy
in classCSRGraphAdapter
- Returns:
- a copy of this iterator that reuses new cursors internally, so that iterations happen independent from other iterations.
-
availableNodeLabels
public java.util.Set<org.neo4j.gds.NodeLabel> availableNodeLabels()
- Specified by:
availableNodeLabels
in interfaceIdMap
- Overrides:
availableNodeLabels
in classGraphAdapter
-
nodeLabels
public java.util.List<org.neo4j.gds.NodeLabel> nodeLabels(long nodeId)
- Specified by:
nodeLabels
in interfaceIdMap
- Overrides:
nodeLabels
in classGraphAdapter
-
hasLabel
public boolean hasLabel(long nodeId, org.neo4j.gds.NodeLabel label)
- Specified by:
hasLabel
in interfaceIdMap
- Overrides:
hasLabel
in classGraphAdapter
-
forEachNodeLabel
public void forEachNodeLabel(long nodeId, IdMap.NodeLabelConsumer consumer)
- Specified by:
forEachNodeLabel
in interfaceIdMap
- Overrides:
forEachNodeLabel
in classGraphAdapter
-
nodeProperties
public NodePropertyValues nodeProperties(java.lang.String propertyKey)
Description copied from interface:NodePropertyContainer
Return the property values for a property key NOTE: Avoid using this on the hot path, favor caching the NodeProperties object when possible- Specified by:
nodeProperties
in interfaceNodePropertyContainer
- Overrides:
nodeProperties
in classGraphAdapter
- Parameters:
propertyKey
- the node property key- Returns:
- the values associated with that key
-
release
public void release()
Description copied from interface:Graph
Release all resources which are not part of the result or IdMap- Specified by:
release
in interfaceGraph
- Overrides:
release
in classGraphAdapter
-
-