Interstage Application Server J2EE ユーザーズガイド

9.2.7 EJB QL

　EJB QLとは、finderメソッドまたはejbSelectメソッドなど検索メソッドのクエリ文を定義するためのSQL92ベースの言語です。
　一般的に使用するSQLとの最大の違いは、SELECT型にEntity Beanの識別子だけが単独で指定されている場合に指定するOBJECTキーワードです。

　EJB QLは抽象スキーマ名に基づいて記述されるので、特定のデータベースに依存しない互換性があります。抽象スキーマ名は、CMP／CMRフィールドに並んで抽象永続スキーマを構成する重要な構成要素です。

　抽象スキーマ名は、ejb-jar内で一意になるようにしてください。

　EJB QLを使用するには、deployment descriptor内の<query>タグにEJB QL文を記述します。
　EJBアプリケーションのdeployment descriptorの情報が定義されているファイル(ejb-jar.xml)は、XML形式で記述する必要があります。このため、ejb-jar.xmlを編集する場合は、XML形式の仕様に従ってください。

　特に以下の文字については、定義済み実体参照(暗黙定義エンティティ)で記述してください。

　EJB QLが使用できるのは、CMP2.0のEntity Beanです。

ejb-jar.xmlを編集する場合

編集する文字	定義済み実体参照
<	&lt;
>	&gt;
&	&amp;
'	&apos;
"	&quot;

◆ SELECT句

　返却値の値としてOBJECT(Entity Bean)、またはパス式を使ってCMF、CMRフィールドを指定できます。

◆ FROM句

　EJBアプリケーションのクラス名ではなく、Entity Bean内に記述された一意の"抽象スキーマ名"を指定します。

◆ WHERE句

　検索条件の指定を行います。例えば ?1は、検索メソッドのパラメタの１番目を意味します。
　Entity Beanの検索メソッドにはfinderメソッド、またはejbselectメソッドがあります。それぞれの検索メソッドにおいてメソッド名、パラメタの型を指定してください。
　また、メソッドの返却値の型をマッピングするために、結果のタイプにLocalまたはRemote要素を指定します。デフォルト値はLocalです。

■検索メソッド

• finderメソッド
  • EJBアプリケーションのHomeインタフェースに定義され、単一または複数のEJBアプリケーションに対するリファレンスを取得します。
  • CMP2.0では戻り値が複数の場合の型は、java.util.Collection型だけサポートされています（java.util.EnumerationはCMP1.1およびBMPではサポートされています）。

• ejbselectメソッド
  • EJBアプリケーション内部でだけ使用できるプライベートメソッドです。
  • ejbselectメソッドを使用してCMFやCMRフィールドの値や、Local/Remoteインタフェースを取得できます。
  • ejbHomeメソッドやビジネスメソッドからも呼び出せることにより、finderメソッドよりも柔軟性に優れていますが、HomeインタフェースではなくEnterprise Beanクラスで抽象メソッドとして定義されるので、クライアントには公開されません（クライアントから呼び出すことができません）。
  • CMP2.0では戻り値が複数の場合の型は、java.util.Collection型だけサポートされています（java.util.Set型は現在未サポートです）。

■ EJB QL定義

◆ EJB QLで使用できる演算子

　以下にEJB QLで使用できる演算子を示します。

SELECT、 FROM、 WHERE、 DISTINCT、 OBJECT、 NULL、 TRUE、 FALSE、 NOT、 AND、 

OR、 BETWEEN、LIKE、 IN、 AS、 UNKNOWN、 EMPTY、 MEMBER、OF、 IS

◆ EJB QLの使用例

演算子を使用したEJB QL文の例です。

• SELECT句
  • 例1）単純なEJB QL文
  • 例2）パス式を使用するEJB QL文
• WHERE句
  • 例1）リテラルを使用
  • 例2）パラメタを使用
  • 例3）算術演算子を使用
  • 例4）BETWEEN演算子を使用
  • 例5）NULL演算子を使用

SELECT句

