org.springframework.data.neo4j.annotation

Annotation Type GraphTraversal

@Retention(value=RUNTIME)
@Target(value={FIELD,METHOD})
public @interface GraphTraversal

Field that provides access to an iterator which is created by applying the traversal that is built by the supplied traversal builder to the current node. The result elements are automatically converted to appropriate element entity class instances.

 @GraphTraversal(traversal=FriendTraversalBuilder.class, elementClass=Person.class)
 Iterable<Person> friends;
 

Since:

15.09.2010

Author:

Michael Hunger

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<?>	elementClass
String[]	params
Class<? extends FieldTraversalDescriptionBuilder>	traversal

Element Detail

traversal

public abstract Class<? extends FieldTraversalDescriptionBuilder> traversal

Returns:

Builder for the TraversalDescription to be applied

Default:

org.springframework.data.neo4j.core.FieldTraversalDescriptionBuilder.class

elementClass

public abstract Class<?> elementClass

Returns:

target graph entity to be iterated over.

Default:

java.lang.Object.class

params

public abstract String[] params

Returns:

parameters that are passed to the @see FieldTraversalDescriptionBuilder#build

Default:

{}