Package org.neo4j.gds.api.properties.nodes

Interface NodePropertyValues

All Superinterfaces:

PropertyValues

All Known Subinterfaces:

DoubleArrayNodePropertyValues, DoubleNodePropertyValues, FloatArrayNodePropertyValues, LongArrayNodePropertyValues, LongNodePropertyValues

All Known Implementing Classes:

EmptyDoubleArrayNodePropertyValues, EmptyDoubleNodePropertyValues, EmptyFloatArrayNodePropertyValues, EmptyLongArrayNodePropertyValues, EmptyLongNodePropertyValues, FilteredNodePropertyValues, FilteredNodePropertyValues.FilteredToOriginalNodePropertyValues, FilteredNodePropertyValues.OriginalToFilteredNodePropertyValues, NullPropertyMap, NullPropertyMap.DoubleNullPropertyMap, NullPropertyMap.LongNullPropertyMap, OriginalIdNodePropertyValues

public interface NodePropertyValues
extends PropertyValues

Method Summary

Modifier and Type	Method	Description
java.util.Optional<java.lang.Integer>	dimension()	The dimension of the properties.
default @org.jetbrains.annotations.Nullable double[]	doubleArrayValue(long nodeId)
default double	doubleValue(long nodeId)
default @org.jetbrains.annotations.Nullable float[]	floatArrayValue(long nodeId)
default java.util.OptionalDouble	getMaxDoublePropertyValue()
default java.util.OptionalLong	getMaxLongPropertyValue()
@Nullable java.lang.Object	getObject(long nodeId)
default boolean	hasValue(long nodeId)
default @org.jetbrains.annotations.Nullable long[]	longArrayValue(long nodeId)
default long	longValue(long nodeId)
long	nodeCount()
org.neo4j.values.storable.Value	value(long nodeId)

Methods inherited from interface org.neo4j.gds.api.properties.PropertyValues

unsupportedTypeException, valueType

Method Detail

doubleValue

default double doubleValue(long nodeId)

longValue

default long longValue(long nodeId)

doubleArrayValue

@Nullable
default @org.jetbrains.annotations.Nullable double[] doubleArrayValue(long nodeId)

floatArrayValue

@Nullable
default @org.jetbrains.annotations.Nullable float[] floatArrayValue(long nodeId)

longArrayValue

@Nullable
default @org.jetbrains.annotations.Nullable long[] longArrayValue(long nodeId)

getObject

@Nullable
@Nullable java.lang.Object getObject(long nodeId)

value

org.neo4j.values.storable.Value value(long nodeId)

nodeCount

long nodeCount()

dimension

java.util.Optional<java.lang.Integer> dimension()

The dimension of the properties. For scalar values, this is 1. For arrays, this is the length of the array stored for the 0th node id. If that array is null, this method returns Optional.empty().

Returns:

the dimension of the properties stored, or empty if the dimension cannot easily be retrieved.

getMaxLongPropertyValue

default java.util.OptionalLong getMaxLongPropertyValue()

Returns:

the maximum long value contained in the mapping or an empty OptionalLong if the mapping is empty or the feature is not supported.

Throws:

java.lang.UnsupportedOperationException - if the type is not coercible into a long.

getMaxDoublePropertyValue

default java.util.OptionalDouble getMaxDoublePropertyValue()

Returns:

the maximum double value contained in the mapping or an empty OptionalDouble if the mapping is empty or the feature is not supported.

Throws:

java.lang.UnsupportedOperationException - if the type is not coercible into a double.

hasValue

default boolean hasValue(long nodeId)

Returns:

Returns whether the value is present. This is necessary as for primitive types, we do not have a `null` value.