AbstractQuery (javax.persistence-api 2.2 API)

型パラメータ:

T - 結果の型

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

CommonAbstractCriteria

既知のサブインタフェースのリスト:

CriteriaQuery<T>, Subquery<T>
```
public interface AbstractQuery<T>
extends CommonAbstractCriteria
```
AbstractQueryインターフェースはトップレベルのクエリーとサブクエリーの両方に共通な機能を定義します。これはクエリーの構築に直接使用するためのものではありません。
すべてのクエリーは(joinを所有している可能性のある)ルートエンティティを持つ必要があります。
すべてのクエリーは制限の論理積を持つ可能性があります。

導入されたバージョン:

Java Persistence 2.0

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド
修飾子とタイプ	メソッドと説明
`AbstractQuery<T>`	`distinct(boolean distinct)` 重複するクエリーの結果を除去するかどうかを指定します。
`<X> Root<X>`	`from(java.lang.Class<X> entityClass)` 指定されたエンティティに対応するクエリールートを作成して追加し、既存のルートとのデカルト積を作成します。
`<X> Root<X>`	`from(EntityType<X> entity)` 指定されたエンティティに対応するクエリールートを作成して追加し、既存のルートとのデカルト積を作成します。
`java.util.List<Expression<?>>`	`getGroupList()` グループ化式のListを返します。
`Predicate`	`getGroupRestriction()` グループ化項目に対応する制限に対応する述語を返します。
`java.lang.Class<T>`	`getResultType()` クエリーもしくはサブクエリーの結果の型を返します。
`java.util.Set<Root<?>>`	`getRoots()` クエリールートを返します。
`Selection<T>`	`getSelection()` クエリーの`Selection`を返します。
`AbstractQuery<T>`	`groupBy(Expression<?>... grouping)` クエリーの結果に対してグループを形成するために使用される式を指定します。
`AbstractQuery<T>`	`groupBy(java.util.List<Expression<?>> grouping)` クエリーの結果に対してグループを形成するために使用される式を指定します。
`AbstractQuery<T>`	`having(Expression<java.lang.Boolean> restriction)` クエリーのグループに対応する制限を指定します。
`AbstractQuery<T>`	`having(Predicate... restrictions)` 指定された制限述語の結合に従ってクエリーのグループに対応する制限を指定します。
`boolean`	`isDistinct()` 重複するクエリーの結果を除去または保持する必要があるかどうかを戻します。
`AbstractQuery<T>`	`where(Expression<java.lang.Boolean> restriction)` 指定されたブール式に従ってクエリ結果を制限するようにクエリを変更します。
`AbstractQuery<T>`	`where(Predicate... restrictions)` 指定されたブール式に従ってクエリ結果を制限するようにクエリを変更します。

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

- メソッドの詳細
  - from
```
<X> Root<X> from(java.lang.Class<X> entityClass)
```
    指定されたエンティティに対応するクエリールートを作成して追加し、既存のルートとのデカルト積を作成します。
    
    パラメータ:
    
    entityClass - エンティティクラス
    
    戻り値:
    
    指定されたエンティティに対応するクエリールート
  - from
```
<X> Root<X> from(EntityType<X> entity)
```
    指定されたエンティティに対応するクエリールートを作成して追加し、既存のルートとのデカルト積を作成します。
    
    パラメータ:
    
    entity - タイプ X のエンティティに対応するメタモデルエンティティ
    
    戻り値:
    
    指定されたエンティティに対応するクエリールート
  - where
```
AbstractQuery<T> where(Expression<java.lang.Boolean> restriction)
```
    指定されたブール式に従ってクエリ結果を制限するようにクエリを変更します。以前に追加された制限があれば置き換えます。
    
    パラメータ:
    
    restriction - 単純な、もしくは複合したブール式
    
    戻り値:
    
    変更されたクエリー
  - where
```
AbstractQuery<T> where(Predicate... restrictions)
```
    指定されたブール式に従ってクエリ結果を制限するようにクエリを変更します。以前に追加された制限があれば置き換えます。制限が指定されていない場合は以前に追加された制限は単純に削除されます。
    
    パラメータ:
    
    restrictions - 0個以上の制限の述語
    
    戻り値:
    
    変更されたクエリー
  - groupBy
