Skyline syntax (preferring clause) (#2078)

* feat: Implement skyline syntax (preferring clause)

* fix: Fix codacy errors

* style: Execute :spotlessApply

* fix: Remove unused import

* refactor: Replace wildcard imports

* refactor: Remove redundant imports

---------

Co-authored-by: Stefan Steinhauser <[email protected]>

Author: ssteinhauser

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

@@ -48,6 +48,8 @@
 import net.sf.jsqlparser.expression.operators.relational.MinorThan;
 import net.sf.jsqlparser.expression.operators.relational.MinorThanEquals;
 import net.sf.jsqlparser.expression.operators.relational.NotEqualsTo;
+import net.sf.jsqlparser.expression.operators.relational.Plus;
+import net.sf.jsqlparser.expression.operators.relational.PriorTo;
 import net.sf.jsqlparser.expression.operators.relational.RegExpMatchOperator;
 import net.sf.jsqlparser.expression.operators.relational.SimilarToExpression;
 import net.sf.jsqlparser.expression.operators.relational.TSQLLeftJoin;
@@ -633,4 +635,34 @@ default void visit(StructType structType) {
     default void visit(LambdaExpression lambdaExpression) {
         this.visit(lambdaExpression, null);
     }
+
+    <S> T visit(HighExpression highExpression, S context);
+
+    default void visit(HighExpression highExpression) {
+        this.visit(highExpression, null);
+    }
+
+    <S> T visit(LowExpression lowExpression, S context);
+
+    default void visit(LowExpression lowExpression) {
+        this.visit(lowExpression, null);
+    }
+
+    <S> T visit(Plus plus, S context);
+
+    default void visit(Plus plus) {
+        this.visit(plus, null);
+    }
+
+    <S> T visit(PriorTo priorTo, S context);
+
+    default void visit(PriorTo priorTo) {
+        this.visit(priorTo, null);
+    }
+
+    <S> T visit(Inverse inverse, S context);
+
+    default void visit(Inverse inverse) {
+        this.visit(inverse, null);
+    }
 }

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

@@ -29,13 +29,15 @@
 import net.sf.jsqlparser.expression.operators.relational.Contains;
 import net.sf.jsqlparser.expression.operators.relational.DoubleAnd;
 import net.sf.jsqlparser.expression.operators.relational.EqualsTo;
+import net.sf.jsqlparser.expression.operators.relational.ExcludesExpression;
 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;
+import net.sf.jsqlparser.expression.operators.relational.IncludesExpression;
 import net.sf.jsqlparser.expression.operators.relational.IsBooleanExpression;
 import net.sf.jsqlparser.expression.operators.relational.IsDistinctExpression;
 import net.sf.jsqlparser.expression.operators.relational.IsNullExpression;
@@ -46,9 +48,12 @@
 import net.sf.jsqlparser.expression.operators.relational.MinorThan;
 import net.sf.jsqlparser.expression.operators.relational.MinorThanEquals;
 import net.sf.jsqlparser.expression.operators.relational.NotEqualsTo;
+import net.sf.jsqlparser.expression.operators.relational.Plus;
+import net.sf.jsqlparser.expression.operators.relational.PriorTo;
 import net.sf.jsqlparser.expression.operators.relational.RegExpMatchOperator;
 import net.sf.jsqlparser.expression.operators.relational.SimilarToExpression;
-import net.sf.jsqlparser.expression.operators.relational.*;
+import net.sf.jsqlparser.expression.operators.relational.TSQLLeftJoin;
+import net.sf.jsqlparser.expression.operators.relational.TSQLRightJoin;
 import net.sf.jsqlparser.schema.Column;
 import net.sf.jsqlparser.statement.select.AllColumns;
 import net.sf.jsqlparser.statement.select.AllTableColumns;
@@ -762,4 +767,29 @@ public <S> T visit(LambdaExpression lambdaExpression, S context) {
         return lambdaExpression.getExpression().accept(this, context);
     }
 
+    @Override
+    public <S> T visit(HighExpression highExpression, S context) {
+        return highExpression.getExpression().accept(this, context);
+    }
+
+    @Override
+    public <S> T visit(LowExpression lowExpression, S context) {
+        return lowExpression.getExpression().accept(this, context);
+    }
+
+    @Override
+    public <S> T visit(Plus plus, S context) {
+        return visitBinaryExpression(plus, context);
+    }
+
+    @Override
+    public <S> T visit(PriorTo priorTo, S context) {
+        return visitBinaryExpression(priorTo, context);
+    }
+
+    @Override
+    public <S> T visit(Inverse inverse, S context) {
+        return inverse.getExpression().accept(this, context);
+    }
+
 }

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

@@ -0,0 +1,42 @@
+/*-
+ * #%L
+ * JSQLParser library
+ * %%
+ * Copyright (C) 2004 - 2019 JSQLParser
+ * %%
+ * Dual licensed under GNU LGPL 2.1 or Apache License 2.0
+ * #L%
+ */
+package net.sf.jsqlparser.expression;
+
+import net.sf.jsqlparser.parser.ASTNodeAccessImpl;
+
+public class HighExpression extends ASTNodeAccessImpl implements Expression {
+    private Expression expression;
+
+    public HighExpression() {
+        // empty constructor
+    }
+
+    public HighExpression(Expression expression) {
+        this.expression = expression;
+    }
+
+    @Override
+    public <T, S> T accept(ExpressionVisitor<T> expressionVisitor, S context) {
+        return expressionVisitor.visit(this, context);
+    }
+
+    public Expression getExpression() {
+        return expression;
+    }
+
+    public void setExpression(Expression expression) {
+        this.expression = expression;
+    }
+
+    @Override
+    public String toString() {
+        return "HIGH " + expression.toString();
+    }
+}

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