• 例1）単純なEJB QL文

  WHERE句がなく識別子が抽象スキーマ1つしか使われないもので、以下のEJB QLの例では、Customerという抽象スキーマから検索します。FROM句の後に抽象スキーマ名（Customer）を指定して、ASの後のcはCustomerをあらわす識別子です（AS は省略可）。
  下記のようにSELECT型にEntity Beanの識別子だけが単独で指定されている場合は、OBJECT（）演算子が必須です。

  SELECT OBJECT (c) FROM Customer AS c

  
  

  すべてのCustomerのCollectionを返します。

• 例2）パス式を使用するEJB QL文

  例2では、Customerという抽象スキーマよりCustomerすべての姓を検索するEJB QLを記述します。この例では、OBJECT（）演算子は不要です。
  SELECT句はCMPフィールドまたはCMRフィールドも返却できます。

  SELECT c.lastName FROM Customer AS c

  全Customerの姓の、Collectionを返します。

WHERE句

　FROM句で検索された値に対しWHERE句を使用して、いろいろな条件テストが指定できます。

• 例1）リテラルを使用

  WHERE句で指定されたリテラル（定数）に一致するBeanを検索するためのEJB QLの記述です。指定したリテラルはシングルクォーテーション（‘）で囲みます。この例では名前がFujitsuであるCustomerを検索するEJB QLです。

  SELECT OBJECT(c) FROM Customer AS c
  WHERE c.name = 'Fujitsu'

  
  

  'Fujitsu'という名前のCustomerを返します。

  【留意事項】

  • EJB QLでは文字列リテラル、数値リテラルおよびboolean型のリテラルが指定できます。
  • 日時型など他のデータ型を指定する場合は、リテラルではなくパラメタを使用してください。
  • EJBアプリケーションのdeployment descriptorの情報が定義されているファイル(ejb-jar.xml)を直接編集する場合は、“ejb-jar.xmlを編集する場合”を参照して、XML形式の仕様に従った記述をしてください。

• 例2）パラメタを使用

  WHERE句の後に指定したパラメタに対して、疑問符(?) とパラメタが最初 (1) から数えて何番目になるかを指定します。以下のEJB QLの例では、Customerという抽象スキーマからパラメタの名前に指定されたCustomerから検索するEJB QLの記述です。

  SELECT OBJECT(c) FROM Customer AS c
  WHERE c.name = ?1

  パラメタに指定された名前のCustomer Collectionを返します。

• 例3）比較式を使用したEJB QL文

  WHERE句では比較式が使用できます。以下の例では比較式（>=）を使用して年齢が25歳以上のCustomerを検索するEJB QLの例を記述します。

  SELECT OBJECT(c) FROM Customer AS c
  WHERE c.age >= 25

  【留意事項】

  • 左辺にリテラルおよびパラメタの指定はできません。
  • 以下のデータ型を比較する場合、左辺および右辺に指定するデータ型は同じ型を指定してください。
    • java.lang.String
    • charまたはjava.lang.Character
    • booleanまたはjava.lang.Boolean
    • java.sql.Date
    • java.sql.Time
    • java.sql.Timestamp
  • 以下のデータ型は比較できません。
    • byte配列
    • Serializableオブジェクト

• 例4）BETWEEN演算子を使用

  BETWEEN（NOT BETWEEN）演算子の使用方法はSQLと同様にBETWEEN演算子の指定区間について検索することができます。例ではIDが100～200のCustomerを検索するEJB QLです。

  SELECT OBJECT(c) FROM Customer AS c
  WHERE c.id BETWEEN 100 and 200

  idが100～200のCustomerのCollectionを返します。

• 例5）NULL比較式を使用したEJB QL文

  NULL比較式演算子は、NULL値の検索に使用します。例えば年齢がNULL値ではないCustomerを検索するEJB QLは次のように記述します。

  SELECT OBJECT(c) FROM Customer AS c
  WHERE c.age IS NOT NULL

  年齢情報があるCustomerのCollectionを返します。

• Symfowareでは、関数式 CONCAT、SQRT、LOCATE、LENGTH、 SUBSTRING は使用できません。
• Oracleでは、関数式 SQRT は使用できません。
• SQL Serverでは、関数式 CONCAT、SQRT、LOCATE、LENGTH は使用できません。
• PostgreSQLでは、関数式 CONCAT、SQRT、LOCATE は使用できません。

　より詳細なEJB QLの使用方法については、EJB2.0の仕様書を参照してください。