Implement P.typeOf() predicate, added new GType enum, with a small set of tests.

Author: xiazcy

CHANGELOG.asciidoc

@@ -101,6 +101,8 @@ This release also includes changes from <<release-3-7-XXX, 3.7.XXX>>.
 * Added optional traversal cache to `GremlinLangScriptEngine`
 * Introduced step interfaces for all parameterizable steps
 * Removed auto-unfold of singleton collections from `range()`, `limit()`, and `tail()` local scope steps to improve consistency of output.
+* Implemented `P.typeOf()` predicate
+* Added `GType` enum to denote types
 * Renamed `MergeElementStep` to `MergeElementStep` as it is a base class to `mergeV()` and `mergeE()`.
 * Renamed `MergeStep` of `merge()` to `MergeElementStep` for consistency.
 

gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/language/grammar/DefaultGremlinBaseVisitor.java

@@ -1087,6 +1087,10 @@ protected void notImplemented(final ParseTree ctx) {
 	 * {@inheritDoc}
 	 */
 	@Override public T visitTraversalMethod_asNumber_traversalN(final GremlinParser.TraversalMethod_asNumber_traversalNContext ctx) { notImplemented(ctx); return null; }
+	/**
+	 * {@inheritDoc}
+	 */
+	@Override public T visitTraversalMethod_asNumber_traversalGType(final GremlinParser.TraversalMethod_asNumber_traversalGTypeContext ctx) { notImplemented(ctx); return null; }
 	/**
 	 * {@inheritDoc}
 	 */
@@ -1131,6 +1135,10 @@ protected void notImplemented(final ParseTree ctx) {
 	 * {@inheritDoc}
 	 */
 	@Override public T visitTraversalN(GremlinParser.TraversalNContext ctx) { notImplemented(ctx); return null; }
+	/**
+	 * {@inheritDoc}
+	 */
+	@Override public T visitTraversalGType(GremlinParser.TraversalGTypeContext ctx) { notImplemented(ctx); return null; }
 	/**
 	 * {@inheritDoc}
 	 */
@@ -1163,6 +1171,10 @@ protected void notImplemented(final ParseTree ctx) {
 	 * {@inheritDoc}
 	 */
 	@Override public T visitTraversalPredicate_neq(final GremlinParser.TraversalPredicate_neqContext ctx) { notImplemented(ctx); return null; }
+	/**
+	 * {@inheritDoc}
+	 */
+	@Override public T visitTraversalPredicate_typeOf(final GremlinParser.TraversalPredicate_typeOfContext ctx) { notImplemented(ctx); return null; }
 	/**
 	 * {@inheritDoc}
 	 */

gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/language/grammar/GenericLiteralVisitor.java

@@ -606,6 +606,11 @@ public Object visitTraversalN(final GremlinParser.TraversalNContext ctx) {
         return TraversalEnumParser.parseTraversalNFromContext(ctx);
     }
 
+    @Override
+    public Object visitTraversalGType(final GremlinParser.TraversalGTypeContext ctx) {
+        return TraversalEnumParser.parseTraversalGTypeFromContext(ctx);
+    }
+
     @Override
     public Object visitTraversalStrategy(final GremlinParser.TraversalStrategyContext ctx) {
         return antlr.traversalStrategyVisitor.visitTraversalStrategy(ctx);

gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/language/grammar/TraversalEnumParser.java

@@ -22,6 +22,7 @@
 import org.apache.tinkerpop.gremlin.process.traversal.N;
 import org.apache.tinkerpop.gremlin.process.traversal.Scope;
 import org.apache.tinkerpop.gremlin.structure.Direction;
+import org.apache.tinkerpop.gremlin.process.traversal.GType;
 
 /**
  * Traversal enum parser parses all the enums like (e.g. {@link Scope} in graph traversal.
@@ -76,4 +77,15 @@ public static N parseTraversalNFromContext(final GremlinParser.TraversalNContext
             text = text.substring(N.class.getSimpleName().length() + 1);
         return text.startsWith("big") ? N.valueOf(text) : N.valueOf(text + "_");
     }
+
+    /**
+     * Parsing of {@link GType} requires some special handling as grammar allows lowercase for tokens.
+     */
+    public static GType parseTraversalGTypeFromContext(final GremlinParser.TraversalGTypeContext context) {
+        String text = context.getText();
+        if (text.startsWith(GType.class.getSimpleName())) {
+            text = text.substring(GType.class.getSimpleName().length() + 1);
+        }
+        return GType.valueOf(text.toUpperCase());
+    }
 }

gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/language/grammar/TraversalMethodVisitor.java

@@ -2249,6 +2249,15 @@ public GraphTraversal visitTraversalMethod_asNumber_traversalN(final GremlinPars
                 TraversalEnumParser.parseTraversalNFromContext(ctx.traversalN()));
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public GraphTraversal visitTraversalMethod_asNumber_traversalGType(final GremlinParser.TraversalMethod_asNumber_traversalGTypeContext ctx) {
+        return graphTraversal.asNumber(
+                TraversalEnumParser.parseTraversalGTypeFromContext(ctx.traversalGType()));
+    }
+
     public GraphTraversal[] getNestedTraversalList(final GremlinParser.NestedTraversalListContext ctx) {
         return ctx.nestedTraversalExpr().nestedTraversal()
                 .stream()

gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/language/grammar/TraversalPredicateVisitor.java

@@ -19,12 +19,11 @@
 package org.apache.tinkerpop.gremlin.language.grammar;
 
 import org.antlr.v4.runtime.tree.ParseTree;
+import org.apache.tinkerpop.gremlin.process.traversal.GType;
 import org.apache.tinkerpop.gremlin.process.traversal.P;
 import org.apache.tinkerpop.gremlin.process.traversal.TextP;
 
 import java.util.Collection;
-import java.util.List;
-import java.util.Set;
 
 public class TraversalPredicateVisitor extends DefaultGremlinBaseVisitor<P> {
 
@@ -79,6 +78,20 @@ public P visitTraversalPredicate_neq(final GremlinParser.TraversalPredicate_neqC
         return P.neq(getSingleGenericLiteralArgument(ctx));
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public P visitTraversalPredicate_typeOf(final GremlinParser.TraversalPredicate_typeOfContext ctx) {
+        final int childIndex = ctx.getChildCount() == 6 ? 4 : 2;
+        final Object child = ctx.getChild(childIndex);
+        if (child instanceof GremlinParser.TraversalGTypeContext) {
+            return P.typeOf(TraversalEnumParser.parseTraversalGTypeFromContext((GremlinParser.TraversalGTypeContext) child));
+        } else {
+            return P.typeOf((String) antlr.genericVisitor.visitStringLiteral((GremlinParser.StringLiteralContext) child));
+        }
+    }
+
     /**
      * {@inheritDoc}
      */
@@ -244,7 +257,7 @@ private Object[] getDoubleGenericLiteralArgument(final ParseTree ctx) {
      * Get 1 generic literal argument from the antlr parse tree context, where the arguments have the child index
      * of 2 with the short form and 4 on the long form (e.g. eq(1) vs P.eq(1) respectively)
      */
-    private Object getSingleGenericLiteralArgument(final ParseTree ctx) {;
+    private Object getSingleGenericLiteralArgument(final ParseTree ctx) {
         final int childIndexOfParameterValue = ctx.getChildCount() == 6 ? 4 : 2;
 
         return antlr.argumentVisitor.visitGenericArgument(

gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/language/translator/DotNetTranslateVisitor.java

@@ -1202,6 +1202,14 @@ public Void visitUuidLiteral(final GremlinParser.UuidLiteralContext ctx) {
         return null;
     }
 
+    @Override
+    public Void visitTraversalGType(GremlinParser.TraversalGTypeContext ctx) {
+        final String[] split = ctx.getText().split("\\.");
+        sb.append(processGremlinSymbol(split[0])).append(".");
+        sb.append(processGremlinSymbol(split[1].toLowerCase()));
+        return null;
+    }
+
     /**
      * Steps with a {@code <TNewEnd>} defined need special handling to append generics.
      */
@@ -1333,6 +1341,11 @@ static final class SymbolHelper {
         static {
             TO_CS_MAP.put("graphml", "GraphML");
             TO_CS_MAP.put("graphson", "GraphSON");
+            TO_CS_MAP.put("bigdecimal", "BigDecimal");
+            TO_CS_MAP.put("bigint", "BigInt");
+            TO_CS_MAP.put("datetime", "DateTime");
+            TO_CS_MAP.put("uuid", "UUID");
+            TO_CS_MAP.put("vp", "VP");
             TO_CS_MAP.forEach((k, v) -> FROM_CS_MAP.put(v, k));
         }
 

gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/language/translator/GoTranslateVisitor.java

@@ -239,6 +239,16 @@ public Void visitNullLiteral(final GremlinParser.NullLiteralContext ctx) {
         return null;
     }
 
+
+    @Override
+    public Void visitTraversalGType(GremlinParser.TraversalGTypeContext ctx) {
+        final String[] split = ctx.getText().split("\\.");
+        sb.append(GO_PACKAGE_NAME);
+        sb.append(processGremlinSymbol(split[0])).append(".");
+        sb.append(processGremlinSymbol(split[1].toLowerCase()));
+        return null;
+    }
+
     @Override
     public Void visitTraversalStrategy(final GremlinParser.TraversalStrategyContext ctx) {
         if (ctx.getChildCount() == 1)
@@ -369,6 +379,11 @@ static final class SymbolHelper {
             TO_GO_MAP.put("OUT", "Out");
             TO_GO_MAP.put("IN", "In");
             TO_GO_MAP.put("BOTH", "Both");
+            TO_GO_MAP.put("bigdecimal", "BigDecimal");
+            TO_GO_MAP.put("bigint", "BigInt");
+            TO_GO_MAP.put("datetune", "DateTime");
+            TO_GO_MAP.put("uuid", "UUID");
+            TO_GO_MAP.put("vp", "VP");
             TO_GO_MAP.put("WithOptions", GO_PACKAGE_NAME + "WithOptions");
             TO_GO_MAP.put("IO", GO_PACKAGE_NAME + "IO");
             TO_GO_MAP.put("__", GO_PACKAGE_NAME + "T__");

gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/language/translator/JavascriptTranslateVisitor.java

@@ -96,6 +96,14 @@ public Void visitTraversalN(GremlinParser.TraversalNContext ctx) {
         return null;
     }
 
+    @Override
+    public Void visitTraversalGType(GremlinParser.TraversalGTypeContext ctx) {
+        final String[] split = ctx.getText().split("\\.");
+        sb.append(processGremlinSymbol(split[0])).append(".");
+        sb.append(processGremlinSymbol(split[1].toLowerCase()));
+        return null;
+    }
+
     @Override
     public Void visitGenericMapLiteral(final GremlinParser.GenericMapLiteralContext ctx) {
         sb.append("new Map([");
@@ -257,6 +265,8 @@ static final class SymbolHelper {
             TO_JS_MAP.put("from", "from_");
             TO_JS_MAP.put("in", "in_");
             TO_JS_MAP.put("with", "with_");
+            TO_JS_MAP.put("bigdecimal", "bigDeciaml");
+            TO_JS_MAP.put("bigint", "bigInt");
             //
             TO_JS_MAP.forEach((k, v) -> FROM_JS_MAP.put(v, k));
         }

gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/language/translator/TranslateVisitor.java

@@ -24,6 +24,7 @@
 import org.apache.tinkerpop.gremlin.language.grammar.GremlinBaseVisitor;
 import org.apache.tinkerpop.gremlin.language.grammar.GremlinParser;
 import org.apache.tinkerpop.gremlin.process.traversal.DT;
+import org.apache.tinkerpop.gremlin.process.traversal.GType;
 import org.apache.tinkerpop.gremlin.process.traversal.Merge;
 import org.apache.tinkerpop.gremlin.process.traversal.N;
 import org.apache.tinkerpop.gremlin.process.traversal.Operator;
@@ -214,6 +215,12 @@ public Void visitTraversalN(final GremlinParser.TraversalNContext ctx) {
         return null;
     }
 
+    @Override
+    public Void visitTraversalGType(final GremlinParser.TraversalGTypeContext ctx) {
+        appendExplicitNaming(ctx.getText(), GType.class.getSimpleName());
+        return null;
+    }
+
     @Override
     public Void visitTraversalPredicate(final GremlinParser.TraversalPredicateContext ctx) {
         switch(ctx.getChildCount()) {
@@ -263,6 +270,8 @@ protected void visitP(final ParserRuleContext ctx, final Class<?> clazzOfP, fina
                 t -> t instanceof GremlinParser.GenericArgumentContext ||
                               t instanceof GremlinParser.GenericArgumentVarargsContext ||
                               t instanceof GremlinParser.StringArgumentContext ||
+                              t instanceof GremlinParser.StringLiteralContext ||
+                              t instanceof GremlinParser.TraversalGTypeContext ||
                               t instanceof GremlinParser.TraversalPredicateContext).collect(Collectors.toList());
         for (int ix = 0; ix < list.size(); ix++) {
             visit(list.get(ix));
@@ -326,6 +335,12 @@ public Void visitTraversalPredicate_without(final GremlinParser.TraversalPredica
         return null;
     }
 
+    @Override
+    public Void visitTraversalPredicate_typeOf(final GremlinParser.TraversalPredicate_typeOfContext ctx) {
+        visitP(ctx, P.class, "typeOf");
+        return null;
+    }
+
     @Override
     public Void visitTraversalPredicate_not(final GremlinParser.TraversalPredicate_notContext ctx) {
         visitP(ctx, P.class, "not");