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

361 words

javax.jdo.annotations.Join - JDO annotation

javax.jdo.annotations
Annotation Join

Target:
Classes and fields (including property get methods)
Annotation for the join of a relation. Corresponds to the xml element "join".
Since:
JDO 2.1
String column
Name of the column in the join table.
Name of the column in the join table.
Returns:
the name of the column in the join table
Default value:
""
Since:
JDO 2.1
Detail definition of the join column(s).
Detail definition of the join column(s). This is needed for more than one join column.
Returns:
the join columns
Default value:
{}
Since:
JDO 2.1
Delete action to be applied to any ForeignKey on this join.
Delete action to be applied to any ForeignKey on this join.
Returns:
the delete action
Default value:
javax.jdo.annotations.ForeignKeyAction.UNSPECIFIED
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
Generate or assume a primary key constraint exists on the column or columns associated with this join.
Generate or assume a primary 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 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 join column is indexed.
Whether the join column is indexed.
Returns:
whether the join column(s) is(are) indexed
Default value:
""
Since:
JDO 2.1
String outer
Whether to use an outer join.
Whether to use an outer join.
Returns:
whether to use an outer join
Default value:
""
Since:
JDO 2.1
String primaryKey
Name for a generated primary key constraint.
Name for a generated primary key constraint.
Returns:
the name of the generated primary key constraint
Default value:
""
Since:
JDO 2.1
String table
Table to join to (used when joining to secondary tables).
Table to join to (used when joining to secondary tables).
Returns:
the table
Default value:
""
Since:
JDO 2.1
String unique
Whether the join column is unique.
Whether the join column is unique.
Returns:
whether the join column(s) is(are) is 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

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.