Cosminexus アプリケーションサーバ V8 リファレンス 定義編(サーバ定義)

[目次][索引][前へ][次へ]

6.3.10 その他の要素

<この項の構成>
(1) <description>
(2) <entity-listener>
(3) <pre-persist>,<post-persist>,<pre-remove>,<post-remove>,<pre-update>,<post-update>,<post-load>
(4) <unique-constraint>
(5) <column-name>
(6) <query>
(7) <hint>
(8) <entity-result>
(9) <field-result>
(10) <column-result>
(11) <attributes>
(12) <column>
(13) <generated-value>
(14) <temporal>
(15) <table-generator>
(16) <attribute-override>
(17) <lob>
(18) <enumerated>
(19) <join-column>
(20) <join-table>
(21) <inverse-join-column>
(22) <cascade>
(23) <cascade-all>
(24) <cascade-persist>
(25) <cascade-merge>
(26) <cascade-remove>
(27) <cascade-refresh>
(28) <order-by>
(29) <map-key>
(30) <primary-key-join-column>

(1) <description>

説明を付加します。

(2) <entity-listener>

エンティティリスナを指定します。

指定できる属性を次の表に示します。

表6-53 <entity-listener>の属性

属性名 任意/必須 説明
class xsd:string 必須 エンティティリスナのクラス名。

(3) <pre-persist>,<post-persist>,<pre-remove>,<post-remove>,<pre-update>,<post-update>,<post-load>

ライフサイクルコールバックメソッドを指定します。

機能および属性の詳細については,マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6 javax.persistenceパッケージ」を参照してください。

指定できる属性を次の表に示します。

表6-54 <pre-persist>,<post-persist>,<pre-remove>,<post-remove>,<pre-update>,<post-update>,<post-load>の属性

属性名 任意/必須 説明
method-name xsd:string 必須 対象のメソッド名。

(4) <unique-constraint>

DDLにユニーク制約を付加します。

機能および属性の詳細については,マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6 javax.persistenceパッケージ」を参照してください。

(5) <column-name>

ユニーク制約を付加するカラムの名前を指定します。

@UniqueConstraintのcolumnNames属性と対応しています。

機能および属性の詳細については,マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6 javax.persistenceパッケージ」を参照してください。

(6) <query>

クエリ文字列を指定します。

@NamedQueryのquery属性および@NamedNativeQueryのquery属性と対応しています。

機能および属性の詳細については,マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6 javax.persistenceパッケージ」を参照してください。

(7) <hint>

クエリにヒントを付加します。

@NamedQueryのhints属性および@NamedNativeQueryのhints属性と対応しています。

機能および属性の詳細については,マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6 javax.persistenceパッケージ」を参照してください。

指定できる属性を次の表に示します。

表6-55 <hint>の属性

属性名 任意/必須 説明
name xsd:string 必須 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.53 @QueryHint」のname属性を参照してください。
value xsd:string 必須 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.53 @QueryHint」のvalue属性を参照してください。

(8) <entity-result>

ネイティブSQLのクエリ結果をマッピングするためのEntityクラスを指定します。

@SqlResultSetMappingのentities属性と対応しています。

機能および属性の詳細については,マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6 javax.persistenceパッケージ」を参照してください。

指定できる属性を次の表に示します。

表6-56 <entity-result>の属性

属性名 任意/必須 説明
entity-class xsd:string 必須 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.15 @EntityResult」のentityClass属性を参照してください。
discriminator-column xsd:string 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.15 @EntityResult」のdiscriminatorColumn属性を参照してください。

(9) <field-result>

ネイティブSQLのクエリ結果をマッピングするためのフィールドを指定します。

@EntityResultのfields属性と対応しています。

機能および属性の詳細については,マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6 javax.persistenceパッケージ」を参照してください。

指定できる属性を次の表に示します。

表6-57 <field-result>の属性

属性名 任意/必須 説明
xsd:string name 必須 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.19 @FieldResult」のname属性を参照してください。
xsd:string column 必須 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.19 @FieldResult」のcolumn属性を参照してください。

(10) <column-result>

ネイティブSQLのクエリ結果をマッピングするためのカラムを指定します。

@SqlResultSetMappingのcolumns属性と対応しています。

機能および属性の詳細については,マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6 javax.persistenceパッケージ」を参照してください。

指定できる属性を次の表に示します。

表6-58 <column-result>の属性

属性名 任意/必須 説明
xsd:string name 必須 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.7 @ColumnResult」のname属性を参照してください。

(11) <attributes>

attributes要素自体の機能はありません。

(12) <column>

Persistentフィールドまたはプロパティに,カラムのマッピングを指定します。

機能および属性の詳細については,マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6 javax.persistenceパッケージ」を参照してください。

指定できる属性を次の表に示します。

表6-59 <column>の属性

属性名 任意/必須 説明
name xsd:string 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.6 @Column」のname属性を参照してください。
unique xsd:boolean 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.6 @Column」のunique属性を参照してください。
nullable xsd:boolean 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.6 @Column」のnullable属性を参照してください。
insertable xsd:boolean 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.6 @Column」のinsertable属性を参照してください。
updatable xsd:boolean 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.6 @Column」のupdatable属性を参照してください。
column-definition xsd:string 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.6 @Column」のcolumnDefinition属性を参照してください。
table xsd:string 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.6 @Column」のtable属性を参照してください。
length xsd:int 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.6 @Column」のlength属性を参照してください。
precision xsd:int 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.6 @Column」のprecision属性を参照してください。
scale xsd:int 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.6 @Column」のscale属性を参照してください。

(13) <generated-value>

プライマリキー値生成戦術を指定します。

機能および属性の詳細については,マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6 javax.persistenceパッケージ」を参照してください。

指定できる属性を次の表に示します。

表6-60 <generated-value>の属性

属性名 任意/必須 説明
strategy orm:generation-type 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.20 @GeneratedValue」のstrategy属性を参照してください。
generator xsd:string 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.20 @GeneratedValue」のgenerator属性を参照してください。

(14) <temporal>

DATE,TIME,TIMESTAMP型へマッピングを行うときに指定します。

機能および属性の詳細については,マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6 javax.persistenceパッケージ」を参照してください。

(15) <table-generator>

テーブルジェネレータを追加します。

機能および属性の詳細については,マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6 javax.persistenceパッケージ」を参照してください。

指定できる属性を次の表に示します。

表6-61 <table-generator>の属性

属性名 任意/必須 説明
name xsd:string 必須 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.60 @TableGenerator」のname属性を参照してください。
table xsd:string 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.60 @TableGenerator」のtable属性を参照してください。
catalog xsd:string 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.60 @TableGenerator」のcatalog属性を参照してください。
schema xsd:string 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.60 @TableGenerator」のschema属性を参照してください。
pk-column-name xsd:string 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.60 @TableGenerator」のpkColumnName属性を参照してください。
value-column-name xsd:string 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.60 @TableGenerator」のvalueColumnName属性を参照してください。
pk-column-value xsd:string 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.60 @TableGenerator」のpkColumnName属性を参照してください。
initial-value xsd:int 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.60 @TableGenerator」のinitialValue属性を参照してください。
allocation-size xsd:int 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.60 @TableGenerator」のallocationSize属性を参照してください。

(16) <attribute-override>

プロパティやフィールドのマッピングを上書きします。

機能および属性の詳細については,マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6 javax.persistenceパッケージ」を参照してください。

指定できる属性を次の表に示します。

表6-62 <attribute-override>の属性

属性名 任意/必須 説明
name xsd:string 必須 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.3 @AttributeOverride」のname属性を参照してください。

(17) <lob>

Lob型へマッピングを行うときに指定します。

機能および属性の詳細については,マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6 javax.persistenceパッケージ」を参照してください。

(18) <enumerated>

列挙型へマッピングを行うときに指定します。

機能および属性の詳細については,マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6 javax.persistenceパッケージ」を参照してください。

(19) <join-column>

テーブルを結合するために,所有者側エンティティに対応する結合表の外部キーカラムを指定します。

機能および属性の詳細については,マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6 javax.persistenceパッケージ」を参照してください。

指定できる属性を次の表に示します。

表6-63 <join-column>の属性

属性名 任意/必須 説明
name xsd:string 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.24 @JoinColumn」のname属性を参照してください。
referenced-column-name xsd:string 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.24 @JoinColumn」のreferencedColumnName属性を参照してください。
unique xsd:boolean 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.24 @JoinColumn」のunique属性を参照してください。
nullable xsd:boolean 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.24 @JoinColumn」のnullable属性を参照してください。
insertable xsd:boolean 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.24 @JoinColumn」のinsertable属性を参照してください。
updatable xsd:boolean 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.24 @JoinColumn」のupdatable属性を参照してください。
column-definition xsd:string 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.24 @JoinColumn」のcolumnDefinition属性を参照してください。
table xsd:string 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.24 @JoinColumn」のtable属性を参照してください。

(20) <join-table>

多対多(many-to-many)や片方向の一対多(one-to-many)で使用する結合表を指定します。

機能および属性の詳細については,マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6 javax.persistenceパッケージ」を参照してください。

指定できる属性を次の表に示します。

表6-64 <join-table>の属性

属性名 任意/必須 説明
name xsd:string 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.26 @JoinTable」のname属性を参照してください。
catalog xsd:string 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.26 @JoinTable」のcatalog属性を参照してください。
schema xsd:string 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.26 @JoinTable」のschema属性を参照してください。

(21) <inverse-join-column>

テーブルを結合するために,被所有者側エンティティに対応する結合表の外部キーカラムを指定します。

機能および属性の詳細については,マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6 javax.persistenceパッケージ」を参照してください。

指定できる属性を次の表に示します。

表6-65 <inverse-join-column>の属性

属性名 任意/必須 説明
name xsd:string 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.24 @JoinColumn」のname属性を参照してください。
referenced-column-name xsd:string 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.24 @JoinColumn」のreferencedColumnName属性を参照してください。
unique xsd:boolean 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.24 @JoinColumn」のunique属性を参照してください。
nullable xsd:boolean 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.24 @JoinColumn」のnullable属性を参照してください。
insertable xsd:boolean 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.24 @JoinColumn」のinsertable属性を参照してください。
updatable xsd:boolean 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.24 @JoinColumn」のupdatable属性を参照してください。
column-definition xsd:string 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.24 @JoinColumn」のcolumnDefinition属性を参照してください。
table xsd:string 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.24 @JoinColumn」のtable属性を参照してください。

(22) <cascade>

カスケードできる操作を指定します。

機能および属性の詳細については,マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6 javax.persistenceパッケージ」を参照してください。

(23) <cascade-all>

すべての操作をカスケードします。

(24) <cascade-persist>

persist操作をカスケードします。

(25) <cascade-merge>

merge操作をカスケードします。

(26) <cascade-remove>

remove操作をカスケードします。

(27) <cascade-refresh>

refresh操作をカスケードします。

(28) <order-by>

関連をコレクションに保持する際に付ける順序を指定します。

機能および属性の詳細については,マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6 javax.persistenceパッケージ」を参照してください。

(29) <map-key>

Map型の関連としてマップキーを指定します。

機能および属性の詳細については,マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6 javax.persistenceパッケージ」を参照してください。

指定できる属性を次の表に示します。

表6-66 <map-key>の属性

属性名 任意/必須 説明
name xsd:string 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.30 @MapKey」のname属性を参照してください。

(30) <primary-key-join-column>

ほかのテーブルにJOINする外部キーとして使われる,プライマリキーカラムを指定します。

機能および属性の詳細については,マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6 javax.persistenceパッケージ」を参照してください。

指定できる属性を次の表に示します。

表6-67 <primary-key-join-column>の属性

属性名 任意/必須 説明
name xsd:string 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.51 @PrimaryKeyJoinColumn」のname属性を参照してください。
referenced-column-name xsd:string 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.51 @PrimaryKeyJoinColumn」のreferencedColumnName属性を参照してください。
column-definition xsd:string 任意 マニュアル「Cosminexus アプリケーションサーバ リファレンス API編」の「2.6.51 @PrimaryKeyJoinColumn」のcolumnDefinition属性を参照してください。