Initial work on parameter type converter

Author: jeffgbutler

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

@@ -0,0 +1,43 @@
+/**
+ *    Copyright 2016-2020 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
+ *
+ *       http://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;
+
+/**
+ * A parameter type converter is used to change a parameter value from one type to another
+ * during statement rendering before the parameter is placed into the parameter map. This can be used
+ * to somewhat mimic the function of a MyBatis type handler for runtimes such as Spring that don't have
+ * a corresponding concept.
+ *
+ * <p>A parameter type converter is associated with a SqlColumn
+ *
+ * <p>The converter is only used for parameters - it is not used for result set processing. The converter will be
+ * called in the following circumstances:
+ *
+ * <ul>
+ *     <li>Parameters in a general insert statement</li>
+ *     <li>Parameters in an update statement</li>
+ *     <li>Parameters in a where clause in any statement</li>
+ * </ul>
+ *
+ * @param <S> Source Type
+ *
+ * @see SqlColumn
+ * @author Jeff Butler
+ */
+@FunctionalInterface
+public interface ParameterTypeConverter<S> {
+    Object convert(S source);
+}

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

@@ -31,22 +31,25 @@ public class SqlColumn<T> implements BindableColumn<T>, SortSpecification {
     protected String alias;
     protected String typeHandler;
     protected RenderingStrategy renderingStrategy;
-    
+    protected ParameterTypeConverter<T> parameterTypeConverter;
+
     private SqlColumn(Builder builder) {
         name = Objects.requireNonNull(builder.name);
         jdbcType = builder.jdbcType;
         table = Objects.requireNonNull(builder.table);
         typeHandler = builder.typeHandler;
     }
-    
-    protected SqlColumn(SqlColumn<?> sqlColumn) {
+
+    @SuppressWarnings("unchecked")
+    protected <S> SqlColumn(SqlColumn<S> sqlColumn) {
         name = sqlColumn.name;
         table = sqlColumn.table;
         jdbcType = sqlColumn.jdbcType;
         isDescending = sqlColumn.isDescending;
         alias = sqlColumn.alias;
         typeHandler = sqlColumn.typeHandler;
         renderingStrategy = sqlColumn.renderingStrategy;
+        parameterTypeConverter = (ParameterTypeConverter<T>) sqlColumn.parameterTypeConverter;
     }
 
     public String name() {
@@ -72,6 +75,10 @@ public Optional<String> typeHandler() {
         return Optional.ofNullable(typeHandler);
     }
 
+    public Optional<ParameterTypeConverter<T>> parameterTypeConverter() {
+        return Optional.ofNullable(parameterTypeConverter);
+    }
+    
     @Override
     public SortSpecification descending() {
         SqlColumn<T> column = new SqlColumn<>(this);
@@ -108,8 +115,8 @@ public Optional<RenderingStrategy> renderingStrategy() {
         return Optional.ofNullable(renderingStrategy);
     }
 
-    public SqlColumn<T> withTypeHandler(String typeHandler) {
-        SqlColumn<T> column = new SqlColumn<>(this);
+    public <S> SqlColumn<S> withTypeHandler(String typeHandler) {
+        SqlColumn<S> column = new SqlColumn<>(this);
         column.typeHandler = typeHandler;
         return column;
     }
@@ -120,6 +127,12 @@ public <S> SqlColumn<S> withRenderingStrategy(RenderingStrategy renderingStrateg
         return column;
     }
 
+    public <S> SqlColumn<S> withParameterTypeConverter(ParameterTypeConverter<S> parameterTypeConverter) {
+        SqlColumn<S> column = new SqlColumn<>(this);
+        column.parameterTypeConverter = parameterTypeConverter;
+        return column;
+    }
+
     private String applyTableAlias(String tableAlias) {
         return tableAlias + "." + name(); //$NON-NLS-1$
     }

src/main/java/org/mybatis/dynamic/sql/insert/AbstractMultiRowInsertModel.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2016-2019 the original author or authors.
+ *    Copyright 2016-2020 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.
@@ -29,15 +29,15 @@
 public abstract class AbstractMultiRowInsertModel<T> {
     private SqlTable table;
     private List<T> records;
-    private List<AbstractColumnMapping> columnMappings;
+    private List<AbstractColumnMapping<?>> columnMappings;
 
     protected AbstractMultiRowInsertModel(AbstractBuilder<T, ?> builder) {
         table = Objects.requireNonNull(builder.table);
         records = Collections.unmodifiableList(Objects.requireNonNull(builder.records));
         columnMappings = Objects.requireNonNull(builder.columnMappings);
     }
 
-    public <R> Stream<R> mapColumnMappings(Function<AbstractColumnMapping, R> mapper) {
+    public <R> Stream<R> mapColumnMappings(Function<AbstractColumnMapping<?>, R> mapper) {
         return columnMappings.stream().map(mapper);
     }
 
@@ -56,7 +56,7 @@ public int recordCount() {
     public abstract static class AbstractBuilder<T, S extends AbstractBuilder<T, S>> {
         private SqlTable table;
         private List<T> records = new ArrayList<>();
-        private List<AbstractColumnMapping> columnMappings = new ArrayList<>();
+        private List<AbstractColumnMapping<?>> columnMappings = new ArrayList<>();
 
         public S withTable(SqlTable table) {
             this.table = table;
@@ -68,7 +68,7 @@ public S withRecords(Collection<T> records) {
             return getThis();
         }
 
-        public S withColumnMappings(List<AbstractColumnMapping> columnMappings) {
+        public S withColumnMappings(List<AbstractColumnMapping<?>> columnMappings) {
             this.columnMappings.addAll(columnMappings);
             return getThis();
         }

src/main/java/org/mybatis/dynamic/sql/insert/BatchInsertDSL.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2016-2019 the original author or authors.
+ *    Copyright 2016-2020 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.
@@ -32,7 +32,7 @@ public class BatchInsertDSL<T> {
 
     private Collection<T> records;
     private SqlTable table;
-    private List<AbstractColumnMapping> columnMappings = new ArrayList<>();
+    private List<AbstractColumnMapping<?>> columnMappings = new ArrayList<>();
 
     private BatchInsertDSL(Collection<T> records, SqlTable table) {
         this.records = records;

src/main/java/org/mybatis/dynamic/sql/insert/GeneralInsertDSL.java

@@ -31,7 +31,7 @@
 import org.mybatis.dynamic.sql.util.ValueWhenPresentMapping;
 
 public class GeneralInsertDSL implements Buildable<GeneralInsertModel> {
-    private List<AbstractColumnMapping> insertMappings = new ArrayList<>();
+    private List<AbstractColumnMapping<?>> insertMappings = new ArrayList<>();
     private SqlTable table;
 
     private GeneralInsertDSL(SqlTable table) {

src/main/java/org/mybatis/dynamic/sql/insert/GeneralInsertModel.java

@@ -31,14 +31,14 @@
 public class GeneralInsertModel {
 
     private SqlTable table;
-    private List<AbstractColumnMapping> insertMappings;
+    private List<AbstractColumnMapping<?>> insertMappings;
 
     private GeneralInsertModel(Builder builder) {
         table = Objects.requireNonNull(builder.table);
         insertMappings = builder.insertMappings;
     }
 
-    public <R> Stream<R> mapColumnMappings(Function<AbstractColumnMapping, R> mapper) {
+    public <R> Stream<R> mapColumnMappings(Function<AbstractColumnMapping<?>, R> mapper) {
         return insertMappings.stream().map(mapper);
     }
 
@@ -56,14 +56,14 @@ public GeneralInsertStatementProvider render(RenderingStrategy renderingStrategy
 
     public static class Builder {
         private SqlTable table;
-        private List<AbstractColumnMapping> insertMappings = new ArrayList<>();
+        private List<AbstractColumnMapping<?>> insertMappings = new ArrayList<>();
 
         public Builder withTable(SqlTable table) {
             this.table = table;
             return this;
         }
 
-        public Builder withInsertMappings(List<AbstractColumnMapping> insertMappings) {
+        public Builder withInsertMappings(List<AbstractColumnMapping<?>> insertMappings) {
             this.insertMappings.addAll(insertMappings);
             return this;
         }

src/main/java/org/mybatis/dynamic/sql/insert/InsertDSL.java

@@ -33,7 +33,7 @@ public class InsertDSL<T> implements Buildable<InsertModel<T>> {
 
     private T record;
     private SqlTable table;
-    private List<AbstractColumnMapping> columnMappings = new ArrayList<>();
+    private List<AbstractColumnMapping<?>> columnMappings = new ArrayList<>();
 
     private InsertDSL(T record, SqlTable table) {
         this.record = record;
@@ -80,7 +80,7 @@ public InsertDSL<T> toProperty(String property) {
             return InsertDSL.this;
         }
 
-        public InsertDSL<T> toPropertyWhenPresent(String property, Supplier<?> valueSupplier) {
+        public InsertDSL<T> toPropertyWhenPresent(String property, Supplier<F> valueSupplier) {
             columnMappings.add(PropertyWhenPresentMapping.of(column, property, valueSupplier));
             return InsertDSL.this;
         }

src/main/java/org/mybatis/dynamic/sql/insert/InsertModel.java

@@ -31,15 +31,15 @@
 public class InsertModel<T> {
     private SqlTable table;
     private T record;
-    private List<AbstractColumnMapping> columnMappings;
+    private List<AbstractColumnMapping<?>> columnMappings;
 
     private InsertModel(Builder<T> builder) {
         table = Objects.requireNonNull(builder.table);
         record = Objects.requireNonNull(builder.record);
         columnMappings = Objects.requireNonNull(builder.columnMappings);
     }
 
-    public <R> Stream<R> mapColumnMappings(Function<AbstractColumnMapping, R> mapper) {
+    public <R> Stream<R> mapColumnMappings(Function<AbstractColumnMapping<?>, R> mapper) {
         return columnMappings.stream().map(mapper);
     }
 
@@ -66,7 +66,7 @@ public static <T> Builder<T> withRecord(T record) {
     public static class Builder<T> {
         private SqlTable table;
         private T record;
-        private List<AbstractColumnMapping> columnMappings = new ArrayList<>();
+        private List<AbstractColumnMapping<?>> columnMappings = new ArrayList<>();
 
         public Builder<T> withTable(SqlTable table) {
             this.table = table;
@@ -78,7 +78,7 @@ public Builder<T> withRecord(T record) {
             return this;
         }
 
-        public Builder<T> withColumnMappings(List<AbstractColumnMapping> columnMappings) {
+        public Builder<T> withColumnMappings(List<AbstractColumnMapping<?>> columnMappings) {
             this.columnMappings.addAll(columnMappings);
             return this;
         }

src/main/java/org/mybatis/dynamic/sql/insert/MultiRowInsertDSL.java

@@ -33,7 +33,7 @@ public class MultiRowInsertDSL<T> implements Buildable<MultiRowInsertModel<T>> {
 
     private Collection<T> records;
     private SqlTable table;
-    private List<AbstractColumnMapping> columnMappings = new ArrayList<>();
+    private List<AbstractColumnMapping<?>> columnMappings = new ArrayList<>();
 
     private MultiRowInsertDSL(Collection<T> records, SqlTable table) {
         this.records = records;

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

@@ -56,13 +56,13 @@ private String calculateInsertStatement(List<Optional<FieldAndValueAndParameters
                 + spaceBefore(calculateValuesPhrase(fieldsAndValues));
     }
 
-    private Function<AbstractColumnMapping, Optional<FieldAndValueAndParameters>> toFieldAndValue(
+    private Function<AbstractColumnMapping<?>, Optional<FieldAndValueAndParameters>> toFieldAndValue(
             GeneralInsertValuePhraseVisitor visitor) {
         return insertMapping -> toFieldAndValue(visitor, insertMapping);
     }
 
-    private Optional<FieldAndValueAndParameters> toFieldAndValue(GeneralInsertValuePhraseVisitor visitor,
-            AbstractColumnMapping insertMapping) {
+    private <T> Optional<FieldAndValueAndParameters> toFieldAndValue(GeneralInsertValuePhraseVisitor visitor,
+            AbstractColumnMapping<T> insertMapping) {
         return insertMapping.accept(visitor);
     }