Package org.apache.tinkerpop.gremlin.process.traversal.dsl.graph

Interface GraphTraversal.Admin<S,E>

All Superinterfaces:

AutoCloseable, Cloneable, GraphTraversal<S,E>, Iterator<E>, Serializable, Traversal<S,E>, Traversal.Admin<S,E>

All Known Subinterfaces:

CredentialTraversal<S,E>, CredentialTraversalDsl<S,E>

All Known Implementing Classes:

DefaultCredentialTraversal, DefaultGraphTraversal

Enclosing interface:

GraphTraversal<S,E>

public static interface GraphTraversal.Admin<S,E>
extends Traversal.Admin<S,E>, GraphTraversal<S,E>

Exposes administrative methods that are either internal to TinkerPop or for users with advanced needs. This separation helps keep the Gremlin API more concise. Any GraphTraversal can get an instance of its administrative form by way of GraphTraversal.asAdmin().

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal

GraphTraversal.Admin<S,E>, GraphTraversal.Symbols

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.process.traversal.Traversal

Traversal.Admin<S,E>, Traversal.Exceptions, Traversal.Symbols

Method Summary

Modifier and Type	Method	Description
default <E2> GraphTraversal.Admin<S,E2>	addStep(Step<?,E2> step)	Add a Step to the end of the traversal.
GraphTraversal.Admin<S,E>	clone()	Cloning is used to duplicate the traversal typically in OLAP environments.
default GraphTraversal<S,E>	iterate()	Iterate all the Traverser instances in the traversal.

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal

addE, addE, addE, addLabel, addLabel, addV, addV, addV, addV, aggregate, all, and, any, as, asAdmin, asBool, asDate, asNumber, asNumber, asString, asString, barrier, barrier, barrier, both, both, both, bothE, bothE, bothE, bothV, branch, branch, by, by, by, by, by, by, by, by, by, by, call, call, call, call, call, call, cap, choose, choose, choose, choose, choose, choose, choose, choose, choose, coalesce, coin, coin, combine, concat, concat, conjoin, connectedComponent, constant, constant, count, count, cyclicPath, dateAdd, dateDiff, dateDiff, dateDiff, dedup, dedup, difference, discard, disjunct, drop, dropLabel, dropLabel, dropLabels, E, E, element, elementMap, emit, emit, emit, fail, fail, filter, filter, flatMap, flatMap, fold, fold, format, from, from, from, from, group, group, groupCount, groupCount, has, has, has, has, has, has, has, has, has, has, has, has, hasId, hasId, hasKey, hasKey, hasKey, hasLabel, hasLabel, hasLabel, hasLabel, hasNot, hasValue, hasValue, hasValue, id, identity, in, in, in, index, inE, inE, inE, inject, intersect, inV, is, is, key, label, labels, length, length, limit, limit, limit, limit, local, loops, loops, lTrim, lTrim, map, map, match, match, match, math, max, max, mean, mean, merge, mergeE, mergeE, mergeE, mergeE, mergeV, mergeV, mergeV, mergeV, min, min, none, not, option, option, option, option, option, optional, or, order, order, otherV, out, out, out, outE, outE, outE, outV, pageRank, pageRank, path, peerPressure, product, profile, profile, program, project, properties, property, property, property, property, propertyMap, range, range, range, range, read, repeat, repeat, replace, replace, reverse, rTrim, rTrim, sack, sack, sample, sample, select, select, select, select, select, select, select, shortestPath, sideEffect, sideEffect, simplePath, skip, skip, skip, skip, split, split, subgraph, substring, substring, substring, substring, sum, sum, tail, tail, tail, tail, tail, tail, timeLimit, times, to, to, to, to, to, to, to, toE, toE, toE, toLower, toLower, toUpper, toUpper, toV, tree, tree, trim, trim, unfold, union, until, until, V, V, value, valueMap, valueMap, values, where, where, where, with, with, write

Methods inherited from interface java.util.Iterator

hasNext, next, remove

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.Traversal

close, explain, fill, forEachRemaining, forEachRemaining, next, notifyClose, promise, toBulkSet, toList, toSet, toStream, tryNext

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.Traversal.Admin

addStart, addStarts, addStep, applyStrategies, equals, getEndStep, getGraph, getGremlinLang, getGValueManager, getParent, getSideEffects, getStartStep, getSteps, getStrategies, getTraversalSource, getTraverserGenerator, getTraverserRequirements, getTraverserSetSupplier, isLocked, isRoot, lock, nextTraverser, removeStep, removeStep, reset, setGraph, setGValueManager, setParent, setSideEffects, setStrategies

Method Details

addStep

default <E2> GraphTraversal.Admin<S,E2> addStep(Step<?,E2> step)

Description copied from interface: Traversal.Admin

Add a Step to the end of the traversal. This method should link the step to its next and previous step accordingly.

Specified by:

addStep in interface Traversal.Admin<S,E>

Type Parameters:

E2 - the output of the step

Parameters:

step - the step to add

Returns:

the updated traversal

iterate

default GraphTraversal<S,E> iterate()

Description copied from interface: Traversal

Iterate all the Traverser instances in the traversal. What is returned is the empty traversal. It is assumed that what is desired from the computation is are the sideEffects yielded by the traversal.

Specified by:

iterate in interface GraphTraversal<S,E>

Specified by:

iterate in interface Traversal<S,E>

Returns:

the fully drained traversal

clone

GraphTraversal.Admin<S,E> clone()

Description copied from interface: Traversal.Admin

Cloning is used to duplicate the traversal typically in OLAP environments.

Specified by:

clone in interface Traversal.Admin<S,E>

Returns:

The cloned traversal