Shim in a more general render method for sort specification

Author: jeffgbutler

src/main/java/org/mybatis/dynamic/sql/SortSpecification.java

@@ -15,6 +15,11 @@
  */
 package org.mybatis.dynamic.sql;
 
+import org.mybatis.dynamic.sql.exception.DynamicSqlException;
+import org.mybatis.dynamic.sql.render.RenderingContext;
+import org.mybatis.dynamic.sql.util.FragmentAndParameters;
+import org.mybatis.dynamic.sql.util.Messages;
+
 /**
  * Defines attributes of columns that are necessary for rendering an order by expression.
  *
@@ -34,13 +39,33 @@ public interface SortSpecification {
      * NOT include the "DESC" word for descending sort specifications.
      *
      * @return the order by phrase
+     * @deprecated Please replace this method by overriding the more general "renderForOrderBy" method. Target for
+     *    removal in release 2.1
      */
-    String orderByName();
+    @Deprecated
+    default String orderByName() {
+        throw new DynamicSqlException(Messages.getString("ERROR.44")); //$NON-NLS-1$
+    }
 
     /**
      * Return true if the sort order is descending.
      *
      * @return true if the SortSpecification should render as descending
+     * @deprecated Please replace this method by overriding the more general "renderForOrderBy" method. Target for
+     *    removal in release 2.1
      */
-    boolean isDescending();
+    @Deprecated
+    default boolean isDescending() {
+        throw new DynamicSqlException(Messages.getString("ERROR.44")); //$NON-NLS-1$
+    }
+
+    // the default implementation ensures compatibility with prior releases. When the
+    // deprecated methods are removed, this function can become purely abstract.
+    default FragmentAndParameters renderForOrderBy(RenderingContext renderingContext) {
+        String phrase = orderByName();
+        if (isDescending()) {
+            phrase = phrase + " DESC"; //$NON-NLS-1$
+        }
+        return FragmentAndParameters.fromFragment(phrase);
+    }
 }

src/main/java/org/mybatis/dynamic/sql/SqlColumn.java