```
AbstractQuery<T> groupBy(Expression<?>... grouping)
```
    クエリーの結果に対してグループを形成するために使用される式を指定します。以前に追加されたグループ化式があれば置き換えます。グループ化式が指定されていない場合は以前に追加されたグループ化式は単純に削除されます。
    
    パラメータ:
    
    grouping - 0個以上のグループ化式
    
    戻り値:
    
    変更されたクエリー
  - groupBy
```
AbstractQuery<T> groupBy(java.util.List<Expression<?>> grouping)
```
    クエリーの結果に対してグループを形成するために使用される式を指定します。以前に追加されたグループ化式があれば置き換えます。グループ化式が指定されていない場合は以前に追加されたグループ化式は単純に削除されます。
    
    パラメータ:
    
    grouping - 0個以上のグループ化式の一覧
    
    戻り値:
    
    変更されたクエリー
  - having
```
AbstractQuery<T> having(Expression<java.lang.Boolean> restriction)
```
    クエリーのグループに対応する制限を指定します。以前に追加されたhaving制限があれば置き換えます。
    
    パラメータ:
    
    restriction - 単純な、もしくは複合したブール式
    
    戻り値:
    
    変更されたクエリー
  - having
```
AbstractQuery<T> having(Predicate... restrictions)
```
    指定された制限述語の結合に従ってクエリーのグループに対応する制限を指定します。以前に追加されたhaving制限があれば置き換えます。制限が指定されていない場合は以前に追加された制限は単純に削除されます。
    
    パラメータ:
    
    restrictions - 0個以上の制限の述語
    
    戻り値:
    
    変更されたクエリー
  - distinct
```
AbstractQuery<T> distinct(boolean distinct)
```
    重複するクエリーの結果を除去するかどうかを指定します。 trueの値は重複を排除します。falseの値を指定すると重複が保持されます。 distinctが指定されていない場合は重複した結果を保持する必要があります。
    
    パラメータ:
    
    distinct - クエリーの結果から重複結果を除去する必要があるかどうか、もしくは保持する必要があるかどうかを指定するブール値
    
    戻り値:
    
    変更されたクエリー
  - getRoots
```
java.util.Set<Root<?>> getRoots()
```
    クエリールートを返します。相関の結果として定義されたサブクエリールートを含むCriteriaQueryやSubquery自身で定義されたルートです。いかなるルートも定義されていない場合は空のSetが返されます。そのSetへの変更はクエリーには影響を与えません。
    
    戻り値:
    
    クエリールートのSet
  - getSelection
```
Selection<T> getSelection()
```
    クエリーのSelectionを返します。Selectionが設定されていない場合はnullを返します。
    
    戻り値:
    
    選択項目
  - getGroupList
```
java.util.List<Expression<?>> getGroupList()
```
    グループ化式のListを返します。グループ化式が指定されていない場合は空のListを返します。そのListへの変更はクエリーには影響を与えません。
    
    戻り値:
    
    グループ化式のList
  - getGroupRestriction
```
Predicate getGroupRestriction()
```
    グループ化項目に対応する制限に対応する述語を返します。制限が指定されていない場合はnullを返します。
    
    戻り値:
    
    having句述語
  - isDistinct
```
boolean isDistinct()
```
    重複するクエリーの結果を除去または保持する必要があるかどうかを戻します。
    
    戻り値:
    
    重複するクエリーの結果を削除する必要があるかどうかを示すブール値
  - getResultType
```
java.lang.Class<T> getResultType()
```
    クエリーもしくはサブクエリーの結果の型を返します。結果の型がcreateQueryもしくはsubqueryメソッドの引数として指定されている場合はその型が戻されます。クエリーがcreateTupleQueryメソッドで作られている場合は結果の型はTupleになります。そうでない場合はObjectです。
    
    戻り値:
    
    結果の型

インタフェース AbstractQuery<T>

メソッドのサマリー

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

メソッドの詳細

from

from

where

where

groupBy

groupBy

having

having

distinct

getRoots

getSelection

getGroupList

getGroupRestriction

isDistinct

getResultType