CriteriaQuery (javax.persistence-api 2.2 API)

型パラメータ:

T - 定義された結果の型

すべてのスーパーインタフェース:

AbstractQuery<T>, CommonAbstractCriteria
```
public interface CriteriaQuery<T>
extends AbstractQuery<T>
```
CriteriaQueryインターフェイスはトップレベルのクエリーに固有の機能を定義します。

導入されたバージョン:

Java Persistence 2.0

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド
修飾子とタイプ	メソッドと説明
`CriteriaQuery<T>`	`distinct(boolean distinct)` 重複するクエリーの結果を除去するかどうかを指定します。
`java.util.List<Order>`	`getOrderList()` 優先順位に従って順序付け式を返します。
`java.util.Set<ParameterExpression<?>>`	`getParameters()` クエリーのパラメーターを返します。
`CriteriaQuery<T>`	`groupBy(Expression<?>... grouping)` クエリーの結果に対してグループを形成するために使用される式を指定します。
`CriteriaQuery<T>`	`groupBy(java.util.List<Expression<?>> grouping)` クエリーの結果に対してグループを形成するために使用される式を指定します。
`CriteriaQuery<T>`	`having(Expression<java.lang.Boolean> restriction)` クエリーのグループに対応する制限を指定します。
`CriteriaQuery<T>`	`having(Predicate... restrictions)` 指定された制限述語の結合に従ってクエリーのグループに対応する制限を指定します。
`CriteriaQuery<T>`	`multiselect(java.util.List<Selection<?>> selectionList)` クエリーの結果から返される選択項目を指定します。
`CriteriaQuery<T>`	`multiselect(Selection<?>... selections)` クエリーの結果から返される選択項目を指定します。
`CriteriaQuery<T>`	`orderBy(java.util.List<Order> o)` クエリーの結果を順序付けするのに使用される順序付け式を指定します。
`CriteriaQuery<T>`	`orderBy(Order... o)` クエリーの結果を順序付けするのに使用される順序付け式を指定します。
`CriteriaQuery<T>`	`select(Selection<? extends T> selection)` クエリーの結果に返される項目を指定します。
`CriteriaQuery<T>`	`where(Expression<java.lang.Boolean> restriction)` 指定されたブール式に従ってクエリーの結果を制限するようにクエリーを変更します。
`CriteriaQuery<T>`	`where(Predicate... restrictions)` 指定されたブール式に従ってクエリーの結果を制限するようにクエリーを変更します。

インタフェースから継承されたメソッド javax.persistence.criteria.AbstractQuery
from, from, getGroupList, getGroupRestriction, getResultType, getRoots, getSelection, isDistinct

インタフェースから継承されたメソッド javax.persistence.criteria.CommonAbstractCriteria
getRestriction, subquery

- メソッドの詳細
  - select
```
CriteriaQuery<T> select(Selection<? extends T> selection)
```
    クエリーの結果に返される項目を指定します。以前に指定された項目があれば置き換えます。
    注意：文字列ベースのAPIを使用するアプリケーションでは、取得操作または結合操作の結果の項目でクエリーの結果の型が指定されている場合には、選択項目の型を指定する必要があります。
```
     例：

     CriteriaQuery<String> q = cb.createQuery(String.class);
     Root<Order> order = q.from(Order.class);
     q.select(order.get("shippingAddress").<String>get("state"));
 
     CriteriaQuery<Product> q2 = cb.createQuery(Product.class);
     q2.select(q2.from(Order.class)
                 .join("items")
                 .<Item,Product>join("product"));
 
 
```
    パラメータ:
    
    selection - クエリーの結果に返される項目を指定するSelection
    
    戻り値:
    
    変更されたクエリー
    
    例外:
    
    java.lang.IllegalArgumentException - 選択項目が複合選択項目であり、複数の選択項目に同じ別名が割り当てられた場合
  - multiselect
