Advertisement

---

Top

< Prev

Next >

Today we are going to understand how to perform a one-to-one bidirectional mapping of objects between two Entity classes using Hibernate. To understand one-to-one mapping, let's take an example of two Entity classes - User_Details and Contact_Info, where objects of both Entity classes are stored in separated database tables and each object of User_Details is associated with a particular Contact_Info object.

A bidirectional one-to-one relationship is a two-way one-to-one relationship i.e. using a User_Details object, you could access its associated Contact_Info object and using a Contact_Info object, you could find the value of its associated User_Details object.

User_Details class is a parent class while Contact_Info is a child class, because first a user is created in User_Details and then his/her contact information is created in Contact_Info class by sharing the common primary key between the two tables i.e. user id and without a user there will be no need to create enter his/her information.

Let's put this example to work and make it easier for you to understand.

Note :

• In the upcoming example, We are going to create a Java class which will be mapped to a table in our database(Oracle Express Edition 10g). We are going to use some Hibernate Annotations, hence, there will be no need to create the mapping-resource with extension hbm.xml . For those who are not aware of Hibernate Annotations, please read Hibernate Annotations for reference.


• And yes, one more thing, we are going to create this program in an Integrated Development Environment (IDE), so you may use any IDE of your choice.







Creating a primary Entity class



We are going to create a class that will contain all the Java code files representing our Model class(whose objects needs to be persisted) and the class that calls the Hibernate API and create an object-relational mapping(ORM) and perform object persistence.

This is a simple Java class whose objects needs to be persisted/saved, these objects are also known as Plain Old Java Objects(POJO) or Entity class. Some may even refer to such class whose objects needs to be persisted as the Model class.


In the upcoming Entity class, we are going to a very important annotation -


@OneToOne - This annotation is placed just above an object property of another Entity class, which tells the Hibernate that the objects of this Entity class maintains a one-to-one association with the objects of the Entity class containing this annotation.

We have used two elements of @OneToOne annotation -


• cascade- This field allows you to take an action on not just the parent object of one-to-one relationship but also on the associated child object as well. For example -
  
  

  cascade = {CascadeType.ALL}

  
  Says - if an object of parent class is removed, refreshed/updated, merged or saved/persisted then its associated child class object should also be removed, refreshed/updated, merged or saved/persisted(depending on the operation).



• mappedBy - This elements allows us to define a field which is the parent of one-to-one relationship. Additionally, mappedBy also removes the extra column of foreign key constraint in the table on which the parent class is applied.


User_Details.java

package decodejava;


import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.persistence.OneToOne;
import javax.persistence.Table;


@Entity
@Table (name ="USER_DETAILS")
public class User_Details {
	
@Id
@GeneratedValue
@Column (name = "USER_ID")
private int id;
	
@Column (name = "First_Name")
private String firstName;
	
@Column (name = "Last_Name")
private String lastName;
	
@OneToOne(cascade = {CascadeType.ALL}, mappedBy = "user")
private Contact_Info contact;
	


public Contact_Info getContact()
{
	return contact;
}


public void setContact(Contact_Info contact) 
{
	this.contact = contact;
}


public int getId() 
{
	return id;
}


public void setId(int id) 
{
	this.id = id;
}
	

public String getFirstName() 
{
	return firstName;
}


public void setFirstName(String firstName) 
{
	this.firstName = firstName;
}


public String getLastName() 
{
	return lastName;
}


public void setLastName(String lastName) 
{
	this.lastName = lastName;
}
}






Advertisement






Creating the secondary Entity class


Next, we are going to create the child Entity class whose objects will also be persisted in a separate database table. The object of this class will contain a specific piece information about each user, such as - email address and phone number. This class is also an entity class, hence it will be preceded with the @Entity annotation.

We have used a few important annotations such as -


• @PrimaryKeyJoinColumn - This annotation is used within the child Entity class to join the secondary table/child table of this child Entity to the primary/parent table of its parent Entity class.
  
  As the name says, using this annotation, the primary key column of parent table becomes a primary key to join its child table i.e. using this annotation, the primary key column of parent Entity class becomes a primary key of its child entity class table.



