Package org.apache.tinkerpop.gremlin.language.grammar

Class GremlinAntlrToJava

java.lang.Object

org.antlr.v4.runtime.tree.AbstractParseTreeVisitor<T>

org.apache.tinkerpop.gremlin.language.grammar.DefaultGremlinBaseVisitor<Object>

org.apache.tinkerpop.gremlin.language.grammar.GremlinAntlrToJava

All Implemented Interfaces:

org.antlr.v4.runtime.tree.ParseTreeVisitor<Object>, GremlinVisitor<Object>

Direct Known Subclasses:

NoOpTerminalVisitor

public class GremlinAntlrToJava
extends DefaultGremlinBaseVisitor<Object>

This is the entry point for converting the Gremlin Antlr grammar into Java. It is bound to a Graph instance as that instance may spawn specific Traversal or TraversalSource types. A new instance should be created for each parse execution.

Constructor Summary

Constructors

Modifier	Constructor	Description
	GremlinAntlrToJava()	Constructs a new instance and is bound to an EmptyGraph.
protected	GremlinAntlrToJava(String traversalSourceName, Graph graph, Supplier<GraphTraversal<?,?>> createAnonymous)	Constructs a new instance that is bound to the specified Graph instance with an override to using __ for constructing anonymous Traversal instances.
protected	GremlinAntlrToJava(String traversalSourceName, Graph graph, Supplier<GraphTraversal<?,?>> createAnonymous, GraphTraversalSource g, VariableResolver variableResolver)	Constructs a new instance that is bound to the specified Graph instance with an override to using __ for constructing anonymous Traversal instances.
	GremlinAntlrToJava(GraphTraversalSource g)	Constructs a new instance that is bound to the specified GraphTraversalSource and thus spawns the Traversal from this "g" rather than from a fresh one constructed from the Graph instance.
protected	GremlinAntlrToJava(GraphTraversalSource g, Supplier<GraphTraversal<?,?>> createAnonymous)	Constructs a new instance that is bound to the specified GraphTraversalSource and thus spawns the Traversal from this "g" rather than from a fresh one constructed from the Graph instance.
	GremlinAntlrToJava(GraphTraversalSource g, VariableResolver variableResolver)	Constructs a new instance that is bound to the specified GraphTraversalSource and thus spawns the Traversal from this "g" rather than from a fresh one constructed from the Graph instance.
	GremlinAntlrToJava(Graph graph)	Constructs a new instance that is bound to the specified Graph instance.
protected	GremlinAntlrToJava(Graph graph, Supplier<GraphTraversal<?,?>> createAnonymous)	Constructs a new instance that is bound to the specified Graph instance with an override to using __ for constructing anonymous Traversal instances.
	GremlinAntlrToJava(Graph graph, VariableResolver variableResolver)	Constructs a new instance that is bound to the specified Graph instance.

Method Summary

Modifier and Type	Method	Description
protected Object	aggregateResult(Object result, Object nextResult)	Override the aggregate result behavior.
Object	visitQuery(GremlinParser.QueryContext ctx)	Visit a parse tree produced by GremlinParser.query().
Object	visitQueryList(GremlinParser.QueryListContext ctx)	Visit a parse tree produced by GremlinParser.queryList().

Methods inherited from class org.apache.tinkerpop.gremlin.language.grammar.DefaultGremlinBaseVisitor

