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.
Interface Summary Interface Description ColumnMetaDataContainerInterface defining an object that contains Columns. MetaDataListenerListener for registering interest when metadata for a class is loaded. MetaDataManagerManager for metadata in DataNucleus. MetaDataScannerScanner for persistable classes, typically provided by a JEE environment to locate classes not easily/efficiently locatable using the builtin file scanner.
Class Summary Class Description AbstractClassMetaDataAbstract representation of the MetaData of a class/interface. AbstractElementMetaDataThis element specifies the mapping for the element component of arrays and collections. AbstractMemberMetaDataAbstract representation of MetaData for a field/property of a class/interface. ArrayMetaDataRepresentation of the Meta-Data for an Array. ClassMetaDataRepresentation of the MetaData of a class. CollectionMetaDataRepresentation of the MetaData of a collection. ColumnMetaDataRepresentation of the Meta-Data for a column mapping of a field. ConstraintMetaDataRepresentation of an ORM constraint. ContainerMetaDataRepresentation of the Meta-Data for a container. DatastoreIdentityMetaDataMeta-Data for the datastore-identity of a class. DiscriminatorMetaDataRepresentation of a discriminator in an inheritance strategy. ElementMetaDataThis element specifies the mapping for the element component of arrays and collections. EmbeddedMetaDataThis element specifies the mapping for an embedded type. EventListenerMetaDataListener for events, following the JPA/Jakarta model. FetchGroupMemberMetaDataMetadata defining a member of a fetch-group. FetchGroupMetaDataA fetch group defines a particular loaded state for an object graph. FetchPlanMetaDataFetchPlan defined in MetaData. FieldMetaDataRepresentation of the Meta-Data for a field of a class. FileMetaDataRepresentation of a Meta-Data file. ForeignKeyActionForeign keys represent a consistency constraint in the database that must be maintained. ForeignKeyMetaDataForeign keys in metadata serve two quite different purposes. ImplementsMetaDataThe implements element declares a persistence-capable interface implemented by the persistence-capable class that contains this element. IndexMetaDataFor schema generation, it might be useful to specify that a column or columns be indexed, and to provide the name of the index. InheritanceMetaDataRepresentation of the Meta-Data defining inherited classes. InterfaceMetaDataRepresentation of the MetaData of a "persistent-interface". JoinMetaDataSecondary 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. KeyMetaDataThis element specifies the mapping for the key component of maps. MapMetaDataRepresentation of the Meta-Data for a Map. MetaDataBase class for all MetaData. MetaDataManagerImplManager of metadata information in DataNucleus having scope of an NucleusContext. MetaDataMergerConvenience class to handle the merging of MetaData. MetaDataUtilsUtilities needed for the processing of MetaData. MultitenancyMetaDataMetaData representation for a multitenancy discriminator. OrderMetaDataRepresentation of Order MetaData - the ordering of the elements of a List. OrderMetaData.FieldOrderDefinition of ordering using a field. PackageMetaDataRepresentation of the Meta-Data for a package. PersistenceFileMetaDataRepresentation of a Meta-Data "persistence.xml" file. PersistenceUnitMetaDataMetaData representation of a "persistence.xml" persistence unit. PrimaryKeyMetaDataRepresentation of a primary key constraint. PropertyMetaDataThe property element declares mapping between a virtual field of an implemented interface and the corresponding persistent field of a persistence-capable class. QueryMetaDataRepresentation of the MetaData of a named Query. QueryResultMetaDataRepresentation of the mapping of (SQL) Query results into a desired output form. QueryResultMetaData.ConstructorTypeColumn QueryResultMetaData.ConstructorTypeMappingClass to wrap the mapping for a constructor type. QueryResultMetaData.PersistentTypeMappingClass to wrap the mapping for a persistent type. SequenceMetaDataRepresentation of the MetaData of a named Sequence (JDO, or JPA). SoftDeleteMetaDataMetaData representation for a soft delete indicator column. StoredProcQueryMetaDataMetadata representation of a named stored proc query. StoredProcQueryParameterMetaDataMetadata representation of a parameter for a named stored proc query. TableGeneratorMetaDataRepresentation of the MetaData of a TableGenerator (JPA). UniqueMetaDataMetaData representing a unique constraint. ValueGenerationStrategyValue generation "strategy". ValueMetaDataThis element specifies the mapping for the value component of maps. VersionMetaDataThree common strategies for versioning instances are supported by standard metadata.
Enum Summary Enum Description ClassPersistenceModifierDefinition of the options for persistence-modifier of a class. DiscriminatorStrategyRepresentation of the values for discriminator "strategy". FieldPersistenceModifierClass defining the possibilities for persistence, in terms of the type of persistence, and the types that are capable to be supported. FieldRoleSeries of roles that fields can be performing in the (ORM) mapping process. IdentityTypeRepresentation of the values for identity-type. IndexedValueRepresentation of whether an item is indexed or not. InheritanceStrategyRepresentation of the values for inheritance "strategy". JdbcTypeRepresentation of the jdbc-type of a column. MapMetaData.MapType MetaDataFileTypeEnum for the different types of metadata "files". NullValueRepresentation of how to handle a null value (in a field). QueryLanguageRepresentation of the primary query languages. RelationTypeUtility class providing enums for the different relation types. SequenceStrategyRepresentation of strategy of a Sequence. StoredProcQueryParameterModeMode of usage of a stored procedure query parameter. TransactionTypeRepresentation of a transaction type. VersionStrategyThree common strategies for versioning instances are supported by standard metadata.
Exception Summary Exception Description InvalidAnnotationExceptionException thrown when an annotation has been specified that is invalid in the circumstances. InvalidClassMetaDataExceptionException thrown when meta-data specific to a class is invalid. InvalidMemberMetaDataExceptionException thrown when meta-data specific to a member of a class is invalid. InvalidMetaDataExceptionRepresentation of an exception thrown when an error occurs in Meta-Data definition. InvalidPrimaryKeyExceptionException thrown when a primary key class is found to be invalid for some reason.