Hibernate Tutorial
Hibernate Tutorial
This tutorial will teach you how to use Hibernate to develop your database based web
applications in simple and easy steps.
Audience
This tutorial is designed for all those Java programmers who would like to understand the
Hibernate framework and its API.
Prerequisites
We assume you have a good understanding of the Java programming language. A basic
understanding of relational databases, JDBC, and SQL will be very helpful in understanding
this tutorial.
All the content and graphics published in this e-book are the property of Tutorials Point (I)
Pvt. Ltd. The user of this e-book is prohibited to reuse, retain, copy, distribute or republish
any contents or a part of the contents of this e-book in any manner without written consent
of the publisher.
We strive to update the contents of our website and tutorials as timely and as precisely as
possible, however, the contents may contain inaccuracies or errors. Tutorials Point (I) Pvt.
Ltd. provides no guarantee regarding the accuracy, timeliness, or completeness of our
website or its contents including this tutorial. If you discover any errors on our website or
in this tutorial, please notify us at [email protected]
i
Hibernate
Table of Contents
About the Tutorial ............................................................................................................... i
Audience............................................................................................................................. i
Prerequisite s ...................................................................................................................... i
What is JDBC?................................................................................................................... 1
Session Object................................................................................................................... 8
Query Object...................................................................................................................... 9
Criteria Object.................................................................................................................... 9
Installing IDE.....................................................................................................................10
Installing Hibernate...........................................................................................................11
ii
Hibernate
Verification .......................................................................................................................16
Hibernate Properties.........................................................................................................22
Session .............................................................................................................................26
Example ............................................................................................................................37
iv
Hibernate
v
Hibernate
vi
Hibernate
1. HIBERNATE – ORM
Any enterprise application performs database operations by storing and retrieving vast
amounts of data. Despite all the available technologies for storage management ,
application developers normally struggle to perform database operations efficiently.
Generally, Java developers use lots of code or proprietary framework to interact with the
database. Therefore, it is advisable to use Object Relational Mapping (ORM) to reduct the
burden of interacting with the database. ORM forms a bridge between object models (Java
program) and relational models (database program) like JDBC.
What is JDBC?
JDBC stands for Java Database Connectivity. It provides a set of Java API for accessing
the relational databases from Java program. These Java APIs enables Java programs to
exec ute SQL statements and interact with any SQL compliant database.
JDBC provides a flexible architecture to write a database independent application that can
run on different platforms and interact with different DBMS without any modification.
Example
One may encounter a few problems when direct interaction takes place between object models
and relation database tables. The following example highlights the problems associated with
traditional database application structure.
Here we have a Java Class called Employee with proper constructors and associated public
functions. We have a simple java entity class for an employee having fields (variables)
such as id, first_name, last_name, and salary.
1
Hibernate
public Employee() {}
public Employee(String fname, String lname, int salary) {
this.first_name = fname;
this.last_name = lname;
this.salary = salary;
}
public int getId() {
return id;
}
public String getFirstName() {
return first_name;
}
public String getLastName() {
return last_name;
}
public int getSalary() {
return salary;
}
}
Consider the above object needs to be stored and retrieved using the following RDBMS
table. : Following is the Create table statement for Employee class. Its field structure
should be same as the given object model (Employee class).
2
Hibernate
Thee following problems may arise when direction interaction takes place between object models
and relation database tables:
First, what if we need to modify the design of our database after having developed
a few pages or our application?
Mismatch Description
Sometimes you will have an object model, which has more classes than
Granularity
the number of corresponding tables in the database.
The ways you access objects in Java and in RDBMS are fundamentally
Navigation
different.
The Object-Relational Mapping (ORM) is the solution to handle all the above impedanc e
mismatches.
What is ORM?
ORM stands for Object-Relational Mapping (ORM) is a programming technique for
converting data between relational databases and object oriented programming languages
such as Java, C#, etc.An ORM system has the following advantages over plain JDBC:
S.N. Advantages
3
Hibernate
S.N. Solutions
Castor
TopLink
Spring DAO
4
Hibernate
2. HIBERNATE – OVERVIEW
Hibernate maps Java classes to database tables and from Java data types to SQL data
types and relieves the developer from 95% of common data persistence related
programming tasks.
Hibernate sits between traditional Java objects and database server to handle all the works
in persisting those objects based on the appropriate O/R mechanisms and patterns.
Hibernate Advantages
Here we have listed down the advantages of using Hibernate:
Hibernate takes care of mapping Java classes to database tables using XML files
and without writing any line of code. If there is a change in the database or in any table,
then all that you need to change are the XML file properties.
Provides simple APIs (classes and methods) for storing and retrieving Java objects
directly to and from the database.
Abstracts away the unfamiliar SQL types and provides a way to work around
familiar Java Objects.
Hibernate Supports only unchecked exceptions, so no need to write try, catch, or throws
blocks. Generally we have a Hibernate translator which converts Checked exceptions to
Unchecked.
5
Hibernate
Hibernate has its own query language. That is Hiberate Query Language (HQL) which
contains database independent controlers.
Hibernate supports caching mechanism: It reduces the number of round trips (tr ansactions)
between an application and the database. It increases the application performance.
Supported Databases
Hibernate supports almost all the major RDBMS database servers. Following is a list of few
of the database engines that Hibernate supports:
DB2/NT
MySQL
PostgreSQL
FrontBase
Oracle
XDoclet Spring
J2EE
Eclipse plug-ins
Maven
6
Hibernate
3. HIBERNATE – ARCHITECTURE
Hibernate has a layered architecture which helps the user to operate without having to
know the underlying APIs. Hibernate makes use of the database and configuration data to
provide persistence services (and persistent objects) to the application.
Following is a detailed view of the Hibernate Application Architecture with a few important
core classes in the Hibernate layer.
7
Hibernate
Hibernate uses various existing Java APIs, like JDBC, Java Transaction API (JTA), and Java
Naming and Directory Interface (JNDI). JDBC provides a rudimentary level of abstraction
of functionality common to relational databases, allowing almost any database with a JDBC
driver to be supported by Hibernate. JNDI and JTA support Hibernate to be integrated with
J2EE application servers.
The following section gives a brief description about the class objects which are involved
in the Hibernate Layer of the given architecture diagram. This sectiong gives you a
theritical idea of how the hibernate class objects are used to build an application.
Configuration Object
Configuration is a serializable class. It is the first Hibernate object that you need to create
in any Hibernate application. It is usually created only once during application initialization.
It allows the application to specify properties and mapping documents to be used. The
Configuration object provides two keys components:
SessionFactory Object
SessionFactory is a Factory Interface used to create Session instances. After adding the
properties and Mapping files to the Configuration object, it is used to create a SessionFactory
object which in turn configures Hibernate (Front-end javaclasses and Back-end tables) for the
application. SessionFactory is a thread-safe object and used by all the threads of an application.
It is a heavyweight object, usually created during application start -up and kept for later
use. You would need one SessionFactory object per database using a separate
configuration file. So, if you are using multiple databases, then you would have to create
multiple SessionFactory objects.
Session Object
Session is an Interface that wraps the JDBC connection. That means, it creates a physical
connection between the application and a database. The Session object is lightweight and
designed to be instantiated each time an interaction is needed with the database.
Persistent objects are saved and retrieved through a Session object.
The Lifecycle of a Session is bounded by the beginning and end of a logical trasaction. It contains
three states:
8
Hibernate
The session objects should not be kept open for a long time because they are not usually
thread-safe. They should be created and destroyed them as needed.
Transaction Object
Transaction is an Interface and it represents a unit of work with the database and most
of the RDBMS supports transaction functionality. Transactions in Hibernate are handled by
an underlying transaction manager.
This is an optional object and Hibernate applications may choose not to use this interface,
instead managing transactions in their own applicat ion code.
Query Object
Query is an interface and it is used in SQL or Hibernate Query Language (HQL) string to
retrieve data from the database and create objects. A Query instance is used to bind query
parameters, limit the number of results returned by the query, and finally to execute the
query.
Criteria Object
Criteria is an interface and it is used for retrieving entity data by composing Criterion
(Interface) objects. Criterion Objects work like a condition (WHERE and IF) in the SQL
query, all the criterion objects (conditions) are added to the Criteria Object and that object
will be executed and used for retriving entity data in objects.
9
Hibernate
4. HIBERNATE – ENVIRONMENT SETUP
This chapter explains how to install Hibernate and other associated packages to prepare a
develop environment for Hibernate applications. We will work with MySQL database for
Hibernate examples, so make sure you already have setup for MySQL database. For more
detail on MySQL, you can check our MySQL Tutorial.
We recommend that you use an IDE for Hibernate programming. We are using Eclipse IDE
for further explanation in this tutorial.
Installing IDE
Follow the steps given below to download and install Eclipse IDE.
Downloading Hibernate
Make sure you already have the latest version of Java installed on your machine. Following
are the simple steps to download Hibernate on your machine.
Make a choice whether you want to install Hibernate on Windows or Unix. Then
proceed to the next step to download either the .zip file for windows or the .tz file
for Unix.
10
Hibernate
Installing Hibernate
Follow the instructions given below for installing Hibernate on your system. We are using
Eclipse IDE for this tutorial, therefore it is required to add Hibernate capabilities (Hibernat e
Tools) to Eclipse IDE.
Open Eclipse IDE and select Help >> Install new Software.
Once you click the new installation software option, you will find the following screenshot.
Here you will provide the URL for downloading Hibernate tools. The URL is
"http://download.jboss.org/jbosstools/updates/stable/luna/" and click the add button.
11
Hibernate
After clicking the Add button, you will find the following dialog box. Here, in the place
of Name field: Enter JBoss Tool - Eclipse. Location Field is automatically filled with the
given JBoss URL (http://download.jboss.org/jbosstools/updates/stable/luna/), otherwise
fill it. Click OK.
After clicking OK, you will find the following screenshot. Fill the following sections in the
given screenshot.
12
Hibernate
SEC-3: Click Select All for selecting all Hibernate tools provided by JBoss
organization.
Click Next to process. The process will take some time, please wait.
After completing the process, you will find the following screenshot. Here, you have to
select all the options using the Control key and click Next.
13
Hibernate
Observe the following screenshot. Here, accept the License Agreement by clicking the
radiobutton and click Finish.
14
Hibernate
After clicking the Finish button, it will display the following dialog box. It will take some
time to install the software, please wait.
After installation, you have to restart your system to save the configurations.
15
Hibernate
Verification
Follow the instructions given below to verify if the Hibernate Installation was successful or not.
You will find the Hibernate Perspective in a dialog box as mentioned in the following
screenshot.
16
Hibernate
If you click Ok, then you will find the Eclipse IDE with Hibernate capabilities.
17
Hibernate
Step 2: Add jars and configure the build path of your project
Right-clik on the project folder (Example_demo). Go to Build Path -> Configure Build
Path. Then you will find the following screenshot. Here click on Add External JARs for
adding the reuired jars to your project.
18
Hibernate
When you click on Add External JARs, you will find the file explorer as shown below. This
screenshot shows two important sections:
1. The address where you downloaded the Hibernate jars that we have shown in the
Downloading Hibernate section of this chapter.
2. Select all jars in the required folder. These jars are used in Hibernate programmi ng.
Click Open to add all these jars to your project.
19
Hibernate
Now, you will find all the added jars in the Libraries section. Click OK to configure the build
path for your project.
20
Hibernate
Finally, after adding all the jars to your project , the directory structure will be as shown in
the following screenshot .
Hibernate requires to know in advance — where to find the mapping information that
defines how your Java classes relate to the database tables. Hibernate also requires a set
of configuration settings to identify the respective database and mapping files. All such
information is usually supplied as a standard Java properties file called
hibernate.properties, or as an XML file named hibernate.cfg.xml.
Connection properties
Hibernate properties
Mapping file names
Most of the properties take their default values and it is not required to specify them in
the property file unless it is really required. This file is kept in the root directory of your
application's classpath.
Note: You must create a Configuration file for each database. Suppose you are using two
different databses like MySQL and Oracle, then you must create two configuration files.
Hibernate Properties
The following table provides a list of important properties that you will be required to
configure for a database in a standalone situation:
hibernate.dialect
1 This property makes Hibernate generate the appropriate SQL for the chosen
database.
hibernate.connection.drive r_class
2
The JDBC driver class.
hibernate.connection.url
3
The JDBC URL to the database instance.
hibernate.connection.username
4
The database username.
hibernate.connection.password
5
The database password.
hibernate.connection.pool_size
6 Limits the number of connections waiting in the Hibernate database connection
pool.
hibernate.connection.autocommit
7
Allows auto-commit mode to be used for the JDBC connection.
22
Hibernate
If you are using a database along with an application server and JNDI, then you would
have to configure the following properties in the Hibernate configuration file:
hibernate.connection.datasource
1
This property specifies the JNDI name defined in the application server context.
hibernate.jndi.class
2
Defines the InitialContext class for JNDI.
hibernate.jndi.<JNDIpropertyname >
3
Passes any JNDI property you like to the JNDI InitialContext.
hibernate.jndi.url
4
Provides the URL for JNDI.
hibernate.connection.username
5
Defines the database username.
hibernate.connection.password
6
Defines the database password.
The XML configuration file must conform to the Hibernate 3 Configuration DTD, which is
available at http://www.hibernate.org/dtd/hibernate-configuration-3.0.dtd.
Example
Let us take an example for hibernate configuration file using the following properties.
Dialect: org.hibernate,dialect.MySQLDialect
Password: root
23
Hibernate
The following XML file is the Hibernate configuration file named hibernate.cfg.xml.
<hibernate-configuration>
<session-factory>
<property name="hibernate.dialect">
org.hibernate.dialect.MySQLDialect
</property>
<property name="hibernate.connection.driver_class">
com.mysql.jdbc.Driver
</property>
</session-factory>
</hibernate-configuration>
The above configuration file includes <mapping> tags, which are related to hibernate-
mapping file and we will see in next chapter what exactly a hibernate mapping file is and
how and why do we use it ?
24
Hibernate
The following table lists the Dialect properties of a few important databases:
DB2 org.hibernate.dialect.DB2Dialect
HSQLDB org.hibernate.dialect.HSQLDialect
HypersonicSQL org.hibernate.dialect.HSQLDialect
Informix org.hibernate.dialect.InformixDialect
Ingres org.hibernate.dialect.IngresDialect
Interbase org.hibernate.dialect.InterbaseDialect
MySQL org.hibernate.dialect.MySQLDialect
Oracle 9i org.hibernate.dialect.Oracle9iDialect
PostgreSQL org.hibernate.dialect.PostgreSQLDialect
Progress org.hibernate.dialect.ProgressDialect
SAP DB org.hibernate.dialect.SAPDBDialect
Sybase org.hibernate.dialect.SybaseDialect
25
Hibernate
6. HIBERNATE – SESSIONS
A Session in Hibernate works like a Connection in JDBC. The session opens a single
database connection when it is created, and holds the connection until the session is
closed. Every entity class object that is loaded by Hibernate to a nd from the database
server is associated with the session.
Session
A Session is an Interface that is used to establish a physical connection with a database. The
Session object is lightweight and designed to be instantiated each time an interaction is
needed with the database. Persistent objects are saved and retrieved through a Session
object.
The session objects should not be kept open for a long time because they are not usually
thread-safe and they should be created and destroyed as needed. The main function of a
Session object is to offer, create, read, and delete operations for instances of mapped
entity classes.
Instances may exist in one of the following three states at a given point in time:
Detached: Once we close the Hibernate Session, the persistent instance will
become a detached instance.
Sample Code
In the following code snippet, the instance of a Configuration class (c) is parsing the
hibernate configuration file (hibernate.cfg.xml) to configure the hibernate application.
Using this conf information, SessionFactory (session Container) creates an instance (sf)
26
Hibernate
for this application, this instance will work throughout the application life cycle. Using this
SessionFactoy instance (sf), we can create a Session object (s) by calling
"sf.openSession();" and finally we can create a transaction object through the Session
object to maintain consistency.
/* This method reads XML document, and take the configuration information
* form "/hibernate.cfg.xml". */
c.configure("/hibernate.cfg.xml");
27
Hibernate
s.close();
If the Session throws an exception, the transaction must be rolled back and the session
must be discarded.
Transaction beginTransaction()
1
Begin a unit of work and return the associated Transaction object.
void cancelQuery()
2
Cancel the execution of the current query.
void clear()
3
Completely clear the session.
Connection close()
4
End the session by releasing the JDBC connection and cleaning up.
Criteria createCriteria(Class persistentClass)
5 Create a new Criteria instance, for the given entity class, or a superclass of an
entity class.
Criteria createCriteria(String entityName)
6
Create a new Criteria instance, for the given entity name.
28
Hibernate
Transaction getTransaction()
16
Get the Transaction instance associated with this session.
boolean isConnected()
17
Check if the session is currently connected.
boolean isDirty()
18 Does this session contain any changes, which must be synchronized with the
database?
boolean isOpen()
19
Check if the session is still open.
Serializable save(Object object)
20
Persist the given transient instance, first assigning a generated identifier.
void saveOrUpdate(Object object)
21
Either save(Object) or update(Object) the given instance.
void update(Object object)
22 Update the persistent instance with the identifier of the given detached
instance.
29
Hibernate
7. HIBERNATE – PERSISTENT CLASS
The entire concept of Hibernate is to take the values from Java class attributes and persist
them to a database table. A mapping document helps Hibernate in determining how to
pull the values from the classes and map them with table and associated fields.
Java classes whose objects or instances will be stored in database tables are called
persistent classes in Hibernate. Hibernate works best if these classes follow some simple
rules, also known as the Plain Old Java Object (POJO) programming model.
There are following main rules of persistent classes, however, none of these rules are hard
requirements:
All classes should contain an ID in order to allow easy identification of your objects
within Hibernate and the database. This property maps to the primary key column
of a database table.
All attributes that will be persisted should be declared private and have get and
set methods defined in the JavaBean style.
A central feature of Hibernate, proxies, depends upon the persistent class being
either non-final, or the implementation of an interface that declares all public
methods.
All classes that do not extend or implement some specialized classes and interfaces
required by the EJB framework.
The POJO name is used to emphasize that a given object is an ordinary Java Object, not
a special object, and in particular not an Enterprise JavaBean.
30
Hibernate
}
public int getId() {
return id;
}
public void setId( int id ) {
this.id = id;
}
public String getFirstName() {
return firstName;
}
public void setFirstName( String first_name ) {
this.firstName = first_name;
}
public String getLastName() {
return lastName;
}
public void setLastName( String last_name ) {
this.lastName = last_name;
}
public int getSalary() {
return salary;
}
public void setSalary( int salary ) {
this.salary = salary;
}
}
31
Hibernate
8. HIBERNATE – MAPPING FILES
Object/relational mappings are usually defined in an XML document. This mapping file
instructs Hibernate — how to map the defined class or classes to the database tables ?
Though many Hibernate users choose to write the XML code by hand, but a number of
tools exist to generate the mapping document. These include XDoclet, Middlegen, and
AndroMDA for the advanced Hibernate users.
Let us consider our previously defined POJO class whose Objects will be persisted in the
table. Let us a look into the following POJO class.
public Employee() {}
public Employee(String fname, String lname, int salary) {
this.firstName = fname;
this.lastName = lname;
this.salary = salary;
}
public int getId() {
return id;
}
public void setId( int id ) {
this.id = id;
}
public String getFirstName() {
return firstName;
}
public void setFirstName( String first_name ) {
this.firstName = first_name;
}
public String getLastName() {
32
Hibernate
return lastName;
}
public void setLastName( String last_name ) {
this.lastName = last_name;
}
public int getSalary() {
return salary;
}
public void setSalary( int salary ) {
this.salary = salary;
}
}
There would be one table corresponding to each object you are willing to provide
persistence. Consider above objects need to be stored and retrieved into the following
RDBMS table:
Based on the two above entities, we can define following mapping file, which instructs
Hibernate how to map the defined class or classes to the database tables.
<hibernate-mapping>
<class name="Employee" table="EMPLOYEE">
<meta attribute="class-description">
This class contains the employee detail.
</meta>
<id name="id" type="int" column="id">
33
Hibernate
<generator class="native"/>
</id>
<property name="firstName" column="first_name" type="string"/>
<property name="lastName" column="last_name" type="string"/>
<property name="salary" column="salary" type="int"/>
</class>
</hibernate-mapping>
You should save the mapping document in a file with the format <classname>.hbm. xml.
We saved our mapping document in the file Employee.hbm.xml. Let us see understand a
little detail about the mapping elements used in the mapping file:
The <class> elements are used to define specific mappings from a Java classes to
the database tables. The Java class name is specified using the name attribute of
the class element and the database table name is specified using the table
attribute.
The <meta> element is optional element and can be used to create the class
description.
The <id> element maps the unique ID attribute in class to the primary key of the
database table. The name attribute of the id element refers to the property in the
class and the column attribute refers to the column in the database table. The
type attribute holds thehibernate type, this type will convert the data type from Java
to SQL.The <generator> element within the id element is used to generate the
primary key values automatically. The class attribute of the generator element is
set to native to let hibernate pick up either identity, sequence, or hilo algorit hm
to create primary key depending upon the capabilities of the underlying database.
The <property> element is used to map a Java class property to a column in the
database table. The name attribute of the element refers to the property in the
class and the column attribute refers to the column in the database table. The
type attribute holds the hibernate mapping type, this mapping types will convert
from Java to SQL data type.
There are other attributes and elements available, which will be used in a mapping
document and we will try to cover as many as possible in the subsequent chapters.
34
Hibernate
9. HIBERNATE – MAPPING TYPES
When you prepare a Hibernate mapping document, you find that you map the Java data
types into RDBMS data types. The types declared and used in the mapping files are not
Java data types; they are not SQL database types either. These types are called
Hibernate mapping types, which can translate from Java to SQL data types and vice
versa.
This chapter lists down all the basic, date and time, large object, and various other built -
in mapping types.
Primitive Types
Mapping type Java type ANSI SQL Type
integer int or java.lang.Integer INTEGER
long long or java.lang.Long BIGINT
short short or java.lang.Short SMALLINT
float float or java.lang.Float FLOAT
double double or java.lang.Double DOUBLE
big_decimal java.math.BigDecimal NUMERIC
character java.lang.String CHAR(1)
string java.lang.String VARCHAR
byte byte or java.lang.Byte TINYINT
boolean boolean or java.lang.Boolean BIT
CHAR(1) ('Y' or
yes/no boolean or java.lang.Boolean
'N')
CHAR(1) ('T' or
true/false boolean or java.lang.Boolean
'F')
35
Hibernate
VARBINARY (or
binary byte[]
BLOB)
text java.lang.String CLOB
any Java class that implements VARBINARY (or
serializable
java.io.Serializable BLOB)
clob java.sql.Clob CLOB
blob java.sql.Blob BLOB
JDK-related Types
Mapping type Java type ANSI SQL Type
class java.lang.Class VARCHAR
locale java.util.Locale VARCHAR
timezone java.util.TimeZone VARCHAR
currency java.util.Currency VARCHAR
36
Hibernate
10. HIBERNATE – EXAMPLES
Let us take an example to understand how to use Hibernate to provide Java persistence in a
standalone application. We will go through the different steps involved in creating a Java
application using Hibernate.
As we are using MySQL database for these examples, we have to add Mysql-
connector.jar to the employee_demo project in Eclipse IDE. You can download this jar
here.
Example
Let us consider employee management as an example. The employee management
system can create, update, find, and delete the records of an employee. As mentioned
above, we are using MySQL database for database operations.
Employee.java
Mapping
Employee.hbm.xml
Configuration
hibernate.cfg.xml
Services
CreatingEmployee.java
UpdatingEmployee.java
FindingEmployee.java
DeletingEmployee.java
Use the same project hierarchy which we have used in the Hibernate Environment chapter.
37
Hibernate
salary, and deg are the attributes of this entity. It contains default constructor, setter
and getter methods of those attributes.
public Employee() {}
public Employee(String fname, String lname, int salary) {
this.firstName = fname;
this.lastName = lname;
this.salary = salary;
}
public int getId() {
return id;
}
public void setId( int id ) {
this.id = id;
}
public String getFirstName() {
return firstName;
}
public void setFirstName( String first_name ) {
this.firstName = first_name;
}
public String getLastName() {
return lastName;
}
public void setLastName( String last_name ) {
this.lastName = last_name;
}
public int getSalary() {
return salary;
38
Hibernate
}
public void setSalary( int salary ) {
this.salary = salary;
}
}
Before going to the next module, we need to create a database for storing relational entity.
Open MySQL command line and type the following query:
It is better to name the POJO class same as the mapping file because each POJO class
must contain one mapping file. Here we are designing the mapping file for Employee.java
so that the mapping file is named as Employee.hbm.xml.
<?xml version="1.0"?>
<!DOCTYPE hibernate-mapping PUBLIC "-//Hibernate/Hibernate Mapping DTD 3.0//EN"
"http://hibernate.sourceforge.net/hibernate -mapping-3.0.dtd">
<hibernate-mapping>
<class name="com.tutorialspoint.hibernate.entity.Employee"
table="EMPLOYEE">
<id name="eid" type="int">
<column name="EID" />
<generator class="assigned" />
</id>
<property name="ename" type="java.lang.String">
<column name="ENAME" />
</property>
<property name="salary" type="double">
<column name="SALARY" />
</property>
<property name="deg" type="java.lang.String">
39
Hibernate
In the above XML, the <hibernate-mapping> tag defines the mapping configuration (how
the entity class data stored into database table). The <class> tag defines entity class with
package name. The <id> tag defines the primary key of the table and the <property> tag
defines the other fields of the table.
<hibernate-configuration>
<session-factory>
<property name="hibernate.dialect">
org.hibernate.dialect.MySQLDialect
</property>
<property name="hibernate.connection.driver_class">
com.mysql.jdbc.Driver
</property>
40
Hibernate
root
</property>
</session-factory>
</hibernate-configuration>
Persistence Operations
Persistence operations include operations such as create, read, update, and delete. In
a business component, all the persistence operations fall under service classes.
Example
Let us take an example to understand persistence operations in detail. Let us first of all
create a table called employee with the following fields – Eid, EName, Designation, and
Salary.
Create an Employee Record: Create a table and insert into it the records of four
employees.
Update an Employee Record: Update the salary of the employee having the id
value "1" to 60000.
Find an Employee Record: Find and Display the details of the employee having
the id value "1".
Delete an Employee Record: Delete the record of the employee having the id
value "1".
41
Hibernate
package com.tutorialspoint.hibernate.services;
import org.hibernate.cfg.*;
import org.hibernate.*;
import com.tutorialspoint.hibernate.entity.Employee;
/* con.setAutoCommit(false); */
Transaction t=s.beginTransaction();
try {
Employee e1= new Employee(1, "Gopal", 50000, "Manager");
Employee e2= new Employee(2, "Kiran", 40000, "Writer");
Employee e3= new Employee(3, "Raju", 20000, "Developer");
42
Hibernate
/* con.commit(); */
t.commit();
After compilation and execution of the above program, you will get notifications from
Hibernate library on the console panel of Eclipse IDE.
For result, open the MySQL query browser and type the following queries.
use test;
select * from employee;
The resultant database table named employee will be shown in a tabular format as
follows:
43
Hibernate
package com.tutorialspoint.hibernate.services;
import org.hibernate.*;
import org.hibernate.cfg.*;
import com.tutorialspoint.hibernate.entity.Employee;
After compilation and execution of the above program, you will get notifications from the
Hibernate library on the console panel of Eclipse IDE.
For result, open the MySQL query browser and type the following queries.
44
Hibernate
use test;
select * from employee;
The resultant database table named employee will be shown in a tabular format as
follows:
package com.tutorialspoint.hibernate.services;
import org.hibernate.*;
import org.hibernate.cfg.*;
import com.tutorialspoint.hibernate.entity.Employee;
After compilation and execution of the above program, you will get output from Hibernat e
library on the console panel of Eclipse IDE as follows:
employee ID = 1
employee NAME = Gopal
employee SALARY = 46000.0
employee DESIGNATION = Technical Manager
package com.tutorialspoint.hibernate.services;
import org.hibernate.*;
import org.hibernate.cfg.*;
import com.tutorialspoint.hibernate.entity.Employee;
46
Hibernate
After compilation and execution of the above program, you will get notifications from
Hibernate library on the console panel of eclipse IDE.
For result, open the MySQL query browser and type the following queries.
use test;
select * from employee;
The resultant database table named employee will be shown in a tabular format as
follows:
The employee record, whose Eid = 1 was removed from database table.
47
Hibernate
11. HIBERNATE – O/R MAPPINGS
So far, we have seen very basic O/R mapping using hibernate, but there are four most
important mapping topics, which we have to learn in detail.
These are:
Collection Mappings.
Association Mappings.
Inheritance Mappings.
Component Mappings.
Collection Mappings
If an entity or class has collection of values for a particular variable, then we can map
those values using any one of the collection interfaces available in java. Hibernate can
persist instances of java.util.Map, java.util.Set, java.util.SortedMa p,
java.util.SortedSet, java.util.List, and any array of persistent entities or values.
Arrays are supported by Hibernate with <primitive-array> for Java primitive value types
and <array> for everything else. However, they are rarely used, so I am not going to
discuss them in this tutorial.
48
Hibernate
If you want to map a user defined collection interfaces, which is not directly supported by
Hibernate, you need to tell Hibernate about the semantics of your custom collections,
which is not very easy and not recommend to be used.
A Set is mapped with a <set> element in the mapping table and initialized with
java.util.HashSet. You can use Set collection in your class when there is no duplicate
element required in the collection.
Further, assume each employee can have one or more certificate associated with him/her.
So, we will store certificate related information in a separate table having the following
structure:
import java.util.*;
public Employee() {}
public Employee(String fname, String lname, int salary) {
this.firstName = fname;
this.lastName = lname;
this.salary = salary;
}
public int getId() {
return id;
}
public void setId( int id ) {
this.id = id;
}
public String getFirstName() {
return firstName;
}
public void setFirstName( String first_name ) {
this.firstName = first_name;
}
public String getLastName() {
return lastName;
}
public void setLastName( String last_name ) {
this.lastName = last_name;
}
public int getSalary() {
return salary;
}
50
Hibernate
Now let us define another POJO class corresponding to CERTIFICATE table so that
certificate objects can be stored and retrieved into the CERTIFICATE table. This class
should also implement both the equals() and hashCode() methods so that Java can
determine whether any two elements/objects are identical.
<hibernate-mapping>
<class name="Employee" table="EMPLOYEE">
<meta attribute="class-description">
This class contains the employee detail.
</meta>
<id name="id" type="int" column="id">
<generator class="native"/>
</id>
<set name="certificates" cascade="all">
<key column="employee_id"/>
52
Hibernate
<one-to-many class="Certificate"/>
</set>
<property name="firstName" column="first_name" type="string"/>
<property name="lastName" column="last_name" type="string"/>
<property name="salary" column="salary" type="int"/>
</class>
</hibernate-mapping>
You should save the mapping document in a file with the format <classname>.hbm. xml.
We saved our mapping document in the file Employee.hbm.xml. You are already familiar
with most of the mapping detail, but let us see all the elements of mapping file once again:
The <class> elements are used to define specific mappings from a Java classes to
the database tables. The Java class name is specified using the name attribute of
the class element and the database table name is specified using the table
attribute.
The <meta> element is optional element and can be used to create the class
description.
The <id> element maps the unique ID attribute in class to the primary key of the
database table. The name attribute of the id element refers to the property in the
class and the column attribute refers to the column in the database table. The
type attribute holds the hibernate mapping type, this mapping types will convert
from Java to SQL data type.
The <generator> element within the id element is used to generate the primary
key values automatically. The class attribute of the generator element is set to
native to let hibernate pick up either identity, sequence or hilo algorithm to
create primary key depending upon the capabilities of the underlying database.
53
Hibernate
The <property> element is used to map a Java class property to a column in the
database table. The name attribute of the element refers to the property in the
class and the column attribute refers to the column in the database table. T he
type attribute holds the hibernate mapping type, this mapping types will convert
from Java to SQL data type.
The <set> element is new here and has been introduced to set the relationship
between Certificate and Employee classes. We used the cascade attribute in the
<set> element to tell Hibernate to persist the Certificate objects at the same time
as the Employee objects. The name attribute is set to the defined Set variable in
the parent class, in our case, it is certificates. For each set variable, we need to
define a separate set element in the mapping file.
The <key> element is the column in the CERTIFICATE table that holds the foreign
key to the parent object i.e. table EMPLOYEE.
The <one-to-many> element indicates that one Employee object relates to many
Certificate objects and, as such, the Certificate object must have a n Employee
parent associated with it. You can use either <one-to-one>, <many-to-one> or
<many-to-many> elements based on your requirement.
CreateApplication Class
Finally, we will c reate our application class with the main() method to run the application.
We will use this application to save few Employees’ records along with their certificates
and then we will apply CRUD operations on those records.
import java.util.*;
import org.hibernate.HibernateException;
import org.hibernate.Session;
import org.hibernate.Transaction;
import org.hibernate.SessionFactory;
import org.hibernate.cfg.Configuration;
tx.commit();
}catch (HibernateException e) {
if (tx!=null) tx.rollback();
e.printStackTrace();
}finally {
session.close();
}
}
/* Method to update salary for an employee */
public void updateEmployee(Integer EmployeeID, int salary ){
Session session = factory.openSession();
Transaction tx = null;
try{
tx = session.beginTransaction();
Employee employee =
(Employee)session.get(Employee.class, EmployeeID);
employee.setSalary( salary );
session.update(employee);
tx.commit();
}catch (HibernateException e) {
if (tx!=null) tx.rollback();
e.printStackTrace();
}finally {
session.close();
}
}
/* Method to delete an employee from the records */
public void deleteEmployee(Integer EmployeeID){
Session session = factory.openSession();
Transaction tx = null;
try{
tx = session.beginTransaction();
Employee employee =
(Employee)session.get(Employee.class, EmployeeID);
session.delete(employee);
tx.commit();
57
Hibernate
}catch (HibernateException e) {
if (tx!=null) tx.rollback();
e.printStackTrace();
}finally {
session.close();
}
}
}
You would get some notifications from Hibernate Library on the screen. And at the same
time, records would be created in EMPLOYEE and CERTIFICATE tables.
$java ManageEmployee
.......VARIOUS LOG MESSAGES WILL DISPLAY HERE........
58
Hibernate
If you check your EMPLOYEE and CERTIFICATE tables, they should have the following
records:
mysql>
A SortedSet is mapped with a <set> element in the mapping table and initialized with
java.util.TreeSet. The sort attribute can be set to either a comparator or natural ordering.
If we use natural ordering, then its iterator will traverse the set in ascending element
order.
59
Hibernate
Further, assume each employee can have one or more certificate associated with him/her.
So, we will store certificate related information in a separate table having the following
structure:
import java.util.*;
public Employee() {}
public Employee(String fname, String lname, int salary) {
this.firstName = fname;
this.lastName = lname;
this.salary = salary;
}
public int getId() {
return id;
60
Hibernate
}
public void setId( int id ) {
this.id = id;
}
public String getFirstName() {
return firstName;
}
public void setFirstName( String first_name ) {
this.firstName = first_name;
}
public String getLastName() {
return lastName;
}
public void setLastName( String last_name ) {
this.lastName = last_name;
}
public int getSalary() {
return salary;
}
public void setSalary( int salary ) {
this.salary = salary;
}
public SortedSet getCertificates() {
return certificates;
}
public void setCertificates( SortedSet certificates ) {
this.certificates = certificates;
}
}
Now let us define another POJO class corresponding to CERTIFICATE table so that
certificate objects can be stored and retrieved into the CERTIFICATE table. This cla ss
should also implement Comparable interface and compareTo method, which will be used
to sort the elements in case you set sort="natural" in your mapping file (see below
mapping file):
public Certificate() {}
public Certificate(String name) {
this.name = name;
}
public int getId() {
return id;
}
public void setId( int id ) {
this.id = id;
}
public String getName() {
return name;
}
public void setName( String name ) {
this.name = name;
}
public int compareTo(Certificate that){
final int BEFORE = -1;
final int AFTER = 1;
if (that == null) {
return BEFORE;
}
if(thisCertificate == null) {
return AFTER;
} else if(thatCertificate == null) {
return BEFORE;
} else {
return thisCertificate.compareTo(thatCertificate);
}
62
Hibernate
}
}
<hibernate-mapping>
<class name="Employee" table="EMPLOYEE">
<meta attribute="class-description">
This class contains the employee detail.
</meta>
<id name="id" type="int" column="id">
<generator class="native"/>
</id>
<set name="certificates" cascade="all" sort="MyClass">
<key column="employee_id"/>
<one-to-many class="Certificate"/>
</set>
<property name="firstName" column="first_name" type="string"/>
<property name="lastName" column="last_name" type="string"/>
<property name="salary" column="salary" type="int"/>
</class>
63
Hibernate
</id>
<property name="name" column="certificate_name" type="string"/>
</class>
</hibernate-mapping>
You should save the mapping document in a file with the format <classname>.hbm. xml.
We saved our mapping document in the file Employee.hbm.xml. You are already familiar
with most of the mapping detail, but let us see all the elements of mapping file once again:
The <class> elements are used to define specific mappings from a Java classes to
the database tables. The Java class name is specified using the name attribute of
the class element and the database table name is specified using the table
attribute.
The <meta> element is optional element and can be used to create the class
description.
The <id> element maps the unique ID attribute in class to the primary key of the
database table. The name attribute of the id element refers to the property in the
class and the column attribute refers to the column in the database table. The
type attribute holds the hibernate mapping type, this mapping types will convert
from Java to SQL data type.
The <generator> element within the id element is used to generate the primary
key values automatically. The class attribute of the generator element is set to
native to let hibernate pick up either identity, sequence or hilo algorithm to
create primary key depending upon the capabilities of the underlying database.
The <property> element is used to map a Java class property to a column in the
database table. The name attribute of the element refers to the property in the
class and the column attribute refers to the column in the database table. The
type attribute holds the hibernate mapping type, this mapping types will convert
from Java to SQL data type.
The <set> element is used to set the relationship between Certificate and
Employee classes. We used the cascade attribute in the <set> element to tell
Hibernate to persist the Certificate objects at the same time as the Employee
objects. The name attribute is set to the defined SortedSet variable in the parent
class, in our case it is certificates. The sort attribute can be set to natural to have
natural sorting or it can be set to a custom class implement i ng
java.util.Comparator. We have used a class MyClass, which impleme nt s
java.util.Comparator to reverse the sorting order imple mented in Certificate class.
The <key> element is the column in the CERTIFICATE table that holds the foreign
key to the parent object i.e. table EMPLOYEE.
64
Hibernate
The <one-to-many> element indicates that one Employee object relates to many
Certificate objects and, as such, the Certificate object must have an Employee
parent associated with it. You can use either <one-to-one>, <many-to-one> or
<many-to-many> elements based on your requirement.
If we use sort="natural" setting, then we do not need to create a separate class because
Certificate class already has implemented Comparable interface and hibernate will use
compareTo() method defined in Certificate class to compare certificate names. But we are
using a custom comparator class MyClass in our mapping file so we would have to create
this class based on our sorting algorithm. Let us do descending sorting in this class using
this class.
import java.util.Comparator;
if(thisCertificate == null) {
return AFTER * 1;
} else if(thatCertificate == null) {
return BEFORE * -1;
} else {
return thisCertificate.compareTo(thatCertificate) * -1;
}
}
}
65
Hibernate
CreateApplication Class
Finally, we will create our application class with the main() method to run the application.
We will use this application to save few Employee’s records along with their certificates
and then we will apply CRUD operations on those records.
import java.util.*;
import org.hibernate.HibernateException;
import org.hibernate.Session;
import org.hibernate.Transaction;
import org.hibernate.SessionFactory;
import org.hibernate.cfg.Configuration;
66
Hibernate
Employee employee =
(Employee)session.get(Employee.class, EmployeeID);
employee.setSalary( salary );
session.update(employee);
tx.commit();
}catch (HibernateException e) {
if (tx!=null) tx.rollback();
e.printStackTrace();
}finally {
session.close();
}
}
/* Method to delete an employee from the records */
public void deleteEmployee(Integer EmployeeID){
Session session = factory.openSession();
Transaction tx = null;
try{
tx = session.beginTransaction();
Employee employee =
(Employee)session.get(Employee.class, EmployeeID);
session.delete(employee);
tx.commit();
}catch (HibernateException e) {
if (tx!=null) tx.rollback();
e.printStackTrace();
}finally {
session.close();
}
}
}
You would get notification from hibernate library on the screen, and same time records would
be created in EMPLOYEE and CERTIFICATE tables. You can see certificates have been
sorted in reverse order. You can try by changing your mapping file, simply set
sort="natural" and execute your program and compare the results.
$java ManageEmployee
.......VARIOUS LOG MESSAGES WILL DISPLAY HERE........
If you check your EMPLOYEE and CERTIFICATE tables, they should have the following
records:
70
Hibernate
| id | certificate_name | employee_id |
+----+------------------+-------------+
| 1 | MBA | 1 |
| 2 | PMP | 1 |
| 3 | MCA | 1 |
+----+------------------+-------------+
3 rows in set (0.00 sec)
mysql>
A List is mapped with a <list> element in the mapping table and initialized with
java.util.ArrayList.
Further, assume each employee can have one or more certificate associated with him/her.
A List collection mapping needs an index column in the collection table. The index column
defines the position of the element in the collection. So, we will store certificate related
information in a separate table having the following structure:
import java.util.*;
public Employee() {}
public Employee(String fname, String lname, int salary) {
this.firstName = fname;
this.lastName = lname;
this.salary = salary;
}
public int getId() {
return id;
}
public void setId( int id ) {
this.id = id;
}
public String getFirstName() {
return firstName;
}
public void setFirstName( String first_name ) {
this.firstName = first_name;
72
Hibernate
}
public String getLastName() {
return lastName;
}
public void setLastName( String last_name ) {
this.lastName = last_name;
}
public int getSalary() {
return salary;
}
public void setSalary( int salary ) {
this.salary = salary;
}
public Certificate() {}
public Certificate(String name) {
this.name = name;
}
public int getId() {
return id;
}
public void setId( int id ) {
73
Hibernate
this.id = id;
}
public String getName() {
return name;
}
public void setName( String name ) {
this.name = name;
}
}
<hibernate-mapping>
<class name="Employee" table="EMPLOYEE">
<meta attribute="class-description">
This class contains the employee detail.
</meta>
<id name="id" type="int" column="id">
<generator class="native"/>
</id>
<list name="certificates" cascade="all">
<key column="employee_id"/>
<list-index column="idx"/>
<one-to-many class="Certificate"/>
</list>
<property name="firstName" column="first_name" type="string"/>
<property name="lastName" column="last_name" type="string"/>
<property name="salary" column="salary" type="int"/>
74
Hibernate
</class>
</hibernate-mapping>
You should save the mapping document in a file with the format <classname>.hbm. xml.
We saved our mapping document in the file Employee.hbm.xml. You are already familiar
with most of the mapping detail, but let us see all the elements of mapping file once again:
The <class> elements are used to define specific mappings from a Java classes to
the database tables. The Java class name is specified using the name attribute of
the class element and the database table name is specified using the table
attribute.
The <meta> element is optional element and can be used to create the class
description.
The <id> element maps the unique ID attribute in class to the primary key of the
database table. The name attribute of the id element refers to the property in the
class and the column attribute refers to the column in the database table. The
type attribute holds the hibernate mapping type, this mapping types will convert
from Java to SQL data type.
The <generator> element within the id element is used to generate the primary
key values automatically. The class attribute of the generator element is set to
native to let hibernate pick up either identity, sequence or hilo algorithm to
create primary key depending upon the capabilities of the underlying database.
The <property> element is used to map a Java class property to a column in the
database table. The name attribute of the element refers to the property in the
class and the column attribute refers to the column in the database table. The
type attribute holds the hibernate mapping type, this mapping types will convert
from Java to SQL data type.
75
Hibernate
The <list> element is used to set the relationship between Certificate and
Employee classes. We used the cascade attribute in the <list> element to tell
Hibernate to persist the Certificate objects at the same time as the Employee
objects. The name attribute is set to the defined List variable in the parent class,
in our case, it is certificates.
The <key> element is the column in the CERTIFICATE table that holds the foreign
key to the parent object i.e. table EMPLOYEE.
The <list-index> element is used to keep the position of the element and map
with the index column in the collection table. The index of the persistent list starts
at zero. You could change this, for example, with <list -index base="1".../> in your
mapping.
The <one-to-many> element indicates that one Employee object relates to many
Certificate objects and, as such, the Certificate object must have a n Employee
parent associated with it. You can use either <one-to-one>, <many-to-one> or
<many-to-many> elements based on your requirement. If we changed this
example to use a many-to-many relationship, we would need an association table
to map between the parent and the child objects.
CreateApplication Class
Finally, we will create our application class with the main() method to run the application.
We will use this application to save few Employee's records along with their certificates
and then we will apply CRUD operations on those records.
import java.util.*;
import org.hibernate.HibernateException;
import org.hibernate.Session;
import org.hibernate.Transaction;
import org.hibernate.SessionFactory;
import org.hibernate.cfg.Configuration;
tx.commit();
}catch (HibernateException e) {
if (tx!=null) tx.rollback();
e.printStackTrace();
}finally {
session.close();
}
}
/* Method to update salary for an employee */
public void updateEmployee(Integer EmployeeID, int salary ){
Session session = factory.openSession();
Transaction tx = null;
try{
tx = session.beginTransaction();
Employee employee =
(Employee)session.get(Employee.class, EmployeeID);
employee.setSalary( salary );
session.update(employee);
tx.commit();
}catch (HibernateException e) {
if (tx!=null) tx.rollback();
e.printStackTrace();
}finally {
session.close();
}
}
/* Method to delete an employee from the records */
public void deleteEmployee(Integer EmployeeID){
Session session = factory.openSession();
Transaction tx = null;
try{
tx = session.beginTransaction();
Employee employee =
(Employee)session.get(Employee.class, EmployeeID);
session.delete(employee);
tx.commit();
79
Hibernate
}catch (HibernateException e) {
if (tx!=null) tx.rollback();
e.printStackTrace();
}finally {
session.close();
}
}
}
You would get the following result on the screen, and same time records would be created
in EMPLOYEE and CERTIFICATE tables. You can see, certificates have been sorted in
reverse order. You can try by changing your mapping file, simply set sort="natural" and
execute your program and compare the results.
$java ManageEmployee
.......VARIOUS LOG MESSAGES WILL DISPLAY HERE........
80
Hibernate
Certificate: PMP
If you check your EMPLOYEE and CERTIFICATE tables, they should have the following
records:
mysql>
Alternatively, you could map a Java array instead of a list. An array mapping is virtually
identical to the previous example, except with different element and attribute names
(<array> and <array-index>). However, for reasons explained earlier, Hibernat e
applications rarely use arrays.
A Collection is mapped with a <bag> element in the mapping table and initialize d with
java.util.ArrayList.
81
Hibernate
Further, assume each employee can have one or more certificate associated with him/her.
We will store certificate related information in a separate table having the following
structure:
import java.util.*;
public Employee() {}
public Employee(String fname, String lname, int salary) {
82
Hibernate
this.firstName = fname;
this.lastName = lname;
this.salary = salary;
}
public int getId() {
return id;
}
public void setId( int id ) {
this.id = id;
}
public String getFirstName() {
return firstName;
}
public void setFirstName( String first_name ) {
this.firstName = first_name;
}
public String getLastName() {
return lastName;
}
public void setLastName( String last_name ) {
this.lastName = last_name;
}
public int getSalary() {
return salary;
}
public void setSalary( int salary ) {
this.salary = salary;
}
83
Hibernate
public Certificate() {}
public Certificate(String name) {
this.name = name;
}
public int getId() {
return id;
}
public void setId( int id ) {
this.id = id;
}
public String getName() {
return name;
}
public void setName( String name ) {
this.name = name;
}
}
<hibernate-mapping>
84
Hibernate
</hibernate-mapping>
You should save the mapping document in a file with the format <classname>.hbm. xml.
We saved our mapping document in the file Employee.hbm.xml. You are already familiar
with most of the mapping detail, but let us see all the elements of mapping file once again:
The <class> elements are used to define specific mappings from a Java classes to
the database tables. The Java class name is specified using the name attribute of
the class element and the database table name is specified using the table
attribute.
85
Hibernate
The <meta> element is optional element and can be used to create the class
description.
The <id> element maps the unique ID attribute in class to the primary key of the
database table. The name attribute of the id element refers to the property in the
class and the column attribute refers to the column in the database table. The
type attribute holds the hibernate mapping type, this mapping types will convert
from Java to SQL data type.
The <generator> element within the id element is used to generate the primary
key values automatically. The class attribute of the generator element is set to
native to let hibernate pick up either identity, sequence or hilo algorithm to
create primary key depending upon the capabilities of the underlying database.
The <property> element is used to map a Java class property to a column in the
database table. The name attribute of the element refers to the property in the
class and the column attribute refers to the column in the database table. The
type attribute holds the hibernate mapping type, this mapping types will convert
from Java to SQL data type.
The <bag> element is used to set the relationship between Certificate and
Employee classes. We used the cascade attribute in the <bag> element to tell
Hibernate to persist the Certificate objects at the same time as the Employee
objects. The name attribute is set to the defined Collection variable in the parent
class, in our c ase it is certificates.
The <key> element is the column in the CERTIFICATE table that holds the foreign
key to the parent object i.e. table EMPLOYEE.
The <one-to-many> element indicates that one Employee object relates to many
Certificate objects and, as such, the Certificate object must have an Employee
parent associated with it. You can use either <one-to-one>, <many-to-one> or
<many-to-many> elements based on your requirement.
CreateApplication Class
Finally, we will create our application class with the main() method to run the application.
We will use this application to save few Employees’ records along with their certificates
and then we will apply CRUD operations on those records.
import java.util.*;
import org.hibernate.HibernateException;
import org.hibernate.Session;
import org.hibernate.Transaction;
import org.hibernate.SessionFactory;
import org.hibernate.cfg.Configuration;
86
Hibernate
ME.listEmployees();
You would get some notifications from hibernate library on the screen, and same time records
would be created in EMPLOYEE and CERTIFICATE tables. You can see , certificates has been
sorted in reverse order. You can try by changing your mapping file, simply set
sort="natural" and execute your program and compare the results.
$java ManageEmployee
.......VARIOUS LOG MESSAGES WILL DISPLAY HERE........
Certificate: MBA
Certificate: PMP
First Name: Dilip Last Name: Kumar Salary: 3000
Certificate: BCA
Certificate: BA
First Name: Manoj Last Name: Kumar Salary: 5000
Certificate: MCA
Certificate: MBA
Certificate: PMP
If you check your EMPLOYEE and CERTIFICATE tables, they should have the following
records:
mysql>
91
Hibernate
allow a map's contents to be viewed as a set of keys, collection of values, or set of key-
value mappings.
A Map is mapped with a <map> element in the mapping table and an unordered map can
be initialized with java.util.HashMap.
Further, assume eac h employee can have one or more certificate associated with him/her.
We will store certificate related information in a separate table having the following
structure:
import java.util.*;
public Employee() {}
public Employee(String fname, String lname, int salary) {
this.firstName = fname;
this.lastName = lname;
this.salary = salary;
}
public int getId() {
return id;
}
public void setId( int id ) {
this.id = id;
}
public String getFirstName() {
return firstName;
}
public void setFirstName( String first_name ) {
this.firstName = first_name;
}
public String getLastName() {
return lastName;
}
public void setLastName( String last_name ) {
this.lastName = last_name;
}
public int getSalary() {
return salary;
}
public void setSalary( int salary ) {
this.salary = salary;
}
}
public void setCertificates( Map certificates ) {
this.certificates = certificates;
}
}
public Certificate() {}
public Certificate(String name) {
this.name = name;
}
public int getId() {
return id;
}
public void setId( int id ) {
this.id = id;
}
public String getName() {
return name;
}
public void setName( String name ) {
this.name = name;
}
}
94
Hibernate
<hibernate-mapping>
<class name="Employee" table="EMPLOYEE">
<meta attribute="class-description">
This class contains the employee detail.
</meta>
<id name="id" type="int" column="id">
<generator class="native"/>
</id>
<map name="certificates" cascade="all">
<key column="employee_id"/>
<index column="certificate_type" type="string"/>
<one-to-many class="Certificate"/>
</map>
<property name="firstName" column="first_name" type="string"/>
<property name="lastName" column="last_name" type="string"/>
<property name="salary" column="salary" type="int"/>
</class>
</hibernate-mapping>
You should save the mapping document in a file with the format <classname>.hbm. xml.
We saved our mapping document in the file Employee.hbm.xml. You are already familiar
with most of the mapping detail, but let us see all the elements of mapping file once again:
95
Hibernate
The <class> elements are used to define specific mappings from a Java classes to
the database tables. The Java class name is specified using the name attribute of
the class element and the database table name is specified using the table
attribute.
The <meta> element is optional element and can be used to create the class
description.
The <id> element maps the unique ID attribute in class to the primary key of the
database table. The name attribute of the id element refers to the property in the
class and the column attribute refers to the column in the database table. The
type attribute holds the hibernate mapping type, this mapping types will convert
from Java to SQL data type.
The <generator> element within the id element is used to generate the primary
key values automatically. The class attribute of the generator element is set to
native to let hibernate pick up either identity, sequence or hilo algorithm to
create primary key depending upon the capabilities of the underlying database.
The <property> element is used to map a Java class property to a column in the
database table. The name attribute of the element refers to the property in the
class and the column attribute refers to the column in the database table. T he
type attribute holds the hibernate mapping type, this mapping types will convert
from Java to SQL data type.
The <map> element is used to set the relationship between Certificate and
Employee classes. We used the cascade attribute in the <map> element t o tell
Hibernate to persist the Certificate objects at the same time as the Employee
objects. The name attribute is set to the defined Map variable in the parent class,
in our case it is certificates.
The <index> element is used to represents the key parts of the key/value map
pair. The key will be stored in the column certificate_type using a type of string.
The <key> element is the column in the CERTIFICATE table that holds the foreign
key to the parent object i.e. table EMPLOYEE.
The <one-to-many> element indicates that one Employee object relates to many
Certificate objects and, as such, the Certificate object must have a n Employee
parent associated with it. You can use either <one-to-one>, <many-to-one> or
<many-to-many> elements based on your requirement.
CreateApplication Class
Finally, we will create our application class with the main() method to run the application.
We will use this application to save an Employee record along with a list of certificates and
then we will apply CRUD operations on that record.
import java.util.*;
96
Hibernate
import org.hibernate.HibernateException;
import org.hibernate.Session;
import org.hibernate.Transaction;
import org.hibernate.SessionFactory;
import org.hibernate.cfg.Configuration;
97
Hibernate
(((Certificate)ec.get("ComputerScience")).getName()));
System.out.println("Certificate: " +
(((Certificate)ec.get("BusinessManagement")).getName()));
System.out.println("Certificate: " +
(((Certificate)ec.get("ProjectManagement")).getName()));
}
tx.commit();
}catch (HibernateException e) {
if (tx!=null) tx.rollback();
e.printStackTrace();
}finally {
session.close();
}
}
/* Method to update salary for an employee */
public void updateEmployee(Integer EmployeeID, int salary ){
Session session = factory.openSession();
Transaction tx = null;
try{
tx = session.beginTransaction();
Employee employee =
(Employee)session.get(Employee.class, EmployeeID);
employee.setSalary( salary );
session.update(employee);
tx.commit();
}catch (HibernateException e) {
if (tx!=null) tx.rollback();
e.printStackTrace();
}finally {
session.close();
}
}
/* Method to delete an employee from the records */
public void deleteEmployee(Integer EmployeeID){
Session session = factory.openSession();
Transaction tx = null;
99
Hibernate
try{
tx = session.beginTransaction();
Employee employee =
(Employee)session.get(Employee.class, EmployeeID);
session.delete(employee);
tx.commit();
}catch (HibernateException e) {
if (tx!=null) tx.rollback();
e.printStackTrace();
}finally {
session.close();
}
}
}
You would get some notifications from Hibernate library on the screen, and at the same
time, records would be created in EMPLOYEE and CERTIFICATE tables.
$java ManageEmployee
.......VARIOUS LOG MESSAGES WILL DISPLAY HERE........
100
Hibernate
Certificate: MBA
Certificate: PMP
If you check your EMPLOYEE and CERTIFICATE tables, they should have the following
records:
A SortedMap is mapped with a <map> element in the mapping table and an ordered map
can be initialized with java.util.TreeMap.
Further, assume each employee can have one or more certificate associated with him/her.
We will store certificate related information in a separate table having the following
structure:
import java.util.*;
public Employee() {}
public Employee(String fname, String lname, int salary) {
this.firstName = fname;
this.lastName = lname;
this.salary = salary;
}
102
Hibernate
103
Hibernate
to sort the key elements of the SortedMap in case you set sort ="natural" in your mapping
file (see below mapping file).
public Certificate() {}
public Certificate(String name) {
this.name = name;
}
public int getId() {
return id;
}
public void setId( int id ) {
this.id = id;
}
public String getName() {
return name;
}
public void setName( String name ) {
this.name = name;
}
public int compareTo(String that){
final int BEFORE = -1;
final int AFTER = 1;
if (that == null) {
return BEFORE;
}
if(thisCertificate == null) {
return AFTER;
} else if(thatCertificate == null) {
104
Hibernate
return BEFORE;
} else {
return thisCertificate.compareTo(thatCertificate);
}
}
}
<hibernate-mapping>
<class name="Employee" table="EMPLOYEE">
<meta attribute="class-description">
This class contains the employee detail.
</meta>
<id name="id" type="int" column="id">
<generator class="native"/>
</id>
<map name="certificates" cascade="all" sort="MyClass">
<key column="employee_id"/>
<index column="certificate_type" type="string"/>
<one-to-many class="Certificate"/>
</map>
<property name="firstName" column="first_name" type="string"/>
<property name="lastName" column="last_name" type="string"/>
<property name="salary" column="salary" type="int"/>
</class>
105
Hibernate
<meta attribute="class-description">
This class contains the certificate records.
</meta>
<id name="id" type="int" column="id">
<generator class="native"/>
</id>
<property name="name" column="certificate_name" type="string"/>
</class>
</hibernate-mapping>
You should save the mapping document in a file with the format <classname>.hbm. xml.
We saved our mapping document in the file Employee.hbm.xml. You are alrea dy familiar
with most of the mapping detail, but let us see all the elements of mapping file once again:
The <class> elements are used to define specific mappings from a Java classes to
the database tables. The Java class name is specified using the name attribute of
the class element and the database table name is specified using the table
attribute.
The <meta> element is optional element and can be used to create the class
description.
The <id> element maps the unique ID attribute in class to the primary key of the
database table. The name attribute of the id element refers to the property in the
class and the column attribute refers to the column in the database table. The
type attribute holds the hibernate mapping type, this mapping types will convert
from Java to SQL data type.
The <generator> element within the id element is used to generate the primary
key values automatically. The class attribute of the generator element is set to
native to let hibernate pick up either identity, sequence or hilo algorithm to
create primary key depending upon the capabilities of the underlying database.
The <property> element is used to map a Java class property to a column in the
database table. The name attribute of the element refers to the property in the
class and the column attribute refers to the column in the database table. The
type attribute holds the hibernate mapping type, this mapping types will convert
from Java to SQL data type.
The <map> element is used to set the relationship between Certificate and
Employee classes. We used the cascade attribute in the <map> element to tell
Hibernate to persist the Certificate objects at the same time as the Employee
objects. The name attribute is set to the defined SortedMap variable in the parent
class, in our case it is certificates. The sort attribute can be set to natural to have
106
Hibernate
The <index> element is used to represents the key parts of the key/value map
pair. The key will be stored in the column certificate_type using a type of string.
The <key> element is the column in the CERTIFICATE table that holds the foreign
key to the parent object i.e. table EMPLOYEE.
The <one-to-many> element indicates that one Employee object relates to many
Certificate objects and, as such, the Certificate object must have a n Employee
parent associated with it. You can use either <one-to-one>, <many-to-one> or
<many-to-many> elements based on your requirement.
If we use sort="natural" setting, then we do not need to create a separate class because
Certificate class already has implemented Comparable interface and hibernate will use
compareTo() method defined in Certificate class to compare SortedMap keys. But we are
using a custom comparator class MyClass in our mapping file so we would have to create
this class based on our sorting algorithm. Let us do descending sorting of the keys available
in the map.
import java.util.Comparator;
if(thisCertificate == null) {
return AFTER * 1;
} else if(thatCertificate == null) {
return BEFORE * -1;
} else {
return thisCertificate.compareTo(thatCertificate) * -1;
107
Hibernate
}
}
}
Finally, we will create our application class with the main() method to run the application.
We will use this application to save few Employee's records along with their certificates
and then we will apply CRUD operations on those records.
import java.util.*;
import org.hibernate.HibernateException;
import org.hibernate.Session;
import org.hibernate.Transaction;
import org.hibernate.SessionFactory;
import org.hibernate.cfg.Configuration;
session.close();
}
return employeeID;
}
111
Hibernate
You would get the following result on the screen, and same time, records would be created
in EMPLOYEE and CERTIFICATE tables. You can see, certificates type has been sorted in
reverse order. You can try by changing your mapping file, simply set sort="natural" and
execute your program and compare the results.
$java ManageEmployee
.......VARIOUS LOG MESSAGES WILL DISPLAY HERE........
If you check your EMPLOYEE and CERTIFICATE tables, they should have the following
records:
+----+------------+-----------+--------+
1 row in set (0.00 sec)
mysql>
Association Mappings
The mapping of associations between entity classes and the relationships between tables
is the soul of ORM. Following are the four ways in which the cardinality of the relationship
between the objects can be expressed. An association mapping can be unidirectional as
well as bidirectional.
113
Hibernate
Further, many employee can have same address, so this association can be presented
using many-to-one association. We will store address related information in a separate
table having the following structure:
Create both the RBDMS tables and keep them ready for the next implementation.
import java.util.*;
public Employee() {}
public Employee(String fname, String lname,
int salary, Address address ) {
this.firstName = fname;
114
Hibernate
this.lastName = lname;
this.salary = salary;
this.address = address;
}
public int getId() {
return id;
}
public void setId( int id ) {
this.id = id;
}
public String getFirstName() {
return firstName;
}
public void setFirstName( String first_name ) {
this.firstName = first_name;
}
public String getLastName() {
return lastName;
}
public void setLastName( String last_name ) {
this.lastName = last_name;
}
public int getSalary() {
return salary;
}
public void setSalary( int salary ) {
this.salary = salary;
}
115
Hibernate
We need to define another POJO class corresponding to ADDRESS table so that address
objects can be stored and retrieved into the ADDRESS table.
import java.util.*;
public Address() {}
public Address(String street, String city,
String state, String zipcode) {
this.street = street;
this.city = city;
this.state = state;
this.zipcode = zipcode;
}
public int getId() {
return id;
}
public void setId( int id ) {
this.id = id;
}
public String getStreet() {
return street;
}
public void setStreet( String street ) {
this.street = street;
}
public String getCity() {
116
Hibernate
return city;
}
public void setCity( String city ) {
this.city = city;
}
public String getState() {
return state;
}
public void setState( String state ) {
this.state = state;
}
public String getZipcode() {
return zipcode;
}
public void setZipcode( String zipcode ) {
this.zipcode = zipcode;
}
<hibernate-mapping>
<class name="Employee" table="EMPLOYEE">
<meta attribute="class-description">
This class contains the employee detail.
</meta>
<id name="id" type="int" column="id">
117
Hibernate
<generator class="native"/>
</id>
<property name="firstName" column="first_name" type="string"/>
<property name="lastName" column="last_name" type="string"/>
<property name="salary" column="salary" type="int"/>
<many-to-one name="address" column="address"
class="Address" not-null="true"/>
</class>
</hibernate-mapping>
You should save the mapping document in a file with the format <classname>.hbm. xml.
We saved our mapping document in the file Employee.hbm.xml. You are already familiar
with most of the mapping detail, but let us see all the elements of mapping file once again:
The <class> elements are used to define specific mappings from a Java classes to
the database tables. The Java class name is specified using the name attribute of
the class element and the database table name is specified using the table
attribute.
The <meta> element is optional element and can be used to create the class
description.
The <id> element maps the unique ID attribute in class to the primary key of the
database table. The name attribute of the id element refers to the property in the
class and the column attribute refers to the column in the database table. The
118
Hibernate
type attribute holds the hibernate mapping type, this mapping types will convert
from Java to SQL data type.
The <generator> element within the id element is used to generate the primary
key values automatically. The class attribute of the generator element is set to
native to let hibernate pick up either identity, sequence or hilo algorithm to
create primary key depending upon the capabilities of the underlying database.
The <property> element is used to map a Java class property to a column in the
database table. The name attribute of the element refers t o the property in the
class and the column attribute refers to the column in the database table. The
type attribute holds the hibernate mapping type, this mapping types will convert
from Java to SQL data type.
Finally, we will create our application class with the main() method to run the application.
We will use this application to save few Employee's records along with their addresses and
then we will apply CRUD operations on those records.
import java.util.*;
import org.hibernate.HibernateException;
import org.hibernate.Session;
import org.hibernate.Transaction;
import org.hibernate.SessionFactory;
import org.hibernate.cfg.Configuration;
e.printStackTrace();
}finally {
session.close();
}
return address;
}
}
/* Method to delete an employee from the records */
public void deleteEmployee(Integer EmployeeID){
Session session = factory.openSession();
Transaction tx = null;
try{
tx = session.beginTransaction();
Employee employee =
(Employee)session.get(Employee.class, EmployeeID);
session.delete(employee);
tx.commit();
}catch (HibernateException e) {
if (tx!=null) tx.rollback();
e.printStackTrace();
}finally {
session.close();
}
}
}
You would get some notifications from hibernate library on the screen, and at the same time,
records would be created in EMPLOYEE and ADDRESS tables.
$java ManageEmployee
.......VARIOUS LOG MESSAGES WILL DISPLAY HERE........
123
Hibernate
Address
Street: Kondapur
City: Hyderabad
State: AP
Zipcode: 532
First Name: Dilip Last Name: Kumar Salary: 3000
Address
Street: Kondapur
City: Hyderabad
State: AP
Zipcode: 532
First Name: Manoj Last Name: Kumar Salary: 5000
Address
Street: Kondapur
City: Hyderabad
State: AP
Zipcode: 532
If you check your EMPLOYEE and ADDRESS tables, they should have the following records:
124
Hibernate
mysql>
Further, assuming that an address can be associated a single employee only, so this
association can be presented using one-to-one association. We will store address related
information in a separate table having the following structure:
Create both the RBDMS tables and keep them ready for the next implementation.
import java.util.*;
125
Hibernate
public Employee() {}
public Employee(String fname, String lname,
int salary, Address address ) {
this.firstName = fname;
this.lastName = lname;
this.salary = salary;
this.address = address;
}
public int getId() {
return id;
}
public void setId( int id ) {
this.id = id;
}
public String getFirstName() {
return firstName;
}
public void setFirstName( String first_name ) {
this.firstName = first_name;
}
public String getLastName() {
return lastName;
}
public void setLastName( String last_name ) {
this.lastName = last_name;
}
public int getSalary() {
return salary;
126
Hibernate
}
public void setSalary( int salary ) {
this.salary = salary;
}
We need to define another POJO class corresponding to ADDRESS table so that address
objects can be stored and retrieved into the ADDRESS table.
import java.util.*;
public Address() {}
public Address(String street, String city,
String state, String zipcode) {
this.street = street;
this.city = city;
this.state = state;
this.zipcode = zipcode;
}
public int getId() {
return id;
}
public void setId( int id ) {
127
Hibernate
this.id = id;
}
public String getStreet() {
return street;
}
public void setStreet( String street ) {
this.street = street;
}
public String getCity() {
return city;
}
public void setCity( String city ) {
this.city = city;
}
public String getState() {
return state;
}
public void setState( String state ) {
this.state = state;
}
public String getZipcode() {
return zipcode;
}
public void setZipcode( String zipcode ) {
this.zipcode = zipcode;
}
128
Hibernate
<hibernate-mapping>
<class name="Employee" table="EMPLOYEE">
<meta attribute="class-description">
This class contains the employee detail.
</meta>
<id name="id" type="int" column="id">
<generator class="native"/>
</id>
<property name="firstName" column="first_name" type="string"/>
<property name="lastName" column="last_name" type="string"/>
<property name="salary" column="salary" type="int"/>
<many-to-one name="address" column="address" unique="true"
class="Address" not-null="true"/>
</class>
</hibernate-mapping>
You should save the mapping document in a file with the format <classname>.hbm. xml.
We saved our mapping document in the file Employee.hbm.xml. You are already familiar
with most of the mapping detail, but let us see all the elements of mapping file once again:
129
Hibernate
The <class> elements are used to define specific mappings from a Java classes to
the database tables. The Java class name is specified using the name attribute of
the class element and the database table name is specified using the table
attribute.
The <meta> element is optional element and can be used to create the class
description.
The <id> element maps the unique ID attribute in class to the primary key of the
database table. The name attribute of the id element refers to the property in the
class and the column attribute refers to the column in the database table. The
type attribute holds the hibernate mapping type, this mapping types will convert
from Java to SQL data type.
The <generator> element within the id element is used to generate the primary
key values automatically. The class attribute of the generator element is set to
native to let hibernate pick up either identity, sequence or hilo algorithm to
create primary key depending upon the capabilities of the underlying database.
The <property> element is used to map a Java class property to a column in the
database table. The name attribute of the element refers to the property in the
class and the column attribute refers to the column in the database table. The
type attribute holds the hibernate mapping type, this mapping types will convert
from Java to SQL data type.
Finally, we will create our application class with the main() method to run the application.
We will use this application to save few Employee's records along with their certificates
and then we will apply CRUD operations on those records.
import java.util.*;
import org.hibernate.HibernateException;
import org.hibernate.Session;
import org.hibernate.Transaction;
import org.hibernate.SessionFactory;
import org.hibernate.cfg.Configuration;
130
Hibernate
try{
factory = new Configuration().configure().buildSessionFactory();
}catch (Throwable ex) {
System.err.println("Failed to create sessionFactory object." + ex);
throw new ExceptionInInitializerError (ex);
}
ManageEmployee ME = new ManageEmployee();
132
Hibernate
employee.setSalary( salary );
session.update(employee);
tx.commit();
}catch (HibernateException e) {
if (tx!=null) tx.rollback();
e.printStackTrace();
}finally {
session.close();
}
}
}
You would get some notificaions from Hibernate library on the screen, and at the same time,
records would be created in EMPLOYEE and ADDRESS tables.
$java ManageEmployee
.......VARIOUS LOG MESSAGES WILL DISPLAY HERE........
134
Hibernate
City: Ambehta
State: UP
Zipcode: 111
First Name: Manoj Last Name: Kumar Salary: 5000
Address
Street: Kondapur
City: Hyderabad
State: AP
Zipcode: 532
First Name: Dilip Last Name: Kumar Salary: 3000
Address
Street: Saharanpur
City: Ambehta
State: UP
Zipcode: 111
If you check your EMPLOYEE and CERTIFICATE tables, they should have the following
records:
135
Hibernate
mysql>
A Set is mapped with a <set> element in the mapping table and initialized with
java.util.HashSet. You can use Set collection in your class when there is no duplicate
element required in the collection.
Further, assume each employee can have one or more certificate associated with him/her.
So, we will store certificate related information in a separate table having the following
structure:
import java.util.*;
136
Hibernate
public Employee() {}
public Employee(String fname, String lname, int salary) {
this.firstName = fname;
this.lastName = lname;
this.salary = salary;
}
public int getId() {
return id;
}
public void setId( int id ) {
this.id = id;
}
public String getFirstName() {
return firstName;
}
public void setFirstName( String first_name ) {
this.firstName = first_name;
}
public String getLastName() {
return lastName;
}
public void setLastName( String last_name ) {
this.lastName = last_name;
}
public int getSalary() {
return salary;
}
public void setSalary( int salary ) {
137
Hibernate
this.salary = salary;
}
Now, let us define another POJO class corresponding to CERTIFICATE table so that
certificate objects can be stored and retrieved into the CERTIFICATE table. This class
should also implement both the equals() and hashCode() methods so that Java can
determine whether any two elements/objects are identical.
public Certificate() {}
public Certificate(String name) {
this.name = name;
}
public int getId() {
return id;
}
public void setId( int id ) {
this.id = id;
}
public String getName() {
return name;
}
public void setName( String name ) {
this.name = name;
}
public boolean equals(Object obj) {
if (obj == null) return false;
138
Hibernate
<hibernate-mapping>
<class name="Employee" table="EMPLOYEE">
<meta attribute="class-description">
This class contains the employee detail.
</meta>
<id name="id" type="int" column="id">
<generator class="native"/>
</id>
<set name="certificates" cascade="all">
<key column="employee_id"/>
<one-to-many class="Certificate"/>
139
Hibernate
</set>
<property name="firstName" column="first_name" type="string"/>
<property name="lastName" column="last_name" type="string"/>
<property name="salary" column="salary" type="int"/>
</class>
</hibernate-mapping>
You should save the mapping document in a file with the format <classname>.hbm. xml.
We saved our mapping document in the file Employee.hbm.xml. You are already familiar
with most of the mapping detail, but let us see all the elements of mapping file once again:
The <class> elements are used to define specific mappings from a Java classes to
the database tables. The Java class name is specified using the name attribute of
the class element and the database table name is specified using the table
attribute.
The <meta> element is optional element and can be used to create the class
description.
The <id> element maps the unique ID attribute in class to the primary key of the
database table. The name attribute of the id element refers to t he property in the
class and the column attribute refers to the column in the database table. The
type attribute holds the hibernate mapping type, this mapping types will convert
from Java to SQL data type.
The <generator> element within the id element is used to generate the primary
key values automatically. The class attribute of the generator element is set to
native to let hibernate pick up either identity, sequence or hilo algorithm to
create primary key depending upon the capabilities of the underlying database.
140
Hibernate
The <property> element is used to map a Java class property to a column in the
database table. The name attribute of the element refers to the property in the
class and the column attribute refers to the column in the database table. The
type attribute holds the hibernate mapping type, this mapping types will convert
from Java to SQL data type.
The <set> element sets the relationship between Certificate and Employee
classes. We used the cascade attribute in the <set> element to tell Hibernate to
persist the Certificate objects at the same time as the Employee objects. The name
attribute is set to the defined Set variable in the parent class, in our case it is
certificates. For each set variable, we need to define a separate set element in the
mapping file.
The <key> element is the column in the CERTIFICATE table that holds the foreign
key to the parent object i.e. table EMPLOYEE.
The <one-to-many> element indicates that one Employee object relates to many
Certificate objects.
CreateApplication Class
Finally, we will create our application class with the main() method to run the application.
We will use this application to save few Employee's records along with their certificates
and then we will apply CRUD operations on those records.
import java.util.*;
import org.hibernate.HibernateException;
import org.hibernate.Session;
import org.hibernate.Transaction;
import org.hibernate.SessionFactory;
import org.hibernate.cfg.Configuration;
141
Hibernate
try{
tx = session.beginTransaction();
Employee employee = new Employee(fname, lname, salary);
employee.setCertificates(cert);
employeeID = (Integer) session.save(employee);
tx.commit();
}catch (HibernateException e) {
if (tx!=null) tx.rollback();
e.printStackTrace();
}finally {
session.close();
}
return employeeID;
}
}catch (HibernateException e) {
if (tx!=null) tx.rollback();
e.printStackTrace();
}finally {
session.close();
}
}
/* Method to update salary for an employee */
public void updateEmployee(Integer EmployeeID, int salary ){
Session session = factory.openSession();
Transaction tx = null;
try{
tx = session.beginTransaction();
Employee employee =
(Employee)session.get(Employee.class, EmployeeID);
employee.setSalary( salary );
session.update(employee);
tx.commit();
}catch (HibernateException e) {
if (tx!=null) tx.rollback();
e.printStackTrace();
}finally {
session.close();
}
}
/* Method to delete an employee from the records */
public void deleteEmployee(Integer EmployeeID){
Session session = factory.openSession();
Transaction tx = null;
try{
tx = session.beginTransaction();
Employee employee =
(Employee)session.get(Employee.class, EmployeeID);
session.delete(employee);
tx.commit();
}catch (HibernateException e) {
144
Hibernate
if (tx!=null) tx.rollback();
e.printStackTrace();
}finally {
session.close();
}
}
}
You would get some notifications from Hibernate Library on the screen, and at the same time,
records would be created in EMPLOYEE and CERTIFICATE tables.
$java ManageEmployee
.......VARIOUS LOG MESSAGES WILL DISPLAY HERE........
If you check your EMPLOYEE and CERTIFICATE tables, they should have the following
records:
145
Hibernate
mysql>
A Set is mapped with a <set> element in the mapping table and initialized with
java.util.HashSet. You can use Set collection in your c lass when there is no duplicate
element required in the collection.
146
Hibernate
Further, assume each employee can have one or more certificate associated with him/her
and a similar certificate can be associated with more than one employee. We will store
certificate related information in a separate table, which has the following structure:
import java.util.*;
public Employee() {}
public Employee(String fname, String lname, int salary) {
147
Hibernate
this.firstName = fname;
this.lastName = lname;
this.salary = salary;
}
public int getId() {
return id;
}
public void setId( int id ) {
this.id = id;
}
public String getFirstName() {
return firstName;
}
public void setFirstName( String first_name ) {
this.firstName = first_name;
}
public String getLastName() {
return lastName;
}
public void setLastName( String last_name ) {
this.lastName = last_name;
}
public int getSalary() {
return salary;
}
public void setSalary( int salary ) {
this.salary = salary;
}
148
Hibernate
Now let us define another POJO class corresponding to CERTIFICATE table so that
certificate objects can be stored and retrieved into the CERTIFICATE table. This class
should also implement both the equals() and hashCode() methods so that Java can
determine whether any two elements/objects are identical.
public Certificate() {}
public Certificate(String name) {
this.name = name;
}
public int getId() {
return id;
}
public void setId( int id ) {
this.id = id;
}
public String getName() {
return name;
}
public void setName( String name ) {
this.name = name;
}
public boolean equals(Object obj) {
if (obj == null) return false;
if (!this.getClass().equals(obj.getClass())) return false;
<hibernate-mapping>
<class name="Employee" table="EMPLOYEE">
<meta attribute="class-description">
This class contains the employee detail.
</meta>
<id name="id" type="int" column="id">
<generator class="native"/>
</id>
<set name="certificates" cascade="save-update" table="EMP_CERT">
<key column="employee_id"/>
<many-to-many column="certificate_id" class="Certificate"/>
</set>
<property name="firstName" column="first_name" type="string"/>
<property name="lastName" column="last_name" type="string"/>
<property name="salary" column="salary" type="int"/>
</class>
150
Hibernate
</hibernate-mapping>
You should save the mapping document in a file with the format <classname>.hbm. xml.
We saved our mapping document in the file Employee.hbm.xml. You are already familiar
with most of the mapping detail, but let us see all the elements of mapping file once again:
The <class> elements are used to define specific mappings from a Java classes to
the database tables. The Java class name is specified using the name attribute of
the class element and the database table name is specified using the table
attribute.
The <meta> element is optional element and can be used to create the class
description.
The <id> element maps the unique ID attribute in class to the primary key of the
database table. The name attribute of the id element refers to the property in the
class and the column attribute refers to the column in the database table. The
type attribute holds the hibernate mapping type, this mapping types will convert
from Java to SQL data type.
The <generator> element within the id element is used to generate the primary
key values automatically. The class attribute of the generator element is set to
native to let hibernate pick up either identity, sequence or hilo algorithm to
create primary key depending upon the capabilities of the underlying database.
The <property> element is used to map a Java class property to a column in the
database table. The name attribute of the element refers to the property in the
class and the column attribute refers to the column in the database table. The
type attribute holds the hibernate mapping type, this mapping types will convert
from Java to SQL data type.
The <set> element sets the relationship between Certificate and Employee
classes. We set cascade attribute to save-update to tell Hibernate to persist the
Certificate objects for SAVE i.e. CREATE and UPDATE operations at the same time
as the Employee objects. The name attribute is set to the defined Set variable in
the parent class, in our case it is certificates. For each set variable, we need to
define a separate set element in the mapping file. Here we used name attribute to
set the intermediate table name to EMP_CERT.
151
Hibernate
The <key> element is the column in the EMP_CERT table that holds the foreign
key to the parent object i.e. table EMPLOYEE and links to the certification_id in the
CERTIFICATE table.
CreateApplication Class
Finally, we will create our application class with the main() method to run the application.
We will use this application to save few Employee's records along with their certificates
and then we will apply CRUD operations on those records.
import java.util.*;
import org.hibernate.HibernateException;
import org.hibernate.Session;
import org.hibernate.Transaction;
import org.hibernate.SessionFactory;
import org.hibernate.cfg.Configuration;
certificates.add(new Certificate("MCA"));
certificates.add(new Certificate("MBA"));
certificates.add(new Certificate("PMP"));
152
Hibernate
}
return employeeID;
}
try{
tx = session.beginTransaction();
Employee employee =
(Employee)session.get(Employee.class, EmployeeID);
employee.setSalary( salary );
session.update(employee);
tx.commit();
}catch (HibernateException e) {
if (tx!=null) tx.rollback();
e.printStackTrace();
}finally {
session.close();
}
}
/* Method to delete an employee from the records */
public void deleteEmployee(Integer EmployeeID){
Session session = factory.openSession();
Transaction tx = null;
try{
tx = session.beginTransaction();
Employee employee =
(Employee)session.get(Employee.class, EmployeeID);
session.delete(employee);
tx.commit();
}catch (HibernateException e) {
if (tx!=null) tx.rollback();
e.printStackTrace();
}finally {
session.close();
}
}
}
155
Hibernate
You would get the following result on the screen, and same time records would be created
in EMPLOYEE, EMP_CERT and CERTIFICATE tables.
$java ManageEmployee
.......VARIOUS LOG MESSAGES WILL DISPLAY HERE........
If you check your EMPLOYEE, EMP_CERT and CERTIFICATE tables, they should have the
following records:
Inheritance Mappings
Inheritance Mapping allows you to map the classes to database tables in a hierarchy. There
are three types of inheritance mappings, as listed in the following table.
Table Per Class Hierarchy Single table is required to map the whole class hierarchy.
157
Hibernate
158
Hibernate
this.designation = designation;
}
public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getDesignation() {
return designation;
}
public void setDesignation(String designation) {
this.designation = designation;
}
@Override
public String toString() {
return "Employee [" + id + ", " + name + ", "+ designation + "]";
}
Let us create another POJO class named Permanent_Employee which is derived from
the class Employee.
public Permanent_Employee() {
super();
}
159
Hibernate
@Override
public String toString() {
return "Permanent_Employee [" + Salary + "]";
}
Let us create another POJO class named Contract_Employee which is derived from the
class Employee.
public Contract_Employee() {
super();
}
160
Hibernate
@Override
public String toString() {
return "Contract_Employee [pay_per_hour=" + pay_per_hour + "]";
}
<?xml version="1.0"?>
<!DOCTYPE hibernate-mapping PUBLIC
"-//Hibernate/Hibernate Mapping DTD 3.0//EN"
"http://hibernate.sourceforge.net/hibernate -mapping-3.0.dtd">
<hibernate-mapping>
<class name="Employee" table="Employee" discriminator-value="E">
<id name="id">
<generator class="increment"/>
</id>
<discriminator column="Etype" type="string" length="3"/>
<property name="name" length="10"/>
<property name="designation" length="10"/>
<subclass name="permanent_Employee" discriminator-value="PE">
<property name="Salary" length="10"/>
</subclass>
<subclass name="Contract_Employee" discriminator-value="CE">
161
Hibernate
Finally, we will create our application class with the main() method to run the application.
We will use this application to insert Employee's records along with their details and then
we will apply CRUD operations on those records.
import org.hibernate.Session;
import org.hibernate.SessionFactory;
import org.hibernate.Transaction;
import org.hibernate.cfg.Configuration;
SessionFactory sf = c.buildSessionFactory();
Session s=sf.openSession();
// transient state
Permanent_Employee e1=new Permanent_Employee(0,"Raju","HR",50000);
Permanent_Employee e2=new
Permanent_Employee(1,"Surendhar","Admin",30000);
Transaction t=s.beginTransaction();
try {
162
Hibernate
// attached state
s.save(e1);
s.save(e2);
s.save(e3);
s.save(e4);
You would get some notifications from Hibernate Library on the screen.
If you check the Employee records on mysql command as follows. Here the column Etype
is the extra column that differentiate the records of Permanent Employee (PE) and
Contract Employee (CE).
+----+-------+-----------+-------------+--------+--------------+
| id | Etype | name | designation | Salary | pay_per_hour |
+----+-------+-----------+-------------+--------+--------------+
163
Hibernate
mysql>
164
Hibernate
165
Hibernate
Let us create another POJO class named Permanent_Employee which is derived from
the class Employee.
public Permanent_Employee() {
super();
}
@Override
public String toString() {
return "Permanent_Employee [" + Salary + "]";
}
Let us create another POJO class named Contract_Employee which is derived from the
class Employee.
166
Hibernate
public Contract_Employee() {
super();
}
@Override
public String toString() {
return "Contract_Employee [pay_per_hour=" + pay_per_hour + "]";
}
<?xml version="1.0"?>
<!DOCTYPE hibernate-mapping PUBLIC
"-//Hibernate/Hibernate Mapping DTD 3.0//EN"
"http://hibernate.sourceforge.net/hibernate -mapping-3.0.dtd">
<hibernate-mapping>
<class name="Employee" table="Employee">
167
Hibernate
<id name="id">
<generator class="increment"/>
</id>
<property name="name" length="10"/>
<property name="designation" length="10"/>
<joined-subclass name="Permanent_Employee">
<key column="eid"/>
<property name="Salary" length="10"/>
</joined-subclass>
<joined-subclass name="Contract_Employee">
<key column="eid"/>
<property name="pay_per_hour" length="20"/>
</joined-subclass>
</class>
</hibernate-mapping>
Finally, we will create our application class with the main() method to run the application.
We will use this application to insert Employee's records along with their details and then
we will apply CRUD operations on those records.
import org.hibernate.Session;
import org.hibernate.SessionFactory;
import org.hibernate.Transaction;
import org.hibernate.cfg.Configuration;
SessionFactory sf = c.buildSessionFactory();
Session s=sf.openSession();
// transient state
168
Hibernate
Transaction t=s.beginTransaction();
try {
// attached state
s.save(e1);
s.save(e2);
s.save(e3);
s.save(e4);
169
Hibernate
You would get some notifications from the Hibernate Library on the screen. Now check the
Employee records. You can observe the records in these three tables share a relation
among them.
170
Hibernate
this.designation = designation;
}
public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getDesignation() {
return designation;
}
public void setDesignation(String designation) {
this.designation = designation;
}
@Override
public String toString() {
return "Employee [" + id + ", " + name + ", "+ designation + "]";
}
Let us create another POJO class named Permanent_Employee which is derived from
the class Employee.
public Permanent_Employee() {
super();
}
172
Hibernate
@Override
public String toString() {
return "Permanent_Employee [" + Salary + "]";
}
Let us create another POJO class named Contract_Employee which is derived from the
class Employee.
public Contract_Employee() {
super();
}
173
Hibernate
@Override
public String toString() {
return "Contract_Employee [pay_per_hour=" + pay_per_hour + "]";
}
<?xml version="1.0"?>
<!DOCTYPE hibernate-mapping PUBLIC
"-//Hibernate/Hibernate Mapping DTD 3.0//EN"
"http://hibernate.sourceforge.net/hibernate -mapping-3.0.dtd">
<hibernate-mapping>
<class name="Permanent_Employee">
<id name="id">
<generator class="increment"/>
</id>
<property name="name" length="10"/>
<property name="designation" length="10"/>
<property name="Salary" length="10"/>
</class>
<class name="Contract_Employee">
<id name="id">
<generator class="increment"/>
174
Hibernate
</id>
<property name="name" length="10"/>
<property name="designation" length="10"/>
<property name="pay_per_hour" length="20"/>
</class>
</hibernate-mapping>
Finally, we will create our application class with the main() method to run the application.
We will use this application to insert Employee's records along with their details and then
we will apply CRUD operations on those records.
import org.hibernate.Session;
import org.hibernate.SessionFactory;
import org.hibernate.Transaction;
import org.hibernate.cfg.Configuration;
SessionFactory sf = c.buildSessionFactory();
Session s=sf.openSession();
// transient state
Permanent_Employee e1=new Permanent_Employee(0,"Raju","HR",50000);
Permanent_Employee e2=new
Permanent_Employee(1,"Surendhar","Admin",30000);
Transaction t=s.beginTransaction();
175
Hibernate
try {
// attached state
s.save(e1);
s.save(e2);
s.save(e3);
s.save(e4);
You would get some notifications from Hibernate Library on the screen.
Now, check the records of both the tables. These two tables are independent of each other.
+----+-----------+-------------+--------+
| 1 | Raju | HR | 50000 |
| 2 | Surendhar | Admin | 30000 |
+----+-----------+-------------+--------+
2 rows in set (0.00 sec)
Component Mappings
It is very much possible that an Entity class can have a reference to another class as a
member variable. If the referred class does not have its own life cycle and completely
depends on the life cycle of the owning entity class, then the referred class he nce therefore
is called as the Component class.
The mapping of Collection of Components is also possible in a similar way just as the
mapping of regular Collections with minor configuration differences. We will see these two
mappings in detail with examples.
177
Hibernate
Further, assume each employee will have an address, so let us add address specific fields
in the same table as follows:
import java.util.*;
public Employee() {}
public Employee(String fname, String lname,
178
Hibernate
}
}
We need to define another POJO class corresponding to ADDRESS entity having address
related fields.
import java.util.*;
public Address() {}
public Address(String street, String city,
String state, String zipcode) {
this.street = street;
this.city = city;
this.state = state;
this.zipcode = zipcode;
}
public int getId() {
return id;
}
public void setId( int id ) {
this.id = id;
}
public String getStreet() {
return street;
}
public void setStreet( String street ) {
this.street = street;
}
public String getCity() {
return city;
180
Hibernate
}
public void setCity( String city ) {
this.city = city;
}
public String getState() {
return state;
}
public void setState( String state ) {
this.state = state;
}
public String getZipcode() {
return zipcode;
}
public void setZipcode( String zipcode ) {
this.zipcode = zipcode;
}
<hibernate-mapping>
<class name="Employee" table="EMPLOYEE">
<meta attribute="class-description">
This class contains the employee detail.
</meta>
<id name="id" type="int" column="id">
<generator class="native"/>
181
Hibernate
</id>
<component name="address" class="Address">
<property name="street" column="street_name" type="string"/>
<property name="city" column="city_name" type="string"/>
<property name="state" column="state_name" type="string"/>
<property name="zipcode" column="zipcode" type="string"/>
</component>
<property name="firstName" column="first_name" type="string"/>
<property name="lastName" column="last_name" type="string"/>
<property name="salary" column="salary" type="int"/>
</class>
</hibernate-mapping>
You should save the mapping document in a file with the format <classname>.hbm. xml.
We saved our mapping document in the file Employee.hbm.xml. You are already familiar
with most of the mapping detail, but let us see all the elements of mapping file once again:
The <class> elements are used to define specific mappings from a Java classes to
the database tables. The Java class name is specified using the name attribute of
the class element and the database table name is specified using the table
attribute.
The <meta> element is optional element and can be used to create the class
description.
The <id> element maps the unique ID attribute in class to the primary key of the
database table. The name attribute of the id element refers to the property in the
class and the column attribute refers to the column in the database table. The
182
Hibernate
type attribute holds the hibernate mapping type, this mapping types will convert
from Java to SQL data type.
The <generator> element within the id element is used to generate the primary
key values automatically. The class attribute of the generator element is set to
native to let hibernate pick up either identity, sequence or hilo algorithm to
create primary key depending upon the capabilities of the underlying database.
The <property> element is used to map a Java class property to a column in the
database table. The name attribute of the element refers to the property in the
class and the column attribute refers to the column in the database table. The
type attribute holds the hibernate mapping type, this mapping types will convert
from Java to SQL data type.
CreateApplication Class
Finally, we will create our application class with the main() method to run the application.
We will use this application to save few Employee's records along with their certificates
and then we will apply CRUD operations on those records.
import java.util.*;
import org.hibernate.HibernateException;
import org.hibernate.Session;
import org.hibernate.Transaction;
import org.hibernate.SessionFactory;
import org.hibernate.cfg.Configuration;
183
Hibernate
e.printStackTrace();
}finally {
session.close();
}
return address;
}
}
}
You would get the following result on the screen, and same time records would be created
in EMPLOYEE table.
$java ManageEmployee
.......VARIOUS LOG MESSAGES WILL DISPLAY HERE........
187
Hibernate
Address
Street: Saharanpur
City: Ambehta
State: UP
Zipcode: 111
If you check your EMPLOYEE table, it should have the following records:
mysql>
188
Hibernate
12. HIBERNATE – ANNOTATIONS
So far you have seen how Hibernate uses XML mapping file for the transformation of data
from POJO to database tables and vice versa. Hibernate annotations are the newest way
to define mappings without the use of XML file. You can use annotations in addition to or
as a replacement of XML mapping metadata.
Hibernate Annotations is the powerful way to provide the metadata for the Object and
Relational Table mapping. All the metadata is clubbed into the POJO java file along with
the code, this helps the user to understand the table structure and POJO simultaneously
during the development.
If you going to make your application portable to other EJB 3 compliant ORM applications,
you must use annotations to represent the mapping information, but still if you want
greater flexibility, then you should go with XML-based mappings.
Second, you will need to install the Hibernate 3.x annotations distribution package,
available from the sourceforge: (Download Hibernate Annotation) and copy hibernate -
annotations.jar, lib/hibernate-comons-annotations. jar and lib/ejb3-
persistence.jar from the Hibernate Annotations distribution to your CLASSPATH.
Consider we are going to use the following EMPLOYEE table to store our objects:
189
Hibernate
Following is the mapping of Employee class with annotations to map objects with the
defined EMPLOYEE table:
import javax.persistence.*;
@Entity
@Table(name = "EMPLOYEE")
public class Employee {
@Id @GeneratedValue
@Column(name = "id")
private int id;
@Column(name = "first_name")
private String firstName;
@Column(name = "last_name")
private String lastName;
@Column(name = "salary")
private int salary;
public Employee() {}
public int getId() {
return id;
}
public void setId( int id ) {
this.id = id;
}
public String getFirstName() {
return firstName;
}
public void setFirstName( String first_name ) {
this.firstName = first_name;
}
public String getLastName() {
return lastName;
}
190
Hibernate
Hibernate detects that the @Id annotation is on a field and assumes that it should access
properties of an object directly through fields at runtime. If you placed the @Id annotation
on the getId() method, you would enable access to properties through gett er and setter
methods by default. Hence, all other annotations are also placed on either fields or getter
methods, following the selected strategy. Following section will explain the annotations
used in the above class.
@Entity Annotation
The EJB 3 standard annotations are contained in the javax.persistence package, so we
import this package as the first step. Second, we used the @Entity annotation to the
Employee class, which marks this class as an entity bean, so it must have a no-argument
constructor that is visible with at least protected scope.
@Table Annotation
The @Table annotation allows you to specify the details of the table that will be used to
persist the entity in the database.
The @Table annotation provides four attributes, allowing you to ove rride the name of the
table, its catalogue, and its schema, and enforce unique constraints on columns in the
table. For now, we are using just table name, which is EMPLOYEE.
By default, the @Id annotation will automatically determine the most appropriate primary
key generation strategy to be used but you can override this by applying the
@GeneratedValue annotation, which takes two parameters strategy and generator
that I'm not going to discuss here, so let us use only the default key generation strategy.
Letting Hibernate determine which generator type to use makes your code portable
between different databases.
191
Hibernate
@Column Annotation
The @Column annotation is used to specify the details of the column to which a field or
property will be mapped. You can use column annotation with the following most
commonly used attributes:
length attribute permits the size of the column used to map a value particularly
for a String value.
nullable attribute permits the column to be marked NOT NULL when the schema
is generated.
import java.util.List;
import java.util.Date;
import java.util.Iterator;
import org.hibernate.HibernateException;
import org.hibernate.Session;
import org.hibernate.Transaction;
import org.hibernate.cfg.AnnotationConfiguration;
import org.hibernate.SessionFactory;
import org.hibernate.cfg.Configuration;
192
Hibernate
}catch (HibernateException e) {
if (tx!=null) tx.rollback();
e.printStackTrace();
}finally {
session.close();
}
return employeeID;
}
/* Method to READ all the employees */
public void listEmployees( ){
Session session = factory.openSession();
Transaction tx = null;
try{
tx = session.beginTransaction();
List employees = session.createQuery("FROM Employee").list();
for (Iterator iterator =
employees.iterator(); iterator.hasNext();){
Employee employee = (Employee) iterator.next();
System.out.print("First Name: " + employee.getFirstName());
System.out.print(" Last Name: " + employee.getLastName());
System.out.println(" Salary: " + employee.getSalary());
}
tx.commit();
}catch (HibernateException e) {
if (tx!=null) tx.rollback();
e.printStackTrace();
}finally {
session.close();
}
}
/* Method to UPDATE salary for an employee */
public void updateEmployee(Integer EmployeeID, int salary ){
Session session = factory.openSession();
Transaction tx = null;
try{
tx = session.beginTransaction();
194
Hibernate
Employee employee =
(Employee)session.get(Employee.class, EmployeeID);
employee.setSalary( salary );
session.update(employee);
tx.commit();
}catch (HibernateException e) {
if (tx!=null) tx.rollback();
e.printStackTrace();
}finally {
session.close();
}
}
/* Method to DELETE an employee from the records */
public void deleteEmployee(Integer EmployeeID){
Session session = factory.openSession();
Transaction tx = null;
try{
tx = session.beginTransaction();
Employee employee =
(Employee)session.get(Employee.class, EmployeeID);
session.delete(employee);
tx.commit();
}catch (HibernateException e) {
if (tx!=null) tx.rollback();
e.printStackTrace();
}finally {
session.close();
}
}
}
Database Configuration
Now let us create hibernate.cfg.xml configuration file to define database related
parameters.
195
Hibernate
<hibernate-configuration>
<session-factory>
<property name="hibernate.dialect">
org.hibernate.dialect.MySQLDialect
</property>
<property name="hibernate.connection.driver_class">
com.mysql.jdbc.Driver
</property>
</session-factory>
</hibernate-configuration>
196
Hibernate
You would get some notification from Hibernate library and the following result, and records
would be created in EMPLOYEE table.
$java ManageEmployee
.......VARIOUS LOG MESSAGES WILL DISPLAY HERE........
If you check your EMPLOYEE table, it should have the following records:
mysql>
197
Hibernate
13. HIBERNATE – QUERY LANGUAGE
Although you can use SQL statements directly with Hibernate using Native SQL, but I
would recommend to use HQL whenever possible to avoid database portability hassles,
and to take advantage of Hibernate's SQL generation and caching strategie s.
Keywords like SELECT, FROM, and WHERE, etc., are not case sensitive, but properties like
table and column names are case sensitive in HQL.
FROM Clause
You will use FROM clause if you want to load a complete persistent objects into memory.
Following is the simple syntax of using FROM clause:
If you need to fully qualify a class name in HQL, just specify the package and class name
as follows:
AS Clause
The AS clause can be used to assign aliases to the classes in your HQL queries, especially
when you have the long queries. For instance, our previous simple example would be the
following:
The AS keyword is optional and you can also specify the alias directly after the class name,
as follows:
SELECT Clause
The SELECT clause provides more control over the result set then the from clause. If you
want to obtain few properties of objects instead of the complete object, use the SELECT
clause. Following is the simple syntax of using SELECT clause to get just first_name field
of the Employee object:
WHERE Clause
If you want to narrow the spec ific objects that are returned from storage, you use the
WHERE clause. Following is the simple syntax of using WHERE clause:
ORDER BY Clause
To sort your HQL query's results, you will need to use the ORDER BY clause. You can
order the results by any property on the objects in the result set either ascending (ASC)
or descending (DESC). Following is the simple syntax of using ORDER BY clause:
String hql = "FROM Employee E WHERE E.id > 10 ORDER BY E.salary DESC";
Query query = session.createQuery(hql);
List results = query.list();
If you wanted to sort by more than one property, you would just add the additional
properties to the end of the order by clause, separated by commas as follows:
199
Hibernate
GROUP by Clause
This clause lets Hibernate pull information from the database and group it based on a value
of an attribute and, typically, use the result to include an aggregate value. Following is the
simple syntax of using GROUP BY clause:
UPDATE Clause
Bulk updates are new to HQL with Hibernate 3, and delete work differently in Hibernate 3
than they did in Hibernate 2. The Query interface now contains a method called
executeUpdate() for executing HQL UPDATE or DELETE statements.
The UPDATE clause can be used to update one or more properties of an one or more
objects. Following is the simple syntax of using UPDATE clause:
200
Hibernate
DELETE Clause
The DELETE clause can be used to delete one or more objects. Following is the simple
syntax of using DELETE clause:
INSERT Clause
HQL supports INSERT INTO clause only where records can be inserted from one object
to another object. Following is the simple syntax of using INSERT INTO clause:
Aggregate Methods
HQL supports a range of aggregate methods, similar to SQL. They work the same way in
HQL as in SQL and following is the list of the available functions:
The distinct keyword only counts the unique values in the row set. The following query
will return only unique count:
201
Hibernate
Using above two methods together, we can construct a paging component in our web or
Swing application. Following is the example, which you can extend to fetch 10 rows at a
time:
202
Hibernate
14. HIBERNATE – CRITERIA QUERIES
Hibernate provides alternate ways of manipulating objects and in turn data available in
RDBMS tables. One of the methods is Criteria API, which allows you to build up a criteria
query object programmatically where you can apply filtration rules and logical conditions.
The Hibernate Session interface provides createCriteria() method, which can be used
to create a Criteria object that returns instances of the persistence object's class when
your application executes a criteria query.
Following is the simplest example of a criteria query is one, which will simply return every
object that corresponds to the Employee class.
Criteria cr = session.createCriteria(Employee.class);
List results = cr.list();
Criteria cr = session.createCriteria(Employee.class);
cr.add(Restrictions.eq("salary", 2000));
List results = cr.list();
Following are the few more examples covering different scenarios and can be used as per
the requirement:
Criteria cr = session.createCriteria(Employee.class);
203
Hibernate
cr.add(Restrictions.ilike("firstName", "zara%"));
Criteria cr = session.createCriteria(Employee.class);
204
Hibernate
Using above two methods together, we can construct a paging component in our web or
Swing application. Following is the example, which you can extend to fetch 10 rows at a
time:
Criteria cr = session.createCriteria(Employee.class);
cr.setFirstResult(1);
cr.setMaxResults(10);
List results = cr.list();
Criteria cr = session.createCriteria(Employee.class);
// To get records having salary more than 2000
cr.add(Restrictions.gt("salary", 2000));
is similar to the Restrictions class, in that it provides several static factory methods for
obtaining Projection instances.
Following are the few examples covering different scenarios and can be us ed as per
requirement:
Criteria cr = session.createCriteria(Employee.class);
public Employee() {}
public Employee(String fname, String lname, int salary) {
this.firstName = fname;
206
Hibernate
this.lastName = lname;
this.salary = salary;
}
public int getId() {
return id;
}
public void setId( int id ) {
this.id = id;
}
public String getFirstName() {
return firstName;
}
public void setFirstName( String first_name ) {
this.firstName = first_name;
}
public String getLastName() {
return lastName;
}
public void setLastName( String last_name ) {
this.lastName = last_name;
}
public int getSalary() {
return salary;
}
public void setSalary( int salary ) {
this.salary = salary;
}
}
);
<hibernate-mapping>
<class name="Employee" table="EMPLOYEE">
<meta attribute="class-description">
This class contains the employee detail.
</meta>
<id name="id" type="int" column="id">
<generator class="native"/>
</id>
<property name="firstName" column="first_name" type="string"/>
<property name="lastName" column="last_name" type="string"/>
<property name="salary" column="salary" type="int"/>
</class>
</hibernate-mapping>
Finally, we will create our application class with the main() method to run the application
where we will use Criteria queries:
import java.util.List;
import java.util.Date;
import java.util.Iterator;
import org.hibernate.HibernateException;
import org.hibernate.Session;
import org.hibernate.Transaction;
import org.hibernate.SessionFactory;
import org.hibernate.Criteria;
import org.hibernate.criterion.Restrictions;
import org.hibernate.criterion.Projections;
import org.hibernate.cfg.Configuration;
208
Hibernate
tx.commit();
}catch (HibernateException e) {
if (tx!=null) tx.rollback();
e.printStackTrace();
}finally {
session.close();
}
return employeeID;
}
/* Method to READ all the employees having salary more than 2000 */
public void listEmployees( ){
Session session = factory.openSession();
Transaction tx = null;
try{
tx = session.beginTransaction();
Criteria cr = session.createCriteria(Employee.class);
// Add restriction.
cr.add(Restrictions.gt("salary", 2000));
List employees = cr.list();
if (tx!=null) tx.rollback();
e.printStackTrace();
}finally {
session.close();
}
}
}
You would get some notifications from hibernate library, the following result, and records
would be created in the EMPLOYEE table.
$java ManageEmployee
.......VARIOUS LOG MESSAGES WILL DISPLAY HERE........
If you check your EMPLOYEE table, it should have the following records:
212
Hibernate
213
Hibernate
15. HIBERNATE – NATIVE SQL
You can use native SQL to express database queries if you want to utilize database -specific
features such as query hints or the CONNECT keyword in Oracle. Hibernate 3.x allows you
to specify handwritten SQL, including stored procedures, for all create, update, delete, and
load operations.
Your application will create a native SQL query from the session with the
createSQLQuery() method on the Session interface.:
After you pass a string containing the SQL query to the createSQLQuery() method, you
can associate the SQL result with either an existing Hibernate entity, a join, or a scalar
result using addEntity(), addJoin(), and addScalar() methods respectively.
Scalar Queries
The most basic SQL query is to get a list of scalars (values) from one or more tables.
Following is the syntax for using native SQL for sc alar values:
Entity Queries
The above queries were all about returning scalar values, basically returning the "raw "
values from the result set. Following is the syntax to get entity objects as a whole from a
native sql query via addEntity().
public Employee() {}
public Employee(String fname, String lname, int salary) {
this.firstName = fname;
this.lastName = lname;
this.salary = salary;
}
public int getId() {
return id;
}
public void setId( int id ) {
this.id = id;
}
public String getFirstName() {
return firstName;
}
public void setFirstName( String first_name ) {
this.firstName = first_name;
}
public String getLastName() {
return lastName;
}
public void setLastName( String last_name ) {
215
Hibernate
this.lastName = last_name;
}
public int getSalary() {
return salary;
}
public void setSalary( int salary ) {
this.salary = salary;
}
}
<hibernate-mapping>
<class name="Employee" table="EMPLOYEE">
<meta attribute="class-description">
This class contains the employee detail.
</meta>
<id name="id" type="int" column="id">
<generator class="native"/>
</id>
<property name="firstName" column="first_name" type="string"/>
<property name="lastName" column="last_name" type="string"/>
<property name="salary" column="salary" type="int"/>
216
Hibernate
</class>
</hibernate-mapping>
Finally, we will create our application class with the main() method to run the application
where we will use Native SQL queries:
import java.util.*;
import org.hibernate.HibernateException;
import org.hibernate.Session;
import org.hibernate.Transaction;
import org.hibernate.SessionFactory;
import org.hibernate.SQLQuery;
import org.hibernate.Criteria;
import org.hibernate.Hibernate;
import org.hibernate.cfg.Configuration;
217
Hibernate
}
}
}
You would get the following result, and records would be created in the EMPLOYEE table.
$java ManageEmployee
.......VARIOUS LOG MESSAGES WILL DISPLAY HERE........
If you check your EMPLOYEE table, it should have the following records:
221
Hibernate
16. HIBERNATE – CACHING
Caching is all about application performance optimization and it sits between your application and
the database to avoid the number of database hits as many as possible to give a better
performance for performance critical applications.
First-level Cache
The first-level cache is the Session cache and is a mandatory cache through which all
requests must pass. The Session object keeps an object under its own pow er before
committing it to the database.
If you issue multiple updates to an object, Hibernate tries to delay doing the update as
long as possible to reduce the number of update SQL statements issued. If you close the
session, all the objects being cached are lost and either persisted or updated in the
database.
222
Hibernate
Second-level Cache
Second level cache is an optional cache and first -level cache will always be consulted
before any attempt is made to locate an object in the second-level cache. The second-
level c ache can be configured on a per-class and per-collection basis and mainly
responsible for caching objects across sessions.
Query-level Cache
Hibernate also implements a cache for query resultsets that integrates closely with the
second-level cache.
This is an optional feature and requires two additional physical cache regions that hold the
cached query results and the timestamps when a table was last updated. This is only useful
for queries that are run frequently with the same parameters.
The Hibernate second-level cache is set up in two steps. First, you have to decide which
concurrency strategy to use. After that, you configure cache expiration and physical cache
attributes using the cache provider.
Concurrency Strategies
A concurrency strategy is a mediator, which is responsible for storing items of data in the
cache and retrieving them from the cache. If you are going to enable a second-level cache,
you will have to decide, for each persistent class and collection, which cache concurrency
strategy to use.
Transactional: Use this strategy for read-mostly data where it is critical to prevent
stale data in concurrent transactions, in the rare case of an update.
Read-write: Again use this strategy for read-mostly data where it is critical to
prevent stale data in concurrent transactions, in the rare case of an update.
Read-only: A concurrency strategy suitable for data, which never changes. Use it
for reference data only.
If we are going to use second-level caching for our Employee class, let us add the
mapping element required to tell Hibernate to cache Employee instances using read-
write strategy.
223
Hibernate
<hibernate-mapping>
<class name="Employee" table="EMPLOYEE">
<meta attribute="class-description">
This class contains the employee detail.
</meta>
<cache usage="read-write"/>
<id name="id" type="int" column="id">
<generator class="native"/>
</id>
<property name="firstName" column="first_name" type="string"/>
<property name="lastName" column="last_name" type="string"/>
<property name="salary" column="salary" type="int"/>
</class>
</hibernate-mapping>
Cache Provider
Your next step after considering the concurrency strategies , you will use your cache
candidate classes to pick a cache provider. Hibernate forces you to choose a s ingle cache
provider for the whole application.
224
Hibernate
Every cache provider is not compatible with every concurrency strategy. The following
compatibility matrix will help you choose an appropriate combination.
EHCache X X X
OSCache X X X
SwarmCache X X
JBoss Cache X X
<hibernate-configuration>
<session-factory>
<property name="hibernate.dialect">
org.hibernate.dialect.MySQLDialect
</property>
<property name="hibernate.connection.driver_cl ass">
com.mysql.jdbc.Driver
</property>
org.hibernate.cache.EhCacheProvider
</property>
</session-factory>
</hibernate-configuration>
Now, you need to specify the properties of the cache regions. EHCache has its own
configuration file, ehcache.xml, which should be in the CLASSPATH of the application. A
cache configuration in ehcache.xml for the Employee class may look like this:
<diskStore path="java.io.tmpdir"/>
<defaultCache
maxElementsInMemory="1000"
eternal="false"
timeToIdleSeconds="120"
timeToLiveSeconds="120"
overflowToDisk="true"
/>
<cache name="Employee"
maxElementsInMemory="500"
eternal="true"
timeToIdleSeconds="0"
timeToLiveSeconds="0"
overflowToDisk="false"
/>
That's it, now we have second-level caching enabled for the Employee class and Hibernate ,
now hits the second-level cache whenever you navigate to an Employee or when you load
an Employee by identifier.
You should analyze your all the classes and choose appropriate caching strategy for each
of the classes. Sometime, second-level caching may downgrade the performance of the
application. So, it is recommended to benchmark your application first , without enabling
caching and later on enable your well suited caching and check the performance. If caching
is not improving system performance, then there is no point in enabling any type of
caching.
226
Hibernate
Next, to use the query cache, you use the setCacheable(Boolean) method of the Query
class. For example:
Hibernate also supports very fine-grained cache support through the concept of a cache
region. A cache region is part of the cache that's given a name.
This code uses the method to tell Hibernate to store and look for the query in the employee
area of the cache.
227
Hibernate
17. HIBERNATE – BATCH PROCESSING
Consider a situation when you need to upload a large number of records into your database
using Hibernate. Following is the code snippet to achieve this using Hibernate:
By default, Hibernate will cache all the persisted objects in the session-level cache and
ultimately your application would fall over with an OutOfMemoryException somewhere
around the 50,000th row. You can resolve this problem, if you are using batch processing
with Hibernate.
To use the batch processing feature, first set hibernate.jdbc.batch_size as batch size
to a number either at 20 or 50 depending on object size. This will tell the hibernat e
container that every X rows to be inserted as batch. To implement this in your code, we
would need to do little modification as follows:
Above code will work fine for the INSERT operation, but if you are willing to make UPDAT E
operation, then you can achieve using the following code:
228
Hibernate
while ( employeeCursor.next() ) {
Employee employee = (Employee) employeeCursor.get(0);
employee.updateEmployee();
seession.update(employee);
if ( ++count % 50 == 0 ) {
session.flush();
session.clear();
}
}
tx.commit();
session.close();
<hibernate-configuration>
<session-factory>
<property name="hibernate.dialect">
org.hibernate.dialect.MySQLDialect
</property>
<property name="hibernate.connection.driver_class">
com.mysql.jdbc.Driver
</property>
<property name="hibernate.connection.url">
jdbc:mysql://localhost/test
</property>
<property name="hibernate.connection.username" >
root
</property>
<property name="hibernate.connection.password" >
root123
</property>
<property name="hibernate.jdbc.batch_size">
50
</property>
</session-factory>
</hibernate-configuration>
public Employee() {}
public Employee(String fname, String lname, int salary) {
this.firstName = fname;
this.lastName = lname;
this.salary = salary;
}
public int getId() {
return id;
}
public void setId( int id ) {
230
Hibernate
this.id = id;
}
public String getFirstName() {
return firstName;
}
public void setFirstName( String first_name ) {
this.firstName = first_name;
}
public String getLastName() {
return lastName;
}
public void setLastName( String last_name ) {
this.lastName = last_name;
}
public int getSalary() {
return salary;
}
public void setSalary( int salary ) {
this.salary = salary;
}
}
Let us create the following EMPLOYEE table to store the Employee objects:
Following will be the mapping file to map the Employee objects with EMPLOYEE table:
<hibernate-mapping>
<class name="Employee" table="EMPLOYEE">
<meta attribute="class-description">
This class contains the employee detail.
</meta>
<id name="id" type="int" column="id">
<generator class="native"/>
</id>
<property name="firstName" column="first_name" type="string"/>
<property name="lastName" column="last_name" type="string"/>
<property name="salary" column="salary" type="int"/>
</class>
</hibernate-mapping>
Finally, we will create our application class with the main() method to run the application
where we will use flush() and clear() methods available with Session object so that
Hibernate keeps writing these records into the database inst ead of caching them in the
memory.
import java.util.*;
import org.hibernate.HibernateException;
import org.hibernate.Session;
import org.hibernate.Transaction;
import org.hibernate.SessionFactory;
import org.hibernate.cfg.Configuration;
233
Hibernate
Execute ManageEmployee binary to run the program, which will create 100000
records in EMPLOYEE table.
234
Hibernate
18. HIBERNATE – INTERCEPTORS
As you have learnt that in Hibernate, an object will be created and persisted. Once the
object has been changed, it must be saved back to the database. This process continues
until the next time the object is needed, and it will be loaded from the persistent store.
Thus an object passes through different stages in its life cycle and Interceptor Interfa c e
provides methods, which can be called at different stages to perform some required tasks.
These methods are callbacks from the session to the application, allowing the application
to inspec t and/or manipulate properties of a persistent object before it is saved, updated,
deleted or loaded. Following is the list of all the methods available within the Interceptor
interface:
findDirty()
1
This method is be called when the flush() method is called on a Session object.
instantiate()
2
This method is called when a persisted class is instantiated.
isUnsaved()
3 This method is called when an object is passed to the saveOrUpdate()
method/
onDelete()
4
This method is called before an object is deleted.
onFlushDirty()
5 This method is called when Hibernate detects that an object is dirty (i.e. have
been changed) during a flush i.e. update operation.
onLoad()
6
This method is called before an object is initialized.
onSave()
7
This method is called before an object is saved.
postFlush()
8 This method is called after a flush has occurred and an object has been updated
in memory.
preFlush()
9
This method is called before a flush.
Hibernate Interceptor gives us total control over how an object will look to both the
application and the database.
235
Hibernate
Create Interceptors
We will extend EmptyInterceptor in our example where Interceptor's method will be called
automatically when Employee object is created and updated. You can implement more
methods as per your requirements.
import java.io.Serializable;
import java.util.Date;
import java.util.Iterator;
import org.hibernate.EmptyInterceptor;
import org.hibernate.Transaction;
import org.hibernate.type.Type;
public class MyInterceptor extends EmptyInterceptor {
private int updates;
private int creates;
private int loads;
236
Hibernate
237
Hibernate
public Employee() {}
public Employee(String fname, String lname, int salary) {
this.firstName = fname;
this.lastName = lname;
this.salary = salary;
}
public int getId() {
return id;
}
public void setId( int id ) {
this.id = id;
}
public String getFirstName() {
return firstName;
}
public void setFirstName( String first_name ) {
this.firstName = first_name;
}
public String getLastName() {
return lastName;
}
public void setLastName( String last_name ) {
this.lastName = last_name;
}
public int getSalary() {
return salary;
238
Hibernate
}
public void setSalary( int salary ) {
this.salary = salary;
}
}
<hibernate-mapping>
<class name="Employee" table="EMPLOYEE">
<meta attribute="class-description">
This class contains the employee detail.
</meta>
<id name="id" type="int" column="id">
<generator class="native"/>
</id>
<property name="firstName" column="first_name" type="string"/>
239
Hibernate
import java.util.List;
import java.util.Date;
import java.util.Iterator;
import org.hibernate.HibernateException;
import org.hibernate.Session;
import org.hibernate.Transaction;
import org.hibernate.SessionFactory;
import org.hibernate.cfg.Configuration;
240
Hibernate
tx = session.beginTransaction();
List employees = session.createQuery("FROM Employee").list();
for (Iterator iterator =
employees.iterator(); iterator.hasNext();){
Employee employee = (Employee) iterator.next();
System.out.print("First Name: " + employee.getFirstName());
System.out.print(" Last Name: " + employee.getLastName());
System.out.println(" Salary: " + employee.getSalary());
}
tx.commit();
}catch (HibernateException e) {
if (tx!=null) tx.rollback();
e.printStackTrace();
}finally {
session.close();
}
}
/* Method to UPDATE salary for an employee */
public void updateEmployee(Integer EmployeeID, int salary ){
Session session = factory.openSession( new MyInterceptor() );
Transaction tx = null;
try{
tx = session.beginTransaction();
Employee employee =
(Employee)session.get(Employee.class, EmployeeID);
employee.setSalary( salary );
session.update(employee);
tx.commit();
}catch (HibernateException e) {
if (tx!=null) tx.rollback();
e.printStackTrace();
}finally {
session.close();
}
}
/* Method to DELETE an employee from the records */
242
Hibernate
You would get the following result, and records would be created in the EMPLOYEE table.
$java ManageEmployee
.......VARIOUS LOG MESSAGES WILL DISPLAY HERE........
Create Operation
preFlush
postFlush
243
Hibernate
Create Operation
preFlush
postFlush
Create Operation
preFlush
postFlush
First Name: Zara Last Name: Ali Salary: 1000
First Name: Daisy Last Name: Das Salary: 5000
First Name: John Last Name: Paul Salary: 10000
preFlush
postFlush
preFlush
Update Operation
postFlush
preFlush
postFlush
First Name: Zara Last Name: Ali Salary: 5000
First Name: John Last Name: Paul Salary: 10000
preFlush
postFlush
If you check your EMPLOYEE table, it should have the following records:
244