notImplemented, visitBooleanArgument, visitBooleanLiteral, visitChainedParentOfGraphTraversal, visitChainedTraversal, visitConnectedComponentConstants, visitConnectedComponentConstants_component, visitConnectedComponentConstants_edges, visitConnectedComponentConstants_propertyName, visitConnectedComponentStringConstant, visitDateArgument, visitDateLiteral, visitEmptyQuery, visitFloatArgument, visitFloatLiteral, visitGenericLiteral, visitGenericLiteralArgument, visitGenericLiteralCollection, visitGenericLiteralExpr, visitGenericLiteralList, visitGenericLiteralListArgument, visitGenericLiteralMap, visitGenericLiteralMapArgument, visitGenericLiteralMapNullableArgument, visitGenericLiteralRange, visitGenericLiteralVarargs, visitInfLiteral, visitIntegerArgument, visitIntegerLiteral, visitIoOptionsConstants_graphml, visitIoOptionsConstants_graphson, visitIoOptionsConstants_gryo, visitIoOptionsConstants_reader, visitIoOptionsConstants_writer, visitIoOptionsKeys, visitIoOptionsStringConstant, visitIoOptionsValues, visitMapEntry, visitNanLiteral, visitNestedTraversal, visitNestedTraversalExpr, visitNestedTraversalList, visitNullLiteral, visitNumericLiteral, visitPageRankConstants, visitPageRankConstants_edges, visitPageRankConstants_propertyName, visitPageRankConstants_times, visitPageRankStringConstant, visitPeerPressureConstants, visitPeerPressureConstants_edges, visitPeerPressureConstants_propertyName, visitPeerPressureConstants_times, visitPeerPressureStringConstant, visitRootTraversal, visitShortestPathConstants, visitShortestPathConstants_distance, visitShortestPathConstants_edges, visitShortestPathConstants_includeEdges, visitShortestPathConstants_maxDistance, visitShortestPathConstants_target, visitShortestPathStringConstant, visitStringArgument, visitStringLiteral, visitStringLiteralExpr, visitStringLiteralList, visitStringLiteralVarargs, visitStringNullableArgument, visitStringNullableLiteral, visitStructureVertex, visitStructureVertexArgument, visitTerminatedTraversal, visitTransactionPart, visitTraversalBiFunction, visitTraversalBiFunctionArgument, visitTraversalCardinality, visitTraversalCardinalityArgument, visitTraversalColumn, visitTraversalColumnArgument, visitTraversalComparator, visitTraversalComparatorArgument, visitTraversalDirection, visitTraversalDirectionArgument, visitTraversalDT, visitTraversalDTArgument, visitTraversalFunction, visitTraversalFunctionArgument, visitTraversalMerge, visitTraversalMergeArgument, visitTraversalMethod, visitTraversalMethod_addE_String, visitTraversalMethod_addE_Traversal, visitTraversalMethod_addV_Empty, visitTraversalMethod_addV_String, visitTraversalMethod_addV_Traversal, visitTraversalMethod_aggregate_Scope_String, visitTraversalMethod_aggregate_String, visitTraversalMethod_all_P, visitTraversalMethod_and, visitTraversalMethod_any_P, visitTraversalMethod_as, visitTraversalMethod_asDate, visitTraversalMethod_asString_Empty, visitTraversalMethod_asString_Scope, visitTraversalMethod_barrier_Consumer, visitTraversalMethod_barrier_Empty, visitTraversalMethod_barrier_int, visitTraversalMethod_both, visitTraversalMethod_bothE, visitTraversalMethod_bothV, visitTraversalMethod_branch, visitTraversalMethod_by_Comparator, visitTraversalMethod_by_Empty, visitTraversalMethod_by_Function, visitTraversalMethod_by_Function_Comparator, visitTraversalMethod_by_Order, visitTraversalMethod_by_String, visitTraversalMethod_by_String_Comparator, visitTraversalMethod_by_T, visitTraversalMethod_by_Traversal, visitTraversalMethod_by_Traversal_Comparator, visitTraversalMethod_call_string, visitTraversalMethod_call_string_map, visitTraversalMethod_call_string_map_traversal, visitTraversalMethod_call_string_traversal, visitTraversalMethod_cap, visitTraversalMethod_choose_Function, visitTraversalMethod_choose_Predicate_Traversal, visitTraversalMethod_choose_Predicate_Traversal_Traversal, visitTraversalMethod_choose_Traversal, visitTraversalMethod_choose_Traversal_Traversal, visitTraversalMethod_choose_Traversal_Traversal_Traversal, visitTraversalMethod_coalesce, visitTraversalMethod_coin, visitTraversalMethod_combine_Object, visitTraversalMethod_concat_String, visitTraversalMethod_concat_Traversal_Traversal, visitTraversalMethod_conjoin_String, visitTraversalMethod_connectedComponent, visitTraversalMethod_constant, visitTraversalMethod_count_Empty, visitTraversalMethod_count_Scope, visitTraversalMethod_cyclicPath, visitTraversalMethod_dateAdd, visitTraversalMethod_dateDiff_Date, visitTraversalMethod_dateDiff_Traversal, visitTraversalMethod_dedup_Scope_String, visitTraversalMethod_dedup_String, visitTraversalMethod_difference_Object, visitTraversalMethod_disjunct_Object, visitTraversalMethod_drop, visitTraversalMethod_E, visitTraversalMethod_element, visitTraversalMethod_elementMap, visitTraversalMethod_emit_Empty, visitTraversalMethod_emit_Predicate, visitTraversalMethod_emit_Traversal, visitTraversalMethod_fail_Empty, visitTraversalMethod_fail_String, visitTraversalMethod_filter_Predicate, visitTraversalMethod_filter_Traversal, visitTraversalMethod_flatMap, visitTraversalMethod_fold_Empty, visitTraversalMethod_fold_Object_BiFunction, visitTraversalMethod_format_String, visitTraversalMethod_from_String, visitTraversalMethod_from_Traversal, visitTraversalMethod_from_Vertex, visitTraversalMethod_group_Empty, visitTraversalMethod_group_String, visitTraversalMethod_groupCount_Empty, visitTraversalMethod_groupCount_String, visitTraversalMethod_has_String, visitTraversalMethod_has_String_Object, visitTraversalMethod_has_String_P, visitTraversalMethod_has_String_String_Object, visitTraversalMethod_has_String_String_P, visitTraversalMethod_has_String_Traversal, visitTraversalMethod_has_T_Object, visitTraversalMethod_has_T_P, visitTraversalMethod_has_T_Traversal, visitTraversalMethod_hasId_Object_Object, visitTraversalMethod_hasId_P, visitTraversalMethod_hasKey_P, visitTraversalMethod_hasKey_String_String, visitTraversalMethod_hasLabel_P, visitTraversalMethod_hasLabel_String_String, visitTraversalMethod_hasNot, visitTraversalMethod_hasValue_Object_Object, visitTraversalMethod_hasValue_P, visitTraversalMethod_id, visitTraversalMethod_identity, visitTraversalMethod_in, visitTraversalMethod_index, visitTraversalMethod_inE, visitTraversalMethod_inject, visitTraversalMethod_intersect_Object, visitTraversalMethod_inV, visitTraversalMethod_is_Object, visitTraversalMethod_is_P, visitTraversalMethod_key, visitTraversalMethod_label, visitTraversalMethod_length_Empty, visitTraversalMethod_length_Scope, visitTraversalMethod_limit_long, visitTraversalMethod_limit_Scope_long, visitTraversalMethod_local, visitTraversalMethod_loops_Empty, visitTraversalMethod_loops_String, visitTraversalMethod_lTrim_Empty, visitTraversalMethod_lTrim_Scope, visitTraversalMethod_map, visitTraversalMethod_match, visitTraversalMethod_math, visitTraversalMethod_max_Empty, visitTraversalMethod_max_Scope, visitTraversalMethod_mean_Empty, visitTraversalMethod_mean_Scope, visitTraversalMethod_merge_Object, visitTraversalMethod_mergeE_empty, visitTraversalMethod_mergeE_Map, visitTraversalMethod_mergeE_Traversal, visitTraversalMethod_mergeV_empty, visitTraversalMethod_mergeV_Map, visitTraversalMethod_mergeV_Traversal, visitTraversalMethod_min_Empty, visitTraversalMethod_min_Scope, visitTraversalMethod_not, visitTraversalMethod_option_Merge_Map, visitTraversalMethod_option_Merge_Map_Cardinality, visitTraversalMethod_option_Merge_Traversal, visitTraversalMethod_option_Object_Traversal, visitTraversalMethod_option_Predicate_Traversal, visitTraversalMethod_option_Traversal, visitTraversalMethod_optional, visitTraversalMethod_or, visitTraversalMethod_order_Empty, visitTraversalMethod_order_Scope, visitTraversalMethod_otherV, visitTraversalMethod_out, visitTraversalMethod_outE, visitTraversalMethod_outV, visitTraversalMethod_pageRank_double, visitTraversalMethod_pageRank_Empty, visitTraversalMethod_path, visitTraversalMethod_peerPressure, visitTraversalMethod_product_Object, visitTraversalMethod_profile_Empty, visitTraversalMethod_profile_String, visitTraversalMethod_project, visitTraversalMethod_properties, visitTraversalMethod_property_Cardinality_Object, visitTraversalMethod_property_Cardinality_Object_Object_Object, visitTraversalMethod_property_Object, visitTraversalMethod_property_Object_Object_Object, visitTraversalMethod_propertyMap, visitTraversalMethod_range_long_long, visitTraversalMethod_range_Scope_long_long, visitTraversalMethod_read, visitTraversalMethod_repeat_String_Traversal, visitTraversalMethod_repeat_Traversal, visitTraversalMethod_replace_Scope_String_String, visitTraversalMethod_replace_String_String, visitTraversalMethod_reverse_Empty, visitTraversalMethod_rTrim_Empty, visitTraversalMethod_rTrim_Scope, visitTraversalMethod_sack_BiFunction, visitTraversalMethod_sack_Empty, visitTraversalMethod_sample_int, visitTraversalMethod_sample_Scope_int, visitTraversalMethod_select_Column, visitTraversalMethod_select_Pop_String, visitTraversalMethod_select_Pop_String_String_String, visitTraversalMethod_select_Pop_Traversal, visitTraversalMethod_select_String, visitTraversalMethod_select_String_String_String, visitTraversalMethod_select_Traversal, visitTraversalMethod_shortestPath, visitTraversalMethod_sideEffect, visitTraversalMethod_simplePath, visitTraversalMethod_skip_long, visitTraversalMethod_skip_Scope_long, visitTraversalMethod_split_Scope_String, visitTraversalMethod_split_String, visitTraversalMethod_store, visitTraversalMethod_subgraph, visitTraversalMethod_substring_int, visitTraversalMethod_substring_int_int, visitTraversalMethod_substring_Scope_int, visitTraversalMethod_substring_Scope_int_int, visitTraversalMethod_sum_Empty, visitTraversalMethod_sum_Scope, visitTraversalMethod_tail_Empty, visitTraversalMethod_tail_long, visitTraversalMethod_tail_Scope, visitTraversalMethod_tail_Scope_long, visitTraversalMethod_timeLimit, visitTraversalMethod_times, visitTraversalMethod_to_Direction_String, visitTraversalMethod_to_String, visitTraversalMethod_to_Traversal, visitTraversalMethod_to_Vertex, visitTraversalMethod_toE, visitTraversalMethod_toLower_Empty, visitTraversalMethod_toLower_Scope, visitTraversalMethod_toUpper_Empty, visitTraversalMethod_toUpper_Scope, visitTraversalMethod_toV, visitTraversalMethod_tree_Empty, visitTraversalMethod_tree_String, visitTraversalMethod_trim_Empty, visitTraversalMethod_trim_Scope, visitTraversalMethod_unfold, visitTraversalMethod_union, visitTraversalMethod_until_Predicate, visitTraversalMethod_until_Traversal, visitTraversalMethod_V, visitTraversalMethod_value, visitTraversalMethod_valueMap_boolean_String, visitTraversalMethod_valueMap_String, visitTraversalMethod_values, visitTraversalMethod_where_P, visitTraversalMethod_where_String_P, visitTraversalMethod_where_Traversal, visitTraversalMethod_with_String, visitTraversalMethod_with_String_Object, visitTraversalMethod_write, visitTraversalOperator, visitTraversalOrder, visitTraversalOrderArgument, visitTraversalPick, visitTraversalPop, visitTraversalPopArgument, visitTraversalPredicate, visitTraversalPredicate_between, visitTraversalPredicate_containing, visitTraversalPredicate_endingWith, visitTraversalPredicate_eq, visitTraversalPredicate_gt, visitTraversalPredicate_gte, visitTraversalPredicate_inside, visitTraversalPredicate_lt, visitTraversalPredicate_lte, visitTraversalPredicate_neq, visitTraversalPredicate_not, visitTraversalPredicate_notContaining, visitTraversalPredicate_notEndingWith, visitTraversalPredicate_notRegex, visitTraversalPredicate_notStartingWith, visitTraversalPredicate_outside, visitTraversalPredicate_regex, visitTraversalPredicate_startingWith, visitTraversalPredicate_within, visitTraversalPredicate_without, visitTraversalSackMethod, visitTraversalSackMethodArgument, visitTraversalScope, visitTraversalScopeArgument, visitTraversalSelfMethod, visitTraversalSelfMethod_none, visitTraversalSource, visitTraversalSourceSelfMethod, visitTraversalSourceSelfMethod_with, visitTraversalSourceSelfMethod_withBulk, visitTraversalSourceSelfMethod_withPath, visitTraversalSourceSelfMethod_withSack, visitTraversalSourceSelfMethod_withSideEffect, visitTraversalSourceSelfMethod_withStrategies, visitTraversalSourceSpawnMethod, visitTraversalSourceSpawnMethod_addE, visitTraversalSourceSpawnMethod_addV, visitTraversalSourceSpawnMethod_call_empty, visitTraversalSourceSpawnMethod_call_string, visitTraversalSourceSpawnMethod_call_string_map, visitTraversalSourceSpawnMethod_call_string_map_traversal, visitTraversalSourceSpawnMethod_call_string_traversal, visitTraversalSourceSpawnMethod_E, visitTraversalSourceSpawnMethod_inject, visitTraversalSourceSpawnMethod_io, visitTraversalSourceSpawnMethod_mergeE_Map, visitTraversalSourceSpawnMethod_mergeE_Traversal, visitTraversalSourceSpawnMethod_mergeV_Map, visitTraversalSourceSpawnMethod_mergeV_Traversal, visitTraversalSourceSpawnMethod_union, visitTraversalSourceSpawnMethod_V, visitTraversalStrategy, visitTraversalStrategyArgs_EdgeLabelVerificationStrategy, visitTraversalStrategyArgs_PartitionStrategy, visitTraversalStrategyArgs_ProductiveByStrategy, visitTraversalStrategyArgs_ReservedKeysVerificationStrategy, visitTraversalStrategyArgs_SubgraphStrategy, visitTraversalStrategyExpr, visitTraversalStrategyList, visitTraversalTerminalMethod, visitTraversalTerminalMethod_explain, visitTraversalTerminalMethod_hasNext, visitTraversalTerminalMethod_iterate, visitTraversalTerminalMethod_next, visitTraversalTerminalMethod_toBulkSet, visitTraversalTerminalMethod_toList, visitTraversalTerminalMethod_toSet, visitTraversalTerminalMethod_tryNext, visitTraversalToken, visitTraversalTokenArgument, visitVariable, visitWithOptionKeys, visitWithOptionsConstants_all, visitWithOptionsConstants_ids, visitWithOptionsConstants_indexer, visitWithOptionsConstants_keys, visitWithOptionsConstants_labels, visitWithOptionsConstants_list, visitWithOptionsConstants_map, visitWithOptionsConstants_none, visitWithOptionsConstants_tokens, visitWithOptionsConstants_values, visitWithOptionsStringConstant, visitWithOptionsValues

