javax.persistence

インタフェース TypedQuery<X>

型パラメータ:

X - クエリーの結果の型

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

Query

public interface TypedQuery<X>
extends Query

型付きクエリーの実行を制御するためのインタフェースです。

導入されたバージョン:

Java Persistence 2.0

関連項目:

Query, Parameter

メソッドのサマリー

修飾子とタイプ	メソッドと説明
java.util.List<X>	getResultList() SELECTクエリーを実行し、問合せ結果を型付きリストとして返します。
default java.util.stream.Stream<X>	getResultStream() SELECTクエリーを実行し、問合せ結果を型付きjava.util.stream.Streamとして戻します。
X	getSingleResult() 一つの結果を返すSELECTクエリーを実行します。
TypedQuery<X>	setFirstResult(int startPosition) 検索結果の最初のポジションを設定します。
TypedQuery<X>	setFlushMode(FlushModeType flushMode) クエリーの実行に使用されるフラッシュモードタイプを設定します。
TypedQuery<X>	setHint(java.lang.String hintName, java.lang.Object value) クエリーのプロパティもしくはヒントを設定します。
TypedQuery<X>	setLockMode(LockModeType lockMode) クエリーの実行に使用されるロックモードタイプを設定します。
TypedQuery<X>	setMaxResults(int maxResult) 検索結果の最大件数を設定します。
TypedQuery<X>	setParameter(int position, java.util.Calendar value, TemporalType temporalType) 位置指定のパラメーターにjava.util.Calendarの値をバインドします。
TypedQuery<X>	setParameter(int position, java.util.Date value, TemporalType temporalType) 位置指定のパラメーターにjava.util.Dateの値をバインドします。
TypedQuery<X>	setParameter(int position, java.lang.Object value) 位置指定のパラメーターに引数の値をバインドします。
TypedQuery<X>	setParameter(Parameter<java.util.Calendar> param, java.util.Calendar value, TemporalType temporalType) java.util.CalendarのインスタンスをParameterオブジェクトにバインドします。
TypedQuery<X>	setParameter(Parameter<java.util.Date> param, java.util.Date value, TemporalType temporalType) java.util.DateのインスタンスをParameterオブジェクトにバインドします。
<T> TypedQuery<X>	setParameter(Parameter<T> param, T value) Parameterオブジェクトの値をバインドします。
TypedQuery<X>	setParameter(java.lang.String name, java.util.Calendar value, TemporalType temporalType) java.util.Calendarのインスタンスを名前付きパラメーターにバインドします。
TypedQuery<X>	setParameter(java.lang.String name, java.util.Date value, TemporalType temporalType) java.util.Dateのインスタンスを名前付きパラメーターにバインドします。
TypedQuery<X>	setParameter(java.lang.String name, java.lang.Object value) 引数の値を名前付きパラメーターにバインドします。

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

executeUpdate, getFirstResult, getFlushMode, getHints, getLockMode, getMaxResults, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, isBound, unwrap

メソッドの詳細

getResultList

java.util.List<X> getResultList()

SELECTクエリーを実行し、問合せ結果を型付きリストとして返します。

定義:

getResultList インタフェース内 Query

戻り値:

結果のリスト

例外:

java.lang.IllegalStateException - Java Persistenceクエリー言語のUPDATEまたはDELETE文で呼び出された場合

QueryTimeoutException - クエリーの実行がクエリーの設定されたタイムアウト値を超え、そのステートメントだけがロールバックされる場合

TransactionRequiredException - NONE以外のロックモードが設定されトランザクションが存在しない場合、 または永続化コンテキストがトランザクションに参加していない場合

PessimisticLockException - 悲観ロックに失敗し、トランザクションがロールバックされる場合

LockTimeoutException - 悲観ロックに失敗し、そのステートメントのみロールバックされる場合

PersistenceException - クエリーの実行がクエリーの設定されたタイムアウト値を超え、トランザクションがロールバックされる場合

getResultStream

default java.util.stream.Stream<X> getResultStream()

SELECTクエリーを実行し、問合せ結果を型付きjava.util.stream.Streamとして戻します。 デフォルトでは、このメソッドはgetResultList().stream()に委譲しますが、 永続化プロバイダはこのメソッドをオーバーライドして追加の機能を提供することもできます。

定義:

getResultStream インタフェース内 Query

戻り値:

結果のストリーム

例外:

