Package org.apache.tinkerpop.gremlin.process.traversal.util

Class TraversalUtil

java.lang.Object

org.apache.tinkerpop.gremlin.process.traversal.util.TraversalUtil

public final class TraversalUtil
extends Object

Author:

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

Method Summary

Modifier and Type	Method	Description
static <S, E> E	apply(Traverser.Admin<S> traverser, Traversal.Admin<S,E> traversal)
static <S, E> E	apply(S start, Traversal.Admin<S,E> traversal)
static <S, E> Iterator<E>	applyAll(Traverser.Admin<S> traverser, Traversal.Admin<S,E> traversal)
static <S, E> Iterator<E>	applyAll(S start, Traversal.Admin<S,E> traversal)
static <S, E> E	applyNullable(Traverser.Admin<S> traverser, Traversal.Admin<S,E> traversal)
static <S, E> E	applyNullable(S start, Traversal.Admin<S,E> traversal)
static <S, E> Traverser<S>	prepare(Traverser.Admin<S> traverser, Traversal.Admin<S,E> traversal)
static <S, E> TraversalProduct	produce(Traverser.Admin<S> traverser, Traversal.Admin<S,E> traversal)
static <S, E> TraversalProduct	produce(S start, Traversal.Admin<S,E> traversal)
static <S> Set<String>	resolveStringArguments(Traverser.Admin<S> traverser, List<Traversal.Admin<S,?>> traversals)	Resolves a list of one or more child traversals against a Traverser into a Set of String values.
static <S, E> boolean	test(Traverser.Admin<S> traverser, Traversal.Admin<S,E> traversal)
static <S, E> boolean	test(Traverser.Admin<S> traverser, Traversal.Admin<S,E> traversal, E end)
static <S, E> boolean	test(S start, Traversal.Admin<S,E> traversal)
static <S, E> boolean	test(S start, Traversal.Admin<S,E> traversal, E end)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

apply

public static <S,
E> E apply(Traverser.Admin<S> traverser,
 Traversal.Admin<S,E> traversal)

apply

public static <S,
E> E apply(S start,
 Traversal.Admin<S,E> traversal)

applyNullable

public static <S,
E> E applyNullable(S start,
 Traversal.Admin<S,E> traversal)

applyNullable

public static <S,
E> E applyNullable(Traverser.Admin<S> traverser,
 Traversal.Admin<S,E> traversal)

applyAll

public static <S,
E> Iterator<E> applyAll(Traverser.Admin<S> traverser,
 Traversal.Admin<S,E> traversal)

applyAll

public static <S,
E> Iterator<E> applyAll(S start,
 Traversal.Admin<S,E> traversal)

test

public static <S,
E> boolean test(Traverser.Admin<S> traverser,
 Traversal.Admin<S,E> traversal,
 E end)

produce

public static <S,
E> TraversalProduct produce(Traverser.Admin<S> traverser,
 Traversal.Admin<S,E> traversal)

produce

public static <S,
E> TraversalProduct produce(S start,
 Traversal.Admin<S,E> traversal)

test

public static <S,
E> boolean test(Traverser.Admin<S> traverser,
 Traversal.Admin<S,E> traversal)

test

public static <S,
E> boolean test(S start,
 Traversal.Admin<S,E> traversal,
 E end)

test

public static <S,
E> boolean test(S start,
 Traversal.Admin<S,E> traversal)

prepare

public static <S,
E> Traverser<S> prepare(Traverser.Admin<S> traverser,
 Traversal.Admin<S,E> traversal)

resolveStringArguments

public static <S> Set<String> resolveStringArguments(Traverser.Admin<S> traverser,
 List<Traversal.Admin<S,?>> traversals)

Resolves a list of one or more child traversals against a Traverser into a Set of String values. This encapsulates a resolution rule shared by steps that accept either a single dynamic argument or several: if exactly one Traversal is given and it produces a Collection, the collection is unfolded and each of its elements must be a String; otherwise (a single scalar result, or more than one Traversal) every traversal must resolve to a single String. This is useful, for example, to steps like addV(), addLabel() and dropLabel() which all support one-or-more Traversal arguments that ultimately resolve to a set of label strings.

Parameters:

traverser - the traverser to apply each traversal to

traversals - the traversals to resolve, in order; must contain at least one element

Returns:

the resolved, ordered set of strings

Throws:

IllegalArgumentException - if a traversal produces null, a non-String scalar, a Collection containing a non-String element, or if a Collection is produced while more than one traversal was supplied