Package org.neo4j.gds

Class PropertyMapping

java.lang.Object

org.neo4j.gds.PropertyMapping

public abstract class PropertyMapping
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_VALUE_KEY
static java.lang.String	PROPERTY_KEY

Constructor Summary

Constructors

Constructor	Description
PropertyMapping()

Method Summary

Modifier and Type	Method	Description
Aggregation	aggregation()
DefaultValue	defaultValue()
boolean	exists()
static PropertyMapping	fromObject(java.lang.String propertyKey, java.lang.Object stringOrMap)
boolean	hasValidName()
@Nullable java.lang.String	neoPropertyKey()	property name in the graph (a:Node {`propertyKey`:xyz})
static PropertyMapping	of(java.lang.String propertyKey)
static PropertyMapping	of(java.lang.String neoPropertyKey, java.lang.Object defaultValue)	Creates a PropertyMapping.
static PropertyMapping	of(java.lang.String propertyKey, java.lang.String neoPropertyKey, java.lang.Object defaultValue)
static PropertyMapping	of(java.lang.String propertyKey, java.lang.String neoPropertyKey, DefaultValue defaultValue, Aggregation aggregation)
static PropertyMapping	of(java.lang.String propertyKey, java.lang.String neoPropertyKey, Aggregation aggregation)
static PropertyMapping	of(java.lang.String propertyKey, DefaultValue defaultValue, Aggregation aggregation)
static PropertyMapping	of(java.lang.String propertyKey, Aggregation aggregation)
abstract @Nullable java.lang.String	propertyKey()	property key in the result map Graph.nodeProperties(`propertyKey`)
PropertyMapping	setNonDefaultAggregation(Aggregation aggregation)
java.util.Map.Entry<java.lang.String,java.lang.Object>	toObject(boolean includeAggregation)
void	validateProperties()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROPERTY_KEY

public static final java.lang.String PROPERTY_KEY

See Also:

Constant Field Values

DEFAULT_VALUE_KEY

public static final java.lang.String DEFAULT_VALUE_KEY

See Also:

Constant Field Values

Constructor Detail

PropertyMapping

public PropertyMapping()

Method Detail

propertyKey

@Nullable
public abstract @Nullable java.lang.String propertyKey()

property key in the result map Graph.nodeProperties(`propertyKey`)

neoPropertyKey

@Default
@Nullable
public @Nullable java.lang.String neoPropertyKey()

property name in the graph (a:Node {`propertyKey`:xyz})

defaultValue

@Default
public DefaultValue defaultValue()

aggregation

@Default
public Aggregation aggregation()

validateProperties

@Check
public void validateProperties()

fromObject

public static PropertyMapping fromObject(java.lang.String propertyKey,
                                         java.lang.Object stringOrMap)

hasValidName

public boolean hasValidName()

exists

public boolean exists()

toObject

public java.util.Map.Entry<java.lang.String,java.lang.Object> toObject(boolean includeAggregation)

setNonDefaultAggregation

public PropertyMapping setNonDefaultAggregation(Aggregation aggregation)

of

public static PropertyMapping of(java.lang.String propertyKey)

of

public static PropertyMapping of(java.lang.String neoPropertyKey,
                                 java.lang.Object defaultValue)

Creates a PropertyMapping. The given property key is also used for internal reference.

of

public static PropertyMapping of(java.lang.String propertyKey,
                                 java.lang.String neoPropertyKey,
                                 java.lang.Object defaultValue)

of

public static PropertyMapping of(java.lang.String propertyKey,
                                 DefaultValue defaultValue,
                                 Aggregation aggregation)

of

public static PropertyMapping of(java.lang.String propertyKey,
                                 Aggregation aggregation)

of

public static PropertyMapping of(java.lang.String propertyKey,
                                 java.lang.String neoPropertyKey,
                                 Aggregation aggregation)

of

public static PropertyMapping of(java.lang.String propertyKey,
                                 java.lang.String neoPropertyKey,
                                 DefaultValue defaultValue,
                                 Aggregation aggregation)