tomee-9.0/examples/jpa-enumerated.html - tomee-site-pub - Git at Google

 <!DOCTYPE html>
 <html lang="en">

 <head>
 	<meta charset="UTF-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<title>Apache TomEE</title>
 	<meta name="description"
 		  content="Apache TomEE is a lightweight, yet powerful, JavaEE Application server with feature rich tooling." />
 	<meta name="keywords" content="tomee,asf,apache,javaee,jee,shade,embedded,test,junit,applicationcomposer,maven,arquillian" />
 	<meta name="author" content="Luka Cvetinovic for Codrops" />
 	<link rel="icon" href="../../favicon.ico">
 	<link rel="icon"  type="image/png" href="../../favicon.png">
 	<meta name="msapplication-TileColor" content="#80287a">
 	<meta name="theme-color" content="#80287a">
 	<link rel="stylesheet" type="text/css" href="../../css/normalize.css">
 	<link rel="stylesheet" type="text/css" href="../../css/bootstrap.css">
 	<link rel="stylesheet" type="text/css" href="../../css/owl.css">
 	<link rel="stylesheet" type="text/css" href="../../css/animate.css">
 	<link rel="stylesheet" type="text/css" href="../../fonts/font-awesome-4.1.0/css/font-awesome.min.css">
 	<link rel="stylesheet" type="text/css" href="../../fonts/eleganticons/et-icons.css">
 	<link rel="stylesheet" type="text/css" href="../../css/jqtree.css">
 	<link rel="stylesheet" type="text/css" href="../../css/idea.css">
 	<link rel="stylesheet" type="text/css" href="../../css/cardio.css">

 	<script type="text/javascript">

       var _gaq = _gaq || [];
       _gaq.push(['_setAccount', 'UA-2717626-1']);
       _gaq.push(['_setDomainName', 'apache.org']);
       _gaq.push(['_trackPageview']);

       (function() {
         var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
         ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
         var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
       })();

     </script>
 </head>

 <body>
     <div class="preloader">
 		<img src="../../img/loader.gif" alt="Preloader image">
 	</div>
 	    <nav class="navbar">
 		<div class="container">
 		  <div class="row">          <div class="col-md-12">

 			<!-- Brand and toggle get grouped for better mobile display -->
 			<div class="navbar-header">
 				<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
 					<span class="sr-only">Toggle navigation</span>
 					<span class="icon-bar"></span>
 					<span class="icon-bar"></span>
 					<span class="icon-bar"></span>
 				</button>
 				<a class="navbar-brand" href="/">
 				    <span>


                         <img src="../../img/logo-active.png">


                     </span>
 				    Apache TomEE
                 </a>
 			</div>
 			<!-- Collect the nav links, forms, and other content for toggling -->
 			<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
 				<ul class="nav navbar-nav navbar-right main-nav">
 					<li><a href="../../docs.html">Documentation</a></li>
 					<li><a href="../../community/index.html">Community</a></li>
 					<li><a href="../../security/security.html">Security</a></li>
 					<li><a href="../../download-ng.html">Downloads</a></li>
 				</ul>
 			</div>
 			<!-- /.navbar-collapse -->
 		   </div></div>
 		</div>
 		<!-- /.container-fluid -->
 	</nav>


     <div id="main-block" class="container main-block">
         <div class="row title">
           <div class="col-md-12">
             <div class='page-header'>

               <h1>JPA and Enums via @Enumerated</h1>
             </div>
           </div>
         </div>
         <div class="row">

             <div class="col-md-12">
                 <div id="preamble">
 <div class="sectionbody">
 <div class="paragraph">
 <p>It can sometimes be desirable to have a Java <code>enum</code> type to represent a particular column in a database. JPA supports converting database data to and from Java <code>enum</code> types via the <code>@jakarta.persistence.Enumerated</code> annotation.</p>
 </div>
 <div class="paragraph">
 <p>This example will show basic <code>@Enumerated</code> usage in a field of an <code>@Entity</code> as well as <code>enum</code>s as the parameter of a <code>Query</code>.  We&#8217;ll also see that the actual database representation can be effectively <code>String</code> or <code>int</code>.</p>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="_enum">Enum</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>For our example we will leverage the familiar <code>Movie</code> entity and add a new field to represent the MPAA.org rating of the movie.  This is defined via a simple <code>enum</code> that requires no JPA specific annotations.</p>
 </div>
 <div class="literalblock">
 <div class="content">
 <pre>public enum Rating {
     UNRATED,
     G,
     PG,
     PG13,
     R,
     NC17
 }</pre>
 </div>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="__enumerated">@Enumerated</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>In our <code>Movie</code> entity, we add a <code>rating</code> field of the enum type <code>Rating</code> and annotate it with <code>@Enumerated(EnumType.STRING)</code> to declare that its value should be converted from what is effectively a <code>String</code> in the database to the <code>Rating</code> type.</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="highlight"><code class="language-java" data-lang="java">@Entity
 public class Movie {

     @Id
     @GeneratedValue
     private int id;
     private String director;
     private String title;
     private int year;

     @Enumerated(EnumType.STRING)
     private Rating rating;

     public Movie() {
     }

     public Movie(String director, String title, int year, Rating rating) {
         this.director = director;
         this.title = title;
         this.year = year;
         this.rating = rating;
     }

     public String getDirector() {
         return director;
     }

     public void setDirector(String director) {
         this.director = director;
     }

     public String getTitle() {
         return title;
     }

     public void setTitle(String title) {
         this.title = title;
     }

     public int getYear() {
         return year;
     }

     public void setYear(int year) {
         this.year = year;
     }

     public Rating getRating() {
         return rating;
     }

     public void setRating(Rating rating) {
         this.rating = rating;
     }
 }</code></pre>
 </div>
 </div>
 <div class="paragraph">
 <p>The above is enough and we are effectively done.  For the sake of completeness we&#8217;ll show a sample <code>Query</code></p>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="_enum_in_jpql_query">Enum in JPQL Query</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>Note the <code>findByRating</code> method which creates a <code>Query</code> with a <code>rating</code> named parameter.  The key thing to notice is that the <code>rating</code> enum instance itself is passed into the
  <code>query.setParameter</code> method, <strong>not</strong> <code>rating.name()</code> or <code>rating.ordinal()</code>.</p>
 </div>
 <div class="paragraph">
 <p>Regardless if you use <code>EnumType.STRING</code> or <code>EnumType.ORDINAL</code>, you still always pass the enum itself in calls to <code>query.setParameter</code>.</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="highlight"><code class="language-java" data-lang="java">@Stateful
 public class Movies {

     @PersistenceContext(unitName = "movie-unit", type = PersistenceContextType.EXTENDED)
     private EntityManager entityManager;

     public void addMovie(Movie movie) {
         entityManager.persist(movie);
     }

     public void deleteMovie(Movie movie) {
         entityManager.remove(movie);
     }

     public List&lt;Movie&gt; findByRating(Rating rating) {
         final Query query = entityManager.createQuery("SELECT m FROM Movie as m WHERE m.rating = :rating");
         query.setParameter("rating", rating);
         return query.getResultList();
     }

     public List&lt;Movie&gt; getMovies() throws Exception {
         Query query = entityManager.createQuery("SELECT m from Movie as m");
         return query.getResultList();
     }

 }</code></pre>
 </div>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="_enumtype_string_vs_enumtype_ordinal">EnumType.STRING vs EnumType.ORDINAL</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>It is a matter of style how you would like your <code>enum</code> data represented in the database.  Either <code>name()</code> or <code>ordinal()</code> are supported:</p>
 </div>
 <div class="ulist">
 <ul>
 <li>
 <p><code>@Enumerated(EnumType.STRING) Rating rating</code> the value of <code>rating.name()</code> is written and read from the corresponding database column; e.g. <code>G</code>, <code>PG</code>, <code>PG13</code></p>
 </li>
 <li>
 <p><code>@Enumerated(EnumType.ORDINAL) Rating rating</code> the value of <code>rating.ordinal()</code> is written and read from the corresponding database column; e.g. <code>0</code>, <code>1</code>, <code>2</code></p>
 </li>
 </ul>
 </div>
 <div class="paragraph">
 <p>The default is <code>EnumType.ORDINAL</code></p>
 </div>
 <div class="paragraph">
 <p>There are advantages and disadvantages to each.</p>
 </div>
 <div class="sect2">
 <h3 id="_disadvantage_of_enumtype_ordinal">Disadvantage of EnumType.ORDINAL</h3>
 <div class="paragraph">
 <p>A disadvantage of <code>EnumType.ORDINAL</code> is the effect of time and the desire to keep <code>enums</code> in a logical order.  With <code>EnumType.ORDINAL</code> any new enum elements must be added to the
 <strong>end</strong> of the list or you will accidentally change the meaning of all your records.</p>
 </div>
 <div class="paragraph">
 <p>Let&#8217;s use our <code>Rating</code> enum and see how it would have had to evolve over time to keep up with changes in the MPAA.org ratings system.</p>
 </div>
 <div class="paragraph">
 <p><strong>1980</strong></p>
 </div>
 <div class="literalblock">
 <div class="content">
 <pre>public enum Rating {
     G,
     PG,
     R,
     UNRATED
 }</pre>
 </div>
 </div>
 <div class="paragraph">
 <p><strong>1984</strong> PG-13 is added</p>
 </div>
 <div class="literalblock">
 <div class="content">
 <pre>public enum Rating {
     G,
     PG,
     R,
     UNRATED,
     PG13
 }</pre>
 </div>
 </div>
 <div class="paragraph">
 <p><strong>1990</strong> NC-17 is added</p>
 </div>
 <div class="literalblock">
 <div class="content">
 <pre>public enum Rating {
     G,
     PG,
     R,
     UNRATED,
     PG13,
     NC17
 }</pre>
 </div>
 </div>
 <div class="paragraph">
 <p>If <code>EnumType.STRING</code> was used, then the enum could be reordered at anytime and would instead look as we have defined it originally with ratings starting at <code>G</code> and increasing in severity to <code>NC17</code> and eventually <code>UNRATED</code>.  With <code>EnumType.ORDINAL</code> the logical ordering would not have withstood the test of time as new values were added.</p>
 </div>
 <div class="paragraph">
 <p>If the order of the enum values is significant to your code, avoid <code>EnumType.ORDINAL</code></p>
 </div>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="_unit_testing_the_jpa_enumerated">Unit Testing the JPA @Enumerated</h2>
 <div class="sectionbody">
 <div class="listingblock">
 <div class="content">
 <pre class="highlight"><code class="language-java" data-lang="java">public class MoviesTest extends TestCase {

     public void test() throws Exception {

         final Properties p = new Properties();
         p.put("movieDatabase", "new://Resource?type=DataSource");
         p.put("movieDatabase.JdbcDriver", "org.hsqldb.jdbcDriver");
         p.put("movieDatabase.JdbcUrl", "jdbc:hsqldb:mem:moviedb");

         EJBContainer container = EJBContainer.createEJBContainer(p);
         final Context context = container.getContext();

         final Movies movies = (Movies) context.lookup("java:global/jpa-scratch/Movies");

         movies.addMovie(new Movie("James Frawley", "The Muppet Movie", 1979, Rating.G));
         movies.addMovie(new Movie("Jim Henson", "The Great Muppet Caper", 1981, Rating.G));
         movies.addMovie(new Movie("Frank Oz", "The Muppets Take Manhattan", 1984, Rating.G));
         movies.addMovie(new Movie("James Bobin", "The Muppets", 2011, Rating.PG));

         assertEquals("List.size()", 4, movies.getMovies().size());

         assertEquals("List.size()", 3, movies.findByRating(Rating.G).size());

         assertEquals("List.size()", 1, movies.findByRating(Rating.PG).size());

         assertEquals("List.size()", 0, movies.findByRating(Rating.R).size());

         container.close();
     }
 }</code></pre>
 </div>
 </div>
 </div>
 </div>
 <h1 id="_running" class="sect0">Running</h1>
 <div class="paragraph">
 <p>To run the example via maven:</p>
 </div>
 <div class="literalblock">
 <div class="content">
 <pre>cd jpa-enumerated
 mvn clean install</pre>
 </div>
 </div>
 <div class="paragraph">
 <p>Which will generate output similar to the following:</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="highlight"><code class="language-console" data-lang="console">-------------------------------------------------------
  T E S T S
 -------------------------------------------------------
 Running org.superbiz.jpa.enums.MoviesTest
 Apache OpenEJB 4.0.0-beta-2    build: 20120115-08:26
 http://tomee.apache.org/
 INFO - openejb.home = /Users/dblevins/openejb/examples/jpa-enumerated
 INFO - openejb.base = /Users/dblevins/openejb/examples/jpa-enumerated
 INFO - Using 'jakarta.ejb.embeddable.EJBContainer=true'
 INFO - Configuring Service(id=Default Security Service, type=SecurityService, provider-id=Default Security Service)
 INFO - Configuring Service(id=Default Transaction Manager, type=TransactionManager, provider-id=Default Transaction Manager)
 INFO - Configuring Service(id=movieDatabase, type=Resource, provider-id=Default JDBC Database)
 INFO - Found EjbModule in classpath: /Users/dblevins/openejb/examples/jpa-enumerated/target/classes
 INFO - Beginning load: /Users/dblevins/openejb/examples/jpa-enumerated/target/classes
 INFO - Configuring enterprise application: /Users/dblevins/openejb/examples/jpa-enumerated
 INFO - Configuring Service(id=Default Stateful Container, type=Container, provider-id=Default Stateful Container)
 INFO - Auto-creating a container for bean Movies: Container(type=STATEFUL, id=Default Stateful Container)
 INFO - Configuring Service(id=Default Managed Container, type=Container, provider-id=Default Managed Container)
 INFO - Auto-creating a container for bean org.superbiz.jpa.enums.MoviesTest: Container(type=MANAGED, id=Default Managed Container)
 INFO - Configuring PersistenceUnit(name=movie-unit)
 INFO - Auto-creating a Resource with id 'movieDatabaseNonJta' of type 'DataSource for 'movie-unit'.
 INFO - Configuring Service(id=movieDatabaseNonJta, type=Resource, provider-id=movieDatabase)
 INFO - Adjusting PersistenceUnit movie-unit &lt;non-jta-data-source&gt; to Resource ID 'movieDatabaseNonJta' from 'movieDatabaseUnmanaged'
 INFO - Enterprise application "/Users/dblevins/openejb/examples/jpa-enumerated" loaded.
 INFO - Assembling app: /Users/dblevins/openejb/examples/jpa-enumerated
 INFO - PersistenceUnit(name=movie-unit, provider=org.apache.openjpa.persistence.PersistenceProviderImpl) - provider time 406ms
 INFO - Jndi(name="java:global/jpa-enumerated/Movies!org.superbiz.jpa.enums.Movies")
 INFO - Jndi(name="java:global/jpa-enumerated/Movies")
 INFO - Created Ejb(deployment-id=Movies, ejb-name=Movies, container=Default Stateful Container)
 INFO - Started Ejb(deployment-id=Movies, ejb-name=Movies, container=Default Stateful Container)
 INFO - Deployed Application(path=/Users/dblevins/openejb/examples/jpa-enumerated)
 INFO - Undeploying app: /Users/dblevins/openejb/examples/jpa-enumerated
 INFO - Closing DataSource: movieDatabase
 INFO - Closing DataSource: movieDatabaseNonJta
 Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 2.831 sec

 Results :

 Tests run: 1, Failures: 0, Errors: 0, Skipped: 0</code></pre>
 </div>
 </div>
             </div>

         </div>
     </div>
 <footer>
 		<div class="container">
 			<div class="row">
 				<div class="col-sm-6 text-center-mobile">
 					<h3 class="white">Be simple.  Be certified. Be Tomcat.</h3>
 					<h5 class="light regular light-white">"A good application in a good server"</h5>
 					<ul class="social-footer">
 						<li><a href="https://www.facebook.com/ApacheTomEE/"><i class="fa fa-facebook"></i></a></li>
 						<li><a href="https://twitter.com/apachetomee"><i class="fa fa-twitter"></i></a></li>
 						<li><a href="https://plus.google.com/communities/105208241852045684449"><i class="fa fa-google-plus"></i></a></li>
 					</ul>
 				</div>
 				<div class="col-sm-6 text-center-mobile">
 					<div class="row opening-hours">
 						<div class="col-sm-3 text-center-mobile">
 							<h5><a href="../../latest/docs/" class="white">Documentation</a></h5>
 							<ul class="list-unstyled">
 								<li><a href="../../latest/docs/admin/configuration/index.html" class="regular light-white">How to configure</a></li>
 								<li><a href="../../latest/docs/admin/file-layout.html" class="regular light-white">Dir. Structure</a></li>
 								<li><a href="../../latest/docs/developer/testing/index.html" class="regular light-white">Testing</a></li>
 								<li><a href="../../latest/docs/admin/cluster/index.html" class="regular light-white">Clustering</a></li>
 							</ul>
 						</div>
 						<div class="col-sm-3 text-center-mobile">
 							<h5><a href="../../latest/examples/" class="white">Examples</a></h5>
 							<ul class="list-unstyled">
 								<li><a href="../../latest/examples/simple-cdi-interceptor.html" class="regular light-white">CDI Interceptor</a></li>
 								<li><a href="../../latest/examples/rest-cdi.html" class="regular light-white">REST with CDI</a></li>
 								<li><a href="../../latest/examples/ejb-examples.html" class="regular light-white">EJB</a></li>
 								<li><a href="../../latest/examples/jsf-managedBean-and-ejb.html" class="regular light-white">JSF</a></li>
 							</ul>
 						</div>
 						<div class="col-sm-3 text-center-mobile">
 							<h5><a href="../../community/index.html" class="white">Community</a></h5>
 							<ul class="list-unstyled">
 								<li><a href="../../community/contributors.html" class="regular light-white">Contributors</a></li>
 								<li><a href="../../community/social.html" class="regular light-white">Social</a></li>
 								<li><a href="../../community/sources.html" class="regular light-white">Sources</a></li>
 							</ul>
 						</div>
 						<div class="col-sm-3 text-center-mobile">
 							<h5><a href="../../security/index.html" class="white">Security</a></h5>
 							<ul class="list-unstyled">
 								<li><a href="http://apache.org/security" target="_blank" class="regular light-white">Apache Security</a></li>
 								<li><a href="http://apache.org/security/projects.html" target="_blank" class="regular light-white">Security Projects</a></li>
 								<li><a href="http://cve.mitre.org" target="_blank" class="regular light-white">CVE</a></li>
 							</ul>
 						</div>
 					</div>
 				</div>
 			</div>
 			<div class="row bottom-footer text-center-mobile">
 				<div class="col-sm-12 light-white">
 					<p>Copyright &copy; 1999-2016 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache TomEE, TomEE, Apache, the Apache feather logo, and the Apache TomEE project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p>
 				</div>
 			</div>
 		</div>
 	</footer>
 	<!-- Holder for mobile navigation -->
 	<div class="mobile-nav">
         <ul>
           <li><a hef="../../latest/docs/admin/index.html">Administrators</a>
           <li><a hef="../../latest/docs/developer/index.html">Developers</a>
           <li><a hef="../../latest/docs/advanced/index.html">Advanced</a>
           <li><a hef="../../community/index.html">Community</a>
         </ul>
 		<a href="#" class="close-link"><i class="arrow_up"></i></a>
 	</div>
 	<!-- Scripts -->
 	<script src="../../js/jquery-1.11.1.min.js"></script>
 	<script src="../../js/owl.carousel.min.js"></script>
 	<script src="../../js/bootstrap.min.js"></script>
 	<script src="../../js/wow.min.js"></script>
 	<script src="../../js/typewriter.js"></script>
 	<script src="../../js/jquery.onepagenav.js"></script>
 	<script src="../../js/tree.jquery.js"></script>
 	<script src="../../js/highlight.pack.js"></script>
     <script src="../../js/main.js"></script>
 		</body>

 </html>
	<!DOCTYPE html>
	<html lang="en">

	<head>
	<meta charset="UTF-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<title>Apache TomEE</title>
	<meta name="description"
	content="Apache TomEE is a lightweight, yet powerful, JavaEE Application server with feature rich tooling." />
	<meta name="keywords" content="tomee,asf,apache,javaee,jee,shade,embedded,test,junit,applicationcomposer,maven,arquillian" />
	<meta name="author" content="Luka Cvetinovic for Codrops" />
	<link rel="icon" href="../../favicon.ico">
	<link rel="icon" type="image/png" href="../../favicon.png">
	<meta name="msapplication-TileColor" content="#80287a">
	<meta name="theme-color" content="#80287a">
	<link rel="stylesheet" type="text/css" href="../../css/normalize.css">
	<link rel="stylesheet" type="text/css" href="../../css/bootstrap.css">
	<link rel="stylesheet" type="text/css" href="../../css/owl.css">
	<link rel="stylesheet" type="text/css" href="../../css/animate.css">
	<link rel="stylesheet" type="text/css" href="../../fonts/font-awesome-4.1.0/css/font-awesome.min.css">
	<link rel="stylesheet" type="text/css" href="../../fonts/eleganticons/et-icons.css">
	<link rel="stylesheet" type="text/css" href="../../css/jqtree.css">
	<link rel="stylesheet" type="text/css" href="../../css/idea.css">
	<link rel="stylesheet" type="text/css" href="../../css/cardio.css">

	<script type="text/javascript">

	var _gaq = _gaq \|\| [];
	_gaq.push(['_setAccount', 'UA-2717626-1']);
	_gaq.push(['_setDomainName', 'apache.org']);
	_gaq.push(['_trackPageview']);

	(function() {
	var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
	ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
	var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
	})();

	</script>
	</head>

	<body>
	<div class="preloader">
	<img src="../../img/loader.gif" alt="Preloader image">
	</div>
	<nav class="navbar">
	<div class="container">
	<div class="row"> <div class="col-md-12">

	<!-- Brand and toggle get grouped for better mobile display -->
	<div class="navbar-header">
	<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
	<span class="sr-only">Toggle navigation</span>
	<span class="icon-bar"></span>
	<span class="icon-bar"></span>
	<span class="icon-bar"></span>
	</button>
	<a class="navbar-brand" href="/">
	<span>


	<img src="../../img/logo-active.png">


	</span>
	Apache TomEE
	</a>
	</div>
	<!-- Collect the nav links, forms, and other content for toggling -->
	<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
	<ul class="nav navbar-nav navbar-right main-nav">
	<li><a href="../../docs.html">Documentation</a></li>
	<li><a href="../../community/index.html">Community</a></li>
	<li><a href="../../security/security.html">Security</a></li>
	<li><a href="../../download-ng.html">Downloads</a></li>
	</ul>
	</div>
	<!-- /.navbar-collapse -->
	</div></div>
	</div>
	<!-- /.container-fluid -->
	</nav>


	<div id="main-block" class="container main-block">
	<div class="row title">
	<div class="col-md-12">
	<div class='page-header'>

	<h1>JPA and Enums via @Enumerated</h1>
	</div>
	</div>
	</div>
	<div class="row">

	<div class="col-md-12">
	<div id="preamble">
	<div class="sectionbody">
	<div class="paragraph">
	<p>It can sometimes be desirable to have a Java <code>enum</code> type to represent a particular column in a database. JPA supports converting database data to and from Java <code>enum</code> types via the <code>@jakarta.persistence.Enumerated</code> annotation.</p>
	</div>
	<div class="paragraph">
	<p>This example will show basic <code>@Enumerated</code> usage in a field of an <code>@Entity</code> as well as <code>enum</code>s as the parameter of a <code>Query</code>. We’ll also see that the actual database representation can be effectively <code>String</code> or <code>int</code>.</p>
	</div>
	</div>
	</div>
	<div class="sect1">
	<h2 id="_enum">Enum</h2>
	<div class="sectionbody">
	<div class="paragraph">
	<p>For our example we will leverage the familiar <code>Movie</code> entity and add a new field to represent the MPAA.org rating of the movie. This is defined via a simple <code>enum</code> that requires no JPA specific annotations.</p>
	</div>
	<div class="literalblock">
	<div class="content">
	<pre>public enum Rating {
	UNRATED,
	G,
	PG,
	PG13,
	R,
	NC17
	}</pre>
	</div>
	</div>
	</div>
	</div>
	<div class="sect1">
	<h2 id="__enumerated">@Enumerated</h2>
	<div class="sectionbody">
	<div class="paragraph">
	<p>In our <code>Movie</code> entity, we add a <code>rating</code> field of the enum type <code>Rating</code> and annotate it with <code>@Enumerated(EnumType.STRING)</code> to declare that its value should be converted from what is effectively a <code>String</code> in the database to the <code>Rating</code> type.</p>
	</div>
	<div class="listingblock">
	<div class="content">
	<pre class="highlight"><code class="language-java" data-lang="java">@Entity
	public class Movie {

	@Id
	@GeneratedValue
	private int id;
	private String director;
	private String title;
	private int year;

	@Enumerated(EnumType.STRING)
	private Rating rating;

	public Movie() {
	}

	public Movie(String director, String title, int year, Rating rating) {
	this.director = director;
	this.title = title;
	this.year = year;
	this.rating = rating;
	}

	public String getDirector() {
	return director;
	}

	public void setDirector(String director) {
	this.director = director;
	}

	public String getTitle() {
	return title;
	}

	public void setTitle(String title) {
	this.title = title;
	}

	public int getYear() {
	return year;
	}

	public void setYear(int year) {
	this.year = year;
	}

	public Rating getRating() {
	return rating;
	}

	public void setRating(Rating rating) {
	this.rating = rating;
	}
	}</code></pre>
	</div>
	</div>
	<div class="paragraph">
	<p>The above is enough and we are effectively done. For the sake of completeness we’ll show a sample <code>Query</code></p>
	</div>
	</div>
	</div>
	<div class="sect1">
	<h2 id="_enum_in_jpql_query">Enum in JPQL Query</h2>
	<div class="sectionbody">
	<div class="paragraph">
	<p>Note the <code>findByRating</code> method which creates a <code>Query</code> with a <code>rating</code> named parameter. The key thing to notice is that the <code>rating</code> enum instance itself is passed into the
	<code>query.setParameter</code> method, <strong>not</strong> <code>rating.name()</code> or <code>rating.ordinal()</code>.</p>
	</div>
	<div class="paragraph">
	<p>Regardless if you use <code>EnumType.STRING</code> or <code>EnumType.ORDINAL</code>, you still always pass the enum itself in calls to <code>query.setParameter</code>.</p>
	</div>
	<div class="listingblock">
	<div class="content">
	<pre class="highlight"><code class="language-java" data-lang="java">@Stateful
	public class Movies {

	@PersistenceContext(unitName = "movie-unit", type = PersistenceContextType.EXTENDED)
	private EntityManager entityManager;

	public void addMovie(Movie movie) {
	entityManager.persist(movie);
	}

	public void deleteMovie(Movie movie) {
	entityManager.remove(movie);
	}

	public List<Movie> findByRating(Rating rating) {
	final Query query = entityManager.createQuery("SELECT m FROM Movie as m WHERE m.rating = :rating");
	query.setParameter("rating", rating);
	return query.getResultList();
	}

	public List<Movie> getMovies() throws Exception {
	Query query = entityManager.createQuery("SELECT m from Movie as m");
	return query.getResultList();
	}

	}</code></pre>
	</div>
	</div>
	</div>
	</div>
	<div class="sect1">
	<h2 id="_enumtype_string_vs_enumtype_ordinal">EnumType.STRING vs EnumType.ORDINAL</h2>
	<div class="sectionbody">
	<div class="paragraph">
	<p>It is a matter of style how you would like your <code>enum</code> data represented in the database. Either <code>name()</code> or <code>ordinal()</code> are supported:</p>
	</div>
	<div class="ulist">
	<ul>
	<li>
	<p><code>@Enumerated(EnumType.STRING) Rating rating</code> the value of <code>rating.name()</code> is written and read from the corresponding database column; e.g. <code>G</code>, <code>PG</code>, <code>PG13</code></p>
	</li>
	<li>
	<p><code>@Enumerated(EnumType.ORDINAL) Rating rating</code> the value of <code>rating.ordinal()</code> is written and read from the corresponding database column; e.g. <code>0</code>, <code>1</code>, <code>2</code></p>
	</li>
	</ul>
	</div>
	<div class="paragraph">
	<p>The default is <code>EnumType.ORDINAL</code></p>
	</div>
	<div class="paragraph">
	<p>There are advantages and disadvantages to each.</p>
	</div>
	<div class="sect2">
	<h3 id="_disadvantage_of_enumtype_ordinal">Disadvantage of EnumType.ORDINAL</h3>
	<div class="paragraph">
	<p>A disadvantage of <code>EnumType.ORDINAL</code> is the effect of time and the desire to keep <code>enums</code> in a logical order. With <code>EnumType.ORDINAL</code> any new enum elements must be added to the
	<strong>end</strong> of the list or you will accidentally change the meaning of all your records.</p>
	</div>
	<div class="paragraph">
	<p>Let’s use our <code>Rating</code> enum and see how it would have had to evolve over time to keep up with changes in the MPAA.org ratings system.</p>
	</div>
	<div class="paragraph">
	<p><strong>1980</strong></p>
	</div>
	<div class="literalblock">
	<div class="content">
	<pre>public enum Rating {
	G,
	PG,
	R,
	UNRATED
	}</pre>
	</div>
	</div>
	<div class="paragraph">
	<p><strong>1984</strong> PG-13 is added</p>
	</div>
	<div class="literalblock">
	<div class="content">
	<pre>public enum Rating {
	G,
	PG,
	R,
	UNRATED,
	PG13
	}</pre>
	</div>
	</div>
	<div class="paragraph">
	<p><strong>1990</strong> NC-17 is added</p>
	</div>
	<div class="literalblock">
	<div class="content">
	<pre>public enum Rating {
	G,
	PG,
	R,
	UNRATED,
	PG13,
	NC17
	}</pre>
	</div>
	</div>
	<div class="paragraph">
	<p>If <code>EnumType.STRING</code> was used, then the enum could be reordered at anytime and would instead look as we have defined it originally with ratings starting at <code>G</code> and increasing in severity to <code>NC17</code> and eventually <code>UNRATED</code>. With <code>EnumType.ORDINAL</code> the logical ordering would not have withstood the test of time as new values were added.</p>
	</div>
	<div class="paragraph">
	<p>If the order of the enum values is significant to your code, avoid <code>EnumType.ORDINAL</code></p>
	</div>
	</div>
	</div>
	</div>
	<div class="sect1">
	<h2 id="_unit_testing_the_jpa_enumerated">Unit Testing the JPA @Enumerated</h2>
	<div class="sectionbody">
	<div class="listingblock">
	<div class="content">
	<pre class="highlight"><code class="language-java" data-lang="java">public class MoviesTest extends TestCase {

	public void test() throws Exception {

	final Properties p = new Properties();
	p.put("movieDatabase", "new://Resource?type=DataSource");
	p.put("movieDatabase.JdbcDriver", "org.hsqldb.jdbcDriver");
	p.put("movieDatabase.JdbcUrl", "jdbc:hsqldb:mem:moviedb");

	EJBContainer container = EJBContainer.createEJBContainer(p);
	final Context context = container.getContext();

	final Movies movies = (Movies) context.lookup("java:global/jpa-scratch/Movies");

	movies.addMovie(new Movie("James Frawley", "The Muppet Movie", 1979, Rating.G));
	movies.addMovie(new Movie("Jim Henson", "The Great Muppet Caper", 1981, Rating.G));
	movies.addMovie(new Movie("Frank Oz", "The Muppets Take Manhattan", 1984, Rating.G));
	movies.addMovie(new Movie("James Bobin", "The Muppets", 2011, Rating.PG));

	assertEquals("List.size()", 4, movies.getMovies().size());

	assertEquals("List.size()", 3, movies.findByRating(Rating.G).size());

	assertEquals("List.size()", 1, movies.findByRating(Rating.PG).size());

	assertEquals("List.size()", 0, movies.findByRating(Rating.R).size());

	container.close();
	}
	}</code></pre>
	</div>
	</div>
	</div>
	</div>
	<h1 id="_running" class="sect0">Running</h1>
	<div class="paragraph">
	<p>To run the example via maven:</p>
	</div>
	<div class="literalblock">
	<div class="content">
	<pre>cd jpa-enumerated
	mvn clean install</pre>
	</div>
	</div>
	<div class="paragraph">
	<p>Which will generate output similar to the following:</p>
	</div>
	<div class="listingblock">
	<div class="content">
	<pre class="highlight"><code class="language-console" data-lang="console">-------------------------------------------------------
	T E S T S
	-------------------------------------------------------
	Running org.superbiz.jpa.enums.MoviesTest
	Apache OpenEJB 4.0.0-beta-2 build: 20120115-08:26
	http://tomee.apache.org/
	INFO - openejb.home = /Users/dblevins/openejb/examples/jpa-enumerated
	INFO - openejb.base = /Users/dblevins/openejb/examples/jpa-enumerated
	INFO - Using 'jakarta.ejb.embeddable.EJBContainer=true'
	INFO - Configuring Service(id=Default Security Service, type=SecurityService, provider-id=Default Security Service)
	INFO - Configuring Service(id=Default Transaction Manager, type=TransactionManager, provider-id=Default Transaction Manager)
	INFO - Configuring Service(id=movieDatabase, type=Resource, provider-id=Default JDBC Database)
	INFO - Found EjbModule in classpath: /Users/dblevins/openejb/examples/jpa-enumerated/target/classes
	INFO - Beginning load: /Users/dblevins/openejb/examples/jpa-enumerated/target/classes
	INFO - Configuring enterprise application: /Users/dblevins/openejb/examples/jpa-enumerated
	INFO - Configuring Service(id=Default Stateful Container, type=Container, provider-id=Default Stateful Container)
	INFO - Auto-creating a container for bean Movies: Container(type=STATEFUL, id=Default Stateful Container)
	INFO - Configuring Service(id=Default Managed Container, type=Container, provider-id=Default Managed Container)
	INFO - Auto-creating a container for bean org.superbiz.jpa.enums.MoviesTest: Container(type=MANAGED, id=Default Managed Container)
	INFO - Configuring PersistenceUnit(name=movie-unit)
	INFO - Auto-creating a Resource with id 'movieDatabaseNonJta' of type 'DataSource for 'movie-unit'.
	INFO - Configuring Service(id=movieDatabaseNonJta, type=Resource, provider-id=movieDatabase)
	INFO - Adjusting PersistenceUnit movie-unit <non-jta-data-source> to Resource ID 'movieDatabaseNonJta' from 'movieDatabaseUnmanaged'
	INFO - Enterprise application "/Users/dblevins/openejb/examples/jpa-enumerated" loaded.
	INFO - Assembling app: /Users/dblevins/openejb/examples/jpa-enumerated
	INFO - PersistenceUnit(name=movie-unit, provider=org.apache.openjpa.persistence.PersistenceProviderImpl) - provider time 406ms
	INFO - Jndi(name="java:global/jpa-enumerated/Movies!org.superbiz.jpa.enums.Movies")
	INFO - Jndi(name="java:global/jpa-enumerated/Movies")
	INFO - Created Ejb(deployment-id=Movies, ejb-name=Movies, container=Default Stateful Container)
	INFO - Started Ejb(deployment-id=Movies, ejb-name=Movies, container=Default Stateful Container)
	INFO - Deployed Application(path=/Users/dblevins/openejb/examples/jpa-enumerated)
	INFO - Undeploying app: /Users/dblevins/openejb/examples/jpa-enumerated
	INFO - Closing DataSource: movieDatabase
	INFO - Closing DataSource: movieDatabaseNonJta
	Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 2.831 sec

	Results :

	Tests run: 1, Failures: 0, Errors: 0, Skipped: 0</code></pre>
	</div>
	</div>
	</div>

	</div>
	</div>
	<footer>
	<div class="container">
	<div class="row">
	<div class="col-sm-6 text-center-mobile">
	<h3 class="white">Be simple. Be certified. Be Tomcat.</h3>
	<h5 class="light regular light-white">"A good application in a good server"</h5>
	<ul class="social-footer">
	<li><a href="https://www.facebook.com/ApacheTomEE/"><i class="fa fa-facebook"></i></a></li>
	<li><a href="https://twitter.com/apachetomee"><i class="fa fa-twitter"></i></a></li>
	<li><a href="https://plus.google.com/communities/105208241852045684449"><i class="fa fa-google-plus"></i></a></li>
	</ul>
	</div>
	<div class="col-sm-6 text-center-mobile">
	<div class="row opening-hours">
	<div class="col-sm-3 text-center-mobile">
	<h5><a href="../../latest/docs/" class="white">Documentation</a></h5>
	<ul class="list-unstyled">
	<li><a href="../../latest/docs/admin/configuration/index.html" class="regular light-white">How to configure</a></li>
	<li><a href="../../latest/docs/admin/file-layout.html" class="regular light-white">Dir. Structure</a></li>
	<li><a href="../../latest/docs/developer/testing/index.html" class="regular light-white">Testing</a></li>
	<li><a href="../../latest/docs/admin/cluster/index.html" class="regular light-white">Clustering</a></li>
	</ul>
	</div>
	<div class="col-sm-3 text-center-mobile">
	<h5><a href="../../latest/examples/" class="white">Examples</a></h5>
	<ul class="list-unstyled">
	<li><a href="../../latest/examples/simple-cdi-interceptor.html" class="regular light-white">CDI Interceptor</a></li>
	<li><a href="../../latest/examples/rest-cdi.html" class="regular light-white">REST with CDI</a></li>
	<li><a href="../../latest/examples/ejb-examples.html" class="regular light-white">EJB</a></li>
	<li><a href="../../latest/examples/jsf-managedBean-and-ejb.html" class="regular light-white">JSF</a></li>
	</ul>
	</div>
	<div class="col-sm-3 text-center-mobile">
	<h5><a href="../../community/index.html" class="white">Community</a></h5>
	<ul class="list-unstyled">
	<li><a href="../../community/contributors.html" class="regular light-white">Contributors</a></li>
	<li><a href="../../community/social.html" class="regular light-white">Social</a></li>
	<li><a href="../../community/sources.html" class="regular light-white">Sources</a></li>
	</ul>
	</div>
	<div class="col-sm-3 text-center-mobile">
	<h5><a href="../../security/index.html" class="white">Security</a></h5>
	<ul class="list-unstyled">
	<li><a href="http://apache.org/security" target="_blank" class="regular light-white">Apache Security</a></li>
	<li><a href="http://apache.org/security/projects.html" target="_blank" class="regular light-white">Security Projects</a></li>
	<li><a href="http://cve.mitre.org" target="_blank" class="regular light-white">CVE</a></li>
	</ul>
	</div>
	</div>
	</div>
	</div>
	<div class="row bottom-footer text-center-mobile">
	<div class="col-sm-12 light-white">
	<p>Copyright © 1999-2016 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache TomEE, TomEE, Apache, the Apache feather logo, and the Apache TomEE project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p>
	</div>
	</div>
	</div>
	</footer>
	<!-- Holder for mobile navigation -->
	<div class="mobile-nav">
	<ul>
	<li><a hef="../../latest/docs/admin/index.html">Administrators</a>
	<li><a hef="../../latest/docs/developer/index.html">Developers</a>
	<li><a hef="../../latest/docs/advanced/index.html">Advanced</a>
	<li><a hef="../../community/index.html">Community</a>
	</ul>
	<a href="#" class="close-link"><i class="arrow_up"></i></a>
	</div>
	<!-- Scripts -->
	<script src="../../js/jquery-1.11.1.min.js"></script>
	<script src="../../js/owl.carousel.min.js"></script>
	<script src="../../js/bootstrap.min.js"></script>
	<script src="../../js/wow.min.js"></script>
	<script src="../../js/typewriter.js"></script>
	<script src="../../js/jquery.onepagenav.js"></script>
	<script src="../../js/tree.jquery.js"></script>
	<script src="../../js/highlight.pack.js"></script>
	<script src="../../js/main.js"></script>
	</body>

	</html>