Package javax.jdo.annotations
Annotation Type Element
Annotation for the element of a collection/array relation.
Corresponds to the xml element "element".
- Since:
- 2.1
- Version:
- 2.1
-
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionName of the column to store the element in.Column[]
The column(s) for the element.Delete action to apply to any foreign key for the element.Whether the element is dependent on the owner, and will be deleted when the owner is deleted.Whether this element is embedded.Embedded[]
The embedded mapping for the element.Vendor extensions.Name for a generated foreign key constraint.Generate or assume a foreign key constraint exists on the column or columns associated with this join.The name of the index to generate.Whether the value column(s) should be indexed.Name of the member in the target class that forms a bidirectional relationship with this member.Whether the element is to be stored serialized (into a join table)Name of the table for the element.Class[]
Types of the elements.Whether a unique constraint should be generated or assumed.The name of the unique key constraint to generate.Update action to apply to any foreign key for the element
-
Element Details
-
types
Class[] typesTypes of the elements. This can be determined if using JDK1.5 generics but is required otherwise. Multiple types can be specified if the implementation supports multiple types.- Returns:
- the types of elements
- Default:
{}
-
serialized
String serializedWhether the element is to be stored serialized (into a join table)- Returns:
- whether the element is to be stored serialized (into a join table)
- Default:
""
-
embedded
String embeddedWhether this element is embedded.- Returns:
- whether this element is embedded
- Default:
""
-
embeddedMapping
Embedded[] embeddedMappingThe embedded mapping for the element.- Returns:
- the embedded mapping for the element
- Default:
{}
-
dependent
String dependentWhether the element is dependent on the owner, and will be deleted when the owner is deleted.- Returns:
- whether the element is dependent on the owner, and will be deleted when the owner is deleted
- Default:
""
-
table
String tableName of the table for the element.- Returns:
- name of the table for the element
- Default:
""
-
column
String columnName of the column to store the element in.- Returns:
- name of the column to store the element in
- Default:
""
-
deleteAction
ForeignKeyAction deleteActionDelete action to apply to any foreign key for the element.- Returns:
- delete action to apply to any foreign key for the element
- Default:
UNSPECIFIED
-
updateAction
ForeignKeyAction updateActionUpdate action to apply to any foreign key for the element- Returns:
- update action to apply to any foreign key for the element
- Default:
UNSPECIFIED
-
indexed
String indexedWhether the value column(s) should be indexed.- Returns:
- whether the value column(s) should be indexed.
- Default:
""
-
index
String indexThe name of the index to generate.- Returns:
- the name of the index
- Default:
""
-
unique
String uniqueWhether a unique constraint should be generated or assumed.- Returns:
- whether a unique constraint should be generated or assumed
- Default:
""
-
uniqueKey
String uniqueKeyThe name of the unique key constraint to generate.- Returns:
- the name of the unique key constraint
- Default:
""
-
mappedBy
String mappedByName of the member in the target class that forms a bidirectional relationship with this member.- Returns:
- name of the member in the target class that forms a bidirectional relationship with this member
- Default:
""
-
columns
Column[] columnsThe column(s) for the element.- Returns:
- the column(s) for the element
- Default:
{}
-
generateForeignKey
String generateForeignKeyGenerate or assume a foreign key constraint exists on the column or columns associated with this join. Specify "true" or "false".- Returns:
- whether to generate or assume a primary key constraint
- Default:
""
-
foreignKey
String foreignKeyName for a generated foreign key constraint.- Returns:
- the name of the generated foreign key constraint
- Default:
""
-
extensions
Extension[] extensionsVendor extensions.- Returns:
- the vendor extensions
- Default:
{}
-