Package javax.jdo.annotations
Annotation Type Value
Annotation for the value of a map relation.
Corresponds to the xml element "value".
- Since:
- 2.1
- Version:
- 2.1
-
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionName of the column to store the value in.Column[]
The column(s) for the value.Class
<? extends AttributeConverter> OptionalAttributeConverter
to use for converting this value.Delete action to apply to any foreign key for the value.Whether the value is dependent on the owner (and will be deleted when the owner is deleted).Whether this value is embedded.Embedded[]
The embedded mapping for the value.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 a member in the key class where this value is stored.Whether the value is to be stored serialized (into a single column of a join table).Name of the table for the value.Class[]
Types of the values.Whether the element column(s) contents should be considered uniqueThe name of the unique key constraint to generate.Update action to apply to any foreign key for the value.boolean
Whether we should disable any converter that was specified as default for this type on the PMF.
-
Element Details
-
types
Class[] typesTypes of the values. 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 values
- Default:
{}
-
serialized
String serializedWhether the value is to be stored serialized (into a single column of a join table).- Returns:
- Whether the value is to be stored serialized (into a join table)
- Default:
""
-
embedded
String embeddedWhether this value is embedded.- Returns:
- whether this value is embedded
- Default:
""
-
embeddedMapping
Embedded[] embeddedMappingThe embedded mapping for the value.- Returns:
- the embedded mapping for the value
- Default:
{}
-
dependent
String dependentWhether the value is dependent on the owner (and will be deleted when the owner is deleted).- Returns:
- whether the value is dependent on the owner
- Default:
""
-
table
String tableName of the table for the value.- Returns:
- the name of the table for the value
- Default:
""
-
column
String columnName of the column to store the value in.- Returns:
- the name of the column to store the value in
- Default:
""
-
deleteAction
ForeignKeyAction deleteActionDelete action to apply to any foreign key for the value.- Returns:
- delete action to apply to any foreign key for the value
- Default:
UNSPECIFIED
-
updateAction
ForeignKeyAction updateActionUpdate action to apply to any foreign key for the value.- Returns:
- update action to apply to any foreign key for the value
- 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 the element column(s) contents should be considered unique- Returns:
- whether the element column(s) contents should be considered unique
- 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 a member in the key class where this value is stored.- Returns:
- the name of a member in the key class where this value is stored
- Default:
""
-
columns
Column[] columnsThe column(s) for the value.- Returns:
- the column(s) for the value
- 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 foreign key constraint
- Default:
""
-
foreignKey
String foreignKeyName for a generated foreign key constraint.- Returns:
- the name of the generated foreign key constraint
- Default:
""
-
converter
Class<? extends AttributeConverter> converterOptionalAttributeConverter
to use for converting this value.- Returns:
- Converter class for converting this value when not PersistenceCapable (or NullAttributeConverter when not specified).
- Default:
javax.jdo.AttributeConverter.UseDefault.class
-
useDefaultConversion
boolean useDefaultConversionWhether we should disable any converter that was specified as default for this type on the PMF. Only has any effect when this is explicitly set to true, when any AttributeConverter specified for this type either here or for the class or at the PMF will be ignored and will use the JDO implementation default handling.- Returns:
- Whether PMF attribute conversion is to be disabled.
- Default:
false
-
extensions
Extension[] extensionsVendor extensions.- Returns:
- the vendor extensions
- Default:
{}
-