Package org.datanucleus.metadata
package org.datanucleus.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.
-
ClassDescriptionAbstract representation of the MetaData of a class/interface.This element specifies the mapping for the element component of arrays and collections.Abstract representation of MetaData for a field/property of a class/interface.Representation of the Meta-Data for an Array.Representation of the MetaData of a class.Definition of the options for persistence-modifier of a class.Representation of the MetaData of a collection.Representation of the Meta-Data for a column mapping of a field.Interface defining an object that contains Columns.Representation of an ORM constraint.Representation of the details of an object stored in a container.Representation of the Meta-Data for a container.Meta-Data for the datastore-identity of a class.Representation of a discriminator in an inheritance strategy.Representation of the values for discriminator "strategy".This element specifies the mapping for the element component of arrays and collections.This element specifies the mapping for an embedded type.Listener for events, following the JPA/Jakarta model.Metadata defining a member of a fetch-group.A fetch group defines a particular loaded state for an object graph.FetchPlan defined in MetaData.Representation of the Meta-Data for a field of a class.Class defining the possibilities for persistence, in terms of the type of persistence, and the types that are capable to be supported.Series of roles that fields can be performing in the (ORM) mapping process.Representation of a Meta-Data file.Foreign keys represent a consistency constraint in the database that must be maintained.Foreign keys in metadata serve two quite different purposes.Representation of the values for identity-type.The implements element declares a persistence-capable interface implemented by the persistence-capable class that contains this element.Representation of whether an item is indexed or not.For schema generation, it might be useful to specify that a column or columns be indexed, and to provide the name of the index.Representation of the Meta-Data defining inherited classes.Representation of the values for inheritance "strategy".Representation of the MetaData of a "persistent-interface".Exception thrown when an annotation has been specified that is invalid in the circumstances.Exception thrown when meta-data specific to a class is invalid.Exception thrown when meta-data specific to a member of a class is invalid.Representation of an exception thrown when an error occurs in Meta-Data definition.Exception thrown when a primary key class is found to be invalid for some reason.Representation of the jdbc-type of a column.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.This element specifies the mapping for the key component of maps.Representation of the Meta-Data for a Map.Base class for all MetaData.Enum for the different types of metadata "files".Listener for registering interest when metadata for a class is loaded.Manager for metadata in DataNucleus.Manager of metadata information in DataNucleus having scope of an NucleusContext.Simple comparator that orders the implementations of an interface so that the initial implementations are first, and the subclasses later.Convenience class to handle the merging of MetaData.Scanner for persistable classes, typically provided by a JEE environment to locate classes not easily/efficiently locatable using the builtin file scanner.Utilities needed for the processing of MetaData.MetaData representation for a multitenancy discriminator.Representation of how to handle a null value (in a field).Representation of Order MetaData - the ordering of the elements of a List.Definition of ordering using a field.Representation of the Meta-Data for a package.Representation of a Meta-Data "persistence.xml" file.MetaData representation of a "persistence.xml" persistence unit.Representation of a primary key constraint.The property element declares mapping between a virtual field of an implemented interface and the corresponding persistent field of a persistence-capable class.Representation of the primary query languages.Representation of the MetaData of a named Query.Representation of the mapping of (SQL) Query results into a desired output form.Class to wrap the mapping for a constructor type.Class to wrap the mapping for a persistent type.Utility class providing enums for the different relation types.Representation of the MetaData of a named Sequence (JDO, or JPA).Representation of strategy of a Sequence.MetaData representation for a soft delete indicator column.Metadata representation of a named stored proc query.Metadata representation of a parameter for a named stored proc query.Mode of usage of a stored procedure query parameter.Representation of the MetaData of a TableGenerator (JPA).Representation of a transaction type.MetaData representing a unique constraint.Value generation "strategy".This element specifies the mapping for the value component of maps.Three common strategies for versioning instances are supported by standard metadata.Three common strategies for versioning instances are supported by standard metadata.