Page tree
Skip to end of metadata
Go to start of metadata

About this Tutorial

This tutorial creates a new database table and the Java code to access that table.

You create an object and then some more classes to persist (save/retrieve/delete) that object from the database. In Java speak, this object is called a Plain Old Java Object (POJO). This object basically represents a database table. With AppFuse, there is a Generics-based DAO and Manager that will CRUD all objects for you. The only time you'll need to create DAOs is when you want custom behavior or if you need finders.

AppFuse uses Hibernate for its default persistence layer. Hibernate is an Object/Relational (O/R) Framework that allows you to relate your Java Objects to database tables. It allows you to very easily perform CRUD (Create, Retrieve, Update, Delete) on your objects.



You can also use JPA as a persistence framework option. To use JPA implementation, see the Using JPA tutorial.

To get started creating a new Object and table in AppFuse's project structure, please complete the instructions below.

Table of Contents

  1. Create a new POJO and add JPA Annotations
  2. Create a new database table from the object using Maven

Create a new POJO and add JPA Annotations

The first thing you need to do is create an object to persist. Create a simple "Person" object (in the src/main/java/**/model directory for the basic archetypes or the core/src/main/java/**/model directory for the modular archetypes) that has an id, a firstName and a lastName (as properties). For recommend package-naming conventions, see the FAQ. These tutorials use "org.appfuse.tutorial" as the root package name.


Extending BaseObject is optional, but recommended as a good practice to force creation of toString(), equals() and hashCode() methods. If you plan to put this object into the user's session, or expose it through a web service, you should implement as well.

When generating or writing equals() and hashCode() methods, you don't want to include your object's primary key. See Hibernate's Equals and Hascode for more information.

IntelliJ Users


If you're using IntelliJ IDEA, you can generate equals() and hashCode(), but not toString(). There is a ToStringPlugin that works reasonably well.

Netbeans Users


If you're using Netbeans, you can generate equals() and hashCode(), using key combination Alt+Insert -> choose override method -> hashCode, equals. You can also use CodeGen plugin.

Now that you have this POJO created, you need to add JPA annotations. These annotations are used by Hibernate to map objects → tables and properties (variables) → columns.

First of all, add an @Entity annotation that signifies what table this object relates to. The "name" is optional; the class name is used if it's not specified. Make sure you import annotations from javax.persistence.* rather than from Hibernate.


If you specify a name value for your @Entity annotation (for example @Entity(name="person")), this will be the alias for HQL queries. If you don't specify this value, the name will match the short name of your class (Person). If you want to change the table name that's generated, use the @Table annotation with a "name" value.

You also have to add an @Id annotation to signify the primary key. The @GeneratedValue annotation should also be specified to indicate the primary key generation strategy.

For the rest of the fields, you aren't required to annotate them unless you want to 1) exclude them from being persisted (with @Transient) or 2) want to change their column name or other attributes. To change the column names, use the @Column annotation. Add the @Column annotation to both the getFirstName() and getLastName() methods.

Annotations on fields


You can also put JPA annotations on fields instead of getters. However, you should be aware that if you add field-level annotations, method-level annotations will be ignored.

Create a new database table from the object using Maven

Open src/main/resources/hibernate.cfg.xml for the basic archetypes (or core/src/main/resources/hibernate.cfg.xml for the modular archetypes) and register your Person object with the following XML:

Save the file and run mvn test-compile hibernate4:export from the command line. For modular projects, make sure you run this command from the "core" directory. This will generate your database schema with the "person" table included.

After you've created a POJO and generated a schema from it, how do you persist that object? AppFuse ships with GenericDao implementations that makes it possible to CRUD any object. In addition to this Generics-based class, there is a UniversalDao that does the same thing. The major difference between the two is you'll need to cast to your specified type for the UniversalDao. However, it also doesn't require you to define any new Spring beans, so there are benefits and drawbacks. For these tutorials, you will learn how to program using the GenericDao.

Please choose the persistence framework you'd like to use to continue: