javax.persistence

注釈型 NamedQuery

@Repeatable(value=NamedQueries.class)
 @Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface NamedQuery

JPQL(Java Persistence query language)の名前付きクエリーを静的に指定します。 クエリーの名前は永続化ユニット内で共有されます。

NamedQueryアノテーションはエンティティ(Entityの付いたクラス)やマップドスーパークラス(MappedSuperclassの付いたクラス)に適用できます。

以下はJPQLの名前付きクエリーの定義の例です。

    @NamedQuery(
            name="findAllCustomersWithName",
            query="SELECT c FROM Customer c WHERE c.name LIKE :custName"
    )
 

以下は名前付きクエリーの使用方法の例です。

    @PersistenceContext
    public EntityManager em;
    ...
    customers = em.createNamedQuery("findAllCustomersWithName")
            .setParameter("custName", "Smith")
            .getResultList();
 

導入されたバージョン:

Java Persistence 1.0

必須要素のサマリー

必須要素

修飾子とタイプ	必須要素と説明
java.lang.String	name (必須) クエリーオブジェクトを作成する EntityManagerのメソッドでクエリを参照するために使用される名前。
java.lang.String	query (必須) JPQLのクエリー文字列。

任意要素のサマリー

任意要素

修飾子とタイプ	任意要素と説明
QueryHint[]	hints (オプション) クエリープロパティとヒント。
LockModeType	lockMode (オプション) クエリー実行で使用されるロックモードタイプ。

要素の詳細

name

public abstract java.lang.String name

(必須) クエリーオブジェクトを作成する EntityManagerのメソッドでクエリを参照するために使用される名前。

query

public abstract java.lang.String query

(必須) JPQLのクエリー文字列。

lockMode

public abstract LockModeType lockMode

(オプション) クエリー実行で使用されるロックモードタイプ。 lockModeにLockModeType.NONE以外が指定されている場合、クエリーはトランザクション内で実行されなければならず、 永続化コンテキストはトランザクションに参加する必要があります。

導入されたバージョン:

Java Persistence 2.0

デフォルト:

javax.persistence.LockModeType.NONE

hints

public abstract QueryHint[] hints

(オプション) クエリープロパティとヒント。ベンダー固有のヒントを含めることができます。

デフォルト:

{}