Add geometry distance operator (#1493)

* Add support for geometry distance operators in PostGIS.

* Fix missing imports.

Co-authored-by: Thomas Powell <[email protected]>

Author: tom-s-powell

src/main/java/net/sf/jsqlparser/expression/ExpressionVisitor.java

@@ -188,4 +188,6 @@ public interface ExpressionVisitor {
     void visit(AllValue allValue);
 
     void visit(IsDistinctExpression isDistinctExpression);
+
+    void visit(GeometryDistance geometryDistance);
 }

src/main/java/net/sf/jsqlparser/expression/ExpressionVisitorAdapter.java

@@ -634,7 +634,12 @@ public void visit(ConnectByRootOperator connectByRootOperator) {
     public void visit(OracleNamedFunctionParameter oracleNamedFunctionParameter) {
         oracleNamedFunctionParameter.getExpression().accept(this);
     }
-    
+
+    @Override
+    public void visit(GeometryDistance geometryDistance) {
+        visitBinaryExpression(geometryDistance);
+    }
+
     public void visit(ColumnDefinition columnDefinition) {
        columnDefinition.accept(this);
      }

src/main/java/net/sf/jsqlparser/expression/operators/relational/GeometryDistance.java

@@ -0,0 +1,19 @@
+package net.sf.jsqlparser.expression.operators.relational;
+
+import net.sf.jsqlparser.expression.ExpressionVisitor;
+
+public class GeometryDistance extends ComparisonOperator {
+
+    public GeometryDistance() {
+        super("<->");
+    }
+
+    public GeometryDistance(String operator) {
+        super(operator);
+    }
+
+    @Override
+    public void accept(ExpressionVisitor expressionVisitor) {
+        expressionVisitor.visit(this);
+    }
+}

src/main/java/net/sf/jsqlparser/util/TablesNamesFinder.java

@@ -1031,4 +1031,9 @@ public void visit(PurgeStatement purgeStatement) {
     public void visit(AlterSystemStatement alterSystemStatement) {
         // no tables involved in this statement
     }
+
+    @Override
+    public void visit(GeometryDistance geometryDistance) {
+        visitBinaryExpression(geometryDistance);
+    }
 }

src/main/java/net/sf/jsqlparser/util/deparser/ExpressionDeParser.java

@@ -34,6 +34,7 @@
 import net.sf.jsqlparser.expression.operators.relational.ExistsExpression;
 import net.sf.jsqlparser.expression.operators.relational.ExpressionList;
 import net.sf.jsqlparser.expression.operators.relational.FullTextSearch;
+import net.sf.jsqlparser.expression.operators.relational.GeometryDistance;
 import net.sf.jsqlparser.expression.operators.relational.GreaterThan;
 import net.sf.jsqlparser.expression.operators.relational.GreaterThanEquals;
 import net.sf.jsqlparser.expression.operators.relational.InExpression;
@@ -996,4 +997,9 @@ public void visit(IsDistinctExpression isDistinctExpression) {
                 isDistinctExpression.getStringExpression() +
                 isDistinctExpression.getRightExpression());
     }
+
+    @Override
+    public void visit(GeometryDistance geometryDistance) {
+        visitOldOracleJoinBinaryExpression(geometryDistance, " <-> ");
+    }
 }

src/main/java/net/sf/jsqlparser/util/validation/validator/ExpressionValidator.java

@@ -30,6 +30,7 @@
 import net.sf.jsqlparser.expression.operators.relational.ExistsExpression;
 import net.sf.jsqlparser.expression.operators.relational.ExpressionList;
 import net.sf.jsqlparser.expression.operators.relational.FullTextSearch;
+import net.sf.jsqlparser.expression.operators.relational.GeometryDistance;
 import net.sf.jsqlparser.expression.operators.relational.GreaterThan;
 import net.sf.jsqlparser.expression.operators.relational.GreaterThanEquals;
 import net.sf.jsqlparser.expression.operators.relational.InExpression;
@@ -586,4 +587,8 @@ public void visit(IsDistinctExpression isDistinctExpression) {
         isDistinctExpression.getRightExpression().accept(this);
     }
 
+    @Override
+    public void visit(GeometryDistance geometryDistance) {
+        visitOldOracleJoinBinaryExpression(geometryDistance, " <-> ");
+    }
 }

src/main/jjtree/net/sf/jsqlparser/parser/JSqlParserCC.jjt

@@ -3112,6 +3112,8 @@ Expression RegularCondition() #RegularCondition:
         | <OP_CONCAT> { result = new JsonOperator("||"); }
         | "-" { result = new JsonOperator("-"); }
         | "-#" { result = new JsonOperator("-#"); }
+        | <-> { result = new GeometryDistance("<->"); }
+        | <#> { result = new GeometryDistance("<#>"); }
     )
 
     ( LOOKAHEAD(2) <K_PRIOR> rightExpression=ComparisonItem() { oraclePrior = EqualsTo.ORACLE_PRIOR_END; }

src/test/java/net/sf/jsqlparser/statement/select/SelectTest.java

@@ -2819,6 +2819,12 @@ public void testNotEqualsTo() throws JSQLParserException {
         assertSqlCanBeParsedAndDeparsed("SELECT * FROM foo WHERE a <> b");
     }
 
+    @Test
+    public void testGeometryDistance() throws JSQLParserException {
+        assertSqlCanBeParsedAndDeparsed("SELECT * FROM foo ORDER BY a <-> b");
+        assertSqlCanBeParsedAndDeparsed("SELECT * FROM foo ORDER BY a <#> b");
+    }
+
     @Test
     public void testJsonExpression() throws JSQLParserException {
         assertSqlCanBeParsedAndDeparsed("SELECT data->'images'->'thumbnail'->'url' AS thumb FROM instagram");