javax.persistence.criteria

インタフェース From<Z,X>

型パラメータ:

Z - ソースの型

X - ターゲットの型

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

Expression<X>, FetchParent<Z,X>, Path<X>, Selection<X>, TupleElement<X>

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

CollectionJoin<Z,E>, Join<Z,X>, ListJoin<Z,E>, MapJoin<Z,K,V>, PluralJoin<Z,C,E>, Root<X>, SetJoin<Z,E>

public interface From<Z,X>
extends Path<X>, FetchParent<Z,X>

境界型を現します。通常、from句に表されるエンティティですが、from句のエンティティに属する組み込み型の可能性もあります。

関連や組み込み、型に属するコレクションの結合のファクトリー及びに型に属する属性へのパスとして機能します。

導入されたバージョン:

Java Persistence 2.0

メソッドのサマリー

修飾子とタイプ	メソッドと説明
From<Z,X>	getCorrelationParent() (Subquery correlateメソッドを使用して)相関の結果として取得された相関したFromオブジェクトから親のFromオブジェクトを返します。
java.util.Set<Join<X,?>>	getJoins() この境界型から作られた結合を返します。
boolean	isCorrelated() このFromオブジェクトが(Subquery correlateメソッドを使用して)相関の結果として取得されたかどうか。
<Y> CollectionJoin<X,Y>	join(CollectionAttribute<? super X,Y> collection) 指定されたCollectionの値の属性への内部結合を作成します。
<Y> CollectionJoin<X,Y>	join(CollectionAttribute<? super X,Y> collection, JoinType jt) 指定されたCollectionの値の属性への与えられた結合の型を使用した結合を作成します。
<Y> ListJoin<X,Y>	join(ListAttribute<? super X,Y> list) 指定されたListの値の属性への内部結合を作成します。
<Y> ListJoin<X,Y>	join(ListAttribute<? super X,Y> list, JoinType jt) 指定されたListの値の属性への与えられた結合の型を使用した結合を作成します。
<K,V> MapJoin<X,K,V>	join(MapAttribute<? super X,K,V> map) 指定されたMapの値の属性への内部結合を作成します。
<K,V> MapJoin<X,K,V>	join(MapAttribute<? super X,K,V> map, JoinType jt) 指定されたMapの値の属性への与えられた結合の型を使用した結合を作成します。
<Y> SetJoin<X,Y>	join(SetAttribute<? super X,Y> set) 指定されたSetの値の属性への内部結合を作成します。
<Y> SetJoin<X,Y>	join(SetAttribute<? super X,Y> set, JoinType jt) 指定されたSetの値の属性への与えられた結合の型を使用した結合を作成します。
<Y> Join<X,Y>	join(SingularAttribute<? super X,Y> attribute) 指定された単一の値の属性への内部結合を作成します。
<Y> Join<X,Y>	join(SingularAttribute<? super X,Y> attribute, JoinType jt) 指定された単一の値の属性への与えられた結合の型を使用した結合を作成します。
<X,Y> Join<X,Y>	join(java.lang.String attributeName) 指定された属性への内部結合を作成します。
<X,Y> Join<X,Y>	join(java.lang.String attributeName, JoinType jt) 指定された属性への与えられた結合の型を使用した結合を作成します。
<X,Y> CollectionJoin<X,Y>	joinCollection(java.lang.String attributeName) 指定されたCollectionの値の属性への内部結合を作成します。
<X,Y> CollectionJoin<X,Y>	joinCollection(java.lang.String attributeName, JoinType jt) 指定されたCollectionの値の属性への与えられた結合の型を使用した結合を作成します。
<X,Y> ListJoin<X,Y>	joinList(java.lang.String attributeName) 指定されたListの値の属性への内部結合を作成します。
<X,Y> ListJoin<X,Y>	joinList(java.lang.String attributeName, JoinType jt) 指定されたListの値の属性への与えられた結合の型を使用した結合を作成します。
<X,K,V> MapJoin<X,K,V>	joinMap(java.lang.String attributeName) 指定されたMapの値の属性への内部結合を作成します。
<X,K,V> MapJoin<X,K,V>	joinMap(java.lang.String attributeName, JoinType jt) 指定されたMapの値の属性への与えられた結合の型を使用した結合を作成します。
<X,Y> SetJoin<X,Y>	joinSet(java.lang.String attributeName) 指定されたSetの値の属性への内部結合を作成します。
<X,Y> SetJoin<X,Y>	joinSet(java.lang.String attributeName, JoinType jt) 指定されたSetの値の属性への与えられた結合の型を使用した結合を作成します。

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

