Package org.neo4j.gds.api

Class GraphAdapter

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

      • 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

      • degree

        public int degree​(long nodeId)
        Specified by:
        degree in interface Degrees

      • 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
        Parameters:
        originalNodeId - must be smaller or equal to the id returned by IdMap.highestNeoId()

      • toOriginalNodeId

        public long toOriginalNodeId​(long mappedNodeId)
        Description copied from interface: IdMap
        Map mapped nodeId back to neo4j nodeId
        Specified by:
        toOriginalNodeId in interface IdMap

      • 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

      • 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 originalNodeId)
        Description copied from interface: IdMap
        Returns true iff the neo4jNodeId 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 java.util.PrimitiveIterator.OfLong nodeIterator()
        Specified by:
        nodeIterator in interface NodeIterator

      • nodeIterator

        public java.util.PrimitiveIterator.OfLong nodeIterator​(java.util.Set<org.neo4j.gds.NodeLabel> labels)
        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 mappedNodeId)
        Specified by:
        nodeLabels in interface IdMap

      • availableNodeLabels

        public java.util.Set<org.neo4j.gds.NodeLabel> availableNodeLabels()
        Specified by:
        availableNodeLabels in interface IdMap

      • hasLabel

        public boolean hasLabel​(long mappedNodeId,
                        org.neo4j.gds.NodeLabel label)
        Specified by:
        hasLabel in interface IdMap

      • withFilteredLabels

        public java.util.Optional<? extends FilteredIdMap> withFilteredLabels​(java.util.Collection<org.neo4j.gds.NodeLabel> nodeLabels,
                                                                      int concurrency)
        Specified by:
        withFilteredLabels in interface IdMap

      • 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
        Parameters:
        propertyKey - the node property key
        Returns:
        the values associated with that key

      • 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

      • relationshipTypeFilteredGraph

        public Graph relationshipTypeFilteredGraph​(java.util.Set<org.neo4j.gds.RelationshipType> relationshipTypes)
        Specified by:
        relationshipTypeFilteredGraph in interface Graph

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