com.syncleus.ferma.annotations

Annotation Type Adjacency

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface Adjacency

Adjacencies annotate getters and adders to represent a Vertex adjacent to a Vertex. This annotation extends the TinkerPop built-in Adjacency annotation. It allows type arguments to be passed into the annotated method. This ensures the returned type is of the specified type in the argument. The following method signatures are valid. T add*(Class<T> type) T get*(Class<T> type) When annotating a get* class it ensures it only returns nodes of the specified type (including sub-classes). Any Nodes which are not of this type will not be returned.

Since:

2.0.0

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	label The label of the edges making the adjacency between the vertices.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
org.apache.tinkerpop.gremlin.structure.Direction	direction The edge direction of the adjacency.

Element Detail

label

public abstract String label

The label of the edges making the adjacency between the vertices.

Returns:

the edge label

Since:

2.0.0

direction

public abstract org.apache.tinkerpop.gremlin.structure.Direction direction

The edge direction of the adjacency.

Returns:

the direction of the edges composing the adjacency

Since:

2.0.0

Default:

org.apache.tinkerpop.gremlin.structure.Direction.OUT