org.jpox.annotations
Annotation Type Field

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

Annotation for defining the persistence of a field.

Version:

$Revision: 1.5 $

Optional Element Summary

java.lang.String	column Name of the column for storing this field.
Column[]	columns Column details where this field is stored.
java.lang.String	defaultFetchGroup Whether this field is in the default fetch group.
ForeignKeyAction	deleteAction Action for the foreign-key on a delete.
java.lang.String	dependent Whether related object(s) of this field are dependent and so deleted when this object is deleted.
java.lang.String	embedded Whether this field is embedded.
Extension[]	extensions Vendor extensions for this field.
java.lang.String	fieldType Type of the field.
java.lang.String	indexed Whether this field is indexed in the datastore.
java.lang.String	loadFetchGroup Whether to load the fetch group.
java.lang.String	mappedBy Name of the field in the fields class where this value is stored (bidir relations).
java.lang.String	nullValue Behaviour when inserting a null value.
FieldPersistenceModifier	persistenceModifier Modifier for this field.
boolean	primaryKey Whether this field is part of the PK of the class.
java.lang.String	recursionDepth Recursion depth for this field (when part of a fetch group).
java.lang.String	sequence Name of a sequence to use with particular value strategies.
java.lang.String	serialized Whether this field is serialised into a single column.
java.lang.String	table Name of the table storing this field (join table maybe).
java.lang.String	unique Whether this field is unique in the datastore.
IdGeneratorStrategy	valueStrategy Value strategy to use to populate this field (if any):

persistenceModifier

public abstract FieldPersistenceModifier persistenceModifier

Modifier for this field.

Default:

UNKNOWN

defaultFetchGroup

public abstract java.lang.String defaultFetchGroup

Whether this field is in the default fetch group.

Default:

""

nullValue

public abstract java.lang.String nullValue

Behaviour when inserting a null value.

Default:

""

embedded

public abstract java.lang.String embedded

Whether this field is embedded.

Default:

""

serialized

public abstract java.lang.String serialized

Whether this field is serialised into a single column.

Default:

""

dependent

public abstract java.lang.String dependent

Whether related object(s) of this field are dependent and so deleted when this object is deleted.

Default:

""

primaryKey

public abstract boolean primaryKey

Whether this field is part of the PK of the class.

Default:

false

valueStrategy

public abstract IdGeneratorStrategy valueStrategy

Value strategy to use to populate this field (if any):

Default:

UNKNOWN

sequence

public abstract java.lang.String sequence

Name of a sequence to use with particular value strategies.

Default:

""

mappedBy

public abstract java.lang.String mappedBy

Name of the field in the fields class where this value is stored (bidir relations).

Default:

""

table

public abstract java.lang.String table

Name of the table storing this field (join table maybe).

Default:

""

column

public abstract java.lang.String column

Name of the column for storing this field.

Default:

""

deleteAction

public abstract ForeignKeyAction deleteAction

Action for the foreign-key on a delete.

Default:

UNKNOWN

indexed

public abstract java.lang.String indexed

Whether this field is indexed in the datastore.

Default:

""

unique

public abstract java.lang.String unique

Whether this field is unique in the datastore.

Default:

""

recursionDepth

public abstract java.lang.String recursionDepth

Recursion depth for this field (when part of a fetch group).

Default:

""

loadFetchGroup

public abstract java.lang.String loadFetchGroup

Whether to load the fetch group.

Default:

""

fieldType

public abstract java.lang.String fieldType

Type of the field. Used when the field is a reference type and we want to be specific.

Default:

""

columns

public abstract Column[] columns

Column details where this field is stored.

Default:

{}

extensions

public abstract Extension[] extensions

Vendor extensions for this field.

Default:

{}