Hibernate-list-mapping

提供:Dev Guides
移動先:案内検索

Hibernate-リストマッピング

*List* は、要素を順番に格納し、要素の重複を許可するJavaコレクションです。 このインターフェイスのユーザーは、リスト内の各要素を挿入する場所を正確に制御できます。 ユーザーは、整数インデックスによって要素にアクセスし、リスト内の要素を検索できます。 より正式には、リストは通常​​、e1.equals(e2)のように要素のペアe1とe2を許可し、それらがまったくヌル要素を許可する場合は通常複数のヌル要素を許可します。

Listは、マッピングテーブルの<list>要素でマップされ、java.util.ArrayListで初期化されます。

RDBMSテーブルを定義する

次の構造を持つ従業員レコードをEMPLOYEEテーブルに保存する必要がある状況を考えます-

create table EMPLOYEE (
   id INT NOT NULL auto_increment,
   first_name VARCHAR(20) default NULL,
   last_name  VARCHAR(20) default NULL,
   salary     INT  default NULL,
   PRIMARY KEY (id)
);

さらに、各従業員が自分に関連付けられた1つ以上の証明書を持つことができると仮定します。 リストコレクションマッピングには、コレクションテーブルにインデックス列が必要です。 インデックス列は、コレクション内の要素の位置を定義します。 だから、私たちは証明書に関連する情報を次の構造を持つ別のテーブルに保存します-

create table CERTIFICATE (
   id INT NOT NULL auto_increment,
   certificate_name VARCHAR(30) default NULL,
   idx INT default NULL,
   employee_id INT default NULL,
   PRIMARY KEY (id)
);

EMPLOYEEオブジェクトとCERTIFICATEオブジェクトの間には* 1対多*の関係があります。

POJOクラスを定義する

EMPLOYEEテーブルに関連するオブジェクトを永続化し、証明書のコレクションを List 変数に保持するために使用されるPOJOクラス Employee を実装しましょう。

import java.util.*;

public class Employee {
   private int id;
   private String firstName;
   private String lastName;
   private int salary;
   private List certificates;

   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 List getCertificates() {
      return certificates;
   }

   public void setCertificates( List certificates ) {
      this.certificates = certificates;
   }
}

証明書オブジェクトを保存してCERTIFICATEテーブルに取得できるように、CERTIFICATEテーブルに対応する別のPOJOクラスを定義する必要があります。

public class Certificate{
   private int id;
   private String name;

   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マッピングファイルの定義

定義したクラスをデータベーステーブルにマップする方法をHibernateに指示するマッピングファイルを作成しましょう。 <list>要素は、使用されるリストコレクションのルールを定義するために使用されます。 リストのインデックスは常に整数型であり、<list-index>要素を使用してマップされます。

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

<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"/>

   </class>

   <class name = "Certificate" table = "CERTIFICATE">

      <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>

マッピングドキュメントは、<classname> .hbm.xml形式のファイルに保存する必要があります。 マッピング文書をファイルEmployee.hbm.xmlに保存しました。 あなたはすでにマッピングの詳細のほとんどに精通していますが、マッピングファイルのすべての要素をもう一度見てみましょう-

  • マッピングドキュメントは、ルート要素として <hibernate-mapping> を持つXMLドキュメントであり、各クラスに対応する2つの<class >>要素が含まれています。
  • <class> 要素は、Javaクラスからデータベーステーブルへの特定のマッピングを定義するために使用されます。 Javaクラス名はクラス要素の name 属性を使用して指定され、データベーステーブル名は table 属性を使用して指定されます。
  • <meta> 要素はオプションの要素であり、クラスの説明を作成するために使用できます。
  • <id> 要素は、クラスの一意のID属性をデータベーステーブルの主キーにマップします。 id要素の name 属性はクラスのプロパティを参照し、 column 属性はデータベーステーブルの列を参照します。 type 属性はhibernateマッピングタイプを保持します。このマッピングタイプはJavaからSQLデータタイプに変換します。
  • id要素内の <generator> 要素は、主キー値を自動的に生成するために使用されます。 ジェネレーター要素の class 属性は native に設定され、休止状態が基になるデータベースの機能に応じて主キーを作成するために identity、sequence または hilo アルゴリズムを選択できるようにします。
  • <property> 要素は、Javaクラスプロパティをデータベーステーブルの列にマップするために使用されます。 要素の name 属性はクラスのプロパティを参照し、 column 属性はデータベーステーブルの列を参照します。 type 属性はhibernateマッピングタイプを保持します。このマッピングタイプはJavaからSQLデータタイプに変換します。
  • <list> 要素は、CertificateクラスとEmployeeクラス間の関係を設定するために使用されます。 <list>要素の cascade 属性を使用して、HibernateにEmployeeオブジェクトと同時にCertificateオブジェクトを永続化するように指示しました。 name 属性は、親クラスで定義された List 変数に設定されます。この例では、_certificates_です。
  • <key> 要素は、親オブジェクトへの外部キーを保持するCERTIFICATEテーブルの列です。 テーブルEMPLOYEE。
  • <list-index> 要素は、要素の位置を保持し、コレクションテーブルのインデックス列とマップするために使用されます。 永続リストのインデックスはゼロから始まります。 たとえば、マッピングで<list-index base = "1" …​/>を使用して、これを変更できます。
  • <one-to-many> 要素は、1つのEmployeeオブジェクトが多くのCertificateオブジェクトに関連しているため、CertificateオブジェクトにはEmployee親が関連付けられている必要があることを示します。 要件に応じて、 <one-to-one><many-to-one> 、または <many-to-many> 要素を使用できます。 この例を多対多のリレーションシップを使用するように変更した場合、親オブジェクトと子オブジェクトをマップするための関連付けテーブルが必要になります。

アプリケーションクラスを作成する

最後に、main()メソッドを使用してアプリケーションクラスを作成し、アプリケーションを実行します。 このアプリケーションを使用して、少数の従業員のレコードと証明書を保存し、それらのレコードにCRUD操作を適用します。

import java.util.*;

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

public class ManageEmployee {
   private static SessionFactory factory;
   public static void main(String[] args) {

      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();
     /*Let us have a set of certificates for the first employee */
      ArrayList set1 = new ArrayList();
      set1.add(new Certificate("MCA"));
      set1.add(new Certificate("MBA"));
      set1.add(new Certificate("PMP"));

     /*Add employee records in the database*/
      Integer empID1 = ME.addEmployee("Manoj", "Kumar", 4000, set1);

     /*Another set of certificates for the second employee */
      ArrayList set2 = new ArrayList();
      set2.add(new Certificate("BCA"));
      set2.add(new Certificate("BA"));

     /*Add another employee record in the database*/
      Integer empID2 = ME.addEmployee("Dilip", "Kumar", 3000, set2);

     /*List down all the employees*/
      ME.listEmployees();

     /*Update employee's salary records*/
      ME.updateEmployee(empID1, 5000);

     /*Delete an employee from the database*/
      ME.deleteEmployee(empID2);

     /*List down all the employees*/
      ME.listEmployees();

   }