```
CriteriaQuery<T> multiselect(Selection<?>... selections)
```
    クエリーの結果から返される選択項目を指定します。以前に指定された項目があれば置き換えます。クエリーの実行結果の型は、作成されたクライテリアクエリーオブジェクトの型の指定だけではなくmultiselectメソッドの引数にも依存します。
    multiselectメソッドの引数はタプルや配列値の複合選択項目であってはなりません。
    このメソッドのセマンティックスは以下のとおりです。:
    - クライテリアクエリーの型がCriteriaQuery<Tuple>である (つまり、クライテリアクエリーオブジェクトがcreateTupleQueryメソッドもしくは createQueryメソッドにTupleクラスを引数として渡されて作られた)場合、 multiselectメソッドの引数に関連するTupleオブジェクトは指定された順序でインスタンス化され、クエリーの実行から結果の行ごとに返されます。
    - クライテリアクエリーの型がユーザーが定義した任意のクラスXのためのCriteriaQuery<X>である (つまり、クライテリアクエリーオブジェクトがcreateQuery メソッドにXクラスを引数として渡されて作られた)場合、 multiselectメソッドの引数はXのコンストラクタに渡され、X型のインスタンスが行ごとに返されます。
    - クライテリアクエリーの型がユーザーが定義した任意のクラスXのためのCriteriaQuery<X[]>である場合、 X[]型のインスタンスが行ごとに返されます。配列の要素は指定された順序でmultiselectメソッドの引数に対応します。
    - クライテリアクエリーの型がCriteriaQuery<Object>であるかクライテリアクエリーが型の指定なしに作られ、 multiselectメソッドに一つの引数しか渡されない場合、 Object型のインスタンスが行ごとに返されます。
    - クライテリアクエリーの型がCriteriaQuery<Object>であるかクライテリアクエリーが型の指定なしに作られ、 multiselectメソッドに二つ以上の引数が渡された場合、 Object[]型のインスタンスが行ごとに返されます。配列の要素は指定された順序でmultiselectメソッドの引数に対応します。
    パラメータ:
    
    selections - クエリーによって返される結果に対応する選択項目
    
    戻り値:
    
    変更されたクエリー
    
    例外:
    
    java.lang.IllegalArgumentException - 選択項目が不正である、もしくは二つ以上の選択項目に同じエイリアスが指定されていた場合
  - multiselect
```
CriteriaQuery<T> multiselect(java.util.List<Selection<?>> selectionList)
```
    クエリーの結果から返される選択項目を指定します。以前に指定された項目があれば置き換えます。
    クエリーの実行結果の型は、作成されたクライテリアクエリーオブジェクトの型の指定だけではなくmultiselectメソッドの引数にも依存します。 multiselectに渡されるListの要素はタプルや配列の値の複合選択項目であってはいけません。
    このメソッドのセマンティックスは以下のとおりです。:
    - クライテリアクエリーの型がCriteriaQuery<Tuple>である (つまり、クライテリアクエリーオブジェクトがcreateTupleQueryメソッドもしくは createQueryメソッドにTupleクラスを引数として渡されて作られた)場合、 multiselectメソッドに渡されたListの要素に関連するTupleオブジェクトは指定された順序でインスタンス化され、クエリーの実行から結果の行ごとに返されます。
    - クライテリアクエリーの型がユーザーが定義した任意のクラスXのためのCriteriaQuery<X>である (つまり、クライテリアクエリーオブジェクトがcreateQuery メソッドにXクラスを引数として渡されて作られた)場合、 multiselectメソッドに渡されたListの要素はXのコンストラクタに渡され、X型のインスタンスが行ごとに返されます。
    - クライテリアクエリーの型がユーザーが定義した任意のクラスXのためのCriteriaQuery<X[]>である場合、 X[]型のインスタンスが行ごとに返されます。配列の要素は指定された順序でmultiselectメソッドに渡されたListの要素に対応します。
    - クライテリアクエリーの型がCriteriaQuery<Object>であるかクライテリアクエリーが型の指定なしに作られ、 multiselectメソッドに一つの要素しか持たないListが渡された場合、 Object型のインスタンスが行ごとに返されます。
    - クライテリアクエリーの型がCriteriaQuery<Object>であるかクライテリアクエリーが型の指定なしに作られ、 multiselectメソッドに二つ以上の要素を持つListが渡された場合、 Object[]型のインスタンスが行ごとに返されます。配列の要素は指定された順序でmultiselectメソッドに渡されたListの要素に対応します。
    パラメータ:
    
    selectionList - クエリーによって返される結果に対応する選択項目の一覧
    
    戻り値:
    
    変更されたクエリー
    
    例外:
    
    java.lang.IllegalArgumentException - 選択項目が不正である、もしくは二つ以上の選択項目に同じエイリアスが指定されていた場合
  - where
```
CriteriaQuery<T> where(Expression<java.lang.Boolean> restriction)
```
    指定されたブール式に従ってクエリーの結果を制限するようにクエリーを変更します。以前に追加された制限があれば置き換えます。このクエリーは対応するAbstractQueryのメソッドの結果型を上書きするだけです。
    
    定義:
    
    where インタフェース内 AbstractQuery<T>
    
    パラメータ:
    
    restriction - 単純な、もしくは複合したブール式
    
    戻り値:
    
    変更されたクエリー
  - where
```
CriteriaQuery<T> where(Predicate... restrictions)
```
    指定されたブール式に従ってクエリーの結果を制限するようにクエリーを変更します。以前に追加された制限があれば置き換えます。制限が指定されていない場合は以前に追加された制限は単純に削除されます。このクエリーは対応するAbstractQueryのメソッドの結果型を上書きするだけです。
    
    定義:
    
    where インタフェース内 AbstractQuery<T>
    
    パラメータ:
    
    restrictions - 0個以上の制限の述語
    
    戻り値:
    
    変更されたクエリー
  - groupBy
