Package javax.jdo.annotations
Annotation Type Value
-
@Target({ANNOTATION_TYPE,FIELD,METHOD}) @Retention(RUNTIME) public @interface 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 Elements Modifier and Type Optional Element Description String
column
Name of the column to store the value in.Column[]
columns
The column(s) for the value.Class<? extends AttributeConverter>
converter
OptionalAttributeConverter
to use for converting this value.ForeignKeyAction
deleteAction
Delete action to apply to any foreign key for the value.String
dependent
Whether the value is dependent on the owner (and will be deleted when the owner is deleted).String
embedded
Whether this value is embedded.Embedded[]
embeddedMapping
The embedded mapping for the value.Extension[]
extensions
Vendor extensions.String
foreignKey
Name for a generated foreign key constraint.String
generateForeignKey
Generate or assume a foreign key constraint exists on the column or columns associated with this join.String
index
The name of the index to generate.String
indexed
Whether the value column(s) should be indexed.String
mappedBy
Name of a member in the key class where this value is stored.String
serialized
Whether the value is to be stored serialized (into a single column of a join table).String
table
Name of the table for the value.Class[]
types
Types of the values.String
unique
Whether the element column(s) contents should be considered uniqueString
uniqueKey
The name of the unique key constraint to generate.ForeignKeyAction
updateAction
Update action to apply to any foreign key for the value.boolean
useDefaultConversion
Whether we should disable any converter that was specified as default for this type on the PMF.
-
-
-
Element Detail
-
types
Class[] types
Types 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 serialized
Whether 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 embedded
Whether this value is embedded.- Returns:
- whether this value is embedded
- Default:
- ""
-
-
-
embeddedMapping
Embedded[] embeddedMapping
The embedded mapping for the value.- Returns:
- the embedded mapping for the value
- Default:
- {}
-
-
-
dependent
String dependent
Whether 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 table
Name of the table for the value.- Returns:
- the name of the table for the value
- Default:
- ""
-
-
-
column
String column
Name of the column to store the value in.- Returns:
- the name of the column to store the value in
- Default:
- ""
-
-
-
deleteAction
ForeignKeyAction deleteAction
Delete action to apply to any foreign key for the value.- Returns:
- delete action to apply to any foreign key for the value
- Default:
- javax.jdo.annotations.ForeignKeyAction.UNSPECIFIED
-
-
-
updateAction
ForeignKeyAction updateAction
Update action to apply to any foreign key for the value.- Returns:
- update action to apply to any foreign key for the value
- Default:
- javax.jdo.annotations.ForeignKeyAction.UNSPECIFIED
-
-
-
indexed
String indexed
Whether the value column(s) should be indexed.- Returns:
- whether the value column(s) should be indexed.
- Default:
- ""
-
-
-
index
String index
The name of the index to generate.- Returns:
- the name of the index
- Default:
- ""
-
-
-
unique
String unique
Whether the element column(s) contents should be considered unique- Returns:
- whether the element column(s) contents should be considered unique
- Default:
- ""
-
-
-
uniqueKey
String uniqueKey
The name of the unique key constraint to generate.- Returns:
- the name of the unique key constraint
- Default:
- ""
-
-
-
mappedBy
String mappedBy
Name 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[] columns
The column(s) for the value.- Returns:
- the column(s) for the value
- Default:
- {}
-
-
-
generateForeignKey
String generateForeignKey
Generate 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 foreignKey
Name for a generated foreign key constraint.- Returns:
- the name of the generated foreign key constraint
- Default:
- ""
-
-
-
converter
Class<? extends AttributeConverter> converter
OptionalAttributeConverter
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 useDefaultConversion
Whether 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[] extensions
Vendor extensions.- Returns:
- the vendor extensions
- Default:
- {}
-
-