  /*Method to add an employee record in the database*/
   public Integer addEmployee(String fname, String lname, int salary, ArrayList cert){
      Session session = factory.openSession();
      Transaction tx = null;
      Integer employeeID = null;

      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;
   }

  /*Method to list all the employees detail*/
   public void listEmployees( ){
      Session session = factory.openSession();
      Transaction tx = null;

      try {
         tx = session.beginTransaction();
         List employees = session.createQuery("FROM Employee").list();
         for (Iterator iterator1 = employees.iterator(); iterator1.hasNext();){
            Employee employee = (Employee) iterator1.next();
            System.out.print("First Name: " + employee.getFirstName());
            System.out.print("  Last Name: " + employee.getLastName());
            System.out.println("  Salary: " + employee.getSalary());
            List certificates = employee.getCertificates();
            for (Iterator iterator2 = certificates.iterator(); iterator2.hasNext();){
               Certificate certName = (Certificate) iterator2.next();
               System.out.println("Certificate: " + certName.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;

      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();
      }
   }
}

コンパイルと実行

上記のアプリケーションをコンパイルして実行する手順は次のとおりです。 コンパイルと実行に進む前に、PATHとCLASSPATHが適切に設定されていることを確認してください。

  • 構成の章で説明されているように、hibernate.cfg.xml構成ファイルを作成します。
  • 上記のように、Employee.hbm.xmlマッピングファイルを作成します。
  • 上記のようにEmployee.javaソースファイルを作成し、コンパイルします。
  • 上記のようにCertificate.javaソースファイルを作成し、コンパイルします。
  • 上記のようにManageEmployee.javaソースファイルを作成し、コンパイルします。
  • ManageEmployeeバイナリを実行してプログラムを実行します。

画面に次の結果が表示され、EMPLOYEEおよびCERTIFICATEテーブルに同じ時間レコードが作成されます。 証明書が逆順にソートされていることがわかります。 マッピングファイルを変更して、 sort = "natural" を設定し、プログラムを実行して結果を比較するだけで試すことができます。

$java ManageEmployee
.......VARIOUS LOG MESSAGES WILL DISPLAY HERE........

First Name: Manoj  Last Name: Kumar  Salary: 4000
Certificate: MCA
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

あなたはあなたの従業員とCERTIFICATEテーブルをチェックする場合、それらは次のレコードを持つ必要があります-

mysql> select *from EMPLOYEE;
+----+------------+-----------+--------+
| id | first_name | last_name | salary |
+----+------------+-----------+--------+
| 51 | Manoj      | Kumar     |   5000 |
+----+------------+-----------+--------+
1 row in set (0.00 sec)

mysql> select* from CERTIFICATE;
+----+------------------+------+-------------+
| id | certificate_name | idx  | employee_id |
+----+------------------+------+-------------+
|  6 | MCA              |    0 |          51 |
|  7 | MBA              |    1 |          51 |
|  8 | PMP              |    2 |          51 |
+----+------------------+------+-------------+
3 rows in set (0.00 sec

mysql>

または、リストの代わりにJava配列をマップできます。 配列マッピングは、異なる要素名と属性名(<array>と<array-index>)を除いて、前の例とほぼ同じです。 ただし、前に説明した理由により、Hibernateアプリケーションが配列を使用することはほとんどありません。