org.apache.tinkerpop.gremlin.process.traversal

Interface Path

All Superinterfaces:

Cloneable

All Known Implementing Classes:

DetachedPath, EmptyPath, ImmutablePath, MutablePath, ReferencePath

public interface Path
extends Cloneable

A Path denotes a particular walk through a Graph as defined by a Traversal. In abstraction, any Path implementation maintains two lists: a list of sets of labels and a list of objects. The list of labels are the labels of the steps traversed. The list of objects are the objects traversed.

Author:

Marko A. Rodriguez (http://markorodriguez.com)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Path.Exceptions

Method Summary

Modifier and Type	Method and Description
void	addLabel(String label) Add label to the current head of the path.
Path	clone()
Path	extend(Object object, Set<String> labels) Add a new step to the path with an object and any number of associated labels.
default Path	extend(Object object, String... labels)
default void	forEach(BiConsumer<Object,Set<String>> consumer)
default void	forEach(Consumer<Object> consumer)
default <A> A	get(int index) Get the object associated with the specified index into the path.
default <A> A	get(Pop pop, String label) Pop the object(s) associated with the label of the path.
default <A> A	get(String label) Get the object associated with the particular label of the path.
default boolean	hasLabel(String label) Return true if the path has the specified label, else return false.
default boolean	isSimple() Determines whether the path is a simple or not.
List<Set<String>>	labels() An ordered list of the labels associated with the path The set of labels for a particular step are ordered by the order in which addLabel(java.lang.String) was called.
List<Object>	objects() An ordered list of the objects in the path.
default int	size() Get the number of step in the path.
default Stream<<any>>	stream()

Method Detail

size

default int size()

Get the number of step in the path.

Returns:

the size of the path

extend

Path extend(Object object,
            Set<String> labels)

Add a new step to the path with an object and any number of associated labels.

Parameters:

object - the new head of the path

labels - the labels at the head of the path

Returns:

the extended path

extend

default Path extend(Object object,
                    String... labels)

get

default <A> A get(String label)
           throws IllegalArgumentException

Get the object associated with the particular label of the path. If the path as multiple labels of the type, then return a List of those objects.

Type Parameters:

A - the type of the object associated with the label

Parameters:

label - the label of the path

Returns:

the object associated with the label of the path

Throws:

IllegalArgumentException - if the path does not contain the label

get

default <A> A get(Pop pop,
                  String label)
           throws IllegalArgumentException

Pop the object(s) associated with the label of the path.

Type Parameters:

A - the type of the object associated with the label

Parameters:

pop - first for least recent, last for most recent, and all for all in a list

label - the label of the path

Returns:

the object associated with the label of the path

Throws:

IllegalArgumentException - if the path does not contain the label

get

default <A> A get(int index)

Get the object associated with the specified index into the path.

Type Parameters:

A - the type of the object associated with the index

Parameters:

index - the index of the path

Returns:

the object associated with the index of the path

hasLabel

default boolean hasLabel(String label)

Return true if the path has the specified label, else return false.

Parameters:

label - the label to search for

Returns:

true if the label exists in the path

addLabel

void addLabel(String label)

Add label to the current head of the path.

Parameters:

label - the label to add to the head of the path

objects

List<Object> objects()

An ordered list of the objects in the path.

Returns:

the objects of the path

labels

List<Set<String>> labels()

An ordered list of the labels associated with the path The set of labels for a particular step are ordered by the order in which addLabel(java.lang.String) was called.

Returns:

the labels of the path

clone

Path clone()

isSimple

default boolean isSimple()

Determines whether the path is a simple or not. A simple path has no cycles and thus, no repeated objects.

Returns:

Whether the path is simple or not

forEach

default void forEach(Consumer<Object> consumer)

forEach

default void forEach(BiConsumer<Object,Set<String>> consumer)

stream

default Stream<<any>> stream()