Package org.neo4j.ogm.annotation

Annotation Interface Relationship

@Retention(RUNTIME)
@Target(FIELD)
@Inherited
public @interface Relationship

Identifies field that is to be represented as a relationship

Author:

Vince Bickers, Frantisek Hartman, Gerrit Meier, Michael J. Simons

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Relationship.Direction	Enumeration of the direction a relationship can take.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
Relationship.Direction	direction	Direction of the relationship.
String	type	Type of the relationship, defaults to name of the field in SNAKE_CASE
String	value

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DIRECTION
static final Relationship.Direction	INCOMING
static final Relationship.Direction	OUTGOING
static final String	TYPE
static final Relationship.Direction	UNDIRECTED

Field Details

TYPE

static final String TYPE

See Also:

• Constant Field Values

DIRECTION

static final String DIRECTION

See Also:

• Constant Field Values

INCOMING

static final Relationship.Direction INCOMING

OUTGOING

static final Relationship.Direction OUTGOING

UNDIRECTED

static final Relationship.Direction UNDIRECTED

Element Details

value

String value

Default:

""

type

String type

Type of the relationship, defaults to name of the field in SNAKE_CASE

Default:

""

direction

Relationship.Direction direction

Direction of the relationship. Defaults to OUTGOING. Possible values are Relationship.Direction.OUTGOING, Relationship.Direction.INCOMING and Relationship.Direction.UNDIRECTED.

Default:

OUTGOING