org.springframework.data.neo4j.core.schema

Annotation Type Relationship

@Retention(value=RUNTIME)
 @Target(value=FIELD)
 @Documented
 @Inherited
 @API(status=STABLE,
     since="6.0")
public @interface Relationship

Annotation to configure mappings of relationship.

Since:

6.0

Author:

Michael J. Simons

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Relationship.Direction	direction If direction is Relationship.Direction.OUTGOING, than the attribute annotated with Relationship will be the target node of the relationship and the class containing the annotated attribute will be the start node.
String	type
String	value

Element Detail

value

@AliasFor(value="type")
public abstract String value

Returns:

See type().

Default:

""

type

@AliasFor(value="value")
public abstract String type

Returns:

The type of the relationship.

Default:

""

direction

public abstract Relationship.Direction direction

If direction is Relationship.Direction.OUTGOING, than the attribute annotated with Relationship will be the target node of the relationship and the class containing the annotated attribute will be the start node.

If direction is Relationship.Direction.INCOMING, than the attribute annotated with Relationship will be the start node of the relationship and the class containing the annotated attribute will be the end node.

Returns:

The direction of the relationship.

Default:

org.springframework.data.neo4j.core.schema.Relationship.Direction.OUTGOING