get, get, get, get, getModel, getParentPath, type

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

as, in, in, in, in, isNotNull, isNull

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

alias, getCompoundSelectionItems, isCompoundSelection

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

getAlias, getJavaType

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

fetch, fetch, fetch, fetch, fetch, fetch, getFetches

メソッドの詳細

getJoins

java.util.Set<Join<X,?>> getJoins()

この境界型から作られた結合を返します。 この境界型から結合が作られていない場合は空のセットを返します。 返されたセットへの変更はクエリーには影響を与えません。

戻り値:

この型から作られた結合

isCorrelated

boolean isCorrelated()

このFromオブジェクトが(Subquery correlateメソッドを使用して)相関の結果として取得されたかどうか。

戻り値:

このオブジェクトが相関によって取得されたかを示すブール値

getCorrelationParent

From<Z,X> getCorrelationParent()

(Subquery correlateメソッドを使用して)相関の結果として取得された相関したFromオブジェクトから親のFromオブジェクトを返します。

戻り値:

相関したFromオブジェクトの親

例外:

java.lang.IllegalStateException - このFromオブジェクトが相関によって取得されていない場合

join

<Y> Join<X,Y> join(SingularAttribute<? super X,Y> attribute)

指定された単一の値の属性への内部結合を作成します。

パラメータ:

attribute - 結合のターゲット

戻り値:

結果の結合

join

<Y> Join<X,Y> join(SingularAttribute<? super X,Y> attribute,
                   JoinType jt)

指定された単一の値の属性への与えられた結合の型を使用した結合を作成します。

パラメータ:

attribute - 結合のターゲット

jt - 結合の型

戻り値:

結果の結合

join

<Y> CollectionJoin<X,Y> join(CollectionAttribute<? super X,Y> collection)

指定されたCollectionの値の属性への内部結合を作成します。

パラメータ:

collection - 結合のターゲット

戻り値:

結果の結合

join

<Y> SetJoin<X,Y> join(SetAttribute<? super X,Y> set)

指定されたSetの値の属性への内部結合を作成します。

パラメータ:

set - 結合のターゲット

戻り値:

結果の結合

join

<Y> ListJoin<X,Y> join(ListAttribute<? super X,Y> list)

指定されたListの値の属性への内部結合を作成します。

パラメータ:

list - 結合のターゲット

戻り値:

結果の結合

join

<K,V> MapJoin<X,K,V> join(MapAttribute<? super X,K,V> map)

指定されたMapの値の属性への内部結合を作成します。

パラメータ:

map - 結合のターゲット

戻り値:

結果の結合

join

<Y> CollectionJoin<X,Y> join(CollectionAttribute<? super X,Y> collection,
                             JoinType jt)

指定されたCollectionの値の属性への与えられた結合の型を使用した結合を作成します。

パラメータ:

collection - 結合のターゲット

jt - 結合の型

戻り値:

結果の結合

join

<Y> SetJoin<X,Y> join(SetAttribute<? super X,Y> set,
                      JoinType jt)

指定されたSetの値の属性への与えられた結合の型を使用した結合を作成します。

パラメータ:

set - 結合のターゲット

jt - 結合の型

戻り値:

結果の結合

join

<Y> ListJoin<X,Y> join(ListAttribute<? super X,Y> list,
                       JoinType jt)

指定されたListの値の属性への与えられた結合の型を使用した結合を作成します。

パラメータ:

list - 結合のターゲット

jt - 結合の型

戻り値:

結果の結合

join

