Package org.neo4j.gds.api

Class GraphAdapter

java.lang.Object

org.neo4j.gds.api.GraphAdapter

All Implemented Interfaces:

BatchNodeIterable, Degrees, Graph, IdMap, NodeIterator, NodePropertyContainer, PartialIdMap, RelationshipIterator, RelationshipPredicate, RelationshipProperties

Direct Known Subclasses:

CSRGraphAdapter

public abstract class GraphAdapter
extends java.lang.Object
implements Graph

Nested Class Summary

Nested classes/interfaces inherited from interface org.neo4j.gds.api.BatchNodeIterable

BatchNodeIterable.IdIterable, BatchNodeIterable.IdIterator

Nested classes/interfaces inherited from interface org.neo4j.gds.api.IdMap

IdMap.NodeLabelConsumer

Field Summary

Fields

Modifier and Type	Field	Description
protected Graph	graph

Fields inherited from interface org.neo4j.gds.api.IdMap

NOT_FOUND, START_NODE_ID

Constructor Summary

Constructors

Constructor	Description
GraphAdapter(Graph graph)

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.Set<java.lang.String>	availableNodeProperties()
java.util.Collection<PrimitiveLongIterable>	batchIterables(long batchSize)
void	canRelease(boolean canRelease)
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 nodeId
void	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.
Graph	graph()
boolean	hasLabel(long nodeId, org.neo4j.gds.NodeLabel label)
boolean	hasRelationshipProperty()
long	highestNeoId()
boolean	isMultiGraph()	Whether the graph is guaranteed to have no parallel relationships.
boolean	isUndirected()
long	nodeCount()	Number of mapped nodeIds.
PrimitiveLongIterator	nodeIterator()
java.util.List<org.neo4j.gds.NodeLabel>	nodeLabels(long nodeId)
NodeProperties	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	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
Graph	relationshipTypeFilteredGraph(java.util.Set<org.neo4j.gds.RelationshipType> relationshipTypes)
void	release()	Release all resources which are not part of the result or IdMap
void	releaseProperties()	Release only the properties associated with that graph.
void	releaseTopology()	Release only the topological data associated with that graph.
IdMap	rootIdMap()	Returns the original node mapping if the current node mapping is filtered, otherwise it returns itself.
java.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 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.

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

concurrentCopy, isEmpty

Methods inherited from interface org.neo4j.gds.api.IdMap

safeToMappedNodeId, withFilteredLabels

Field Detail

graph

protected final Graph graph

Constructor Detail

GraphAdapter

public GraphAdapter(Graph graph)

Method Detail

graph

public Graph graph()

relationshipCount

public long relationshipCount()

Specified by:

relationshipCount in interface Graph

Returns:

returns the total number of relationships in the graph.

isUndirected

public boolean isUndirected()

Specified by:

isUndirected in interface Graph

hasRelationshipProperty

public boolean hasRelationshipProperty()

Specified by:

hasRelationshipProperty in interface Graph

canRelease

public void canRelease(boolean canRelease)

Specified by:

canRelease in interface Graph

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

batchIterables

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

Specified by:

batchIterables in interface BatchNodeIterable

Returns:

a collection of iterables over every node, partitioned by the given batch size.

degree

public int degree(long nodeId)

Specified by:

degree in interface Degrees

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

See Also:

Graph.isMultiGraph()

toMappedNodeId

public long toMappedNodeId(long nodeId)

Description copied from interface: PartialIdMap

Map original nodeId to inner nodeId

Specified by:

toMappedNodeId in interface PartialIdMap

Parameters:

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

toOriginalNodeId

public long toOriginalNodeId(long nodeId)

Description copied from interface: IdMap

Map inner nodeId back to original nodeId

Specified by:

toOriginalNodeId in interface IdMap

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

rootIdMap

public IdMap rootIdMap()

Description copied from interface: IdMap

Returns the original node mapping if the current node mapping is filtered, otherwise it returns itself.

Specified by:

rootIdMap in interface IdMap

contains

public boolean contains(long nodeId)

Description copied from interface: IdMap

Returns true iff the nodeId is mapped, otherwise false.

Specified by:

contains in interface IdMap

nodeCount

public long nodeCount()

Description copied from interface: IdMap

Number of mapped nodeIds.

Specified by:

nodeCount in interface IdMap

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

highestNeoId

public long highestNeoId()

Specified by:

highestNeoId in interface IdMap

forEachNode

public void forEachNode(java.util.function.LongPredicate consumer)

Description copied from interface: NodeIterator

Iterate over each nodeId

Specified by:

forEachNode in interface NodeIterator

nodeIterator

public PrimitiveLongIterator nodeIterator()

Specified by:

nodeIterator in interface NodeIterator

schema

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

Specified by:

schema in interface Graph

nodeLabels

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

Specified by:

nodeLabels in interface IdMap

forEachNodeLabel

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

Specified by:

forEachNodeLabel in interface IdMap

availableNodeLabels

public java.util.Set<org.neo4j.gds.NodeLabel> availableNodeLabels()

Specified by:

availableNodeLabels in interface IdMap

hasLabel

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

Specified by:

hasLabel in interface IdMap

nodeProperties

public NodeProperties 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

Parameters:

propertyKey - the node property key

Returns:

the values associated with that key

availableNodeProperties

public java.util.Set<java.lang.String> availableNodeProperties()

Specified by:

availableNodeProperties in interface NodePropertyContainer

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

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

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

relationshipTypeFilteredGraph

public Graph relationshipTypeFilteredGraph(java.util.Set<org.neo4j.gds.RelationshipType> relationshipTypes)

Specified by:

relationshipTypeFilteredGraph in interface Graph

exists

public boolean exists(long sourceNodeId,
                      long targetNodeId)

Specified by:

exists in interface RelationshipPredicate

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

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

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

releaseTopology

public void releaseTopology()

Description copied from interface: Graph

Release only the topological data associated with that graph.

Specified by:

releaseTopology in interface Graph

releaseProperties

public void releaseProperties()

Description copied from interface: Graph

Release only the properties associated with that graph.

Specified by:

releaseProperties in interface Graph

isMultiGraph

public boolean isMultiGraph()

Description copied from interface: Graph

Whether the graph is guaranteed to have no parallel relationships. If this returns false it still may be parallel-free, but we do not know.

Specified by:

isMultiGraph in interface Graph

Returns:

true iff the graph has maximum one relationship between each pair of nodes.