Hibernate Table Per Hierarchy using xml file

Table Per Hierarchy
Example of Table Per Hierarchy

By this inheritance strategy, we can map the whole hierarchy by single table only. Here, an extra column (also known as discriminator column) is created in the table to identify the class.

Let’s understand the problem first. I want to map the whole hierarchy given below into one table of the database.

table per class hierarchy in inhertance mapping

There are three classes in this hierarchy. Employee is the super class for Regular_Employee and Contract_Employee classes. Let’s see the mapping file for this hierarchy.

  <?xml version=’1.0′ encoding=’UTF-8′?> <!DOCTYPE hibernate-mapping PUBLIC           “-//Hibernate/Hibernate Mapping DTD 5.3//EN”           “http://hibernate.sourceforge.net/hibernate-mapping-5.3.dtd”>  <hibernate-mapping> <class name=”com.tutoraspire.mypackage.Employee” table=”emp121″ discriminator-value=”emp”> <id name=”id”> <generator class=”increment”></generator> </id>  <discriminator column=”type” type=”string”></discriminator> <property name=”name”></property>            <subclass name=”com.tutoraspire.mypackage.Regular_Employee” discriminator-value=”reg_emp”> <property name=”salary”></property> <property name=”bonus”></property> </subclass>            <subclass name=”com.tutoraspire.mypackage.Contract_Employee” discriminator-value=”con_emp”> <property name=”pay_per_hour”></property> <property name=”contract_duration”></property> </subclass>            </class>            </hibernate-mapping>  

In case of table per class hierarchy an discriminator column is added by the hibernate framework that specifies the type of the record. It is mainly used to distinguish the record. To specify this, discriminator subelement of class must be specified.

The subclass subelement of class, specifies the subclass. In this case, Regular_Employee and Contract_Employee are the subclasses of Employee class.

The table structure for this hierarchy is as shown below:

table per class hierarchy table

Example of Table per class hierarchy

In this example we are creating the three classes and provide mapping of these classes in the employee.hbm.xml file.

1) Create the Persistent classes

You need to create the persistent classes representing the inheritance. Let’s create the three classes for the above hierarchy:

File: Employee.java

  package com.tutoraspire.mypackage;  public class Employee { private int id; private String name;  //getters and setters }  

File: Regular_Employee.java

  package com.tutoraspire.mypackage;  public class Regular_Employee extends Employee{ private float salary; private int bonus;  //getters and setters }  

File: Contract_Employee.java

  package com.tutoraspire.mypackage;  public class Contract_Employee extends Employee{ private float pay_per_hour; private String contract_duration;  //getters and setters }  

2) Create the mapping file for Persistent class

The mapping has been discussed above for the hierarchy.

File: employee.hbm.xml

  <?xml version=’1.0′ encoding=’UTF-8′?> <!DOCTYPE hibernate-mapping PUBLIC           “-//Hibernate/Hibernate Mapping DTD 5.3//EN”           “http://hibernate.sourceforge.net/hibernate-mapping-5.3.dtd”>  <hibernate-mapping> <class name=”com.tutoraspire.mypackage.Employee” table=”emp121″ discriminator-value=”emp”> <id name=”id”> <generator class=”increment”></generator> </id>  <discriminator column=”type” type=”string”></discriminator> <property name=”name”></property>            <subclass name=”com.tutoraspire.mypackage.Regular_Employee” discriminator-value=”reg_emp”> <property name=”salary”></property> <property name=”bonus”></property> </subclass>            <subclass name=”com.tutoraspire.mypackage.Contract_Employee” discriminator-value=”con_emp”> <property name=”pay_per_hour”></property> <property name=”contract_duration”></property> </subclass>            </class>            </hibernate-mapping>  

3) Add mapping of hbm file in configuration file

Open the hibernate.cgf.xml file, and add an entry of mapping resource like this:

Now the configuration file will look like this:

File: hibernate.cfg.xml

  <?xml version=’1.0′ encoding=’UTF-8′?> <!DOCTYPE hibernate-configuration PUBLIC           “-//Hibernate/Hibernate Configuration DTD 5.3//EN”           “http://hibernate.sourceforge.net/hibernate-configuration-5.3.dtd”>  <hibernate-configuration>      <session-factory>         <property name=”hbm2ddl.auto”>update</property>         <property name=”dialect”>org.hibernate.dialect.Oracle9Dialect</property>         <property name=”connection.url”>jdbc:oracle:thin:@tutoraspire.com:1521:xe</property>         <property name=”connection.username”>system</property>         <property name=”connection.password”>jtp</property>         <property name=”connection.driver_class”>oracle.jdbc.driver.OracleDriver</property>     <mapping resource=”employee.hbm.xml”/>     </session-factory>  </hibernate-configuration>  

The hbm2ddl.auto property is defined for creating automatic table in the database.

4) Create the class that stores the persistent object

In this class, we are simply storing the employee objects in the database.

File: StoreData.java

 package com.tutoraspire.mypackage;   import org.hibernate.Session; import org.hibernate.SessionFactory; import org.hibernate.Transaction; import org.hibernate.boot.Metadata; import org.hibernate.boot.MetadataSources; import org.hibernate.boot.registry.StandardServiceRegistry; import org.hibernate.boot.registry.StandardServiceRegistryBuilder;  public class StoreData {   public static void main(String[] args) {        StandardServiceRegistry ssr=new StandardServiceRegistryBuilder().configure(“hibernate.cfg.xml”).build(); Metadata meta=new MetadataSources(ssr).getMetadataBuilder().build();  SessionFactory factory=meta.getSessionFactoryBuilder().build(); Session session=factory.openSession();        Transaction t=session.beginTransaction();              Employee e1=new Employee();       e1.setName(“Gaurav Chawla”);              Regular_Employee e2=new Regular_Employee();       e2.setName(“Vivek Kumar”);       e2.setSalary(50000);       e2.setBonus(5);              Contract_Employee e3=new Contract_Employee();       e3.setName(“Arjun Kumar”);       e3.setPay_per_hour(1000);       e3.setContract_duration(“15 hours”);              session.persist(e1);       session.persist(e2);       session.persist(e3);              t.commit();       session.close();       System.out.println(“success”);   }   }   

Output:

output of the table per class hierarchy

Download this inheritance mapping example (Developed using Eclipse IDE)

Topics in Hibernate Inheritance Mapping

Table Per Hierarchy using xml file
Table Per Hierarchy using Annotation
Table Per Concrete class using xml file
Table Per Concrete class using Annotation
Table Per Subclass using xml file
Table Per Subclass using Annotation

Next TopicHibernate Table Per Hierarchy Using Annotation Tutorial Example

Hibernate Tutorial: Table per Hierarchy Example using XML file