Note: This ORM/SQL annotation is silently ignored by ObjectDB

javax.jdo.annotations.Key - JDO annotation

javax.jdo.annotations
Annotation Key

Target:
Fields (including property get methods)
Annotation for the key of a map relation. Corresponds to the xml element "key".
Since:
JDO 2.1
String column
Name of the column to store the key in.
Name of the column to store the key in.
Returns:
name of the column to store the key in
Default value:
""
Since:
JDO 2.1
The column(s) for the key
The column(s) for the key
Returns:
the column(s) for the key
Default value:
{}
Since:
JDO 2.1
Delete action to apply to the foreign key for the key.
Delete action to apply to the foreign key for the key.
Returns:
delete action to apply to the foreign key for the key
Default value:
javax.jdo.annotations.ForeignKeyAction.UNSPECIFIED
Since:
JDO 2.1
String dependent
Whether the key is dependent on the owner (and will be deleted when the owner is deleted).
Whether the key is dependent on the owner (and will be deleted when the owner is deleted).
Returns:
whether the key is dependent on the owner
Default value:
""
Since:
JDO 2.1
String embedded
Whether this key is embedded.
Whether this key is embedded.
Returns:
whether this key is embedded
Default value:
""
Since:
JDO 2.1
The embedded mapping for the key.
The embedded mapping for the key.
Returns:
the embedded mapping for the key
Default value:
{}
Since:
JDO 2.1
Vendor extensions.
Vendor extensions.
Returns:
the vendor extensions
Default value:
{}
Since:
JDO 2.1
String foreignKey
Name for a generated foreign key constraint.
Name for a generated foreign key constraint.
Returns:
the name of the generated foreign key constraint
Default value:
""
Since:
JDO 2.1
Generate or assume a foreign key constraint exists on the column or columns associated with this join.
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 value:
""
Since:
JDO 2.1
String index
The name of the index to generate.
The name of the index to generate.
Returns:
the name of the index
Default value:
""
Since:
JDO 2.1
String indexed
Whether the value column(s) should be indexed.
Whether the value column(s) should be indexed.
Returns:
whether the value column(s) should be indexed.
Default value:
""
Since:
JDO 2.1
String mappedBy
Name of a member in the value class where this key is stored.
Name of a member in the value class where this key is stored.
Returns:
the name of a member in the value class where this key is stored
Default value:
""
Since:
JDO 2.1
String serialized
Whether the key is to be stored serialized (into a single column of a join table).
Whether the key is to be stored serialized (into a single column of a join table).
Returns:
whether the key is to be stored serialized
Default value:
""
Since:
JDO 2.1
String table
Name of the table for the key.
Name of the table for the key.
Returns:
name of the table for the key
Default value:
""
Since:
JDO 2.1
Class[] types
Types of the keys.
Types of the keys. 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 keys
Default value:
{}
Since:
JDO 2.1
String unique
Whether the element column(s) contents should be considered unique
Whether the element column(s) contents should be considered unique
Returns:
whether the element column(s) contents should be considered unique
Default value:
""
Since:
JDO 2.1
String uniqueKey
The name of the unique key constraint to generate.
The name of the unique key constraint to generate.
Returns:
the name of the unique key constraint
Default value:
""
Since:
JDO 2.1
Update action to apply to the foreign key for the key.
Update action to apply to the foreign key for the key.
Returns:
update action to apply to the foreign key for the key
Default value:
javax.jdo.annotations.ForeignKeyAction.UNSPECIFIED
Since:
JDO 2.1

This documentation page is derived (with some adjustments) from the JDO 2.2 API
and is available under the terms of the Apache License, v. 2.0.