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, FilteredIdMap, Graph, IdMap, NodeIterator, PartialIdMap, NodePropertyContainer, RelationshipIterator, RelationshipPredicate, RelationshipProperties

public class NodeFilteredGraph
extends CSRGraphAdapter
implements FilteredIdMap

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, FilteredIdMap filteredIdMap)

Method Summary

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 originalNodeId)	Returns true iff the neo4jNodeId is mapped, otherwise false.
boolean	containsRootNodeId(long rootNodeId)	Checks if the rootNodeId (mappedNodeId) is present in the IdMaps mapping information.
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 nodeId
void	forEachNodeLabel(long mappedNodeId, 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 mappedNodeId, 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 mappedNodeId)
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 possible
long	nthTarget(long nodeId, int offset)	Get the n-th target node id for a given sourceNodeId.
long	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 id
void	release()	Release all resources which are not part of the result or IdMap
java.util.OptionalLong	rootNodeCount()	Number of mapped node ids in the root mapping.
long	rootToMappedNodeId(long rootNodeId)	Maps a root mapped node id to a filtered mapped node id.
org.neo4j.gds.api.schema.GraphSchema	schema()
java.util.stream.Stream<RelationshipCursor>	streamRelationships(long nodeId, double fallbackValue)
long	toMappedNodeId(long originalNodeId)	Maps an original node id to a mapped node id.
long	toOriginalNodeId(long mappedNodeId)	Map mapped nodeId back to neo4j nodeId
long	toRootNodeId(long mappedNodeId)	Maps a filtered mapped node id to its root mapped node id.
java.util.Optional<? extends FilteredIdMap>	withFilteredLabels(java.util.Collection<org.neo4j.gds.NodeLabel> nodeLabels, int concurrency)

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

Methods inherited from interface org.neo4j.gds.api.properties.nodes.NodePropertyContainer

availableNodeProperties

Constructor Detail

NodeFilteredGraph

public NodeFilteredGraph(CSRGraph originalGraph,
                         FilteredIdMap filteredIdMap)

Method Detail

schema

public org.neo4j.gds.api.schema.GraphSchema schema()

Specified by:

schema in interface Graph

Overrides:

schema in class GraphAdapter

nodeIterator

public java.util.PrimitiveIterator.OfLong nodeIterator()

Specified by:

nodeIterator in interface NodeIterator

Overrides:

nodeIterator in class GraphAdapter

nodeIterator

public java.util.PrimitiveIterator.OfLong nodeIterator(java.util.Set<org.neo4j.gds.NodeLabel> labels)

Specified by:

nodeIterator in interface NodeIterator

Overrides:

nodeIterator in class GraphAdapter

batchIterables

public java.util.Collection<PrimitiveLongIterable> batchIterables(long batchSize)

Specified by:

batchIterables in interface BatchNodeIterable

Overrides:

batchIterables in class GraphAdapter

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 interface NodeIterator

Overrides:

forEachNode in class GraphAdapter

degree

public int degree(long nodeId)

Specified by:

degree in interface Degrees

Overrides:

degree in class GraphAdapter

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 use RelationshipIterator.concurrentCopy().

Specified by:

degreeWithoutParallelRelationships in interface Degrees

Overrides:

degreeWithoutParallelRelationships in class GraphAdapter

See Also:

Graph.isMultiGraph()

nodeCount

public long nodeCount()

Description copied from interface: IdMap

Number of mapped nodeIds.

Specified by:

nodeCount in interface IdMap

Overrides:

nodeCount in class GraphAdapter

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 interface PartialIdMap

Overrides:

rootNodeCount in class GraphAdapter

containsRootNodeId

public boolean containsRootNodeId(long rootNodeId)

Description copied from interface: FilteredIdMap

Checks if the rootNodeId (mappedNodeId) is present in the IdMaps mapping information.

Specified by:

containsRootNodeId in interface FilteredIdMap

relationshipCount

public long relationshipCount()

Specified by:

relationshipCount in interface Graph

Overrides:

relationshipCount in class GraphAdapter

Returns:

returns the total number of relationships in the graph.

highestNeoId

public long highestNeoId()

Specified by:

highestNeoId in interface IdMap

Overrides:

highestNeoId in class GraphAdapter

toMappedNodeId

public long toMappedNodeId(long originalNodeId)

Description copied from interface: PartialIdMap

Maps an original node id to a mapped node id. In case of nested id maps, the mapped node id is always in the space of the innermost mapping.

Specified by:

toMappedNodeId in interface PartialIdMap

Overrides:

toMappedNodeId in class GraphAdapter

Parameters:

originalNodeId - must be smaller or equal to the id returned by IdMap.highestNeoId()