java.lang.IllegalStateException - Java Persistenceクエリー言語のUPDATEまたはDELETE文で呼び出された場合

QueryTimeoutException - クエリーの実行がクエリーの設定されたタイムアウト値を超え、そのステートメントだけがロールバックされる場合

TransactionRequiredException - NONE以外のロックモードが設定されトランザクションが存在しない場合、 または永続化コンテキストがトランザクションに参加していない場合

PessimisticLockException - 悲観ロックに失敗し、トランザクションがロールバックされる場合

LockTimeoutException - 悲観ロックに失敗し、そのステートメントのみロールバックされる場合

PersistenceException - クエリーの実行がクエリーの設定されたタイムアウト値を超え、トランザクションがロールバックされる場合

導入されたバージョン:

2.2

関連項目:

Stream, getResultList()

getSingleResult

X getSingleResult()

一つの結果を返すSELECTクエリーを実行します。

定義:

getSingleResult インタフェース内 Query

戻り値:

結果

例外:

NoResultException - 結果がなかった場合

NonUniqueResultException - 2つ以上の結果があった場合

java.lang.IllegalStateException - Java Persistenceクエリー言語のUPDATEまたはDELETE文で呼び出された場合

QueryTimeoutException - クエリーの実行がクエリーの設定されたタイムアウト値を超え、そのステートメントだけがロールバックされる場合

TransactionRequiredException - NONE以外のロックモードが設定されトランザクションが存在しない場合、 または永続化コンテキストがトランザクションに参加していない場合

PessimisticLockException - 悲観ロックに失敗し、トランザクションがロールバックされる場合

LockTimeoutException - 悲観ロックに失敗し、そのステートメントのみロールバックされる場合

PersistenceException - クエリーの実行がクエリーの設定されたタイムアウト値を超え、トランザクションがロールバックされる場合

setMaxResults

TypedQuery<X> setMaxResults(int maxResult)

検索結果の最大件数を設定します。

定義:

setMaxResults インタフェース内 Query

パラメータ:

maxResult - 検索結果の最大件数

戻り値:

同じクエリーのインスタンス

例外:

java.lang.IllegalArgumentException - 引数が負数だった場合

setFirstResult

TypedQuery<X> setFirstResult(int startPosition)

検索結果の最初のポジションを設定します。

定義:

setFirstResult インタフェース内 Query

パラメータ:

startPosition - 検索結果の0から始まる最初のポジション

戻り値:

同じクエリーのインスタンス

例外:

java.lang.IllegalArgumentException - 引数が負数だった場合

setHint

TypedQuery<X> setHint(java.lang.String hintName,
                      java.lang.Object value)

クエリーのプロパティもしくはヒントを設定します。 ヒント要素はクエリーのプロパティとヒントを指定するために使用できます。 この仕様で定義されているプロパティはプロバイダによって監視されなければなりません。 プロバイダによって認識されないベンダー固有のヒントは、暗黙のうちに無視されなければなりません。 ポータブルアプリケーションは標準のタイムアウトのヒントに頼るべきではありません。 使用されているデータベースおよびプロバイダが使用しているロックメカニズムによっては、このヒントが監視されるかどうかはわかりません。

定義:

setHint インタフェース内 Query

パラメータ:

hintName - プロパティもしくはヒントの名前

value - プロパティもしくはヒントのための値

戻り値:

同じクエリーのインスタンス

例外:

java.lang.IllegalArgumentException - 二つ目の引数が実装に適合しない場合

setParameter

<T> TypedQuery<X> setParameter(Parameter<T> param,
                               T value)

Parameterオブジェクトの値をバインドします。

定義:

setParameter インタフェース内 Query

パラメータ:

param - パラメーターオブジェクト

value - パラメーターの値

戻り値:

同じクエリーのインスタンス

例外:

java.lang.IllegalArgumentException - パラメーターがクエリーのパラメーターに対応しない場合

setParameter

TypedQuery<X> setParameter(Parameter<java.util.Calendar> param,
                           java.util.Calendar value,
                           TemporalType temporalType)

java.util.CalendarのインスタンスをParameterオブジェクトにバインドします。

定義:

setParameter インタフェース内 Query

パラメータ:

param - パラメーターオブジェクト

value - パラメーターの値

temporalType - 時制の型

戻り値:

同じクエリーのインスタンス

例外:

java.lang.IllegalArgumentException - パラメーターがクエリーのパラメーターに対応しない場合

setParameter

