com.syncleus.ferma.annotations

Annotation Type Incidence

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

Incidences annotate getters and adders to represent a Vertex incident to an Edge. This annotation extends the TinkerPop built-in Incidence 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 labels of the edges that are incident to the vertex.

Optional Element Summary

Optional Elements

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

Element Detail

label

public abstract String label

The labels of the edges that are incident to the vertex.

Returns:

the edge label

Since:

2.0.0

direction

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

The direction of the edges.

Returns:

the edge direction

Since:

2.0.0

Default:

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