Merge pull request #609 from jeffgbutler/misc-updates

Misc Small Updates

Author: jeffgbutler

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

@@ -92,7 +92,7 @@ private Optional<FragmentAndParameters> calculateLimitClause() {
     }
 
     private FragmentAndParameters renderLimitClause(Long limit) {
-        String mapKey = RenderingStrategy.formatParameterMapKey(sequence);
+        String mapKey = renderingStrategy.formatParameterMapKey(sequence);
         String jdbcPlaceholder =
                 renderingStrategy.getFormattedJdbcPlaceholder(RenderingStrategy.DEFAULT_PARAMETER_PREFIX, mapKey);
 

src/main/java/org/mybatis/dynamic/sql/insert/render/GeneralInsertValuePhraseVisitor.java

@@ -85,7 +85,7 @@ private Optional<FieldAndValueAndParameters> buildNullFragment(AbstractColumnMap
     }
 
     private Optional<FieldAndValueAndParameters> buildFragment(AbstractColumnMapping mapping, Object value) {
-        String mapKey = RenderingStrategy.formatParameterMapKey(sequence);
+        String mapKey = renderingStrategy.formatParameterMapKey(sequence);
 
         String jdbcPlaceholder = mapping.mapColumn(c -> calculateJdbcPlaceholder(c, mapKey));
 

src/main/java/org/mybatis/dynamic/sql/render/RenderingStrategy.java

@@ -19,17 +19,83 @@
 
 import org.mybatis.dynamic.sql.BindableColumn;
 
+/**
+ * A rendering strategy is used to generate a platform specific binding.
+ * <p>
+ * Rendering strategies are used during the rendering phase of statement generation.
+ * All generated SQL statements include the generated statement itself, and a map of parameters that
+ * should be bound to the statement at execution time. For example, a generated select statement may
+ * look like this when rendered for MyBatis:
+ * <p>
+ * <code>select foo from bar where id = #{parameters.p1,jdbcType=INTEGER}</code>
+ * <p>
+ * In this case, the binding is <code>#{parameters.p1,jdbcType=INTEGER}</code>. MyBatis knows how to interpret this
+ * binding - it will look for a value in the <code>parameters.p1</code> property of the parameter object
+ * passed to the statement and bind it as a prepared statement parameter when executing the statement.
+ */
 public abstract class RenderingStrategy {
     public static final String DEFAULT_PARAMETER_PREFIX = "parameters"; //$NON-NLS-1$
 
-    public static String formatParameterMapKey(AtomicInteger sequence) {
+    public String formatParameterMapKey(AtomicInteger sequence) {
         return "p" + sequence.getAndIncrement(); //$NON-NLS-1$
     }
 
+    /**
+     * This method generates a binding for a parameter to a placeholder in a generated SQL statement.
+     * <p>
+     * This binding is appropriate when there can be a mapping between a parameter and a known target column,
+     * In MyBatis, the binding can specify type information based on the column. The bindings are specific
+     * to the target framework.
+     * <p>
+     * For MyBatis, a binding looks like this: "#{prefix.parameterName,jdbcType=xxx,typeHandler=xxx,javaType=xxx}"
+     * <p>
+     * For Spring, a binding looks like this: ":parameterName"
+     *
+     * @param column column definition used for generating type details in a MyBatis binding. Ignored for Spring.
+     * @param prefix parameter prefix used for locating the parameters in a SQL provider object. Typically, will be
+     *               {@link RenderingStrategy#DEFAULT_PARAMETER_PREFIX}. This is ignored for Spring.
+     * @param parameterName name of the parameter. Typically generated by calling
+     *    {@link RenderingStrategy#formatParameterMapKey(AtomicInteger)}
+     * @return the generated binding
+     */
     public abstract String getFormattedJdbcPlaceholder(BindableColumn<?> column, String prefix, String parameterName);
 
+    /**
+     * This method generates a binding for a parameter to a placeholder in a generated SQL statement.
+     * <p>
+     * This binding is appropriate when the parameter is bound to placeholder that is not a known column (such as
+     * a limit or offset parameter). The bindings are specific to the target framework.
+     * <p>
+     * For MyBatis, a binding looks like this: "#{prefix.parameterName}"
+     * <p>
+     * For Spring, a binding looks like this: ":parameterName"
+     *
+     * @param prefix parameter prefix used for locating the parameters in a SQL provider object. Typically, will be
+     *               {@link RenderingStrategy#DEFAULT_PARAMETER_PREFIX}. This is ignored for Spring.
+     * @param parameterName name of the parameter. Typically generated by calling
+     *    {@link RenderingStrategy#formatParameterMapKey(AtomicInteger)}
+     * @return the generated binding
+     */
     public abstract String getFormattedJdbcPlaceholder(String prefix, String parameterName);
 
+    /**
+     * This method generates a binding for a parameter to a placeholder in a generated multirow insert statement.
+     * <p>
+     * This binding is specifically for use with a multirow insert. The Spring implementation changes the binding
+     * to match values expected for a multirow insert statement. For MyBatis, the binding is the same
+     * as {@link RenderingStrategy#getFormattedJdbcPlaceholder(BindableColumn, String, String)}.
+     * <p>
+     * For MyBatis, a binding looks like this: "#{prefix.parameterName,jdbcType=xxx,typeHandler=xxx,javaType=xxx}"
+     * <p>
+     * For Spring, a binding looks like this: ":prefix.parameterName"
+     *
+     * @param column column definition used for generating type details in a MyBatis binding. Ignored for Spring.
+     * @param prefix parameter prefix used for locating the parameters in a SQL provider object. Typically, will be
+     *               {@link RenderingStrategy#DEFAULT_PARAMETER_PREFIX}. This is ignored for Spring.
+     * @param parameterName name of the parameter. Typically generated by calling
+     *    {@link RenderingStrategy#formatParameterMapKey(AtomicInteger)}
+     * @return the generated binding
+     */
     public String getMultiRowFormattedJdbcPlaceholder(BindableColumn<?> column, String prefix, String parameterName) {
         return getFormattedJdbcPlaceholder(column, prefix, parameterName);
     }

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

@@ -21,6 +21,7 @@
 import org.mybatis.dynamic.sql.render.RenderingStrategy;
 import org.mybatis.dynamic.sql.select.PagingModel;
 import org.mybatis.dynamic.sql.util.FragmentAndParameters;
+import org.mybatis.dynamic.sql.util.InternalError;
 import org.mybatis.dynamic.sql.util.Messages;
 
 public class FetchFirstPagingModelRenderer {
@@ -49,11 +50,12 @@ private FragmentAndParameters renderWithOffset(Long offset) {
 
     private FragmentAndParameters renderFetchFirstRowsOnly() {
         return pagingModel.fetchFirstRows().map(this::renderFetchFirstRowsOnly)
-                .orElseThrow(() -> new InvalidSqlException(Messages.getInternalErrorString(13)));
+                .orElseThrow(() ->
+                        new InvalidSqlException(Messages.getInternalErrorString(InternalError.INTERNAL_ERROR_13)));
     }
 
     private FragmentAndParameters renderFetchFirstRowsOnly(Long fetchFirstRows) {
-        String mapKey = RenderingStrategy.formatParameterMapKey(sequence);
+        String mapKey = renderingStrategy.formatParameterMapKey(sequence);
         return FragmentAndParameters
                 .withFragment("fetch first " + renderPlaceholder(mapKey) //$NON-NLS-1$
                     + " rows only") //$NON-NLS-1$
@@ -62,16 +64,16 @@ private FragmentAndParameters renderFetchFirstRowsOnly(Long fetchFirstRows) {
     }
 
     private FragmentAndParameters renderOffsetOnly(Long offset) {
-        String mapKey = RenderingStrategy.formatParameterMapKey(sequence);
+        String mapKey = renderingStrategy.formatParameterMapKey(sequence);
         return FragmentAndParameters.withFragment("offset " + renderPlaceholder(mapKey) //$NON-NLS-1$
                 + " rows") //$NON-NLS-1$
                 .withParameter(mapKey, offset)
                 .build();
     }
 
     private FragmentAndParameters renderOffsetAndFetchFirstRows(Long offset, Long fetchFirstRows) {
-        String mapKey1 = RenderingStrategy.formatParameterMapKey(sequence);
-        String mapKey2 = RenderingStrategy.formatParameterMapKey(sequence);
+        String mapKey1 = renderingStrategy.formatParameterMapKey(sequence);
+        String mapKey2 = renderingStrategy.formatParameterMapKey(sequence);
         return FragmentAndParameters.withFragment("offset " + renderPlaceholder(mapKey1) //$NON-NLS-1$
                 + " rows fetch first " + renderPlaceholder(mapKey2) //$NON-NLS-1$
                 + " rows only") //$NON-NLS-1$

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

@@ -42,15 +42,15 @@ public FragmentAndParameters render() {
     }
 
     private FragmentAndParameters renderLimitOnly() {
-        String mapKey = RenderingStrategy.formatParameterMapKey(sequence);
+        String mapKey = renderingStrategy.formatParameterMapKey(sequence);
         return FragmentAndParameters.withFragment("limit " + renderPlaceholder(mapKey)) //$NON-NLS-1$
                 .withParameter(mapKey, limit)
                 .build();
     }
 
     private FragmentAndParameters renderLimitAndOffset(Long offset) {
-        String mapKey1 = RenderingStrategy.formatParameterMapKey(sequence);
-        String mapKey2 = RenderingStrategy.formatParameterMapKey(sequence);
+        String mapKey1 = renderingStrategy.formatParameterMapKey(sequence);
+        String mapKey2 = renderingStrategy.formatParameterMapKey(sequence);
         return FragmentAndParameters.withFragment("limit " + renderPlaceholder(mapKey1) //$NON-NLS-1$
                     + " offset " + renderPlaceholder(mapKey2)) //$NON-NLS-1$
                 .withParameter(mapKey1, limit)

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

@@ -127,7 +127,7 @@ public Optional<FragmentAndParameters> visit(ColumnToColumnMapping mapping) {
     }
 
     private <T> Optional<FragmentAndParameters> buildFragment(AbstractColumnMapping mapping, T value) {
-        String mapKey = RenderingStrategy.formatParameterMapKey(sequence);
+        String mapKey = renderingStrategy.formatParameterMapKey(sequence);
 
         String jdbcPlaceholder = mapping.mapColumn(c -> calculateJdbcPlaceholder(c, mapKey));
         String setPhrase = mapping.mapColumn(aliasedColumnNameFunction)

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

@@ -122,7 +122,7 @@ private Optional<FragmentAndParameters> calculateLimitClause() {
     }
 
     private FragmentAndParameters renderLimitClause(Long limit) {
-        String mapKey = RenderingStrategy.formatParameterMapKey(sequence);
+        String mapKey = renderingStrategy.formatParameterMapKey(sequence);
         String jdbcPlaceholder =
                 renderingStrategy.getFormattedJdbcPlaceholder(RenderingStrategy.DEFAULT_PARAMETER_PREFIX, mapKey);
 

src/main/java/org/mybatis/dynamic/sql/util/GeneralInsertMappingVisitor.java

@@ -18,21 +18,21 @@
 public abstract class GeneralInsertMappingVisitor<R> implements ColumnMappingVisitor<R> {
     @Override
     public final R visit(SelectMapping mapping) {
-        throw new UnsupportedOperationException(Messages.getInternalErrorString(1));
+        throw new UnsupportedOperationException(Messages.getInternalErrorString(InternalError.INTERNAL_ERROR_1));
     }
 
     @Override
     public final R visit(PropertyMapping mapping) {
-        throw new UnsupportedOperationException(Messages.getInternalErrorString(2));
+        throw new UnsupportedOperationException(Messages.getInternalErrorString(InternalError.INTERNAL_ERROR_2));
     }
 
     @Override
     public final R visit(PropertyWhenPresentMapping mapping) {
-        throw new UnsupportedOperationException(Messages.getInternalErrorString(3));
+        throw new UnsupportedOperationException(Messages.getInternalErrorString(InternalError.INTERNAL_ERROR_3));
     }
 
     @Override
     public final R visit(ColumnToColumnMapping columnMapping) {
-        throw new UnsupportedOperationException(Messages.getInternalErrorString(4));
+        throw new UnsupportedOperationException(Messages.getInternalErrorString(InternalError.INTERNAL_ERROR_4));
     }
 }

src/main/java/org/mybatis/dynamic/sql/util/InsertMappingVisitor.java

@@ -18,26 +18,26 @@
 public abstract class InsertMappingVisitor<R> implements ColumnMappingVisitor<R> {
     @Override
     public final <T> R visit(ValueMapping<T> mapping) {
-        throw new UnsupportedOperationException(Messages.getInternalErrorString(5));
+        throw new UnsupportedOperationException(Messages.getInternalErrorString(InternalError.INTERNAL_ERROR_5));
     }
 
     @Override
     public final <T> R visit(ValueOrNullMapping<T> mapping) {
-        throw new UnsupportedOperationException(Messages.getInternalErrorString(6));
+        throw new UnsupportedOperationException(Messages.getInternalErrorString(InternalError.INTERNAL_ERROR_6));
     }
 
     @Override
     public final <T> R visit(ValueWhenPresentMapping<T> mapping) {
-        throw new UnsupportedOperationException(Messages.getInternalErrorString(7));
+        throw new UnsupportedOperationException(Messages.getInternalErrorString(InternalError.INTERNAL_ERROR_7));
     }
 
     @Override
     public final R visit(SelectMapping mapping) {
-        throw new UnsupportedOperationException(Messages.getInternalErrorString(8));
+        throw new UnsupportedOperationException(Messages.getInternalErrorString(InternalError.INTERNAL_ERROR_8));
     }
 
     @Override
     public final R visit(ColumnToColumnMapping columnMapping) {
-        throw new UnsupportedOperationException(Messages.getInternalErrorString(9));
+        throw new UnsupportedOperationException(Messages.getInternalErrorString(InternalError.INTERNAL_ERROR_9));
     }
 }

src/main/java/org/mybatis/dynamic/sql/util/InternalError.java

@@ -0,0 +1,45 @@
+/*
+ *    Copyright 2016-2023 the original author or authors.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *       https://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+package org.mybatis.dynamic.sql.util;
+
+/**
+ * Enum for managing internal error numbers.
+ */
+public enum InternalError {
+    INTERNAL_ERROR_1(1),
+    INTERNAL_ERROR_2(2),
+    INTERNAL_ERROR_3(3),
+    INTERNAL_ERROR_4(4),
+    INTERNAL_ERROR_5(5),
+    INTERNAL_ERROR_6(6),
+    INTERNAL_ERROR_7(7),
+    INTERNAL_ERROR_8(8),
+    INTERNAL_ERROR_9(9),
+    INTERNAL_ERROR_10(10),
+    INTERNAL_ERROR_11(11),
+    INTERNAL_ERROR_12(12),
+    INTERNAL_ERROR_13(13);
+
+    private final int number;
+
+    InternalError(int number) {
+        this.number = number;
+    }
+
+    public int getNumber() {
+        return number;
+    }
+}