javax.persistence.criteria

インタフェース Path<X>

型パラメータ:

X - パスによって参照される型

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

Expression<X>, Selection<X>, TupleElement<X>

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

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

public interface Path<X>
extends Expression<X>

境界型やコレクションからの単純な、もしくは複合した属性のパスを表す"プリミティブ"な式です。

導入されたバージョン:

Java Persistence 2.0

メソッドのサマリー

修飾子とタイプ	メソッドと説明
<K,V,M extends java.util.Map<K,V>> Expression<M>	get(MapAttribute<X,K,V> map) 参照されたマップ値の属性に対応するパスを作ります。
<E,C extends java.util.Collection<E>> Expression<C>	get(PluralAttribute<X,C,E> collection) 参照されたコレクション値の属性に対応するパスを作ります。
<Y> Path<Y>	get(SingularAttribute<? super X,Y> attribute) 参照された単独の値を持つ属性に対応するパスを作ります。
<Y> Path<Y>	get(java.lang.String attributeName) 参照された属性に対応するパスを作ります。
Bindable<X>	getModel() パス式に対応する束縛可能なオブジェクトを返します。
Path<?>	getParentPath() パスの親"ノード"を返します。
Expression<java.lang.Class<? extends X>>	type() パスの型に対応する式を作ります。

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

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

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

alias, getCompoundSelectionItems, isCompoundSelection

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

getAlias, getJavaType

メソッドの詳細

getModel

Bindable<X> getModel()

パス式に対応する束縛可能なオブジェクトを返します。

戻り値:

パス式に対応する束縛可能なオブジェクト

getParentPath

Path<?> getParentPath()

パスの親"ノード"を返します。親が存在しない場合はnullです。

戻り値:

親

get

<Y> Path<Y> get(SingularAttribute<? super X,Y> attribute)

参照された単独の値を持つ属性に対応するパスを作ります。

パラメータ:

attribute - 単独の値持つ属性

戻り値:

参照された属性に対応するパス

get

<E,C extends java.util.Collection<E>> Expression<C> get(PluralAttribute<X,C,E> collection)

参照されたコレクション値の属性に対応するパスを作ります。

パラメータ:

collection - コレクション値の属性

戻り値:

参照された属性に対応するパス

get

<K,V,M extends java.util.Map<K,V>> Expression<M> get(MapAttribute<X,K,V> map)

参照されたマップ値の属性に対応するパスを作ります。

パラメータ:

map - マップ値の属性

戻り値:

参照された属性に対応するパス

type

Expression<java.lang.Class<? extends X>> type()

パスの型に対応する式を作ります。

戻り値:

パスの型に対応する式

get

<Y> Path<Y> get(java.lang.String attributeName)

参照された属性に対応するパスを作ります。

注意：文字列ベースのAPIを使用するアプリケーションではPath変数の使用を避けるために get操作の結果の型を指定する必要があります。

     良い例:

     CriteriaQuery<Person> q = cb.createQuery(Person.class);
     Root<Person> p = q.from(Person.class);
     q.select(p)
      .where(cb.isMember("joe",
                         p.<Set<String>>get("nicknames")));

     良くない例:
 
     CriteriaQuery<Person> q = cb.createQuery(Person.class);
     Root<Person> p = q.from(Person.class);
     Path<Set<String>> nicknames = p.get("nicknames");
     q.select(p)
      .where(cb.isMember("joe", nicknames));
  

パラメータ:

attributeName - 属性の名前

戻り値:

参照された属性に対応するパス

例外:

java.lang.IllegalStateException - 基本型に対応するパスで呼び出された場合

java.lang.IllegalArgumentException - 指定された名前の属性が存在しない場合