Methods inherited from class org.antlr.v4.runtime.tree.AbstractParseTreeVisitor

defaultResult, shouldVisitNextChild, visit, visitChildren, visitErrorNode, visitTerminal

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.antlr.v4.runtime.tree.ParseTreeVisitor

visit, visitChildren, visitErrorNode, visitTerminal

Constructor Detail

GremlinAntlrToJava

public GremlinAntlrToJava()

Constructs a new instance and is bound to an EmptyGraph. This form of construction is helpful for generating Bytecode or for various forms of testing. Traversal instances constructed from this form will not be capable of iterating. Assumes that "g" is the name of the GraphTraversalSource.

GremlinAntlrToJava

public GremlinAntlrToJava(Graph graph)

Constructs a new instance that is bound to the specified Graph instance. Assumes that "g" is the name of the GraphTraversalSource.

GremlinAntlrToJava

public GremlinAntlrToJava(Graph graph,
                          VariableResolver variableResolver)

Constructs a new instance that is bound to the specified Graph instance. Assumes that "g" is the name of the GraphTraversalSource.

GremlinAntlrToJava

public GremlinAntlrToJava(GraphTraversalSource g)

Constructs a new instance that is bound to the specified GraphTraversalSource and thus spawns the Traversal from this "g" rather than from a fresh one constructed from the Graph instance.

