Package org.neo4j.gds

Class RelationshipProjection

java.lang.Object

org.neo4j.gds.ElementProjection

org.neo4j.gds.RelationshipProjection

public abstract class RelationshipProjection
extends ElementProjection

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RelationshipProjection.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	AGGREGATION_KEY
static RelationshipProjection	ALL
static RelationshipProjection	ALL_UNDIRECTED
static java.lang.String	INDEX_INVERSE_KEY
static java.lang.String	ORIENTATION_KEY
static java.lang.String	TYPE_KEY

Fields inherited from class org.neo4j.gds.ElementProjection

PROJECT_ALL, PROPERTIES_KEY

Constructor Summary

Constructors

Constructor	Description
RelationshipProjection()

Method Summary

Modifier and Type	Method	Description
Aggregation	aggregation()
static RelationshipProjection.Builder	builder()
protected void	check()
static RelationshipProjection	fromMap(java.util.Map<java.lang.String,java.lang.Object> map, RelationshipType relationshipType)
static RelationshipProjection	fromObject(java.lang.Object object, RelationshipType relationshipType)
static RelationshipProjection	fromString(@Nullable java.lang.String type)
boolean	indexInverse()
boolean	isMultiGraph()
static RelationshipProjection	of(java.lang.String type, Aggregation aggregation)
static RelationshipProjection	of(java.lang.String type, Orientation orientation)
static RelationshipProjection	of(java.lang.String type, Orientation orientation, Aggregation aggregation)
Orientation	orientation()
boolean	projectAll()
PropertyMappings	properties()
abstract java.lang.String	type()
RelationshipProjection	withAdditionalPropertyMappings(PropertyMappings mappings)

Methods inherited from class org.neo4j.gds.ElementProjection

toObject

Methods inherited from class java.lang.Object

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

Field Detail

ALL

public static final RelationshipProjection ALL

ALL_UNDIRECTED

public static final RelationshipProjection ALL_UNDIRECTED

TYPE_KEY

public static final java.lang.String TYPE_KEY

See Also:

Constant Field Values

ORIENTATION_KEY

public static final java.lang.String ORIENTATION_KEY

See Also:

Constant Field Values

AGGREGATION_KEY

public static final java.lang.String AGGREGATION_KEY

See Also:

Constant Field Values

INDEX_INVERSE_KEY

public static final java.lang.String INDEX_INVERSE_KEY

See Also:

Constant Field Values

Constructor Detail

RelationshipProjection

public RelationshipProjection()

Method Detail

type

public abstract java.lang.String type()

orientation

@Default
public Orientation orientation()

aggregation

@Default
public Aggregation aggregation()

indexInverse

@Default
public boolean indexInverse()

properties

@Default
@Parameter(false)
public PropertyMappings properties()

Overrides:

properties in class ElementProjection

check

@Check
protected void check()

projectAll

public boolean projectAll()

Specified by:

projectAll in class ElementProjection

fromMap

public static RelationshipProjection fromMap(java.util.Map<java.lang.String,java.lang.Object> map,
                                             RelationshipType relationshipType)

fromString

public static RelationshipProjection fromString(@Nullable
                                                @Nullable java.lang.String type)

fromObject

public static RelationshipProjection fromObject(java.lang.Object object,
                                                RelationshipType relationshipType)

of

public static RelationshipProjection of(java.lang.String type,
                                        Orientation orientation)

of

public static RelationshipProjection of(java.lang.String type,
                                        Aggregation aggregation)

of

public static RelationshipProjection of(java.lang.String type,
                                        Orientation orientation,
                                        Aggregation aggregation)

isMultiGraph

public boolean isMultiGraph()

withAdditionalPropertyMappings

public RelationshipProjection withAdditionalPropertyMappings(PropertyMappings mappings)

Specified by:

withAdditionalPropertyMappings in class ElementProjection

builder

public static RelationshipProjection.Builder builder()