• GenerationValue - Using this annotation, we can specified a strategy which is used for the generation of primary key values, using its strategy element as GenerationType.SEQUENCE, generates the sequence of primary key column in the table on the basis of a sequence generator referred by element generator. This sequence generator is defined in @SequenceGenerator annotation.



• @SequenceGenerator - This annotations is used define a primary key generator. The name element of @SequenceGenerator annotation is required to specify the name of primary key generator, which is referenced from @GeneratedValue annotation from its generator element.


Contact_Info.java

package decodejava;

import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Embeddable;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.OneToOne;
import javax.persistence.PrimaryKeyJoinColumn;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;

@Entity
@Table (name ="CONTACT_INFO")
public class Contact_Info 
{
@Id
@Column(name="USER_ID")
@SequenceGenerator(name = "id_generator", sequenceName = "id_seq")
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "id_generator")
private int id;
	
private String emailId;
private String phoneNo;
	
	
	
@OneToOne(cascade=CascadeType.ALL)
@PrimaryKeyJoinColumn
private User_Details user;


public int getId() 
{
	return id;
}

public void setId(int id) 
{
	this.id = id;
}

public User_Details getUser() 
{
	return user;
}

public void setUser(User_Details user) 
{
	this.user = user;
}
	
	
public String getEmailId() 
{
	return emailId;
}

public void setEmailId(String emailId) 
{
	this.emailId = emailId;
}
	
public String getPhoneNo() 
{
	return phoneNo;
}

public void setPhoneNo(String phoneNo) 
{
	this.phoneNo = phoneNo;
}
}








Creating the class that calls the Hibernate API


This class will create some User_Details objects , which will be persisted using the Hibernate API and an object-relational mapping(ORM) in the database is performed.

The Hiber class creates a Configuration object, used to configure the Hibernate. This is the first object we use when using the Hibernate. This object is used to specify the location of a configuration file and mapping document used by Hibernate. Using Configuration object we can create a SessionFactory object, which is eventually used to create a Session object to perform the object persistence operations.

Note : We will not need to set the Id value of each object, as it is automatically done by Hibernate's sequence object by using @GeneratedValue annotation.


Hiber.java

package decodejava;

import java.util.HashSet;

import org.hibernate.Session;
import org.hibernate.SessionFactory;
import org.hibernate.cfg.Configuration;


public class Hiber 
{
	
	public static void main(String... ar)
	{
	Configuration config = new Configuration();
	SessionFactory sf = config.configure().buildSessionFactory();
	Session session  = sf.openSession();
	
	
	//Creating the first User details
	User_Details user1 = new User_Details();
	user1.setFirstName("First");
	user1.setLastName("User");
	
	//Creating the contact info for the user 
	Contact_Info contact1 = new Contact_Info();
	contact1.setEmailId("email1-firstuser@email.com");
	contact1.setPhoneNo("11111111");
	
	
	//Setting the contact info of the first user 
	user1.setContact(contact1);
	
	
	//Setting the first Contact_Info object to its correspoding user to create a one-to-one bidirectional relationship
	contact1.setUser(user1);
	

	
	
	
	//Creating the second User details
	User_Details user2 = new User_Details();
	user2.setFirstName("Second");
	user2.setLastName("User");
		
		
	//Creating another contact info for the same user
	Contact_Info contact2 = new Contact_Info();
	contact2.setEmailId("email2-firstuser@email.com");
	contact2.setPhoneNo("22222222");
	
	
	//Setting the contact info of the second user 
	user2.setContact(contact2);
	
	
	//Setting the second Contact_Info object to its correspoding user to create a one-to-one bidirectional relationship
	contact2.setUser(user2);
	
	session.beginTransaction();
	session.save(user1); //Saving the first User_Details object
	session.save(user2); //Saving the Second User_Details object
	session.getTransaction().commit();
	session.close();	
		

		
		
		
	//Retrieve and displaying the user details.
	session = sf.openSession();
	session.beginTransaction();
	user1 = (User_Details)session.get(User_Details.class,1);
	user2 = (User_Details)session.get(User_Details.class,2);
	System.out.println("Retrieving the saved objects");
				
				


	//Retrieving details of the first user.
	System.out.println("First User");
	System.out.println("Id : " + user1.getId());
	System.out.println("First Name : " + user1.getFirstName());
	System.out.println("Last Name : " +user1.getLastName());
	contact1 = user1.getContact();
	System.out.println("Email id : " + contact1.getEmailId());
	System.out.println("Phone number : " + contact1.getPhoneNo());
				         
	//Retrieving details of the seco d user.
	System.out.println("Second User");
	System.out.println("Id : " + user2.getId());
	System.out.println("First Name : " + user2.getFirstName());
	System.out.println("Last Name : " +user2.getLastName());
	contact2 = user2.getContact();
	System.out.println("Email id : " + contact1.getEmailId());
	System.out.println("Phone number : " + contact1.getPhoneNo());
	
	session.getTransaction().commit();
	session.close();	
	}
}








