GremlinVisitor (grakn-graql 0.17.1 API)

java.lang.Object
- org.antlr.v4.runtime.tree.AbstractParseTreeVisitor<T>
- - ai.grakn.graql.internal.antlr.GremlinBaseVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>
  - - ai.grakn.graql.internal.parser.GremlinVisitor

All Implemented Interfaces:

GremlinVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>, org.antlr.v4.runtime.tree.ParseTreeVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>
```
public class GremlinVisitor
extends GremlinBaseVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>
```
Parser to make Gremlin queries pretty

Author:

Felix Chapman

Constructor Summary

Constructors
Constructor and Description

GremlinVisitor()

Constructors
Constructor and Description
`GremlinVisitor()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`main(String[] args)`
`static String`	`prettify(org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal<?,?> traversal)` Change the traversal to a string in a readable format
`static void`	`prettyPrint(org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal<?,?> traversal)` Print the traversal to stdout in a readable format
`java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>`	`visitCall(GremlinParser.CallContext ctx)` Visit a parse tree produced by `GremlinParser.call()`.
`java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>`	`visitIdExpr(GremlinParser.IdExprContext ctx)` Visit a parse tree produced by the `idExpr` labeled alternative in `GremlinParser.expr()`.
`java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>`	`visitIds(GremlinParser.IdsContext ctx)` Visit a parse tree produced by `GremlinParser.ids()`.
`java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>`	`visitList(GremlinParser.ListContext ctx)` Visit a parse tree produced by `GremlinParser.list()`.
`java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>`	`visitListExpr(GremlinParser.ListExprContext ctx)` Visit a parse tree produced by the `listExpr` labeled alternative in `GremlinParser.expr()`.
`java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>`	`visitMapEntry(GremlinParser.MapEntryContext ctx)` Visit a parse tree produced by `GremlinParser.mapEntry()`.
`java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>`	`visitMapExpr(GremlinParser.MapExprContext ctx)` Visit a parse tree produced by the `mapExpr` labeled alternative in `GremlinParser.expr()`.
`java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>`	`visitMethodExpr(GremlinParser.MethodExprContext ctx)` Visit a parse tree produced by the `methodExpr` labeled alternative in `GremlinParser.expr()`.
`java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>`	`visitNegExpr(GremlinParser.NegExprContext ctx)` Visit a parse tree produced by the `negExpr` labeled alternative in `GremlinParser.expr()`.
`java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>`	`visitSquigglyExpr(GremlinParser.SquigglyExprContext ctx)` Visit a parse tree produced by the `squigglyExpr` labeled alternative in `GremlinParser.expr()`.
`java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>`	`visitStep(GremlinParser.StepContext ctx)` Visit a parse tree produced by `GremlinParser.step()`.
`java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>`	`visitStepExpr(GremlinParser.StepExprContext ctx)` Visit a parse tree produced by the `stepExpr` labeled alternative in `GremlinParser.expr()`.
`java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>`	`visitTerminal(org.antlr.v4.runtime.tree.TerminalNode node)`
`java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>`	`visitTraversal(GremlinParser.TraversalContext ctx)` Visit a parse tree produced by `GremlinParser.traversal()`.

Methods inherited from class org.antlr.v4.runtime.tree.AbstractParseTreeVisitor
aggregateResult, defaultResult, shouldVisitNextChild, visit, visitChildren, visitErrorNode

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

- Constructor Detail
  - GremlinVisitor
```
public GremlinVisitor()
```
- Method Detail
  - main
```
public static void main(String[] args)
                 throws IOException