@@ -0,0 +1,42 @@
+/*-
+ * #%L
+ * JSQLParser library
+ * %%
+ * Copyright (C) 2004 - 2019 JSQLParser
+ * %%
+ * Dual licensed under GNU LGPL 2.1 or Apache License 2.0
+ * #L%
+ */
+package net.sf.jsqlparser.expression;
+
+import net.sf.jsqlparser.parser.ASTNodeAccessImpl;
+
+public class Inverse extends ASTNodeAccessImpl implements Expression {
+    private Expression expression;
+
+    public Inverse() {
+        // empty constructor
+    }
+
+    public Inverse(Expression expression) {
+        this.expression = expression;
+    }
+
+    @Override
+    public <T, S> T accept(ExpressionVisitor<T> expressionVisitor, S context) {
+        return expressionVisitor.visit(this, context);
+    }
+
+    public Expression getExpression() {
+        return expression;
+    }
+
+    public void setExpression(Expression expression) {
+        this.expression = expression;
+    }
+
+    @Override
+    public String toString() {
+        return "INVERSE (" + expression.toString() + ")";
+    }
+}

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

@@ -0,0 +1,42 @@
+/*-
+ * #%L
+ * JSQLParser library
+ * %%
+ * Copyright (C) 2004 - 2019 JSQLParser
+ * %%
+ * Dual licensed under GNU LGPL 2.1 or Apache License 2.0
+ * #L%
+ */
+package net.sf.jsqlparser.expression;
+
+import net.sf.jsqlparser.parser.ASTNodeAccessImpl;
+
+public class LowExpression extends ASTNodeAccessImpl implements Expression {
+    private Expression expression;
+
+    public LowExpression() {
+        // empty constructor
+    }
+
+    public LowExpression(Expression expression) {
+        this.expression = expression;
+    }
+
+    @Override
+    public <T, S> T accept(ExpressionVisitor<T> expressionVisitor, S context) {
+        return expressionVisitor.visit(this, context);
+    }
+
+    public Expression getExpression() {
+        return expression;
+    }
+
+    public void setExpression(Expression expression) {
+        this.expression = expression;
+    }
+
+    @Override
+    public String toString() {
+        return "LOW " + expression.toString();
+    }
+}

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

@@ -0,0 +1,48 @@
+/*-
+ * #%L
+ * JSQLParser library
+ * %%
+ * Copyright (C) 2004 - 2019 JSQLParser
+ * %%
+ * Dual licensed under GNU LGPL 2.1 or Apache License 2.0
+ * #L%
+ */
+package net.sf.jsqlparser.expression;
+
+import net.sf.jsqlparser.expression.operators.relational.ExpressionList;
+
+import java.io.Serializable;
+
+public class PreferringClause implements Serializable {
+    private Expression preferring;
+    private PartitionByClause partitionBy;
+
+    public PreferringClause(Expression preferring) {
+        this.preferring = preferring;
+    }
+
+    public void setPartitionExpressionList(ExpressionList expressionList,
+            boolean brackets) {
+        if (this.partitionBy == null) {
+            this.partitionBy = new PartitionByClause();
+        }
+        partitionBy.setPartitionExpressionList(expressionList, brackets);
+    }
+
+    public void toStringPreferring(StringBuilder b) {
+        b.append("PREFERRING ");
+        b.append(preferring.toString());
+
+        if (partitionBy != null) {
+            b.append(" ");
+            partitionBy.toStringPartitionBy(b);
+        }
+    }
+
+    @Override
+    public String toString() {
+        StringBuilder sb = new StringBuilder();
+        toStringPreferring(sb);
+        return sb.toString();
+    }
+}

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

@@ -0,0 +1,30 @@
+/*-
+ * #%L
+ * JSQLParser library
+ * %%
+ * Copyright (C) 2004 - 2019 JSQLParser
+ * %%
+ * Dual licensed under GNU LGPL 2.1 or Apache License 2.0
+ * #L%
+ */
+package net.sf.jsqlparser.expression.operators.relational;
+
+import net.sf.jsqlparser.expression.BinaryExpression;
+import net.sf.jsqlparser.expression.Expression;
+import net.sf.jsqlparser.expression.ExpressionVisitor;
+
+public class Plus extends BinaryExpression {
+    public Plus(Expression leftExpression, Expression rightExpression) {
+        super(leftExpression, rightExpression);
+    }
+
+    @Override
+    public String getStringExpression() {
+        return "PLUS";
+    }
+
+    @Override
+    public <T, S> T accept(ExpressionVisitor<T> expressionVisitor, S context) {
+        return expressionVisitor.visit(this, context);
+    }
+}

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

@@ -0,0 +1,30 @@
+/*-
+ * #%L
+ * JSQLParser library
+ * %%
+ * Copyright (C) 2004 - 2019 JSQLParser
+ * %%
+ * Dual licensed under GNU LGPL 2.1 or Apache License 2.0
+ * #L%
+ */
+package net.sf.jsqlparser.expression.operators.relational;
+
+import net.sf.jsqlparser.expression.BinaryExpression;
+import net.sf.jsqlparser.expression.Expression;
+import net.sf.jsqlparser.expression.ExpressionVisitor;
+
+public class PriorTo extends BinaryExpression {
+    public PriorTo(Expression leftExpression, Expression rightExpression) {
+        super(leftExpression, rightExpression);
+    }
+
+    @Override
+    public String getStringExpression() {
+        return "PRIOR TO";
+    }
+
+    @Override
+    public <T, S> T accept(ExpressionVisitor<T> expressionVisitor, S context) {
+        return expressionVisitor.visit(this, context);
+    }
+}