Package org.neo4j.gds.api

Interface Graph

All Superinterfaces:

BatchNodeIterable, Degrees, IdMapping, NodeIterator, NodeMapping, NodePropertyContainer, RelationshipAccess, RelationshipIterator, RelationshipPredicate, RelationshipProperties

All Known Subinterfaces:

CSRGraph

All Known Implementing Classes:

CSRGraphAdapter, GraphAdapter, HugeGraph, NodeFilteredGraph, UnionGraph

public interface Graph
extends NodeMapping, NodePropertyContainer, Degrees, RelationshipIterator, RelationshipProperties, RelationshipAccess

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.NodeMapping

NodeMapping.NodeLabelConsumer

Field Summary

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

NOT_FOUND, START_NODE_ID

Method Summary

Modifier and Type	Method	Description
void	canRelease(boolean canRelease)
Graph	concurrentCopy()
boolean	hasRelationshipProperty()
default boolean	isEmpty()
boolean	isMultiGraph()	Whether the graph is guaranteed to have no parallel relationships.
boolean	isUndirected()
long	relationshipCount()
Graph	relationshipTypeFilteredGraph(java.util.Set<org.neo4j.gds.RelationshipType> relationshipTypes)
default void	release()	Release all resources which are not part of the result or IdMapping
default void	releaseProperties()	Release only the properties associated with that graph.
default void	releaseTopology()	Release only the topological data associated with that graph.
org.neo4j.gds.api.schema.GraphSchema	schema()

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

batchIterables

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

degree, degreeWithoutParallelRelationships

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

cloneIdMapping, contains, highestNeoId, nodeCount, rootNodeCount, safeToMappedNodeId, toMappedNodeId, toOriginalNodeId, toRootNodeId

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

forEachNode, nodeIterator

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

availableNodeLabels, forEachNodeLabel, hasLabel, nodeLabels, withFilteredLabels

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

availableNodeProperties, nodeProperties

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

getTarget

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

forEachRelationship, forEachRelationship, streamRelationships

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

exists

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

relationshipProperty, relationshipProperty

Method Detail

schema

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

isEmpty

default boolean isEmpty()

relationshipCount

long relationshipCount()

Returns:

returns the total number of relationships in the graph.

release

default void release()

Release all resources which are not part of the result or IdMapping

releaseTopology

default void releaseTopology()

Release only the topological data associated with that graph.

releaseProperties

default void releaseProperties()

Release only the properties associated with that graph.

isUndirected

boolean isUndirected()

isMultiGraph

boolean isMultiGraph()

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.

Returns:

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

relationshipTypeFilteredGraph

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

hasRelationshipProperty

boolean hasRelationshipProperty()

canRelease

void canRelease(boolean canRelease)

concurrentCopy

Graph concurrentCopy()

Specified by:

concurrentCopy in interface RelationshipIterator

Returns:

a copy of this iterator that reuses new cursors internally, so that iterations happen independent from other iterations.