```
    Throws:
    
    IOException
  - prettyPrint
```
public static void prettyPrint(org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal<?,?> traversal)
```
    Print the traversal to stdout in a readable format
  - prettify
```
public static String prettify(org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal<?,?> traversal)
```
    Change the traversal to a string in a readable format
  - visitTraversal
```
public java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder> visitTraversal(GremlinParser.TraversalContext ctx)
```
    Description copied from class: GremlinBaseVisitor
    
    Visit a parse tree produced by GremlinParser.traversal().
    The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.
    
    Specified by:
    
    visitTraversal in interface GremlinVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>
    
    Overrides:
    
    visitTraversal in class GremlinBaseVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>
    
    Parameters:
    
    ctx - the parse tree
    
    Returns:
    
    the visitor result
  - visitList
```
public java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder> visitList(GremlinParser.ListContext ctx)
```
    Description copied from class: GremlinBaseVisitor
    
    Visit a parse tree produced by GremlinParser.list().
    The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.
    
    Specified by:
    
    visitList in interface GremlinVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>
    
    Overrides:
    
    visitList in class GremlinBaseVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>
    
    Parameters:
    
    ctx - the parse tree
    
    Returns:
    
    the visitor result
  - visitStep
```
public java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder> visitStep(GremlinParser.StepContext ctx)
```
    Description copied from class: GremlinBaseVisitor
    
    Visit a parse tree produced by GremlinParser.step().
    The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.
    
    Specified by:
    
    visitStep in interface GremlinVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>
    
    Overrides:
    
    visitStep in class GremlinBaseVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>
    
    Parameters:
    
    ctx - the parse tree
    
    Returns:
    
    the visitor result
  - visitCall
```
public java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder> visitCall(GremlinParser.CallContext ctx)
```
    Description copied from class: GremlinBaseVisitor
    
    Visit a parse tree produced by GremlinParser.call().
    The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.
    
    Specified by:
    
    visitCall in interface GremlinVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>
    
    Overrides:
    
    visitCall in class GremlinBaseVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>
    
    Parameters:
    
    ctx - the parse tree
    
    Returns:
    
    the visitor result
  - visitIdExpr
```
public java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder> visitIdExpr(GremlinParser.IdExprContext ctx)
```
    Description copied from class: GremlinBaseVisitor
    
    Visit a parse tree produced by the idExpr labeled alternative in GremlinParser.expr().
    The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.
    
    Specified by:
    
    visitIdExpr in interface GremlinVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>
    
    Overrides:
    
    visitIdExpr in class GremlinBaseVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>
    
    Parameters:
    
    ctx - the parse tree
    
    Returns:
    
    the visitor result
  - visitMethodExpr
```
public java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder> visitMethodExpr(GremlinParser.MethodExprContext ctx)
```
    Description copied from class: GremlinBaseVisitor
    
    Visit a parse tree produced by the methodExpr labeled alternative in GremlinParser.expr().
    The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.
    
    Specified by:
    
    visitMethodExpr in interface GremlinVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>
    
    Overrides:
    
    visitMethodExpr in class GremlinBaseVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>
    
    Parameters:
    
    ctx - the parse tree
    
    Returns:
    
    the visitor result
  - visitListExpr
```
public java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder> visitListExpr(GremlinParser.ListExprContext ctx)
```
    Description copied from class: GremlinBaseVisitor
    
    Visit a parse tree produced by the listExpr labeled alternative in GremlinParser.expr().
    The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.
    
    Specified by:
    
    visitListExpr in interface GremlinVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>
    
    Overrides:
    
    visitListExpr in class GremlinBaseVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>
    
    Parameters:
    
    ctx - the parse tree
    
    Returns:
    
    the visitor result
  - visitStepExpr
```
public java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder> visitStepExpr(GremlinParser.StepExprContext ctx)
```
    Description copied from class: GremlinBaseVisitor
    
    Visit a parse tree produced by the stepExpr labeled alternative in GremlinParser.expr().
    The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.
    
    Specified by:
    
    visitStepExpr in interface GremlinVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>
    
    Overrides:
    
    visitStepExpr in class GremlinBaseVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>
    
    Parameters:
    
    ctx - the parse tree
    
    Returns:
    
    the visitor result
  - visitNegExpr
```
public java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder> visitNegExpr(GremlinParser.NegExprContext ctx)
```
    Description copied from class: GremlinBaseVisitor
    
    Visit a parse tree produced by the negExpr labeled alternative in GremlinParser.expr().
    The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.
    
    Specified by:
    
    visitNegExpr in interface GremlinVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>
    
    Overrides:
    
    visitNegExpr in class GremlinBaseVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>
    
    Parameters:
    
    ctx - the parse tree
    
    Returns:
    
    the visitor result
  - visitSquigglyExpr
```
public java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder> visitSquigglyExpr(GremlinParser.SquigglyExprContext ctx)
```
    Description copied from class: GremlinBaseVisitor
    
    Visit a parse tree produced by the squigglyExpr labeled alternative in GremlinParser.expr().
    The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.
    
    Specified by:
    
    visitSquigglyExpr in interface GremlinVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>
    
    Overrides:
    
    visitSquigglyExpr in class GremlinBaseVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>
    
    Parameters:
    
    ctx - the parse tree
    
    Returns:
    
    the visitor result
  - visitMapExpr
```
public java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder> visitMapExpr(GremlinParser.MapExprContext ctx)
```
    Description copied from class: GremlinBaseVisitor
    
    Visit a parse tree produced by the mapExpr labeled alternative in GremlinParser.expr().
    The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.
    
    Specified by:
    
    visitMapExpr in interface GremlinVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>
    
    Overrides:
    
    visitMapExpr in class GremlinBaseVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>
    
    Parameters:
    
    ctx - the parse tree
    
    Returns:
    
    the visitor result
  - visitMapEntry
```
public java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder> visitMapEntry(GremlinParser.MapEntryContext ctx)
```
    Description copied from class: GremlinBaseVisitor
    
    Visit a parse tree produced by GremlinParser.mapEntry().
    The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.
    
    Specified by:
    
    visitMapEntry in interface GremlinVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>
    
    Overrides:
    
    visitMapEntry in class GremlinBaseVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>
    
    Parameters:
    
    ctx - the parse tree
    
    Returns:
    
    the visitor result
  - visitIds
```
public java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder> visitIds(GremlinParser.IdsContext ctx)
```
    Description copied from class: GremlinBaseVisitor
    
    Visit a parse tree produced by GremlinParser.ids().
    The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.
    
    Specified by:
    
    visitIds in interface GremlinVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>
    
    Overrides:
    
    visitIds in class GremlinBaseVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>
    
    Parameters:
    
    ctx - the parse tree
    
    Returns:
    
    the visitor result
  - visitTerminal
```
public java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder> visitTerminal(org.antlr.v4.runtime.tree.TerminalNode node)
```
    Specified by:
    
    visitTerminal in interface org.antlr.v4.runtime.tree.ParseTreeVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>
    
    Overrides:
    
    visitTerminal in class org.antlr.v4.runtime.tree.AbstractParseTreeVisitor<java.util.function.Consumer<ai.grakn.graql.internal.parser.GremlinVisitor.PrettyStringBuilder>>

Class GremlinVisitor

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

GremlinVisitor

Method Detail

main

prettyPrint

prettify

visitTraversal

visitList

visitStep

visitCall

visitIdExpr

visitMethodExpr

visitListExpr

visitStepExpr

visitNegExpr

visitSquigglyExpr

visitMapExpr

visitMapEntry

visitIds

visitTerminal