Package org.apache.tinkerpop.gremlin.process.traversal
-
Interface Summary Interface Description Failure Path PBiPredicate<T,U> Marker interface for predefinedBiPredicatepredicates that can be used inPredicate}.Step<S,E> Translator<S,T> A Translator will translateBytecodeinto another representation.Translator.ScriptTranslator Translates bytecode to a Script representation.Translator.ScriptTranslator.TypeTranslator Provides a way for theTranslator.ScriptTranslatorto convert various data types to their string representations in their target language.Translator.StepTranslator<S extends TraversalSource,T extends Traversal.Admin<?,?>> Translates bytecode to actual steps.Traversal<S,E> Traversal.Admin<S,E> TraversalSideEffects ATraversalcan maintain global sideEffects.TraversalSource ATraversalSourceis used to createTraversalinstances.TraversalStrategies ATraversalmaintains a set ofTraversalStrategyinstances within a TraversalStrategies object.TraversalStrategy<S extends TraversalStrategy> ATraversalStrategydefines a particular atomic operation for mutating aTraversalprior to its evaluation.TraversalStrategy.DecorationStrategy Implemented by strategies that adds "application logic" to the traversal (e.g.TraversalStrategy.FinalizationStrategy Implemented by strategies that do final behaviors that require a fully compiled traversal to work (e.g.TraversalStrategy.OptimizationStrategy Implemented by strategies that rewrite the traversal to be more efficient, but with the same semantics (e.g.TraversalStrategy.ProviderOptimizationStrategy Implemented by strategies that rewrite the traversal to be more efficient, but with the same semantics.TraversalStrategy.VerificationStrategy Implemented by strategies where there is no more behavioral tweaking of the traversal required.Traverser<T> ATraverserrepresents the current state of an object flowing through aTraversal.Traverser.Admin<T> The methods in System.Traverser are useful to underlying Step and Traversal implementations.TraverserGenerator A TraverserGenerator will generate traversers for a particularTraversal. -
Class Summary Class Description AnonymousTraversalSource<T extends TraversalSource> Provides a unified way to construct aTraversalSourcefrom the perspective of the traversal.Bindings Bindings are used to associate a variable with a value.Bytecode When aTraversalSourceis manipulated and then aTraversalis spawned and mutated, a language agnostic representation of those mutations is recorded in a bytecode instance.Bytecode.Binding<V> Bytecode.Instruction IO Fields that can be provided to theGraphTraversalSource.io(String)using theGraphTraversal.with(String,Object)step modulator to provide additional configurations.P<V> PredefinedPredicatevalues that can be used to define filters tohas()andwhere().Path.Exceptions SackFunctions Script General representation of scriptText.RegexPredicate Allows for a compiled version of the regex pattern.TextP PredefinedPredicatevalues that can be used asStringfilters.Translator.ScriptTranslator.AbstractTypeTranslator Traversal.Exceptions A collection ofExceptiontypes associated with Traversal execution.Traversal.Symbols TraversalSideEffects.Exceptions TraversalSource.Symbols TraversalStrategies.GlobalCache -
Enum Summary Enum Description Compare Compareis aBiPredicatethat determines whether the first argument is==,!=,>,>=,<,<=to the second argument.Contains Containsis aBiPredicatethat evaluates whether the first object is contained within (or not within) the second collection object.GraphOp AGraphOpor "graph operation" is a staticBytecodeform that does not translate to a traversal but instead refers to a specific function to perform on a graph instance.Merge Merge options relevant to upsert-like stepsmergeV()andmergeE()that are applied to the relevantoption()modulator.Operator A set ofBinaryOperatorinstances that handle common operations for traversal steps.Order ProvidesComparatorinstances for ordering traversers.Pick A token used withoption().Pop APathmay have multiple values associated with a single label.SackFunctions.Barrier Scope ManyStepinstance can have a variable scope which alter the manner in which the step will behave in relation to how the traversers are processed.Text Textis aBiPredicatethat determines whether the first string starts with, starts not with, ends with, ends not with, contains or does not contain the second string argument. -
Exception Summary Exception Description GremlinTypeErrorException We use this exception type to signify ERROR in Ternary Boolean Logics.