Package org.neo4j.gds.api

Interface AdjacencyProperties

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

UncompressedAdjacencyList

public interface AdjacencyProperties
extends java.lang.AutoCloseable

The properties for a mono-partite graph for a single relationship property. Provides access to the target properties for any given source node.

Method Summary

Modifier and Type	Method	Description
void	close()
default PropertyCursor	propertyCursor(long node)	Create a new cursor for the properties of the relationships of a given node.
PropertyCursor	propertyCursor(long node, double fallbackValue)	Create a new cursor for the properties of the relationships of a given node.
default PropertyCursor	propertyCursor(PropertyCursor reuse, long node)	Create a new cursor for the properties of the relationships of a given node.
default PropertyCursor	propertyCursor(PropertyCursor reuse, long node, double fallbackValue)	Create a new cursor for the properties of the relationships of a given node.
PropertyCursor	rawPropertyCursor()	Create a new uninitialized cursor.

Method Detail

propertyCursor

default PropertyCursor propertyCursor(long node)

Create a new cursor for the properties of the relationships of a given node. The cursor is expected to produce property values. Undefined behavior if the node does not exist. Undefined behavior if this list does not have properties.

propertyCursor

PropertyCursor propertyCursor(long node,
                              double fallbackValue)

Create a new cursor for the properties of the relationships of a given node. If the cursor cannot produce property values, it will yield the provided fallbackValue. NOTE: Fallback behavior is not widely available and will be part of the next episode. Undefined behavior if the node does not exist.

propertyCursor

default PropertyCursor propertyCursor(PropertyCursor reuse,
                                      long node)

Create a new cursor for the properties of the relationships of a given node. The cursor is expected to produce property values. The Implementation might try to reuse the provided reuse cursor, if possible. That is not guaranteed, however, implementation may choose to ignore the reuse cursor for any reason. Undefined behavior if the node does not exist. Undefined behavior if this list does not have properties.

propertyCursor

default PropertyCursor propertyCursor(PropertyCursor reuse,
                                      long node,
                                      double fallbackValue)

Create a new cursor for the properties of the relationships of a given node. If the cursor cannot produce property values, it will yield the provided fallbackValue. NOTE: Fallback behavior is not widely available and will be part of the next episode. The Implementation might try to reuse the provided reuse cursor, if possible. That is not guaranteed, however, implementation may choose to ignore the reuse cursor for any reason. Undefined behavior if the node does not exist.

rawPropertyCursor

PropertyCursor rawPropertyCursor()

Create a new uninitialized cursor. NOTE: In order to use the returned cursor PropertyCursor.init(long, int) must be called.

close

void close()

Specified by:

close in interface java.lang.AutoCloseable