Representation of the Meta-Data for a field of a class.
Lifecycle state
An object of this type has 2 lifecycle states. The first is the raw constructed object which represents pure MetaData (maybe from a MetaData file). The second is a "populated" object which represents MetaData for a Field of a class with the metadata aligned to be appropriate for that Field.
Containers
Each field can represent a container. The container can be an array, a Collection or a Map. The field type must be of the correct type to represent these.
JPOX Management
Each field can be managed by JPOX or not. The class provides a method for identifying if a field is managed by JPOX (
isJdoField()). If a field is managed by JPOX, it will have a field "id" (within its class). In a class the field "id" will start at 0 (for the first field, in alphabetical order).
MetaData Element
The MetaData element represented here is as follows
<!ELEMENT field (extension*, (collection|map|array|(column*))?, join?, element?, key?, value?, fetch-group*, order?, embedded?, index?, unique?, foreign-key?, delete-action?, extension*)?> <!ATTLIST field name CDATA #REQUIRED> <!ATTLIST field persistence-modifier (persistent|transactional|none) #IMPLIED> <!ATTLIST field table CDATA #IMPLIED> <!ATTLIST field null-value (exception|default|none) 'none'> <!ATTLIST field default-fetch-group (true|false) #IMPLIED> <!ATTLIST field embedded (true|false) #IMPLIED> <!ATTLIST field serialized (true|false) #IMPLIED> <!ATTLIST field dependent (true|false) #IMPLIED> <!ATTLIST field indexed (true|false|unique) #IMPLIED> <!ATTLIST field unique (true|false) #IMPLIED> <!ATTLIST field load-fetch-group CDATA #IMPLIED> <!ATTLIST field recursion-depth CDATA #IMPLIED> <!ATTLIST field primary-key (true|false) 'false'> <!ATTLIST field mapped-by CDATA #IMPLIED> <!ATTLIST field value-strategy CDATA #IMPLIED> <!ATTLIST field delete-action (restrict|cascade|null|default|none) #IMPLIED> <!ATTLIST field sequence CDATA #IMPLIED> <!ATTLIST field field-type CDATA #IMPLIED>
@since 1.1
@version $Revision: 1.83 $