Hibernate-criteria-queries
提供：Dev Guides
Hibernate-基準クエリ
Hibernateは、RDBMSテーブルで利用可能なオブジェクトとデータを操作する別の方法を提供します。 メソッドの1つにCriteria APIがあります。このAPIを使用すると、フィルタールールと論理条件を適用できるプログラムで条件クエリオブジェクトを構築できます。
Hibernate Session インターフェースは* createCriteria（）メソッドを提供します。このメソッドを使用して、アプリケーションが条件クエリを実行するときに永続化オブジェクトのクラスのインスタンスを返す *Criteria オブジェクトを作成できます。
次に、条件クエリの最も単純な例を示します。これは、Employeeクラスに対応するすべてのオブジェクトを返すだけです。
Criteria cr = session.createCriteria(Employee.class);
List results = cr.list();基準の制限
*Criteria* オブジェクトで使用可能な* add（）*メソッドを使用して、条件クエリの制限を追加できます。 以下は、給与が2000に等しいレコードを返すための制限を追加する例です-Criteria cr = session.createCriteria(Employee.class);
cr.add(Restrictions.eq("salary", 2000));
List results = cr.list();以下は、さまざまなシナリオをカバーするいくつかの例であり、要件に従って使用できます-
Criteria cr = session.createCriteria(Employee.class);
//To get records having salary more than 2000
cr.add(Restrictions.gt("salary", 2000));
//To get records having salary less than 2000
cr.add(Restrictions.lt("salary", 2000));
//To get records having fistName starting with zara
cr.add(Restrictions.like("firstName", "zara%"));
//Case sensitive form of the above restriction.
cr.add(Restrictions.ilike("firstName", "zara%"));
//To get records having salary in between 1000 and 2000
cr.add(Restrictions.between("salary", 1000, 2000));
//To check if the given property is null
cr.add(Restrictions.isNull("salary"));
//To check if the given property is not null
cr.add(Restrictions.isNotNull("salary"));
//To check if the given property is empty
cr.add(Restrictions.isEmpty("salary"));
//To check if the given property is not empty
cr.add(Restrictions.isNotEmpty("salary"));次のようにLogicalExpression制限を使用してANDまたはOR条件を作成できます-
Criteria cr = session.createCriteria(Employee.class);
Criterion salary = Restrictions.gt("salary", 2000);
Criterion name = Restrictions.ilike("firstNname","zara%");
//To get records matching with OR conditions
LogicalExpression orExp = Restrictions.or(salary, name);
cr.add( orExp );
//To get records matching with AND conditions
LogicalExpression andExp = Restrictions.and(salary, name);
cr.add( andExp );
List results = cr.list();前のチュートリアルで説明したように、上記のすべての条件はHQLで直接使用できます。
基準を使用したページネーション
ページネーションのためのCriteriaインターフェースには2つの方法があります。
| Sr.No. | Method & Description |
|---|---|
| 1 |
public Criteria setFirstResult(int firstResult) このメソッドは、結果セットの行0から始まる最初の行を表す整数を受け取ります。 |
| 2 |
public Criteria setMaxResults(int maxResults) このメソッドは、オブジェクトの固定数 maxResults を取得するようにHibernateに指示します。 |
上記の2つの方法を一緒に使用して、WebアプリケーションまたはSwingアプリケーションでページングコンポーネントを構築できます。 以下は、一度に10行をフェッチするように拡張できる例です-
Criteria cr = session.createCriteria(Employee.class);
cr.setFirstResult(1);
cr.setMaxResults(10);
List results = cr.list();結果の並べ替え
Criteria APIは org.hibernate.criterion.Order クラスを提供し、オブジェクトのプロパティの1つに従って、結果セットを昇順または降順でソートします。 この例では、Orderクラスを使用して結果セットを並べ替える方法を示します-
Criteria cr = session.createCriteria(Employee.class);
//To get records having salary more than 2000
cr.add(Restrictions.gt("salary", 2000));
//To sort records in descening order
cr.addOrder(Order.desc("salary"));
//To sort records in ascending order
cr.addOrder(Order.asc("salary"));
List results = cr.list();予測と集計
Criteria APIは org.hibernate.criterion.Projections クラスを提供します。これを使用して、プロパティ値の平均、最大、または最小を取得できます。 Projectionsクラスは、 Projection インスタンスを取得するためのいくつかの静的ファクトリメソッドを提供するという点で、Restrictionsクラスに似ています。
以下は、さまざまなシナリオをカバーするいくつかの例であり、要件ごとに使用できます-
Criteria cr = session.createCriteria(Employee.class);
//To get total row count.
cr.setProjection(Projections.rowCount());
//To get average of a property.
cr.setProjection(Projections.avg("salary"));
//To get distinct count of a property.
cr.setProjection(Projections.countDistinct("firstName"));
//To get maximum of a property.
cr.setProjection(Projections.max("salary"));
//To get minimum of a property.
cr.setProjection(Projections.min("salary"));
//To get sum of a property.
cr.setProjection(Projections.sum("salary"));基準クエリの例
次のPOJOクラスを考慮してください-
public class Employee {
private int id;
private String firstName;
private String lastName;
private int salary;
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;
}
}次のEMPLOYEEテーブルを作成して、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)
);以下はマッピングファイルです。
<?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>
<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>最後に、main（）メソッドを使用してアプリケーションクラスを作成し、 Criteria クエリを使用するアプリケーションを実行します-
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;
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();
/*Add few employee records in database*/
Integer empID1 = ME.addEmployee("Zara", "Ali", 2000);
Integer empID2 = ME.addEmployee("Daisy", "Das", 5000);
Integer empID3 = ME.addEmployee("John", "Paul", 5000);
Integer empID4 = ME.addEmployee("Mohd", "Yasee", 3000);
/*List down all the employees*/
ME.listEmployees();
/*Print Total employee's count*/
ME.countEmployee();
/*Print Total salary*/
ME.totalSalary();
}
/*Method to CREATE an employee in the database*/
public Integer addEmployee(String fname, String lname, int salary){
Session session = factory.openSession();
Transaction tx = null;
Integer employeeID = null;
try {
tx = session.beginTransaction();
Employee employee = new Employee(fname, lname, salary);
employeeID = (Integer) session.save(employee);
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();
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 print total number of records*/
public void countEmployee(){
Session session = factory.openSession();
Transaction tx = null;
try {
tx = session.beginTransaction();
Criteria cr = session.createCriteria(Employee.class);
//To get total row count.
cr.setProjection(Projections.rowCount());
List rowCount = cr.list();
System.out.println("Total Coint: " + rowCount.get(0) );
tx.commit();
} catch (HibernateException e) {
if (tx!=null) tx.rollback();
e.printStackTrace();
} finally {
session.close();
}
}
/*Method to print sum of salaries*/
public void totalSalary(){
Session session = factory.openSession();
Transaction tx = null;
try {
tx = session.beginTransaction();
Criteria cr = session.createCriteria(Employee.class);
//To get total salary.
cr.setProjection(Projections.sum("salary"));
List totalSalary = cr.list();
System.out.println("Total Salary: " + totalSalary.get(0) );
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ソースファイルを作成し、コンパイルします。
- 上記のようにManageEmployee.javaソースファイルを作成し、コンパイルします。 *ManageEmployeeバイナリを実行してプログラムを実行します。
次の結果が得られ、EMPLOYEEテーブルにレコードが作成されます。
$java ManageEmployee
.......VARIOUS LOG MESSAGES WILL DISPLAY HERE........
First Name: Daisy Last Name: Das Salary: 5000
First Name: John Last Name: Paul Salary: 5000
First Name: Mohd Last Name: Yasee Salary: 3000
Total Coint: 4
Total Salary: 15000EMPLOYEEテーブルを確認する場合、次のレコードが必要です。
mysql> select* from EMPLOYEE;
+----+------------+-----------+--------+
| id | first_name | last_name | salary |
+----+------------+-----------+--------+
| 14 | Zara | Ali | 2000 |
| 15 | Daisy | Das | 5000 |
| 16 | John | Paul | 5000 |
| 17 | Mohd | Yasee | 3000 |
+----+------------+-----------+--------+
4 rows in set (0.00 sec)
mysql>