Simple Hibernate Example with Enums

[Christopher Rygaard]

Simple Enum Example

This is the simplest stand-alone Hibernate Enum example I could cook up.

The interesting part is the annotation on MyPersistentObject._myEnum. Also notice that I don't need to register the Enum with Hibernate (eg. call addAnnotatedClass(...)).

Notice: This is provided with no warranty whatsoever. Use at your own risk.

This is the Enum:

public enum MyEnum
{
   MY_ENUM_1,
   MY_ENUM_2;
}

This is the class that has an instance of the Enum:

@javax.persistence.Entity
public class MyPersistentObject
{
   @javax.persistence.Id
   @javax.persistence.GeneratedValue( generator = "increment" )
   @org.hibernate.annotations.GenericGenerator( name = "increment", strategy = "increment" )
   private Long           _persistenceID;
   private String         _title;
   @javax.persistence.Enumerated( javax.persistence.EnumType.STRING )
   private MyEnum         _myEnum;

   private MyPersistentObject()
   {
   }

   public MyPersistentObject( String title,
                              MyEnum myEnum )
   {
      _title = title;
      _myEnum = myEnum;
   }

   public String getTitle()
   {
      return _title;
   }

   public MyEnum getMyEnum()
   {
      return _myEnum;
   }
}

This is how I use it:

public class HibernateExample
{
   private org.hibernate.SessionFactory _sessionFactory;
   private MyPersistentObject           _myPersistentObject1;
   private MyPersistentObject           _myPersistentObject2;
   private MyPersistentObject           _myPersistentObject3;

   final static public void main( String arguments[] )
   {
      HibernateExample example;
      example = new HibernateExample();
      example.createPersistentObjects();
      example.readAndDisplayPersistentObjects();
      example.manipulatePersistentObjects();
      example.readAndDisplayPersistentObjects();
      example.cleanup();
   }

   private HibernateExample()
   {
      org.hibernate.cfg.Configuration configuration;

      java.util.logging.Logger.getLogger( "org.hibernate" ).setLevel( java.util.logging.Level.SEVERE );  // Supress Hibernate's excessive output

      configuration = new org.hibernate.cfg.Configuration();
      configuration.setProperty( "hibernate.dialect",                 "org.hibernate.dialect.H2Dialect" );                                          // Customize this for your particular RDBMS
      configuration.setProperty( "hibernate.connection.driver_class", "org.h2.Driver" );                                                            // Customize this for your particular RDBMS
      configuration.setProperty( "hibernate.connection.url",          "jdbc:h2:file:C:/SFTData/SFTDatabases/SFTInterfaceData;DB_CLOSE_DELAY=-1" );  // Customize this for your particular RDBMS
      configuration.setProperty( "hibernate.connection.username",     "sa" );                                                                       // Customize this for your particular RDBMS
      configuration.setProperty( "hibernate.connection.password",     "" );     // Customize this for your particular RDBMS installation
      configuration.setProperty( "hibernate.connection.pool_size",    "1" );    // Customize this for your particular RDBMS installation
      configuration.setProperty( "hibernate.cache.provider_class",    "org.hibernate.cache.internal.NoCacheProvider" );  // This is not ready for prime-time
      configuration.setProperty( "hibernate.show_sql",                "false" );  // Tell hibernate to not echo the SQL
      configuration.setProperty( "hibernate.hbm2ddl.auto",            "create" );
      configuration.addAnnotatedClass( MyPersistentObject.class );

      _sessionFactory = configuration.buildSessionFactory();
   }

   final private void createPersistentObjects()
   {
      org.hibernate.Session     session;
      boolean                   committed;
      org.hibernate.Transaction transaction;

      session = _sessionFactory.openSession();

      try
      {
         committed = false;
         transaction = session.beginTransaction();

         try
         {
            _myPersistentObject1 = new MyPersistentObject( "First persistent object", MyEnum.MY_ENUM_1 );
            session.save( _myPersistentObject1 );

            _myPersistentObject2 = new MyPersistentObject( "A second persistent object", MyEnum.MY_ENUM_2 );
            session.save( _myPersistentObject2 );

            transaction.commit();
            committed = true;
         }
         finally
         {
            if ( !committed )
            {
               transaction.rollback();
            }
         }
      }
      finally
      {
         session.close();
      }
   }

   final private void manipulatePersistentObjects()
   {
      org.hibernate.Session     session;
      org.hibernate.Transaction transaction;

      session = _sessionFactory.openSession();

      try
      {
         transaction = session.beginTransaction();

         _myPersistentObject3 = new MyPersistentObject( "A third persistent object", MyEnum.MY_ENUM_1 );
         session.save( _myPersistentObject3 );

         session.delete( _myPersistentObject2 );

         transaction.commit();
      }
      finally
      {
         session.close();
      }
   }

   final private void readAndDisplayPersistentObjects()
   {
      org.hibernate.Session session;
      java.util.List<MyPersistentObject> result;

      session = _sessionFactory.openSession();

      try
      {
         session.beginTransaction();

         result = (java.util.List<MyPersistentObject>)( session.createQuery("from MyPersistentObject").list() );

         for ( MyPersistentObject persistentObject: result )
         {
            System.out.println( "MyPersistentObject (" + persistentObject.getMyEnum() + ") : " + persistentObject.getTitle() );
         }

         session.getTransaction().commit();
      }
      finally
      {
         session.close();
      }
   }

   final private void cleanup()
   {
      if ( _sessionFactory != null )
      {
         _sessionFactory.close();
      }
   }
}