<K,V> MapJoin<X,K,V> join(MapAttribute<? super X,K,V> map,
                          JoinType jt)

指定されたMapの値の属性への与えられた結合の型を使用した結合を作成します。

パラメータ:

map - 結合のターゲット

jt - 結合の型

戻り値:

結果の結合

join

<X,Y> Join<X,Y> join(java.lang.String attributeName)

指定された属性への内部結合を作成します。

パラメータ:

attributeName - 結合のターゲットの属性の名前

戻り値:

結果の結合

例外:

java.lang.IllegalArgumentException - 与えられた名前の属性が存在しない場合

joinCollection

<X,Y> CollectionJoin<X,Y> joinCollection(java.lang.String attributeName)

指定されたCollectionの値の属性への内部結合を作成します。

パラメータ:

attributeName - 結合のターゲットの属性の名前

戻り値:

結果の結合

例外:

java.lang.IllegalArgumentException - 与えられた名前の属性が存在しない場合

joinSet

<X,Y> SetJoin<X,Y> joinSet(java.lang.String attributeName)

指定されたSetの値の属性への内部結合を作成します。

パラメータ:

attributeName - 結合のターゲットの属性の名前

戻り値:

結果の結合

例外:

java.lang.IllegalArgumentException - 与えられた名前の属性が存在しない場合

joinList

<X,Y> ListJoin<X,Y> joinList(java.lang.String attributeName)

指定されたListの値の属性への内部結合を作成します。

パラメータ:

attributeName - 結合のターゲットの属性の名前

戻り値:

結果の結合

例外:

java.lang.IllegalArgumentException - 与えられた名前の属性が存在しない場合

joinMap

<X,K,V> MapJoin<X,K,V> joinMap(java.lang.String attributeName)

指定されたMapの値の属性への内部結合を作成します。

パラメータ:

attributeName - 結合のターゲットの属性の名前

戻り値:

結果の結合

例外:

java.lang.IllegalArgumentException - 与えられた名前の属性が存在しない場合

join

<X,Y> Join<X,Y> join(java.lang.String attributeName,
                     JoinType jt)

指定された属性への与えられた結合の型を使用した結合を作成します。

パラメータ:

attributeName - 結合のターゲットの属性の名前

jt - 結合の型

戻り値:

結果の結合

例外:

java.lang.IllegalArgumentException - 与えられた名前の属性が存在しない場合

joinCollection

<X,Y> CollectionJoin<X,Y> joinCollection(java.lang.String attributeName,
                                         JoinType jt)

指定されたCollectionの値の属性への与えられた結合の型を使用した結合を作成します。

パラメータ:

attributeName - 結合のターゲットの属性の名前

jt - 結合の型

戻り値:

結果の結合

例外:

java.lang.IllegalArgumentException - 与えられた名前の属性が存在しない場合

joinSet

<X,Y> SetJoin<X,Y> joinSet(java.lang.String attributeName,
                           JoinType jt)

指定されたSetの値の属性への与えられた結合の型を使用した結合を作成します。

パラメータ:

attributeName - 結合のターゲットの属性の名前

jt - 結合の型

戻り値:

結果の結合

例外:

java.lang.IllegalArgumentException - 与えられた名前の属性が存在しない場合

joinList

<X,Y> ListJoin<X,Y> joinList(java.lang.String attributeName,
                             JoinType jt)

指定されたListの値の属性への与えられた結合の型を使用した結合を作成します。

パラメータ:

attributeName - 結合のターゲットの属性の名前

jt - 結合の型

戻り値:

結果の結合

例外:

java.lang.IllegalArgumentException - 与えられた名前の属性が存在しない場合

joinMap

<X,K,V> MapJoin<X,K,V> joinMap(java.lang.String attributeName,
                               JoinType jt)

指定されたMapの値の属性への与えられた結合の型を使用した結合を作成します。

パラメータ:

attributeName - 結合のターゲットの属性の名前

jt - 結合のターゲット

戻り値:

結果の結合

例外:

java.lang.IllegalArgumentException - 与えられた名前の属性が存在しない場合