Package org.neo4j.graphalgo.api
Interface Graph
-
- All Superinterfaces:
BatchNodeIterable
,Degrees
,IdMapping
,NodeIterator
,NodeMapping
,NodePropertyContainer
,RelationshipAccess
,RelationshipIterator
,RelationshipPredicate
,RelationshipProperties
- All Known Implementing Classes:
FilterGraph
,HugeGraph
,NodeFilteredGraph
,UnionGraph
public interface Graph extends NodeMapping, NodePropertyContainer, Degrees, RelationshipIterator, RelationshipProperties, RelationshipAccess
-
-
Field Summary
-
Fields inherited from interface org.neo4j.graphalgo.api.IdMapping
START_NODE_ID
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default java.util.Set<NodeLabel>
availableNodeLabels()
void
canRelease(boolean canRelease)
Graph
concurrentCopy()
boolean
hasRelationshipProperty()
default RelationshipIntersect
intersection()
RelationshipIntersect
intersection(long maxDegree)
default boolean
isEmpty()
boolean
isMultiGraph()
Whether the graph is guaranteed to have no parallel relationships.boolean
isUndirected()
default java.util.Set<NodeLabel>
nodeLabels(long nodeId)
NodeMapping
nodeMapping()
long
relationshipCount()
default void
release()
Release all resources which are not part of the result or IdMappingdefault void
releaseProperties()
Release only the properties associated with that graph.default void
releaseTopology()
Release only the topological data associated with that graph.-
Methods inherited from interface org.neo4j.graphalgo.api.BatchNodeIterable
batchIterables
-
Methods inherited from interface org.neo4j.graphalgo.api.Degrees
degree, degreeWithoutParallelRelationships
-
Methods inherited from interface org.neo4j.graphalgo.api.IdMapping
contains, nodeCount, toMappedNodeId, toOriginalNodeId
-
Methods inherited from interface org.neo4j.graphalgo.api.NodeIterator
forEachNode, nodeIterator
-
Methods inherited from interface org.neo4j.graphalgo.api.NodeMapping
containsOnlyAllNodesLabel, hasLabel
-
Methods inherited from interface org.neo4j.graphalgo.api.NodePropertyContainer
availableNodeProperties, nodeProperties
-
Methods inherited from interface org.neo4j.graphalgo.api.RelationshipAccess
getTarget
-
Methods inherited from interface org.neo4j.graphalgo.api.RelationshipIterator
forEachRelationship, forEachRelationship, streamRelationships
-
Methods inherited from interface org.neo4j.graphalgo.api.RelationshipPredicate
exists
-
Methods inherited from interface org.neo4j.graphalgo.api.RelationshipProperties
relationshipProperty, relationshipProperty
-
-
-
-
Method Detail
-
nodeMapping
NodeMapping nodeMapping()
-
nodeLabels
default java.util.Set<NodeLabel> nodeLabels(long nodeId)
- Specified by:
nodeLabels
in interfaceNodeMapping
-
availableNodeLabels
default java.util.Set<NodeLabel> availableNodeLabels()
- Specified by:
availableNodeLabels
in interfaceNodeMapping
-
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 returnsfalse
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.
-
hasRelationshipProperty
boolean hasRelationshipProperty()
-
canRelease
void canRelease(boolean canRelease)
-
intersection
default RelationshipIntersect intersection()
-
intersection
RelationshipIntersect intersection(long maxDegree)
-
concurrentCopy
Graph concurrentCopy()
- Specified by:
concurrentCopy
in interfaceRelationshipIterator
- Returns:
- a copy of this iterator that reuses new cursors internally, so that iterations happen independent from other iterations.
-
-