@@ -30,7 +30,7 @@ public class SqlColumn<T> implements BindableColumn<T>, SortSpecification {
     protected final String name;
     protected final SqlTable table;
     protected final JDBCType jdbcType;
-    protected final boolean isDescending;
+    protected final String descendingPhrase;
     protected final String alias;
     protected final String typeHandler;
     protected final RenderingStrategy renderingStrategy;
@@ -42,7 +42,7 @@ private SqlColumn(Builder<T> builder) {
         name = Objects.requireNonNull(builder.name);
         table = Objects.requireNonNull(builder.table);
         jdbcType = builder.jdbcType;
-        isDescending = builder.isDescending;
+        descendingPhrase = builder.descendingPhrase;
         alias = builder.alias;
         typeHandler = builder.typeHandler;
         renderingStrategy = builder.renderingStrategy;
@@ -87,7 +87,7 @@ public Object convertParameterType(T value) {
     @Override
     public SortSpecification descending() {
         Builder<T> b = copy();
-        return b.withDescending(true).build();
+        return b.withDescendingPhrase(" DESC").build(); //$NON-NLS-1$
     }
 
     @Override
@@ -126,13 +126,8 @@ public SqlColumn<T> asCamelCase() {
     }
 
     @Override
-    public boolean isDescending() {
-        return isDescending;
-    }
-
-    @Override
-    public String orderByName() {
-        return alias().orElse(name);
+    public FragmentAndParameters renderForOrderBy(RenderingContext renderingContext) {
+        return FragmentAndParameters.fromFragment(alias().orElse(name) + descendingPhrase);
     }
 
     @Override
@@ -188,7 +183,7 @@ private <S> Builder<S> copy() {
                 .withName(this.name)
                 .withTable(this.table)
                 .withJdbcType(this.jdbcType)
-                .withDescending(this.isDescending)
+                .withDescendingPhrase(this.descendingPhrase)
                 .withAlias(this.alias)
                 .withTypeHandler(this.typeHandler)
                 .withRenderingStrategy(this.renderingStrategy)
@@ -214,7 +209,7 @@ public static class Builder<T> {
         protected String name;
         protected SqlTable table;
         protected JDBCType jdbcType;
-        protected boolean isDescending = false;
+        protected String descendingPhrase = ""; //$NON-NLS-1$
         protected String alias;
         protected String typeHandler;
         protected RenderingStrategy renderingStrategy;
@@ -237,8 +232,8 @@ public Builder<T> withJdbcType(JDBCType jdbcType) {
             return this;
         }
 
-        public Builder<T> withDescending(boolean isDescending) {
-            this.isDescending = isDescending;
+        public Builder<T> withDescendingPhrase(String descendingPhrase) {
+            this.descendingPhrase = descendingPhrase;
             return this;
         }
 

src/main/java/org/mybatis/dynamic/sql/common/OrderByRenderer.java

@@ -15,24 +15,24 @@
  */
 package org.mybatis.dynamic.sql.common;
 
+import java.util.Objects;
 import java.util.stream.Collectors;
 
-import org.mybatis.dynamic.sql.SortSpecification;
+import org.mybatis.dynamic.sql.render.RenderingContext;
 import org.mybatis.dynamic.sql.util.FragmentAndParameters;
+import org.mybatis.dynamic.sql.util.FragmentCollector;
 
 public class OrderByRenderer {
-    public FragmentAndParameters render(OrderByModel orderByModel) {
-        String phrase = orderByModel.columns()
-                .map(this::calculateOrderByPhrase)
-                .collect(Collectors.joining(", ", "order by ", "")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
-        return FragmentAndParameters.fromFragment(phrase);
+    private final RenderingContext renderingContext;
+
+    public OrderByRenderer(RenderingContext renderingContext) {
+        this.renderingContext = Objects.requireNonNull(renderingContext);
     }
 
-    private String calculateOrderByPhrase(SortSpecification column) {
-        String phrase = column.orderByName();
-        if (column.isDescending()) {
-            phrase = phrase + " DESC"; //$NON-NLS-1$
-        }
-        return phrase;
+    public FragmentAndParameters render(OrderByModel orderByModel) {
+        return orderByModel.columns().map(c -> c.renderForOrderBy(renderingContext))
+                .collect(FragmentCollector.collect())
+                .toFragmentAndParameters(
+                        Collectors.joining(", ", "order by ", "")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
     }
 }

src/main/java/org/mybatis/dynamic/sql/delete/render/DeleteRenderer.java

@@ -96,7 +96,7 @@ private Optional<FragmentAndParameters> calculateOrderByClause() {
     }
 
     private FragmentAndParameters renderOrderByClause(OrderByModel orderByModel) {
-        return new OrderByRenderer().render(orderByModel);
+        return new OrderByRenderer(renderingContext).render(orderByModel);
     }
 
     public static Builder withDeleteModel(DeleteModel deleteModel) {

src/main/java/org/mybatis/dynamic/sql/select/ColumnSortSpecification.java

@@ -19,34 +19,31 @@
 
 import org.mybatis.dynamic.sql.SortSpecification;
 import org.mybatis.dynamic.sql.SqlColumn;
+import org.mybatis.dynamic.sql.render.RenderingContext;
+import org.mybatis.dynamic.sql.util.FragmentAndParameters;
 
 public class ColumnSortSpecification implements SortSpecification {
     private final String tableAlias;
     private final SqlColumn<?> column;
-    private final boolean isDescending;
+    private final String descendingPhrase;
 
     public ColumnSortSpecification(String tableAlias, SqlColumn<?> column) {
-        this(tableAlias, column, false);
+        this(tableAlias, column, ""); //$NON-NLS-1$
     }
 
-    private ColumnSortSpecification(String tableAlias, SqlColumn<?> column, boolean isDescending) {
+    private ColumnSortSpecification(String tableAlias, SqlColumn<?> column, String descendingPhrase) {
         this.tableAlias = Objects.requireNonNull(tableAlias);
         this.column = Objects.requireNonNull(column);
-        this.isDescending = isDescending;
+        this.descendingPhrase = descendingPhrase;
     }
 
     @Override
     public SortSpecification descending() {
-        return new ColumnSortSpecification(tableAlias, column, true);
+        return new ColumnSortSpecification(tableAlias, column, " DESC"); //$NON-NLS-1$
     }
 
     @Override
-    public String orderByName() {
-        return tableAlias + "." + column.name(); //$NON-NLS-1$
-    }
-
-    @Override
-    public boolean isDescending() {
-        return isDescending;
+    public FragmentAndParameters renderForOrderBy(RenderingContext renderingContext) {
+        return FragmentAndParameters.fromFragment(tableAlias + "." + column.name() + descendingPhrase); //$NON-NLS-1$
     }
 }

src/main/java/org/mybatis/dynamic/sql/select/SimpleSortSpecification.java

@@ -18,6 +18,8 @@
 import java.util.Objects;
 
 import org.mybatis.dynamic.sql.SortSpecification;
+import org.mybatis.dynamic.sql.render.RenderingContext;
+import org.mybatis.dynamic.sql.util.FragmentAndParameters;
 
 /**
  * This class is used for an order by phrase where there is no suitable column name
@@ -28,30 +30,25 @@
 public class SimpleSortSpecification implements SortSpecification {
 
     private final String name;
-    private final boolean isDescending;
+    private final String descendingPhrase;
 
     private SimpleSortSpecification(String name) {
-        this(name, false);
+        this(name, ""); //$NON-NLS-1$
     }
 
-    private SimpleSortSpecification(String name, boolean isDescending) {
+    private SimpleSortSpecification(String name, String descendingPhrase) {
         this.name = Objects.requireNonNull(name);
-        this.isDescending = isDescending;
+        this.descendingPhrase = descendingPhrase;
     }
 
     @Override
     public SortSpecification descending() {
-        return new SimpleSortSpecification(name, true);
+        return new SimpleSortSpecification(name, " DESC"); //$NON-NLS-1$
     }
 
     @Override
-    public String orderByName() {
-        return name;
-    }
-
-    @Override
-    public boolean isDescending() {
-        return isDescending;
+    public FragmentAndParameters renderForOrderBy(RenderingContext renderingContext) {
+        return FragmentAndParameters.fromFragment(name + descendingPhrase);
     }
 
     public static SimpleSortSpecification of(String name) {

src/main/java/org/mybatis/dynamic/sql/select/render/MultiSelectRenderer.java

@@ -87,7 +87,7 @@ private Optional<FragmentAndParameters> renderOrderBy() {
     }
 
     private FragmentAndParameters renderOrderBy(OrderByModel orderByModel) {
-        return new OrderByRenderer().render(orderByModel);
+        return new OrderByRenderer(renderingContext).render(orderByModel);
     }
 
     private Optional<FragmentAndParameters> renderPagingModel() {

src/main/java/org/mybatis/dynamic/sql/select/render/SelectRenderer.java

@@ -68,7 +68,7 @@ private Optional<FragmentAndParameters> renderOrderBy() {
     }
 
     private FragmentAndParameters renderOrderBy(OrderByModel orderByModel) {
-        return new OrderByRenderer().render(orderByModel);
+        return new OrderByRenderer(renderingContext).render(orderByModel);
     }
 
     private Optional<FragmentAndParameters> renderPagingModel() {

src/main/java/org/mybatis/dynamic/sql/update/render/UpdateRenderer.java

@@ -122,7 +122,7 @@ private Optional<FragmentAndParameters> calculateOrderByClause() {
     }
 
     private FragmentAndParameters renderOrderByClause(OrderByModel orderByModel) {
-        return new OrderByRenderer().render(orderByModel);
+        return new OrderByRenderer(renderingContext).render(orderByModel);
     }
 
     public static Builder withUpdateModel(UpdateModel updateModel) {

src/main/resources/org/mybatis/dynamic/sql/util/messages.properties

@@ -52,12 +52,14 @@ ERROR.33=Calling "select" or "selectDistinct" more than once is not allowed. Add
   union or unionAll expression
 ERROR.34=You must specify "select" or "selectDistinct" before any other clauses in a multi-select statement
 ERROR.35=Multi-select statements must have at least one "union" or "union all" expression
-ERROR.36=You must either implement the "render" or  "renderWithTableAlias" method in a column or function
+ERROR.36=You must either implement the "render" or "renderWithTableAlias" method in a column or function
 ERROR.37=The "{0}" function does not support conditions that fail to render
 ERROR.38=Bound values cannot be aliased
 ERROR.39=When clauses in case expressions must render
 ERROR.40=Case expressions must have at least one "when" clause
 ERROR.41=You cannot call "then" in a Kotlin case expression more than once
 ERROR.42=You cannot call `else` in a Kotlin case expression more than once
 ERROR.43=A Kotlin cast expression must have one, and only one, `as` element
+ERROR.44=You must either implement the "renderForOrderBy" method or both "orderByName" and "isDescending" methods in a \
+  sort specification
 INTERNAL.ERROR=Internal Error {0}