toRootNodeId

public long toRootNodeId(long mappedNodeId)

Description copied from interface: IdMap

Maps a filtered mapped node id to its root mapped node id. This is necessary for nested (filtered) id mappings. If this mapping is a nested mapping, this method returns the root mapped node id of the parent mapping. For the root mapping this method returns the given node id.

Specified by:

toRootNodeId in interface IdMap

Overrides:

toRootNodeId in class GraphAdapter

rootToMappedNodeId

public long rootToMappedNodeId(long rootNodeId)

Description copied from interface: FilteredIdMap

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.

Specified by:

rootToMappedNodeId in interface FilteredIdMap

contains

public boolean contains(long originalNodeId)

Description copied from interface: IdMap

Returns true iff the neo4jNodeId is mapped, otherwise false.

Specified by:

contains in interface IdMap

Overrides:

contains in class GraphAdapter

toOriginalNodeId

public long toOriginalNodeId(long mappedNodeId)

Description copied from interface: IdMap

Map mapped nodeId back to neo4j nodeId

Specified by:

toOriginalNodeId in interface IdMap

Overrides:

toOriginalNodeId in class GraphAdapter

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 interface RelationshipIterator

Overrides:

forEachRelationship in class GraphAdapter

Parameters:

nodeId - id of the node for which to iterate relationships

consumer - 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 interface RelationshipIterator

Overrides:

forEachRelationship in class GraphAdapter

Parameters:

nodeId - id of the node for which to iterate relationships

fallbackValue - value used as relationship property if no properties were loaded

consumer - relationship consumer function

streamRelationships

public java.util.stream.Stream<RelationshipCursor> streamRelationships(long nodeId,
                                                                       double fallbackValue)

Specified by:

streamRelationships in interface RelationshipIterator

Overrides:

streamRelationships in class GraphAdapter

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 interface Graph

Overrides:

asNodeFilteredGraph in class GraphAdapter

exists

public boolean exists(long sourceNodeId,
                      long targetNodeId)

Specified by:

exists in interface RelationshipPredicate

Overrides:

exists in class GraphAdapter

nthTarget

public long nthTarget(long nodeId,
                      int offset)

Description copied from interface: Graph

Get the n-th target node id for a given sourceNodeId. The order of the targets is not defined and depends on the implementation of the graph, but it is consistent across separate calls to this method on the same graph. The sourceNodeId must be a node id existing in the graph. The offset parameter is 0-indexed and must be positive. If offset is greater than the number of targets for sourceNodeId, -1 is returned. It is undefined behavior if the sourceNodeId does not exist in the graph or the offset is negative.

Specified by:

nthTarget in interface Graph

Overrides:

nthTarget in class GraphAdapter

offset - the n-th target to return. Must be positive.

Returns:

the target at the offset or -1 if there is no such target.

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 interface RelationshipProperties

Overrides:

relationshipProperty in class GraphAdapter

Parameters:

sourceNodeId - source node

targetNodeId - target node

fallbackValue - 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 interface RelationshipProperties

Overrides:

relationshipProperty in class GraphAdapter

concurrentCopy

public CSRGraph concurrentCopy()

Specified by:

concurrentCopy in interface CSRGraph

Specified by:

concurrentCopy in interface Graph

Specified by:

concurrentCopy in interface RelationshipIterator

Overrides:

concurrentCopy in class CSRGraphAdapter

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 interface IdMap

Overrides:

availableNodeLabels in class GraphAdapter

nodeLabels

public java.util.List<org.neo4j.gds.NodeLabel> nodeLabels(long mappedNodeId)

Specified by:

nodeLabels in interface IdMap

Overrides:

nodeLabels in class GraphAdapter

hasLabel

public boolean hasLabel(long mappedNodeId,
                        org.neo4j.gds.NodeLabel label)

Specified by:

hasLabel in interface IdMap

Overrides:

hasLabel in class GraphAdapter

forEachNodeLabel

public void forEachNodeLabel(long mappedNodeId,
                             IdMap.NodeLabelConsumer consumer)

Specified by:

forEachNodeLabel in interface IdMap

Overrides:

forEachNodeLabel in class GraphAdapter

withFilteredLabels

public java.util.Optional<? extends FilteredIdMap> withFilteredLabels(java.util.Collection<org.neo4j.gds.NodeLabel> nodeLabels,
                                                                      int concurrency)

Specified by:

withFilteredLabels in interface IdMap

Overrides:

withFilteredLabels in class GraphAdapter

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 interface NodePropertyContainer

Overrides:

nodeProperties in class GraphAdapter

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 interface Graph

Overrides:

release in class GraphAdapter