Added support for Oracle UNPIVOT keyword. (#882)

BlenderRender3D · wumpz · commit bcc271870ad7 · 2019-10-26T22:35:43.000+02:00
* Added support for Oracle UNPIVOT keyword.

* Back to original version number.

* Updated imports.

* Added missing import.
diff --git a/src/main/java/net/sf/jsqlparser/expression/ExpressionVisitorAdapter.java b/src/main/java/net/sf/jsqlparser/expression/ExpressionVisitorAdapter.java
@@ -26,6 +26,7 @@
 import net.sf.jsqlparser.statement.select.SelectItemVisitor;
 import net.sf.jsqlparser.statement.select.SelectVisitor;
 import net.sf.jsqlparser.statement.select.SubSelect;
+import net.sf.jsqlparser.statement.select.UnPivot;
 import net.sf.jsqlparser.statement.select.WithItem;
 
 public class ExpressionVisitorAdapter implements ExpressionVisitor, ItemsListVisitor, PivotVisitor, SelectItemVisitor {
@@ -469,6 +470,11 @@ public void visit(PivotXml pivot) {
         }
     }
 
+    @Override
+    public void visit(UnPivot unpivot) {
+        unpivot.accept(this);
+    }
+
     @Override
     public void visit(AllColumns allColumns) {
 
diff --git a/src/main/java/net/sf/jsqlparser/schema/Table.java b/src/main/java/net/sf/jsqlparser/schema/Table.java
@@ -33,6 +33,7 @@ public class Table extends ASTNodeAccessImpl implements FromItem, MultiPartName
 
     private Alias alias;
     private Pivot pivot;
+    private UnPivot unpivot;
     private MySQLIndexHint hint;
 
     public Table() {
@@ -148,6 +149,16 @@ public void setPivot(Pivot pivot) {
         this.pivot = pivot;
     }
 
+    @Override
+    public UnPivot getUnPivot() {
+        return this.unpivot;
+    }
+
+    @Override
+    public void setUnPivot(UnPivot unpivot) {
+        this.unpivot = unpivot;
+    }
+
     public MySQLIndexHint getIndexHint() {
         return hint;
     }
@@ -161,6 +172,7 @@ public String toString() {
         return getFullyQualifiedName()
                 + ((alias != null) ? alias.toString() : "")
                 + ((pivot != null) ? " " + pivot : "")
+                + ((unpivot != null) ? " " + unpivot : "")
                 + ((hint != null) ? hint.toString() : "");
     }
 }
diff --git a/src/main/java/net/sf/jsqlparser/statement/select/FromItem.java b/src/main/java/net/sf/jsqlparser/statement/select/FromItem.java
@@ -23,4 +23,8 @@ public interface FromItem {
 
     void setPivot(Pivot pivot);
 
+    UnPivot getUnPivot();
+
+    void setUnPivot(UnPivot unpivot);
+
 }
diff --git a/src/main/java/net/sf/jsqlparser/statement/select/LateralSubSelect.java b/src/main/java/net/sf/jsqlparser/statement/select/LateralSubSelect.java
@@ -16,6 +16,7 @@ public class LateralSubSelect implements FromItem {
     private SubSelect subSelect;
     private Alias alias;
     private Pivot pivot;
+    private UnPivot unpivot;
 
     public void setSubSelect(SubSelect subSelect) {
         this.subSelect = subSelect;
@@ -50,10 +51,21 @@ public void setPivot(Pivot pivot) {
         this.pivot = pivot;
     }
 
+    @Override
+    public UnPivot getUnPivot() {
+        return this.unpivot;
+    }
+
+    @Override
+    public void setUnPivot(UnPivot unpivot) {
+        this.unpivot = unpivot;
+    }
+
     @Override
     public String toString() {
         return "LATERAL" + subSelect.toString()
                 + ((alias != null) ? alias.toString() : "")
-                + ((pivot != null) ? " " + pivot : "");
+                + ((pivot != null) ? " " + pivot : "")
+                + ((unpivot != null) ? " " + unpivot : "");
     }
 }
diff --git a/src/main/java/net/sf/jsqlparser/statement/select/ParenthesisFromItem.java b/src/main/java/net/sf/jsqlparser/statement/select/ParenthesisFromItem.java
@@ -54,11 +54,21 @@ public void setAlias(Alias alias) {
 
     @Override
     public Pivot getPivot() {
-        throw new UnsupportedOperationException("Not supported yet."); 
+        throw new UnsupportedOperationException("Not supported yet.");
     }
 
     @Override
     public void setPivot(Pivot pivot) {
-        throw new UnsupportedOperationException("Not supported yet."); 
+        throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    @Override
+    public UnPivot getUnPivot() {
+        throw new UnsupportedOperationException("Not supported yet.");
+    }
+
+    @Override
+    public void setUnPivot(UnPivot unpivot) {
+        throw new UnsupportedOperationException("Not supported yet.");
     }
 }
diff --git a/src/main/java/net/sf/jsqlparser/statement/select/PivotVisitor.java b/src/main/java/net/sf/jsqlparser/statement/select/PivotVisitor.java
@@ -15,4 +15,6 @@ public interface PivotVisitor {
 
     void visit(PivotXml pivot);
 
+    void visit(UnPivot unpivot);
+
 }
diff --git a/src/main/java/net/sf/jsqlparser/statement/select/PivotVisitorAdapter.java b/src/main/java/net/sf/jsqlparser/statement/select/PivotVisitorAdapter.java
@@ -20,4 +20,9 @@ public void visit(Pivot pivot) {
     public void visit(PivotXml pivot) {
 
     }
+
+    @Override
+    public void visit(UnPivot unpivot) {
+
+    }
 }
diff --git a/src/main/java/net/sf/jsqlparser/statement/select/SubJoin.java b/src/main/java/net/sf/jsqlparser/statement/select/SubJoin.java
@@ -17,6 +17,7 @@ public class SubJoin implements FromItem {
     private FromItem left;
     private Alias alias;
     private Pivot pivot;
+    private UnPivot unpivot;
     private List<Join> joinList;
 
     @Override
@@ -50,6 +51,16 @@ public void setPivot(Pivot pivot) {
         this.pivot = pivot;
     }
 
+    @Override
+    public UnPivot getUnPivot() {
+        return this.unpivot;
+    }
+
+    @Override
+    public void setUnPivot(UnPivot unpivot) {
+        this.unpivot = unpivot;
+    }
+
     @Override
     public Alias getAlias() {
         return alias;
@@ -72,7 +83,8 @@ public String toString() {
             }
         }
 
-        sb.append(")").append((alias != null) ? (" " + alias.toString()) : "").append((pivot != null) ? " " + pivot : "");
+        sb.append(")").append((alias != null) ? (" " + alias.toString()) : "").append((pivot != null) ? " " + pivot : "")
+                .append((unpivot != null) ? " " + unpivot : "");
         return sb.toString();
     }
 }
diff --git a/src/main/java/net/sf/jsqlparser/statement/select/SubSelect.java b/src/main/java/net/sf/jsqlparser/statement/select/SubSelect.java
@@ -26,6 +26,7 @@ public class SubSelect extends ASTNodeAccessImpl implements FromItem, Expression
     private List<WithItem> withItemsList;
 
     private Pivot pivot;
+    private UnPivot unpivot;
 
     @Override
     public void accept(FromItemVisitor fromItemVisitor) {
@@ -65,6 +66,16 @@ public void setPivot(Pivot pivot) {
         this.pivot = pivot;
     }
 
+    @Override
+    public UnPivot getUnPivot() {
+        return this.unpivot;
+    }
+
+    @Override
+    public void setUnPivot(UnPivot unpivot) {
+        this.unpivot = unpivot;
+    }
+
     public boolean isUseBrackets() {
         return useBrackets;
     }
@@ -114,6 +125,9 @@ public String toString() {
         if (pivot != null) {
             retval.append(" ").append(pivot);
         }
+        if (unpivot != null) {
+            retval.append(" ").append(unpivot);
+        }
 
         return retval.toString();
     }
diff --git a/src/main/java/net/sf/jsqlparser/statement/select/TableFunction.java b/src/main/java/net/sf/jsqlparser/statement/select/TableFunction.java
@@ -24,4 +24,13 @@ public Pivot getPivot() {
     @Override
     public void setPivot(Pivot pivot) {
     }
+
+    @Override
+    public UnPivot getUnPivot() {
+        return null;
+    }
+
+    @Override
+    public void setUnPivot(UnPivot unpivot) {
+    }
 }
diff --git a/src/main/java/net/sf/jsqlparser/statement/select/UnPivot.java b/src/main/java/net/sf/jsqlparser/statement/select/UnPivot.java
@@ -0,0 +1,74 @@
+/*-
+ * #%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.statement.select;
+
+import net.sf.jsqlparser.schema.Column;
+
+import java.util.List;
+
+public class UnPivot {
+
+    private boolean includeNulls = false;
+    private boolean includeNullsSpecified = false;
+    private Column unpivotClause;
+    private List<Column> unpivotForClause;
+    private List<SelectExpressionItem> unpivotInClause;
+
+    public void accept(PivotVisitor pivotVisitor) {
+        pivotVisitor.visit(this);
+    }
+
+    public boolean getIncludeNulls() {
+        return includeNulls;
+    }
+
+    public void setIncludeNulls(boolean includeNulls) {
+        this.includeNullsSpecified = true;
+        this.includeNulls = includeNulls;
+    }
+
+    public boolean getIncludeNullsSpecified() {
+        return includeNullsSpecified;
+    }
+
+    public Column getUnPivotClause() {
+        return unpivotClause;
+    }
+
+    public void setUnPivotClause(Column unpivotClause) {
+        this.unpivotClause = unpivotClause;
+    }
+
+    public List<Column> getUnPivotForClause() {
+        return unpivotForClause;
+    }
+
+    public void setUnPivotForClause(List<Column> forColumns) {
+        this.unpivotForClause = forColumns;
+    }
+
+    public List<?> getUnPivotInClause() {
+        return unpivotInClause;
+    }
+
+    public void setUnPivotInClause(List<SelectExpressionItem> unpivotInClause) {
+        this.unpivotInClause = unpivotInClause;
+    }
+
+    @Override
+    public String toString() {
+        return "UNPIVOT"
+                + (includeNullsSpecified && includeNulls ? " INCLUDE NULLS" : "")
+                + (includeNullsSpecified && !includeNulls ? " EXCLUDE NULLS" : "")
+                + " (" + unpivotClause
+                + " FOR " + PlainSelect.getStringList(unpivotForClause, true, unpivotForClause != null && unpivotForClause.size() > 1)
+                + " IN " + PlainSelect.getStringList(unpivotInClause, true, true) + ")";
+    }
+}
diff --git a/src/main/java/net/sf/jsqlparser/statement/select/ValuesList.java b/src/main/java/net/sf/jsqlparser/statement/select/ValuesList.java
@@ -54,6 +54,15 @@ public Pivot getPivot() {
     public void setPivot(Pivot pivot) {
     }
 
+    @Override
+    public UnPivot getUnPivot() {
+        return null;
+    }
+
+    @Override
+    public void setUnPivot(UnPivot unpivot) {
+    }
+
     public MultiExpressionList getMultiExpressionList() {
         return multiExpressionList;
     }
diff --git a/src/main/java/net/sf/jsqlparser/util/deparser/SelectDeParser.java b/src/main/java/net/sf/jsqlparser/util/deparser/SelectDeParser.java
@@ -223,6 +223,10 @@ public void visit(Table tableName) {
         if (pivot != null) {
             pivot.accept(this);
         }
+        UnPivot unpivot = tableName.getUnPivot();
+        if (unpivot != null) {
+            unpivot.accept(this);
+        }
         MySQLIndexHint indexHint = tableName.getIndexHint();
         if (indexHint != null) {
             buffer.append(indexHint);
@@ -245,6 +249,21 @@ public void visit(Pivot pivot) {
         }
     }
 
+    @Override
+    public void visit(UnPivot unpivot) {
+        boolean showOptions = unpivot.getIncludeNullsSpecified();
+        boolean includeNulls = unpivot.getIncludeNulls();
+        List<Column> unpivotForClause = unpivot.getUnPivotForClause();
+        buffer.append(" UNPIVOT")
+                .append(showOptions && includeNulls ? " INCLUDE NULLS" : "")
+                .append(showOptions && !includeNulls ? " EXCULDE NULLS" : "")
+                .append(" (")
+                .append(unpivot.getUnPivotClause())
+                .append(" FOR ").append(PlainSelect.getStringList(unpivotForClause, true, unpivotForClause != null && unpivotForClause.size() > 1))
+                .append(" IN ").append(PlainSelect.getStringList(unpivot.getUnPivotInClause(), true, true))
+                .append(")");
+    }
+
     @Override
     public void visit(PivotXml pivot) {
         List<Column> forColumns = pivot.getForColumns();
diff --git a/src/main/jjtree/net/sf/jsqlparser/parser/JSqlParserCC.jjt b/src/main/jjtree/net/sf/jsqlparser/parser/JSqlParserCC.jjt
diff --git a/src/test/java/net/sf/jsqlparser/statement/select/SpecialOracleTest.java b/src/test/java/net/sf/jsqlparser/statement/select/SpecialOracleTest.java

Original file line number	Diff line number	Diff line change
`@@ -23,4 +23,8 @@ public interface FromItem {`
`23`	`23`
`24`	`24`	`void setPivot(Pivot pivot);`
`25`	`25`
	`26`	`+ UnPivot getUnPivot();`
	`27`	`+`
	`28`	`+ void setUnPivot(UnPivot unpivot);`
	`29`	`+`
`26`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,4 +15,6 @@ public interface PivotVisitor {`
`15`	`15`
`16`	`16`	`void visit(PivotXml pivot);`
`17`	`17`
	`18`	`+ void visit(UnPivot unpivot);`
	`19`	`+`
`18`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,4 +20,9 @@ public void visit(Pivot pivot) {`
`20`	`20`	`public void visit(PivotXml pivot) {`
`21`	`21`
`22`	`22`	`}`
	`23`	`+`
	`24`	`+ @Override`
	`25`	`+ public void visit(UnPivot unpivot) {`
	`26`	`+`
	`27`	`+ }`
`23`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,4 +24,13 @@ public Pivot getPivot() {`
`24`	`24`	`@Override`
`25`	`25`	`public void setPivot(Pivot pivot) {`
`26`	`26`	`}`
	`27`	`+`
	`28`	`+ @Override`
	`29`	`+ public UnPivot getUnPivot() {`
	`30`	`+ return null;`
	`31`	`+ }`
	`32`	`+`
	`33`	`+ @Override`
	`34`	`+ public void setUnPivot(UnPivot unpivot) {`
	`35`	`+ }`
`27`	`36`	`}`