GremlinAntlrToJava

public GremlinAntlrToJava(GraphTraversalSource g,
                          VariableResolver variableResolver)

Constructs a new instance that is bound to the specified GraphTraversalSource and thus spawns the Traversal from this "g" rather than from a fresh one constructed from the Graph instance. Allows for specification of a VariableResolver to allow parameters to be resolved.

GremlinAntlrToJava

protected GremlinAntlrToJava(Graph graph,
                             Supplier<GraphTraversal<?,?>> createAnonymous)

Constructs a new instance that is bound to the specified Graph instance with an override to using __ for constructing anonymous Traversal instances. Assumes that "g" is the name of the GraphTraversalSource.

GremlinAntlrToJava

protected GremlinAntlrToJava(GraphTraversalSource g,
                             Supplier<GraphTraversal<?,?>> createAnonymous)

Constructs a new instance that is bound to the specified GraphTraversalSource and thus spawns the Traversal from this "g" rather than from a fresh one constructed from the Graph instance.

GremlinAntlrToJava

protected GremlinAntlrToJava(String traversalSourceName,
                             Graph graph,
                             Supplier<GraphTraversal<?,?>> createAnonymous)

Constructs a new instance that is bound to the specified Graph instance with an override to using __ for constructing anonymous Traversal instances.

