@NamedStoredFunctionQuery

@NamedStoredFunctionQueryを使用して、名前付き問合せとしてストアド・ファンクションをコールする問合せを定義します。

注釈要素

表2-39は、この注釈の要素を示しています。

表2-39 @NamedStoredFunctionQueryの注釈要素

注釈要素	説明	デフォルト
`functionName`	(必須)ストアド・ファンクションの名前
name	(必須)このストアド・ファンクション問合せを参照する一意の名前
`returnParamter`	(必須)ストアド・ファンクションの戻り値
`callByIndex`	(オプション)ストアド・ファンクションを索引で、または名前でコールすることを指定します。索引の場合、データベースのプロシージャと同じ順序でパラメータを定義する必要があります。名前の場合、プロシージャ・パラメータに名前を付けるデータベース・プラットフォーム・サポートを使用する必要があります。	false
`hints`	(オプション)問合せヒント
`parameters`	(オプション)ストアド・ファンクションのパラメータ
`resultSetMapping`	(オプション)SQLResultMappingの名前

使用方法

@NamedStoredFunctionQueryは、エンティティまたはMappedSuperclassに指定できます。

例

例2-71に、この注釈を使用する方法を示します。

例2-71 @NamedStoredFunctionQuery注釈の使用

@Entity
@Table(name="CMP3_ADDRESS")
 
@NamedStoredFunctionQuery(
  name="StoredFunction_In",
  functionName="StoredFunction_In",
  parameters={
    @StoredProcedureParameter(direction=IN, name="P_IN", queryParameter="P_IN", type=Long.class)
    },
  returnParameter=@StoredProcedureParameter(queryParameter="RETURN", type=Long.class)
  )
public class Address implements Serializable {
...
}

例2-72に、eclipselink-orm.xmlファイルの<named-stored-function-query>要素を使用する方法を示します。

例2-72 <named-stored-function-query> XMLの使用

<named-stored-function-query name="StoredFunction_In" procedure-name="StoredFunction_In">
    <parameter direction="IN" name="P_IN" query-parameter="P_IN" type="Long"/>
</named-stored-function-query>