| org.jpox.metadata |
|
Provides classes representing the MetaData for files, packages, classes, fields, containers, etc.
Structured to map to the JDO2 Meta-Data file structure, though also now maps to the JPA Meta-Data structure
approximately.
Key aspects of this package are
- MetaDataManager is the entry point into this package. A call is typically made to getMetaDataForClass
and the MetaDataManager will take care of finding the MetaData, parsing any files, and populating the MetaData.
- MetaDataMerger is responsible for merging annotations with metadata, and JDO MetaData with ORM MetaData
- FileMetaData is the top level of a metadata representation, represening the actual file. It will contain
metadata for a series of packages, etc. The components are laid out in a tree
- ClassMetaData is the most used class, and is the representation of the persistence of a class.
It contains a series of FieldMetaData/PropertyMetaDataobjects, representing the fields and properties
of the class.
The "data" classes have a lifecycle, being created, then populated, and finally initialised. When a file is read in
all classes are read and populated at that time.
|
| Java Source File Name | Type | Comment |
| AbstractClassMetaData.java | Class | Abstract representation of the MetaData of a class/interface.
Has a parent PackageMetaData that can contain the metadata for several classes/interfaces. |
| AbstractConstraintMetaData.java | Class | Abstract representation of an ORM constraint. |
| AbstractElementMetaData.java | Class | This element specifies the mapping for the element component of arrays and
collections.
If only one column is mapped, and no additional information is needed for the
column, then the column attribute can be used. |
| AbstractMemberMetaData.java | Class | Abstract representation of MetaData for a field/property of a class/interface.
The term "member" is used to represent either a field or a method(property). |
| ArrayMetaData.java | Class | Representation of the Meta-Data for an Array. |
| ClassMetaData.java | Class | Representation of the MetaData of a class. |
| ClassPersistenceModifier.java | Class | Definition of the options for persistence-modifier of a class. |
| CollectionMetaData.java | Class | Representation of the MetaData of a collection. |
| ColumnMetaData.java | Class | Representation of the Meta-Data for a column mapping of a field. |
| ColumnMetaDataContainer.java | Interface | Interface defining an object that contains Columns. |
| ContainerComponent.java | Class | Representation of the details of an object stored in a container. |
| ContainerMetaData.java | Class | Representation of the Meta-Data for a container.
This is subclasses by Array, Collection, and Map. |
| DefaultMetaDataFactory.java | Class | Default implementation of MetaDataFactory. |
| DiscriminatorMetaData.java | Class | Representation of a discriminator in an inheritance strategy. |
| DiscriminatorStrategy.java | Class | Representation of the values for discriminator "strategy". |
| ElementMetaData.java | Class | This element specifies the mapping for the element component of arrays and
collections.
If only one column is mapped, and no additional information is needed for the
column, then the column attribute can be used. |
| EmbeddedMetaData.java | Class | This element specifies the mapping for an embedded type. |
| EventListenerMetaData.java | Class | Listener for events, following the JPA1 model. |
| ExtensionMetaData.java | Class | Representation of the Meta-Data for an extension.
Takes the form of key and value. |
| FetchGroupMetaData.java | Class | A fetch group defines a particular loaded state for an object graph. |
| FetchPlanMetaData.java | Class | FetchPlan defined in MetaData. |
| FieldMetaData.java | Class | Representation of the Meta-Data for a field of a class.
Lifecycle state
An object of this type has 2 lifecycle states. |
| FieldPersistenceModifier.java | Class | Class defining the possibilities for persistence, in terms of the type of
persistence, and the types that are capable to be supported. |
| FileMetaData.java | Class | Representation of a Meta-Data file. |
| ForeignKeyAction.java | Class | Foreign keys represent a consistency constraint in the database that must be
maintained. |
| ForeignKeyMetaData.java | Class | Foreign keys in metadata serve two quite different purposes. |
| IdentityMetaData.java | Class | Meta-Data for the datastore-identity of a class. |
| IdentityStrategy.java | Class | Representation of the values for identity "strategy". |
| IdentityType.java | Class | Representation of the values for identity-type. |
| ImplementsMetaData.java | Class | The implements element declares a persistence-capable interface implemented by the
persistence-capable class that contains this element. |
| IndexedValue.java | Class | Representation of whether an item is indexed or not. |
| IndexMetaData.java | Class | For schema generation, it might be useful to specify that a column or columns
be indexed, and to provide the name of the index. |
| InheritanceMetaData.java | Class | Representation of the Meta-Data defining inherited classes. |
| InheritanceStrategy.java | Class | Representation of the values for inheritance "strategy". |
| InterfaceMetaData.java | Class | Representation of the MetaData of a "persistent-interface". |
| InvalidAnnotationException.java | Class | Exception thrown when an annotation has been specified that is invalid in the circumstances. |
| InvalidMetaDataException.java | Class | Representation of an exception thrown when an error occurs in Meta-Data definition. |
| InvalidPrimaryKeyException.java | Class | Exception thrown when a primary key class is found to be invalid for some reason. |
| JoinMetaData.java | Class | Secondary tables and join tables are mapped using a join condition that
associates a column or columns in the secondary or join table with a column
or columns in the primary table, typically the primary tables primary key
columns. |
| KeyMetaData.java | Class | This element specifies the mapping for the key component of maps. |
| MapMetaData.java | Class | Representation of the Meta-Data for a Map. |
| MetaData.java | Class | Base class for all MetaData.
MetaData Lifecycle
The states represent the lifecycle of a MetaData object. |
| MetaDataFactory.java | Interface | Factory for ClassMetaData, InterfaceMetaData, FieldMetaData and PropertyMetaData objects. |
| MetaDataManager.java | Class | Manager of MetaData information in JPOX having scope of an ObjectManagerFactory.
Each PMF/EMF will effectively have a single MetaDataManager handling all XML/Annotations MetaData.
A MetaDataManager can be "initialised" to start with particular MetaData. |
| MetaDataManagerTest.java | Class | Component tests for the MetaDataManager class. |
| MetaDataMerger.java | Class | Convenience class to handle the merging of MetaData. |
| MetaDataUtils.java | Class | Utilities needed for the processing of MetaData. |
| NullValue.java | Class | jdo config null-value class. |
| OrderMetaData.java | Class | Representation of Order MetaData - the ordering of the elements of a List. |
| PackageMetaData.java | Class | Representation of the Meta-Data for a package. |
| PersistenceFileMetaData.java | Class | Representation of a Meta-Data "persistence.xml" file. |
| PersistenceFlags.java | Class | Series of flag settings used in the persistence process. |
| PersistenceUnitMetaData.java | Class | MetaData representation of a "persistence.xml" persistence unit. |
| PrimaryKeyMetaData.java | Class | Representation of a primary key constraint. |
| PropertyMetaData.java | Class | The property element declares mapping between a virtual field of an implemented
interface and the corresponding persistent field of a persistence-capable class. |
| QueryLanguage.java | Class | Representation of the query languages. |
| QueryMetaData.java | Class | Representation of the MetaData of a named Query. |
| QueryResultMetaData.java | Class | Representation of the mapping of (SQL) Query results into a desired output form. |
| Relation.java | Class | Utility class providing enums for the different relation types.
TODO Consider adding the other subtypes of relations ... |
| SequenceMetaData.java | Class | Representation of the MetaData of a named Sequence (JDO, or JPA). |
| SequenceStrategy.java | Class | Representation of strategy of a Sequence. |
| TableGeneratorMetaData.java | Class | Representation of the MetaData of a TableGenerator (JPA). |
| TransactionType.java | Class | Representation of a transaction type. |
| UniqueMetaData.java | Class | MetaData representing a unique constraint. |
| ValueMetaData.java | Class | This element specifies the mapping for the value component of maps. |
| VersionMetaData.java | Class | Three common strategies for versioning instances are supported by standard
metadata. |
| VersionStrategy.java | Class | Three common strategies for versioning instances are supported by standard
metadata. |