Adding JARs



• We are going to add some JARs files to the build path of our Java project. These JARs make the Hibernate work with our database using a specific JDBC Driver for our particular database.
  
  All these JARs are included in the folder named required(within our Hibernate installation folder). So, we need to add all the JARs in the required to our build path of our Java project.
  
  
• Finally, we are going to add one more JAR file. This is a specific JDBC JAR file(ojdbc14.jar) required by Hibernate to connect to our database(Oracle Express Edition 10g) and perform object-relational mapping and object persistence.


Note : Those who don't know how to add JARs to the build path of your Java project in Eclipse IDE, please refer to our section Adding JARs to your Hibernate project in Eclipse.







Adding a configuration file



• Next, we are going to add a configuration file to our project.
  
  This configuration document ends with an extension .cfg.xml, and it is named as hibernate.cfg.xml.
  
  
  This configuration file is an xml file and it allows us to specify the following features -
  • A database to which Hibernate connects to perform object-relational mapping and object persistence.
  • The JDBC driver class for our specific database, used by the Hibernate to connect to the database.
  • The username and password of database, using which the Hibernate connects to the database.
  • An SQL Dialect, used by the Hibernate to instruct the database.
  • A Entity/POJO class which will be mapped to a database table by Hibernate.
  • A command to echo all the SQL commands which are executed by the Hibernate on stdout.
  • The mapping entity class, used by Hibernate to correctly map the class to a database table. We will specify two Entity classes, User_Details and Contact_Info.
  
  
  
  hibernate.cfg.xml

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE hibernate-configuration PUBLIC
    "-//Hibernate/Hibernate Configuration DTD 3.0//EN"
    "http://www.hibernate.org/dtd/hibernate-configuration-3.0.dtd">



<hibernate-configuration>

<session-factory>


<!-- Database connection settings -->
<property name="connection.driver_class">oracle.jdbc.driver.OracleDriver</property>
<property name="connection.url">jdbc:oracle:thin:@localhost:1521:XE</property>
<property name="connection.username">scott</property>
<property name="connection.password">tiger</property>


<!-- JDBC connection pool (use the built-in) -->
<property name="connection.pool_size">1</property>


<!-- SQL dialect -->
<property name="dialect">org.hibernate.dialect.Oracle10gDialect</property>


<!-- Disable the second-level cache  -->
<property name="cache.provider_class">org.hibernate.cache.internal.NoCacheProvider</property>
        
        
<!-- Echo all executed SQL to stdout -->
<property name="show_sql">true</property>


<!-- Drop and re-create the database schema on startup -->
<property name="hbm2ddl.auto">create</property>


<!-- Names the mapping entity class -->
<mapping class ="decodejava.User_Details"/>
<mapping class ="decodejava.Contact_Info"/>

</session-factory>

</hibernate-configuration>









Directory Structure of Hibernate Project






The picture above depicts how and where to arrange the primary POJO/Entity(.java) file, the secondary Entity(.java) class file and the other the class(that calls the hibernate into action) in a specific directory structure.

Project Folder - HibernateOneToOneMapping is the name of our Project and it is a top-level directory.


• This project folder contains the main package of our project i.e. decodejava, which contains the primary POJO/Entity class file i.e. User_Details.java, the secondary Entity class i.e. Contact_Info.java and the class that calls the hibernate into action i.e. Hiber.java.



