Implement EnhancedUserType in a new DescriptorImmutableType in Hibern…

…ate 6 modules #633
vladmihalcea · Jun 16, 2023 · 5fe3d3b · 5fe3d3b
1 parent 4887e9c
commit 5fe3d3b
Show file tree

Hide file tree

Showing 59 changed files with 840 additions and 116 deletions.
diff --git a/...rnate-60/src/main/java/io/hypersistence/utils/hibernate/type/DescriptorImmutableType.java b/...rnate-60/src/main/java/io/hypersistence/utils/hibernate/type/DescriptorImmutableType.java
@@ -0,0 +1,73 @@
+package io.hypersistence.utils.hibernate.type;
+
+import io.hypersistence.utils.hibernate.type.util.Configuration;
+import org.hibernate.HibernateException;
+import org.hibernate.engine.spi.SharedSessionContractImplementor;
+import org.hibernate.query.BindableType;
+import org.hibernate.query.sqm.SqmExpressible;
+import org.hibernate.type.descriptor.java.JavaType;
+import org.hibernate.type.descriptor.jdbc.JdbcType;
+import org.hibernate.usertype.UserType;
+
+import java.sql.PreparedStatement;
+import java.sql.ResultSet;
+import java.sql.SQLException;
+
+/**
+ * Very convenient base class for implementing immutable object types using Hibernate {@link UserType} using the {@link JdbcType} and {@link JavaType} descriptors.
+ *
+ * @author Vlad Mihalcea
+ */
+public abstract class DescriptorImmutableType<T, JDBC extends JdbcType, JAVA extends JavaType<T>> extends ImmutableType<T> implements BindableType<T>, SqmExpressible<T> {
+
+    private final JDBC jdbcTypeDescriptor;
+    private final JAVA javaTypeDescriptor;
+
+    public DescriptorImmutableType(Class<T> clazz, JDBC jdbcTypeDescriptor, JAVA javaTypeDescriptor) {
+        super(clazz);
+        this.jdbcTypeDescriptor = jdbcTypeDescriptor;
+        this.javaTypeDescriptor = javaTypeDescriptor;
+    }
+
+    public DescriptorImmutableType(Class<T> clazz, JDBC jdbcTypeDescriptor, JAVA javaTypeDescriptor, Configuration configuration) {
+        super(clazz, configuration);
+        this.jdbcTypeDescriptor = jdbcTypeDescriptor;
+        this.javaTypeDescriptor = javaTypeDescriptor;
+    }
+
+    @Override
+    public T nullSafeGet(ResultSet rs, int position, SharedSessionContractImplementor session, Object owner) throws
+        SQLException {
+        return jdbcTypeDescriptor.getExtractor(javaTypeDescriptor).extract(rs, position, session);
+    }
+
+    @Override
+    public void nullSafeSet(PreparedStatement st, Object value, int index, SharedSessionContractImplementor session) throws HibernateException, SQLException {
+        jdbcTypeDescriptor.getBinder(javaTypeDescriptor).bind(st, (T) value, index, session);
+    }
+
+    @Override
+    protected T get(ResultSet rs, int position, SharedSessionContractImplementor session, Object owner) throws SQLException {
+        return nullSafeGet(rs, position, session, owner);
+    }
+
+    @Override
+    protected void set(PreparedStatement st, T value, int index, SharedSessionContractImplementor session) throws SQLException {
+        nullSafeSet(st, value, index, session);
+    }
+
+    @Override
+    public int getSqlType() {
+        return jdbcTypeDescriptor.getJdbcTypeCode();
+    }
+
+    @Override
+    public Class<T> getBindableJavaType() {
+        return returnedClass();
+    }
+
+    @Override
+    public JavaType<T> getExpressibleJavaType() {
+        return javaTypeDescriptor;
+    }
+}
diff --git a/...rc/main/java/io/hypersistence/utils/hibernate/type/ImmutableDynamicParameterizedType.java b/...rc/main/java/io/hypersistence/utils/hibernate/type/ImmutableDynamicParameterizedType.java
@@ -1,12 +1,14 @@
 package io.hypersistence.utils.hibernate.type;
 
 import io.hypersistence.utils.hibernate.type.util.Configuration;