```
CriteriaQuery<T> groupBy(Expression<?>... grouping)
```
    クエリーの結果に対してグループを形成するために使用される式を指定します。以前に追加されたグループ化式があれば置き換えます。グループ化式が指定されていない場合は以前に追加されたグループ化式は単純に削除されます。このクエリーは対応するAbstractQueryのメソッドの結果型を上書きするだけです。
    
    定義:
    
    groupBy インタフェース内 AbstractQuery<T>
    
    パラメータ:
    
    grouping - 0個以上のグループ化式
    
    戻り値:
    
    変更されたクエリー
  - groupBy
```
CriteriaQuery<T> groupBy(java.util.List<Expression<?>> grouping)
```
    クエリーの結果に対してグループを形成するために使用される式を指定します。以前に追加されたグループ化式があれば置き換えます。グループ化式が指定されていない場合は以前に追加されたグループ化式は単純に削除されます。このクエリーは対応するAbstractQueryのメソッドの結果型を上書きするだけです。
    
    定義:
    
    groupBy インタフェース内 AbstractQuery<T>
    
    パラメータ:
    
    grouping - 0個以上のグループ化式のリスト
    
    戻り値:
    
    変更されたクエリー
  - having
```
CriteriaQuery<T> having(Expression<java.lang.Boolean> restriction)
```
    クエリーのグループに対応する制限を指定します。以前に追加されたhaving制限があれば置き換えます。このクエリーは対応するAbstractQueryのメソッドの結果型を上書きするだけです。
    
    定義:
    
    having インタフェース内 AbstractQuery<T>
    
    パラメータ:
    
    restriction - 単純な、もしくは複合したブール式
    
    戻り値:
    
    変更されたクエリー
  - having
```
CriteriaQuery<T> having(Predicate... restrictions)
```
    指定された制限述語の結合に従ってクエリーのグループに対応する制限を指定します。以前に追加されたhaving制限があれば置き換えます。制限が指定されていない場合は以前に追加された制限は単純に削除されます。このクエリーは対応するAbstractQueryのメソッドの結果型を上書きするだけです。
    
    定義:
    
    having インタフェース内 AbstractQuery<T>
    
    パラメータ:
    
    restrictions - 0個以上の制限の述語
    
    戻り値:
    
    変更されたクエリー
  - orderBy
```
CriteriaQuery<T> orderBy(Order... o)
```
    クエリーの結果を順序付けするのに使用される順序付け式を指定します。以前に追加された順序付け式があれば置き換えます。順序付け式が指定されていない場合は以前に追加された順序付け式は単純に削除され、結果は不特定の順序で返されます。順序付け式の左から右の順序で優先順位が決定され、最も左の優先順位が最も高くなります。
    
    パラメータ:
    
    o - 0個以上の順序付け式
    
    戻り値:
    
    変更されたクエリー
  - orderBy
```
CriteriaQuery<T> orderBy(java.util.List<Order> o)
```
    クエリーの結果を順序付けするのに使用される順序付け式を指定します。以前に追加された順序付け式があれば置き換えます。順序付け式が指定されていない場合は以前に追加された順序付け式は単純に削除され、結果は不特定の順序で返されます。リスト内の順序付け式の順序によって優先順位が決定され、リスト内の最初の要素の優先順位が最も高くなります。
    
    パラメータ:
    
    o - 0個以上の順序付け式のList
    
    戻り値:
    
    変更されたクエリー
  - distinct
```
CriteriaQuery<T> distinct(boolean distinct)
```
    重複するクエリーの結果を除去するかどうかを指定します。 trueの値は重複を排除します。falseの値を指定すると重複が保持されます。 distinctが指定されていない場合は重複した結果を保持する必要があります。このクエリーは対応するAbstractQueryのメソッドの結果型を上書きするだけです。
    
    定義:
    
    distinct インタフェース内 AbstractQuery<T>
    
    パラメータ:
    
    distinct - クエリーの結果から重複した結果を取り除くべきか、保持するべきかを指定するブール値
    
    戻り値:
    
    変更されたクエリー
  - getOrderList
```
java.util.List<Order> getOrderList()
```
    優先順位に従って順序付け式を返します。順序付け式が指定されていない場合は空のListを返します。そのListへの変更はクエリーには影響を与えません。
    
    戻り値:
    
    順序付け式のList
  - getParameters
```
java.util.Set<ParameterExpression<?>> getParameters()
```
    クエリーのパラメーターを返します。パラメーターが存在しない場合は空のSetを返します。そのSetへの変更はクエリーには影響を与えません。
    
    戻り値:
    
    クエリーのパラメーター

インタフェース CriteriaQuery<T>

メソッドのサマリー

インタフェースから継承されたメソッド javax.persistence.criteria.AbstractQuery

インタフェースから継承されたメソッド javax.persistence.criteria.CommonAbstractCriteria

メソッドの詳細

select

multiselect

multiselect

where

where

groupBy

groupBy

having

having

orderBy

orderBy

distinct

getOrderList

getParameters