• Besides this, the project folder also contains the hibernate configuration file i.e. hibernate.cfg.xml, and as we have used some Hibernate Annotations in this project, hence, there will be no need to create the mapping-resource with extension hbm.xml .



• The project folder also contains all the needed Hibernate JARs present in the required folder of Hibernate installation and the JDBC JAR file(ojdbc14.jar) required by Hibernate to connect to our database.







Execution


Finally, after executing Hiber class, two separate tables will be created in the database -
• USER_DETAILS
• CONTACT_INFO


Hence, when you execute the Hiber.java class, you will see the following output which shows one-to-one bidirectional mapping .



Hibernate: create sequence hibernate_sequence start with 1 increment by 1
Hibernate: create sequence id_seq start with 1 increment by 1
Hibernate: create table CONTACT_INFO (USER_ID number(10,0) not null, emailId varchar2(255 char), phoneNo varchar2(255 char), primary key (USER_ID))
Hibernate: create table USER_DETAILS (USER_ID number(10,0) not null, First_Name varchar2(255 char), Last_Name varchar2(255 char), primary key (USER_ID))
Hibernate: select hibernate_sequence.nextval from dual
Hibernate: select id_seq.nextval from dual
Hibernate: select id_seq.nextval from dual
Hibernate: select hibernate_sequence.nextval from dual
Hibernate: insert into USER_DETAILS (First_Name, Last_Name, USER_ID) values (?, ?, ?)
Hibernate: insert into CONTACT_INFO (emailId, phoneNo, USER_ID) values (?, ?, ?)
Hibernate: insert into USER_DETAILS (First_Name, Last_Name, USER_ID) values (?, ?, ?)
Hibernate: insert into CONTACT_INFO (emailId, phoneNo, USER_ID) values (?, ?, ?)
Hibernate: select user_detai0_.USER_ID as USER_ID1_1_0_, user_detai0_.First_Name as First_Name2_1_0_, user_detai0_.Last_Name as Last_Name3_1_0_, contact_in1_.USER_ID as USER_ID1_0_1_, contact_in1_.emailId as emailId2_0_1_, contact_in1_.phoneNo as phoneNo3_0_1_ from USER_DETAILS user_detai0_ left outer join CONTACT_INFO contact_in1_ on user_detai0_.USER_ID=contact_in1_.USER_ID where user_detai0_.USER_ID=?
Hibernate: select user_detai0_.USER_ID as USER_ID1_1_0_, user_detai0_.First_Name as First_Name2_1_0_, user_detai0_.Last_Name as Last_Name3_1_0_, contact_in1_.USER_ID as USER_ID1_0_1_, contact_in1_.emailId as emailId2_0_1_, contact_in1_.phoneNo as phoneNo3_0_1_ from USER_DETAILS user_detai0_ left outer join CONTACT_INFO contact_in1_ on user_detai0_.USER_ID=contact_in1_.USER_ID where user_detai0_.USER_ID=?
Retrieving the saved objects
First User
Id : 1
First Name : First
Last Name : User
Email id : email1-firstuser@email.com
Phone number : 11111111
Second User
Id : 2
First Name : Second
Last Name : User
Email id : email1-firstuser@email.com
Phone number : 11111111


This output shows you all the SQL commands executed by the Hibernate within the database to map the Java class to a database table and perform all the activities of saving and retrieving the objects of both Entity classes involved in a one-to-one relationship.



Moreover, if you see the following SQL query in the database -



• select * from USER_DETAILS; 



you will get the following output displaying the objects of User_Details Entity class stored in USER_DETAILS table, as shown below.







And on executing the second query in the database -



• select * from CONTACT_INFO; 



you will get the following output displaying the objects of child Contact_Info class stored in CONTACT_INFO table, as shown below.





This output shows how each object of CONTACT_INFO class is in one of one relationship with each object of USER_DETAILS through the same USER_ID primary key.

Note : The output clearly shows you that Hibernate has used its sequence object to generate the value of each primary key(Id) automatically as we have used @GeneratedValue annotations with it.






Please share this article -






< Prev
Next >
< Hibernate mapping TreeMap
OneToOne Mapping with Mapping Resource>



Advertisement