TypedQuery<X> setParameter(Parameter<java.util.Date> param,
                           java.util.Date value,
                           TemporalType temporalType)

java.util.DateのインスタンスをParameterオブジェクトにバインドします。

定義:

setParameter インタフェース内 Query

パラメータ:

param - パラメーターオブジェクト

value - パラメーターの値

temporalType - 時制の型

戻り値:

同じクエリーのインスタンス

例外:

java.lang.IllegalArgumentException - パラメーターがクエリーのパラメーターに対応しない場合

setParameter

TypedQuery<X> setParameter(java.lang.String name,
                           java.lang.Object value)

引数の値を名前付きパラメーターにバインドします。

定義:

setParameter インタフェース内 Query

パラメータ:

name - パラメーターの名前

value - パラメーターの値

戻り値:

同じクエリーのインスタンス

例外:

java.lang.IllegalArgumentException - パラメーター名がクエリーのパラメーターに対応しない場合、もしくは引数が不正な型の場合

setParameter

TypedQuery<X> setParameter(java.lang.String name,
                           java.util.Calendar value,
                           TemporalType temporalType)

java.util.Calendarのインスタンスを名前付きパラメーターにバインドします。

定義:

setParameter インタフェース内 Query

パラメータ:

name - パラメーターの名前

value - パラメーターの値

temporalType - 時制の型

戻り値:

同じクエリーのインスタンス

例外:

java.lang.IllegalArgumentException - パラメーター名がクエリーのパラメーターに対応しない場合、もしくは引数が不正な型の場合

setParameter

TypedQuery<X> setParameter(java.lang.String name,
                           java.util.Date value,
                           TemporalType temporalType)

java.util.Dateのインスタンスを名前付きパラメーターにバインドします。

定義:

setParameter インタフェース内 Query

パラメータ:

name - パラメーターの名前

value - パラメーターの値

temporalType - 時制の型

戻り値:

同じクエリーのインスタンス

例外:

java.lang.IllegalArgumentException - パラメーター名がクエリーのパラメーターに対応しない場合、もしくは引数が不正な型の場合

setParameter

TypedQuery<X> setParameter(int position,
                           java.lang.Object value)

位置指定のパラメーターに引数の値をバインドします。

定義:

setParameter インタフェース内 Query

パラメータ:

position - 位置

value - パラメーターの値

戻り値:

同じクエリーのインスタンス

例外:

java.lang.IllegalArgumentException - positionがクエリーの位置指定のパラメーターに対応しない場合、もしくは引数が不正な型の場合

setParameter

TypedQuery<X> setParameter(int position,
                           java.util.Calendar value,
                           TemporalType temporalType)

位置指定のパラメーターにjava.util.Calendarの値をバインドします。

定義:

setParameter インタフェース内 Query

パラメータ:

position - 位置

value - パラメーターの値

temporalType - 時制の型

戻り値:

同じクエリーのインスタンス

例外:

java.lang.IllegalArgumentException - positionがクエリーの位置指定のパラメーターに対応しない場合、もしくは引数が不正な型の場合

setParameter

TypedQuery<X> setParameter(int position,
                           java.util.Date value,
                           TemporalType temporalType)

位置指定のパラメーターにjava.util.Dateの値をバインドします。

定義:

setParameter インタフェース内 Query

パラメータ:

position - 位置

value - パラメーターの値

temporalType - 時制の型

戻り値:

同じクエリーのインスタンス

例外:

java.lang.IllegalArgumentException - positionがクエリーの位置指定のパラメーターに対応しない場合、もしくは引数が不正な型の場合

setFlushMode

TypedQuery<X> setFlushMode(FlushModeType flushMode)

クエリーの実行に使用されるフラッシュモードタイプを設定します。 フラッシュモードタイプはエンティティマネージャーで使用中のフラッシュモードタイプと関係なくクエリーに適用されます。

定義:

setFlushMode インタフェース内 Query

パラメータ:

flushMode - フラッシュモード

戻り値:

同じクエリーのインスタンス

setLockMode

TypedQuery<X> setLockMode(LockModeType lockMode)

クエリーの実行に使用されるロックモードタイプを設定します。

定義:

setLockMode インタフェース内 Query

パラメータ:

lockMode - ロックモード

戻り値:

同じクエリーのインスタンス

例外:

java.lang.IllegalStateException - クエリーがJava Persistenceクエリー言語のSELECTクエリーかCriteriaQueryクエリーでないと判明した場合