org.jpox.annotations
Annotation Type ForeignKey

@Target(value={TYPE,FIELD,METHOD})
@Retention(value=RUNTIME)
public @interface ForeignKey

Annotation for a JDO foreign-key. Maps across to the JDO2 element "foreign-key".

Version:

$Revision: 1.1 $

Required Element Summary

java.lang.String	name Name of the foreign-key.
java.lang.String	table Table for the foreign-key.

Optional Element Summary

boolean	deferred Whether this foreign-key is deferred
ForeignKeyAction	deleteAction The delete action of this FK
java.lang.String	unique Whether this foreign-key is unique
ForeignKeyAction	updateAction The update action of this FK

Element Detail

name

public abstract java.lang.String name

Name of the foreign-key.

table

public abstract java.lang.String table

Table for the foreign-key.

deferred

public abstract boolean deferred

Whether this foreign-key is deferred

Default:

false

unique

public abstract java.lang.String unique

Whether this foreign-key is unique

Default:

""

deleteAction

public abstract ForeignKeyAction deleteAction

The delete action of this FK

Default:

RESTRICT

updateAction

public abstract ForeignKeyAction updateAction

The update action of this FK

Default:

RESTRICT