HibernateRelationships |
|
| Your trail: |
This is version 81.
It is not the current version, and thus it cannot be edited.
[Back to current version]
[Restore this version]
About this tutorial
This is a tutorial to show how to create and manage Hibernate relationships within AppFuse. This tutorial was written using AppFuse 1.8. All of the code for this tutorial is downloadable. To begin, I created a new application with an app/db name of blog/blog.
- For further details about the specifics regarding creating objects, XDoclet tags for Hibernate, DAO development, etc., please refer to Creating new DAOs and Objects in AppFuse.
Table of Contents
- Create Weblog.java, Entry.java and add XDoclet tags
- [Many-to-One] Create a new Category object and modify Entry.java to use it
- [One-to-Many] A Weblog object can have many Entries
- [Many-to-Many] Shared Weblogs are possible for multiple Users
- [DAO Stuff] Setting up Unit Tests and DAO classes for basic CRUD
- Lazy-Loading Issues
- Managing relationships and indexed properties in the UI
Create Weblog.java, Entry.java and add XDoclet tags
In this example, the Weblog object is used to indentify a person's blog. This class has the following properties:
- weblogId
- username
- blogTitle
- dateCreated
The Entry object is used to contain a listing of a person's blog entries in their Weblog. This class contains the following properties:
NOTE: The primary keys are prefixed with their entity name to avoid confusion. I generally recommend using "id" for your entities, but wanted to make thing clearer in this tutorial.
TODO: Create diagram of the tables and their relationships.
The first thing you need to do in this tutorial is these two object to persist. Create both a Weblog.java class and an Entry.java class (in the src/dao/**/model directory). The necessary XDoclet tags for these entities is included on the getter method's javadoc. You can download these files using the links below. Note that javadocs have been eliminated for brevity.
- Rather than fill up this tutorial with large blocks of Java code, the necessary files are attached and linked to. Small code snippets are used where appropriate.
Tip: The equals(), hashCode() and toString() methods can be generated by your IDE. If you're using Eclipse, get the Commonclipse plugin. For IDEA, the first two are built into the "Generate..." dialog, and toString() is a plugin you can download.
[Many-to-One] Create a new Category object and modify Entry.java to use it
A category object will act as an entity for persisting category information about weblog entries. A category object will consist of an id (primary key), category name, and a description. Each category can have many entries.
The many-to-one relationship between entry and category can be established using XDoclet tags. Hibernate relationships can typically be established on either side of the relationship or as a bi-directional one as well. For our purposes,this relationship will be maintained by an extra property and collection held by Entry. The list of possible categories for a weblog entry will eventually be represented as a drop-down on the UI.
private Long categoryId;
private Category category;
/**
* @hibernate.many-to-one insert="false" update="false" cascade="none"
* column="category_id" outer-join="true"
*/
public Category getCategory() {
return category;
}
public void setCategory(Category category) {
this.category = category;
}
/**
* @hibernate.property column="category_id"
*/
public Long getCategoryId() {
return categoryId;
}
public void setCategoryId(Long categoryId) {
this.categoryId = categoryId;
}
|
[One-to-Many] A Weblog object can have many Entries
Modify the Weblog object and Entry object to represent the multiplicity of a weblog that can have many entries. This relationship is set on the Weblog class using a list. XDoclet tags are used to establish this relationship using a bag as the Hibernate collection type.
private List entries;
/**
* @return Returns the entries.
*
* @hibernate.bag name="entries" lazy="false" inverse="true" cascade="delete"
* @hibernate.collection-key column="weblog_id"
* @hibernate.collection-one-to-many class="org.appfuse.model.Entry"
*/
public List getEntries() {
return entries;
}
public void setEntries(List entries) {
this.entries = entries;
}
|
The Entry class is modified slightly to provide a placeholder for the relationships between Weblog and Entry.
private Long weblogId;
/**
* @hibernate.property column="weblog_id"
*/
public Long getWeblogId() {
return weblogId;
}
public void setWeblogId(Long weblogId) {
this.weblogId = weblogId;
}
|
[Many-to-Many]
The Weblog system that we are developing allows one additional bit of functionality. A particular Weblog can have many Users. Basically the idea is of a shared weblog that is a place where many users can express themselves about a particular topic of interest. For this bit of functionality the User object will be modified to have a many-to-many relationship with Weblog.
Add the following users property and accessor methods to Weblog.java.
private Set users = new HashSet();
/**
* @hibernate.set table="weblog_user" cascade="none" lazy="false"
* @hibernate.collection-key column="weblog_id"
* @hibernate.collection-many-to-many class="org.appfuse.model.User" column="username"
*/
public Set getUsers() {
return users;
}
public void addUser(User user) {
getUsers().add(user);
}
public void setUsers(Set users) {
this.users = users;
}
|
User modifications
In addition to allow navigation from a Weblog object to their list of users, you need to add a Set of Weblogs to the User object - allowing that path of navigation as well. Modify User.java to add a weblogs Set and accessor methods.
protected Set weblogs;
public Set getWeblogs() {
return weblogs;
}
public void setWeblogs(Set weblogs) {
this.weblogs = weblogs;
}
|
[DAO Stuff]
In order to test that all of this works, you need to create some test classes, add some sample data, develop some DAO interfaces, and create hibernate DAO classes.
Test Classes
WeblogDaoTest
Let's start with WeblogDaoTest.java class. Create this class in test/dao/**/dao and fill it with the following code.
package org.appfuse.dao;
import java.util.Date;
import java.util.List;
import org.appfuse.model.Weblog;
import org.appfuse.model.User;
import org.springframework.dao.DataAccessException;
public class WeblogDaoTest extends BaseDaoTestCase {
private WeblogDAO wldao = null;
private Weblog weblog = null;
private UserDAO udao = null;
private User user = null;
protected void setUp() throws Exception {
super.setUp();
wldao = (WeblogDAO) ctx.getBean("weblogDAO");
udao = (UserDAO) ctx.getBean("userDAO");
}
protected void tearDown() throws Exception {
super.tearDown();
wldao = null;
}
public void testGetWeblog() throws Exception {
weblog = wldao.getWeblog(new Long(1));
assertNotNull(weblog);
assertEquals(2, weblog.getUsers().size());
}
public void testUpdateWeblog() throws Exception {
weblog = wldao.getWeblog(new Long(2));
weblog.setBlogTitle("Testing Update Weblog");
wldao.saveWeblog(weblog);
assertEquals("Testing Update Weblog", weblog.getBlogTitle());
}
public void testAddWeblogUser() throws Exception {
weblog = wldao.getWeblog(new Long(2));
assertEquals(1, weblog.getUsers().size());
user = udao.getUser("tomcat");
weblog.addUser(user);
wldao.saveWeblog(weblog);
assertEquals(2, weblog.getUsers().size());
// add the same user twice - should result in no additional user
weblog.addUser(user);
wldao.saveWeblog(weblog);
assertEquals("more than 2 of the same users", 2, weblog.getUsers().size());
weblog.getUsers().remove(user);
wldao.saveWeblog(weblog);
assertEquals(1, weblog.getUsers().size());
}
public void testAddAndRemoveWeblog() throws Exception {
weblog = new Weblog();
weblog.setBlogTitle("A new test for adding and then deleting a weblog");
weblog.setDateCreated(new Date(2005-04-17));
weblog.setUsername("Cartman");
wldao.saveWeblog(weblog);
assertNotNull(weblog.getBlogTitle());
assertEquals("Cartman", weblog.getUsername());
wldao.removeWeblog(weblog.getWeblogId());
try {
weblog = wldao.getWeblog(weblog.getWeblogId());
fail("saveWeblog didn't throw DataAccessException");
} catch (DataAccessException d) {
assertNotNull(d);
}
}
public void testGetEntries() throws Exception {
List list = wldao.getEntries(new Long(1));
assertTrue(list.size() > 0);
}
}
|
EntryDaoTest
Now, create an EntryDaoTest.java class. Again, create this class in test/dao/**/dao and fill it with the following code.
package org.appfuse.dao;
import java.sql.Timestamp;
import org.appfuse.model.Entry;
import org.springframework.dao.DataAccessException;
public class EntryDaoTest extends BaseDaoTestCase {
private EntryDAO edao = null;
private Entry entry = null;
protected void setUp() throws Exception {
super.setUp();
edao = (EntryDAO) ctx.getBean("entryDAO");
}
protected void tearDown() throws Exception {
super.tearDown();
edao = null;
}
public void testGetEntry() throws Exception {
entry = edao.getEntry(new Long(1));
assertNotNull(entry);
assertEquals("Testing", entry.getText());
}
public void testUpdateEntry() throws Exception {
entry = edao.getEntry(new Long(2));
entry.setText("Testing update entry");
entry.setCategoryId(new Long(2));
edao.saveEntry(entry);
assertEquals("Testing update entry", entry.getText());
}
public void testAddAndRemoveEntry() throws Exception {
entry = new Entry();
entry.setText("Testing add a new entry");
entry.setTimeCreated(new Timestamp(2004-04-02));
entry.setCategoryId(new Long(3));
entry.setWeblogId(new Long(1));
edao.saveEntry(entry);
assertNotNull(entry.getText());
assertEquals("Testing add a new entry", entry.getText());
edao.removeEntry(entry.getEntryId());
try {
entry = edao.getEntry(entry.getEntryId());
fail("saveEntry didn't throw DataAccessException");
} catch (DataAccessException d) {
assertNotNull(d);
}
}
}
|
CategoryDaoTest
Next, create an CategoryDaoTest.java class in test/dao/**/dao.
package org.appfuse.dao;
import org.appfuse.model.Category;
import org.springframework.dao.DataAccessException;
public class CategoryDaoTest extends BaseDaoTestCase {
private CategoryDAO catdao = null;
private Category category = null;
protected void setUp() throws Exception {
super.setUp();
catdao = (CategoryDAO) ctx.getBean("categoryDAO");
}
protected void tearDown() throws Exception {
super.tearDown();
catdao = null;
}
public void testGetCategory() throws Exception {
category = catdao.getCategory(new Long(1));
assertNotNull(category);
assertEquals("Struts v. Spring MVC", category.getCategoryName());
}
public void testUpdateCategory() throws Exception {
category = catdao.getCategory(new Long(2));
category.setCategoryName("Testing update category");
catdao.saveCategory(category);
assertEquals("Testing update category", category.getCategoryName());
}
public void testAddAndRemoveCategory() throws Exception {
category = new Category();
category.setCategoryName("Spaceman Biff");
category.setCategoryDescription("Paying homage to Calvin's alter ego!");
catdao.saveCategory(category);
assertNotNull(category.getCategoryDescription());
assertEquals("Spaceman Biff", category.getCategoryName());
catdao.removeCategory(category.getCategoryId());
try {
category = catdao.getCategory(category.getCategoryId());
fail("saveCategory didn't throw DataAccessException");
} catch (DataAccessException d) {
assertNotNull(d);
}
}
}
|
All of these tests rely on some sample data, so add the following XML to metadata/sql/sample-data.xml.
<table name='weblog'>
<column>weblog_id</column>
<column>blog_title</column>
<column>date_created</column>
<column>username</column>
<row>
<value>1</value>
<value><![CDATA[Sponge Bob is Cool]]></value>
<value>2004-03-31</value>
<value>tomcat</value>
</row>
<row>
<value>2</value>
<value><![CDATA[Java Development = Fun]]></value>
<value>2005-01-05</value>
<value>mraible</value>
</row>
</table>
<table name='weblog_user'>
<column>weblog_id</column>
<column>username</column>
<row>
<value>1</value>
<value>tomcat</value>
</row>
<row>
<value>1</value>
<value>mraible</value>
</row>
<row>
<value>2</value>
<value>mraible</value>
</row>
</table>
<table name='category'>
<column>category_id</column>
<column>category_name</column>
<column>category_description</column>
<row>
<value>1</value>
<value><![CDATA[Struts v. Spring MVC]]></value>
<value><![CDATA[Comparing implementations of the MVC Design Pattern]]></value>
</row>
<row>
<value>2</value>
<value><![CDATA[Cycling Notes]]></value>
<value><![CDATA[All about cycling in the US.]]></value>
</row>
<row>
<value>3</value>
<value><![CDATA[Cyclocross]]></value>
<value><![CDATA[Bog Trotters Unite!]]></value>
</row>
</table>
<table name='entry'>
<column>entry_id</column>
<column>entry_text</column>
<column>time_created</column>
<column>weblog_id</column>
<column>category_id</column>
<row>
<value>1</value>
<value><![CDATA[Testing]]></value>
<value>2005-04-11</value>
<value>1</value>
<value>1</value>
</row>
<row>
<value>2</value>
<value><![CDATA[Test Value]]></value>
<value>2005-04-12</value>
<value>1</value>
<value>1</value>
</row>
<row>
<value>3</value>
<value><![CDATA[Test Value 3]]></value>
<value>2005-04-12</value>
<value>2</value>
<value>3</value>
</row>
</table>
DAO Interfaces
Before any of these tests will compile, you need to create the DAO interfaces and then implementations.
WeblogDAO Interface
Create a WeblogDAO.java interface in src/dao/**/dao:
package org.appfuse.dao;
import java.util.List;
import org.appfuse.model.Weblog;
public interface WeblogDAO extends Dao{
public Weblog getWeblog(Long weblogId);
public List getWeblogs(Weblog weblog);
public void saveWeblog(Weblog weblog);
public void removeWeblog(Long weblogId);
public List getEntries(Long weblogId);
}
|
EntryDAO Interface
package org.appfuse.dao;
import java.util.List;
import org.appfuse.model.Entry;
public interface EntryDAO {
public Entry getEntry(Long entryId);
public List getEntries(Entry entry);
public void saveEntry(Entry entry);
public void removeEntry(Long entryId);
}
|
CategoryDAO Interface
package org.appfuse.dao;
import java.util.List;
import org.appfuse.model.Category;
public interface CategoryDAO {
public Category getCategory(Long categoryId);
public List getCategories(Category category);
public void saveCategory(Category category);
public void removeCategory(Long categoryId);
}
|
DAO Implementation
Then create the Hibernate implementations of the interfaces in the src/dao/**/dao/hibernate directory.
WeblogDAOHibernate
package org.appfuse.dao.hibernate;
import java.util.List;
import org.appfuse.dao.WeblogDAO;
import org.appfuse.model.Weblog;
import org.springframework.orm.ObjectRetrievalFailureException;
public class WeblogDAOHibernate extends BaseDaoHibernate implements WeblogDAO {
public Weblog getWeblog(Long weblogId) {
Weblog weblog = (Weblog) getHibernateTemplate().get(Weblog.class,
weblogId);
if (weblog == null) {
log.warn("uh oh, weblog '" + weblogId + "' not found...");
throw new ObjectRetrievalFailureException(Weblog.class, weblogId);
}
return weblog;
}
public List getWeblogs(Weblog weblog) {
return getHibernateTemplate().find(
"from Weblog wl order by upper(wl.blogTitle)");
}
public void saveWeblog(final Weblog weblog) {
getHibernateTemplate().saveOrUpdate(weblog);
}
public void removeWeblog(Long weblogId) {
getHibernateTemplate().delete(getWeblog(weblogId));
}
public List getEntries(Long weblogId) {
return getHibernateTemplate().find("from Entry e where e.weblogId=?",
weblogId);
}
}
|
EntryDAOHibernate
package org.appfuse.dao.hibernate;
import java.util.List;
import org.appfuse.dao.EntryDAO;
import org.appfuse.model.Entry;
import org.springframework.orm.ObjectRetrievalFailureException;
public class EntryDAOHibernate extends BaseDaoHibernate implements EntryDAO {
public Entry getEntry(Long entryId) {
Entry entry = (Entry) getHibernateTemplate().get(Entry.class, entryId);
if (entry == null) {
log.warn("uh oh, weblog '" + entryId + "' not found...");
throw new ObjectRetrievalFailureException(Entry.class, entryId);
}
return entry;
}
public List getEntries(Entry entry) {
return getHibernateTemplate().find("from Entry e order by upper(e.timeCreated)");
}
public void saveEntry(final Entry entry) {
getHibernateTemplate().saveOrUpdate(entry);
}
public void removeEntry(Long entryId) {
getHibernateTemplate().delete(getEntry(entryId));
}
}
|
CategoryDAOHibernate
package org.appfuse.dao.hibernate;
import java.util.List;
import org.appfuse.dao.CategoryDAO;
import org.appfuse.model.Category;
import org.springframework.orm.ObjectRetrievalFailureException;
public class CategoryDAOHibernate extends BaseDaoHibernate implements CategoryDAO {
public Category getCategory(Long categoryId) {
Category category = (Category) getHibernateTemplate().get(Category.class, categoryId);
if (category == null) {
log.warn("uh oh, weblog '" + categoryId + "' not found...");
throw new ObjectRetrievalFailureException(Category.class, categoryId);
}
return category;
}
public List getCategories(Category category) {
return getHibernateTemplate().find("from Category cat order by upper(cat.categoryName)");
}
public void saveCategory(final Category category) {
getHibernateTemplate().saveOrUpdate(category);
}
public void removeCategory(Long categoryId) {
getHibernateTemplate().delete(getCategory(categoryId));
}
}
|
Modifications need to be made in applicationContext-hibernate.xml for the 3 new entities you created in this tutorial.
<property name="mappingResources">
<list>
<value>org/appfuse/model/Role.hbm.xml</value>
<value>org/appfuse/model/User.hbm.xml</value>
<value>org/appfuse/model/UserCookie.hbm.xml</value>
<value>org/appfuse/model/Weblog.hbm.xml</value>
<value>org/appfuse/model/Entry.hbm.xml</value>
<value>org/appfuse/model/Category.hbm.xml</value>
</list>
</property>
|
Also, you need to add the "weblogDAO", "entryDAO", and "categoryDAO" bean definitions.
<!-- WeblogDAO: Hibernate implementation -->
<bean id="weblogDAO" class="org.appfuse.dao.hibernate.WeblogDAOHibernate">
<property name="sessionFactory"><ref local="sessionFactory"/></property>
</bean>
<!-- EntryDAO: Hibernate implementation -->
<bean id="entryDAO" class="org.appfuse.dao.hibernate.EntryDAOHibernate">
<property name="sessionFactory"><ref local="sessionFactory"/></property>
</bean>
<!-- CategoryDAO: Hibernate implementation -->
<bean id="categoryDAO" class="org.appfuse.dao.hibernate.CategoryDAOHibernate">
<property name="sessionFactory"><ref local="sessionFactory"/></property>
</bean>
|
After making these changes, you should be able to run ant test-dao -Dtestcase=WeblogDAO for example. All of the tests should pass successfully.
Lazy-Loading Issues
Karl Baum has an excellent article on lazy-loading.
Managing relationships and indexed properties in the UI
Attachments:
|
![[RSS]](https://raibledesigns.com/wiki/images/xml.png "Aggregate the RSS feed")
