Reputation: 4966

Hibernate map enum to varchar

Suppose I have this enum:

public enum TestEnum { EXAMPLE, FURTHER_EXAMPLE, LAST_EXAMPLE }

With this mapping in the .hbm:

<property name="testEnum" column="TEST_COLUMN">
    <type name="org.hibernate.type.EnumType">
        <param name="enumClass">p.a.c.k.TestEnum</param>
    </type>
 </property>

The enum is sent to the database as 0, 1, 2. I'd like the values to be instead stored as EXAMPLE, FURTHER_EXAMPLE or LAST_EXAMPLE in a varchar column.

How can I map enum to a varchar column?

Upvotes: 22

Answers (4)

Monim

Reputation: 3577

You can use annotations like this:

public class MyClass {
    TestEnum testEnum;
    @column(name="TEST_COLUMN")
    @Enumerated(EnumType.STRING)
    public TestEnum getTestEnum(){
        this.testEnum;
    }
}

Upvotes: 5

kandarp

Reputation: 5047

If you want to store any enum's value as varchar in database, please follow below steps.

Hibernate provides an UserTpe interface. We need to create a class which implements UserType interface.

import java.io.Serializable;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Types;

import org.hibernate.HibernateException;
import org.hibernate.usertype.UserType;

public class EnumUserType<E extends Enum<E>> implements UserType {
   private Class<E> clazz = null;

   protected EnumUserType(Class<E> c) {
       this.clazz = c;
   }

   private static final int[] SQL_TYPES = { Types.VARCHAR };

   public int[] sqlTypes() {
           return SQL_TYPES;
   }

   public Class returnedClass() {
       return clazz;
   }

   public Object nullSafeGet(ResultSet resultSet, String[] names, Object owner)
        throws HibernateException, SQLException {

       String name = resultSet.getString(names[0]);

       E result = null;
       if (!resultSet.wasNull()) {
           result = Enum.valueOf(clazz, name);

       }
       return result;
   }

   public void nullSafeSet(PreparedStatement preparedStatement, Object value,
        int index) throws HibernateException, SQLException {

       if (null == value) {
           preparedStatement.setNull(index, Types.VARCHAR);
       } else {
           preparedStatement.setString(index, ((Enum) value).name());
       }
   }

   public Object deepCopy(Object value) throws HibernateException {
       return value;
   }

   public boolean isMutable() {
       return false;
   }

   public Object assemble(Serializable cached,Object owner) throws HibernateException {
       return cached;
   }

   public Serializable disassemble(Object value) throws HibernateException {
       return (Serializable) value;
   }

   public Object replace(Object original, Object target, Object owner)
        throws HibernateException {
       return original;
   }

   public int hashCode(Object x) throws HibernateException {
       return x.hashCode();
   }

   public boolean equals(Object x, Object y) throws HibernateException {
       if (x == y)
           return true;
       if (null == x || null == y)
           return false;
       return x.equals(y);
   }
}

Suppose I have a EncryptionStatus Enum.

import java.io.Serializable;
import com.google.gwt.user.client.rpc.IsSerializable;

public enum EncryptionStatus implements IsSerializable, Serializable {
    PLAIN, HASH, RE_HASH, SUPER_HASH, SUPER_REHASH, OPEN, ENCRYPT, RE_ENCRYPT
}

We need to create a class which extends our created EnumUserType>.

public class EncryptionStatusType extends EnumUserType<EncryptionStatus>{

   public  EncryptionStatusType() {     
       super(EncryptionStatus.class);
   }
}