+import org.hibernate.HibernateException;
 import org.hibernate.usertype.DynamicParameterizedType;
+import org.hibernate.usertype.EnhancedUserType;
 
 /**
  * @author Vlad Mihalcea
  */
-public abstract class ImmutableDynamicParameterizedType<T> extends ImmutableType<T> implements DynamicParameterizedType {
+public abstract class ImmutableDynamicParameterizedType<T> extends ImmutableType<T> implements DynamicParameterizedType, EnhancedUserType<T> {
 
     /**
      * {@inheritDoc}
@@ -21,4 +23,14 @@ public ImmutableDynamicParameterizedType(Class<T> clazz) {
     public ImmutableDynamicParameterizedType(Class<T> clazz, Configuration configuration) {
         super(clazz, configuration);
     }
+
+    @Override
+    public String toSqlLiteral(T o) {
+        return toString(o);
+    }
+
+    @Override
+    public String toString(T o) throws HibernateException {
+        return o != null ? o.toString() : null;
+    }
 }
diff --git a/...utils-hibernate-60/src/main/java/io/hypersistence/utils/hibernate/type/ImmutableType.java b/...utils-hibernate-60/src/main/java/io/hypersistence/utils/hibernate/type/ImmutableType.java
@@ -11,6 +11,7 @@
 import org.hibernate.type.ForeignKeyDirection;
 import org.hibernate.type.Type;
 import org.hibernate.type.descriptor.java.IncomparableComparator;
+import org.hibernate.usertype.EnhancedUserType;
 import org.hibernate.usertype.UserType;
 
 import java.io.Serializable;
@@ -28,7 +29,7 @@
  *
  * @author Vlad Mihalcea
  */
-public abstract class ImmutableType<T> implements UserType<T>, Type {
+public abstract class ImmutableType<T> implements UserType<T>, Type, EnhancedUserType<T> {
 
     private final Configuration configuration;
 
@@ -283,4 +284,14 @@ public boolean[] toColumnNullness(Object value, Mapping mapping) {
     public int[] getSqlTypeCodes(Mapping mapping) throws MappingException {
         return new int[]{getSqlType()};
     }
-}
+
+    @Override
+    public String toSqlLiteral(T o) {
+        return toString(o);
+    }
+
+    @Override
+    public String toString(T o) throws HibernateException {
+        return o != null ? o.toString() : null;
+    }
+}
diff --git a/...e-utils-hibernate-60/src/main/java/io/hypersistence/utils/hibernate/type/MutableType.java b/...e-utils-hibernate-60/src/main/java/io/hypersistence/utils/hibernate/type/MutableType.java
@@ -29,7 +29,7 @@
  */
 public abstract class MutableType<T, JDBC extends JdbcType, JAVA extends JavaType<T>> implements UserType<T>, BindableType<T>, SqmExpressible<T>, BasicValuedMapping {
 
-    private final Class<T> returnedClass;
+    private final Class<T> clazz;
 
     private final JDBC jdbcTypeDescriptor;
     private final JAVA javaTypeDescriptor;
@@ -41,25 +41,25 @@ public abstract class MutableType<T, JDBC extends JdbcType, JAVA extends JavaTyp
      * Initialization constructor taking the {@link Class}
      * and using the default {@link Configuration} object.
      *
-     * @param returnedClass The class returned by {@link UserType#nullSafeGet(ResultSet, int, SharedSessionContractImplementor, Object)}.
+     * @param clazz The class returned by {@link UserType#nullSafeGet(ResultSet, int, SharedSessionContractImplementor, Object)}.
      * @param jdbcTypeDescriptor the JDBC type descriptor
      * @param javaTypeDescriptor the Java type descriptor
      */
-    public MutableType(Class<T> returnedClass, JDBC jdbcTypeDescriptor, JAVA javaTypeDescriptor) {
-        this(returnedClass, jdbcTypeDescriptor, javaTypeDescriptor, Configuration.INSTANCE);
+    public MutableType(Class<T> clazz, JDBC jdbcTypeDescriptor, JAVA javaTypeDescriptor) {
+        this(clazz, jdbcTypeDescriptor, javaTypeDescriptor, Configuration.INSTANCE);
     }
 
     /**
      * Initialization constructor taking the {@link Class}
      * and using the provided {@link Configuration} object.
      *
-     * @param returnedClass The class returned by {@link UserType#nullSafeGet(ResultSet, int, SharedSessionContractImplementor, Object)}.
+     * @param clazz The class returned by {@link UserType#nullSafeGet(ResultSet, int, SharedSessionContractImplementor, Object)}.
      * @param jdbcTypeDescriptor the JDBC type descriptor
      * @param javaTypeDescriptor the Java type descriptor
      * @param configuration the configuration
      */
-    public MutableType(Class<T> returnedClass, JDBC jdbcTypeDescriptor, JAVA javaTypeDescriptor, Configuration configuration) {
-        this.returnedClass = returnedClass;
+    public MutableType(Class<T> clazz, JDBC jdbcTypeDescriptor, JAVA javaTypeDescriptor, Configuration configuration) {
+        this.clazz = clazz;
         this.jdbcTypeDescriptor = jdbcTypeDescriptor;
         this.javaTypeDescriptor = javaTypeDescriptor;
         this.configuration = configuration;
@@ -137,12 +137,12 @@ public int getSqlType() {
 
     @Override
     public Class<T> returnedClass() {
-        return returnedClass;
+        return clazz;
     }
 
     @Override
     public Class<T> getBindableJavaType() {
-        return returnedClass;
+        return clazz;
     }
 
     @Override

diff --git a/...ernate-60/src/main/java/io/hypersistence/utils/hibernate/type/basic/Iso8601MonthType.java b/...ernate-60/src/main/java/io/hypersistence/utils/hibernate/type/basic/Iso8601MonthType.java
@@ -1,8 +1,9 @@
 package io.hypersistence.utils.hibernate.type.basic;
 
-import io.hypersistence.utils.hibernate.type.MutableType;
+import io.hypersistence.utils.hibernate.type.DescriptorImmutableType;
 import io.hypersistence.utils.hibernate.type.basic.internal.Iso8601MonthMonthTypeDescriptor;
 import io.hypersistence.utils.hibernate.type.util.Configuration;
+import org.hibernate.HibernateException;
 import org.hibernate.type.descriptor.jdbc.IntegerJdbcType;
 
 import java.time.Month;
@@ -14,7 +15,7 @@
  *
  * @author Martin Panzer
  */
-public class Iso8601MonthType extends MutableType<Month, IntegerJdbcType, Iso8601MonthMonthTypeDescriptor> {
+public class Iso8601MonthType extends DescriptorImmutableType<Month, IntegerJdbcType, Iso8601MonthMonthTypeDescriptor> {
 
     public static final Iso8601MonthType INSTANCE = new Iso8601MonthType();
 
@@ -42,4 +43,9 @@ public Iso8601MonthType(org.hibernate.type.spi.TypeBootstrapContext typeBootstra
     public String getName() {
         return "month";
     }
+
+    @Override
+    public Month fromStringValue(CharSequence sequence) throws HibernateException {
+        return sequence != null ? Month.valueOf((String) sequence) : null;
+    }
 }
diff --git a/...ernate-60/src/main/java/io/hypersistence/utils/hibernate/type/basic/MonthDayDateType.java b/...ernate-60/src/main/java/io/hypersistence/utils/hibernate/type/basic/MonthDayDateType.java
@@ -1,10 +1,13 @@
 package io.hypersistence.utils.hibernate.type.basic;
 
+import io.hypersistence.utils.hibernate.type.DescriptorImmutableType;
 import io.hypersistence.utils.hibernate.type.MutableType;
 import io.hypersistence.utils.hibernate.type.basic.internal.MonthDayTypeDescriptor;
 import io.hypersistence.utils.hibernate.type.util.Configuration;
+import org.hibernate.HibernateException;
 import org.hibernate.type.descriptor.jdbc.DateJdbcType;
 
+import java.time.Month;
 import java.time.MonthDay;
 
 /**
@@ -13,7 +16,7 @@
  * @author Mladen Savic (mladensavic94@gmail.com)
  */
 
-public class MonthDayDateType extends MutableType<MonthDay, DateJdbcType, MonthDayTypeDescriptor> {
+public class MonthDayDateType extends DescriptorImmutableType<MonthDay, DateJdbcType, MonthDayTypeDescriptor> {
 
     public static final MonthDayDateType INSTANCE = new MonthDayDateType();
 
@@ -32,4 +35,9 @@ public MonthDayDateType(org.hibernate.type.spi.TypeBootstrapContext typeBootstra
     public String getName() {
         return "monthday-date";
     }
+
+    @Override
+    public MonthDay fromStringValue(CharSequence sequence) throws HibernateException {
+        return sequence != null ? MonthDay.parse(sequence) : null;
+    }
 }
diff --git a/...ate-60/src/main/java/io/hypersistence/utils/hibernate/type/basic/MonthDayIntegerType.java b/...ate-60/src/main/java/io/hypersistence/utils/hibernate/type/basic/MonthDayIntegerType.java
@@ -1,8 +1,9 @@
 package io.hypersistence.utils.hibernate.type.basic;
 
-import io.hypersistence.utils.hibernate.type.MutableType;
+import io.hypersistence.utils.hibernate.type.DescriptorImmutableType;
 import io.hypersistence.utils.hibernate.type.basic.internal.MonthDayTypeDescriptor;
 import io.hypersistence.utils.hibernate.type.util.Configuration;
+import org.hibernate.HibernateException;
 import org.hibernate.type.descriptor.jdbc.IntegerJdbcType;
 
 import java.time.MonthDay;
@@ -12,7 +13,7 @@
  *
  * @author Mladen Savic (mladensavic94@gmail.com)
  */
-public class MonthDayIntegerType extends MutableType<MonthDay, IntegerJdbcType, MonthDayTypeDescriptor> {
+public class MonthDayIntegerType extends DescriptorImmutableType<MonthDay, IntegerJdbcType, MonthDayTypeDescriptor> {
 
     public static final MonthDayIntegerType INSTANCE = new MonthDayIntegerType();
 
@@ -40,4 +41,9 @@ public MonthDayIntegerType(org.hibernate.type.spi.TypeBootstrapContext typeBoots
     public String getName() {
         return "monthday-int";
     }
+
+    @Override
+    public MonthDay fromStringValue(CharSequence sequence) throws HibernateException {
+        return sequence != null ? MonthDay.parse(sequence) : null;
+    }
 }
diff --git a/...e-60/src/main/java/io/hypersistence/utils/hibernate/type/basic/NullableCharacterType.java b/...e-60/src/main/java/io/hypersistence/utils/hibernate/type/basic/NullableCharacterType.java
@@ -2,6 +2,7 @@
 
 import io.hypersistence.utils.hibernate.type.ImmutableType;
 import io.hypersistence.utils.hibernate.type.util.Configuration;
+import org.hibernate.HibernateException;
 import org.hibernate.engine.spi.SharedSessionContractImplementor;
 
 import java.sql.PreparedStatement;
@@ -49,4 +50,9 @@ public void set(PreparedStatement st, Character value, int index,
             st.setString(index, String.valueOf(value));
         }
     }
+
+    @Override
+    public Character fromStringValue(CharSequence sequence) throws HibernateException {
+        return sequence != null ? sequence.charAt(0) : null;
+    }
 }
diff --git a/...te-60/src/main/java/io/hypersistence/utils/hibernate/type/basic/PostgreSQLCITextType.java b/...te-60/src/main/java/io/hypersistence/utils/hibernate/type/basic/PostgreSQLCITextType.java
@@ -2,6 +2,7 @@
 
 import io.hypersistence.utils.hibernate.type.ImmutableType;
 import io.hypersistence.utils.hibernate.type.util.Configuration;
+import org.hibernate.HibernateException;
 import org.hibernate.engine.spi.SharedSessionContractImplementor;
 
 import java.sql.PreparedStatement;
@@ -42,4 +43,9 @@ protected String get(ResultSet rs, int position, SharedSessionContractImplemento
     protected void set(PreparedStatement st, String value, int index, SharedSessionContractImplementor session) throws SQLException {
         st.setObject(index, value, Types.OTHER);
     }
+
+    @Override
+    public String fromStringValue(CharSequence sequence) throws HibernateException {
+        return (String) sequence;
+    }
 }
diff --git a/...nate-60/src/main/java/io/hypersistence/utils/hibernate/type/basic/PostgreSQLEnumType.java b/...nate-60/src/main/java/io/hypersistence/utils/hibernate/type/basic/PostgreSQLEnumType.java
@@ -2,6 +2,7 @@
 
 import io.hypersistence.utils.hibernate.type.ImmutableDynamicParameterizedType;
 import io.hypersistence.utils.hibernate.util.ReflectionUtils;
+import org.hibernate.HibernateException;
 import org.hibernate.engine.spi.SharedSessionContractImplementor;
 import org.hibernate.metamodel.model.convert.spi.EnumValueConverter;
 import org.hibernate.type.EnumType;
@@ -12,6 +13,7 @@
 import org.hibernate.type.descriptor.jdbc.JdbcType;
 import org.hibernate.type.descriptor.jdbc.ObjectJdbcType;
 import org.hibernate.type.spi.TypeConfiguration;
+import org.hibernate.usertype.DynamicParameterizedType;
 
 import java.sql.PreparedStatement;
 import java.sql.ResultSet;
@@ -85,4 +87,9 @@ public Class<Enum> returnedClass() {
     public int getSqlType() {
         return Types.OTHER;
     }
+
+    @Override
+    public Enum fromStringValue(CharSequence charSequence) throws HibernateException {
+        return charSequence != null ? Enum.valueOf(enumType.returnedClass(), (String) charSequence) : null;
+    }
 }
diff --git a/...te-60/src/main/java/io/hypersistence/utils/hibernate/type/basic/PostgreSQLHStoreType.java b/...te-60/src/main/java/io/hypersistence/utils/hibernate/type/basic/PostgreSQLHStoreType.java
@@ -1,7 +1,9 @@
 package io.hypersistence.utils.hibernate.type.basic;
 
 import io.hypersistence.utils.hibernate.type.ImmutableType;
+import io.hypersistence.utils.hibernate.type.json.internal.JacksonUtil;
 import io.hypersistence.utils.hibernate.type.util.Configuration;
+import org.hibernate.HibernateException;
 import org.hibernate.engine.spi.SharedSessionContractImplementor;
 
 import java.sql.PreparedStatement;
@@ -47,4 +49,18 @@ protected Map get(ResultSet rs, int position, SharedSessionContractImplementor s
     protected void set(PreparedStatement st, Map value, int index, SharedSessionContractImplementor session) throws SQLException {
         st.setObject(index, value);
     }
+
+    @Override
+    public Map fromStringValue(CharSequence sequence) throws HibernateException {
+        try {
+            return JacksonUtil.fromString((String) sequence, Map.class);
+        } catch (Exception e) {
+            throw new IllegalArgumentException(
+                String.format(
+                    "Could not transform the [%s] value to a Map!",
+                    sequence
+                )
+            );
+        }
+    }
 }