Parameters:

traversalSourceName - The name of the traversal source which will be "g" if not specified.

GremlinAntlrToJava

protected GremlinAntlrToJava(String traversalSourceName,
                             Graph graph,
                             Supplier<GraphTraversal<?,?>> createAnonymous,
                             GraphTraversalSource g,
                             VariableResolver variableResolver)

Constructs a new instance that is bound to the specified Graph instance with an override to using __ for constructing anonymous Traversal instances. If the GraphTraversalSource is provided then the Traversal will spawn from it as opposed to a fresh one from the Graph instance. When a VariableResolver is supplied it will attempt to resolve parameters in the Gremlin to objects.

Parameters:

traversalSourceName - The name of the traversal source which will be "g" if not specified.

Method Detail

visitQuery

public Object visitQuery(GremlinParser.QueryContext ctx)

Visit a parse tree produced by GremlinParser.query().

Specified by:

visitQuery in interface GremlinVisitor<Object>

Overrides:

visitQuery in class DefaultGremlinBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitQueryList

public Object visitQueryList(GremlinParser.QueryListContext ctx)

Visit a parse tree produced by GremlinParser.queryList().

Specified by:

visitQueryList in interface GremlinVisitor<Object>

Overrides:

visitQueryList in class DefaultGremlinBaseVisitor<Object>

Parameters:

ctx - the parse tree

Returns:

the visitor result

aggregateResult

protected Object aggregateResult(Object result,
                                 Object nextResult)

Override the aggregate result behavior. If the next result is null, return the current result. This is used to handle child EOF, which is the last child of the QueryList context. If the next Result is not null, return the next result. This is used to handle multiple queries, and return only the last query result logic.

Overrides:

aggregateResult in class org.antlr.v4.runtime.tree.AbstractParseTreeVisitor<Object>