@Incubating

Package org.hibernate.metamodel.mapping

Defines the runtime mapping metamodel, which describes the mapping of the application's domain model parts (entities, attributes) to relational database objects (tables, columns).

Implementation Specification:

This entire package is considered incubating at the moment

Implementation Note:

Built on top of the org.hibernate.persister package.

Interface Summary

Interface	Description
AggregatedIdentifierMapping	An "aggregated" composite identifier, which is another way to say that the identifier is represented as an embeddable.
Association	Commonality for an association, mainly details relative to the foreign-key
AttributeMapping	Describes an attribute at the mapping model level.
AttributeMappingsList	This is essentially a List of AttributeMapping(s), but exposing an interface which is more suitable to our needs; in particular it expresses the immutable nature of this structure, and allows us to extend it with additional convenience methods such as AttributeMappingsList.indexedForEach(IndexedConsumer).
AttributeMappingsMap	Similar to AttributeMappingsList, this is essentially an immutable Map of AttributeMapping(s), allowing iteration of all mappings but also retrieval by name (a String key).
AttributeMetadata
BasicEntityIdentifierMapping	Mapping for a simple, single-column identifier
BasicValuedMapping	Any basic-typed ValueMapping.
BasicValuedModelPart	Describes a ModelPart which is a basic value, either a Basic attribute a basic-valued collection part
Bindable	Contract for things at the domain mapping level that can be bound into a JDBC PreparedStatement.
Bindable.JdbcValuesBiConsumer<X,Y>	Functional interface for consuming the JDBC values, along with two values of type X and Y.
Bindable.JdbcValuesConsumer	Functional interface for consuming the JDBC values.
CollectionIdentifierDescriptor	Descriptor for the collection identifier.
CollectionMappingType<C>	MappingType descriptor for the collection Java type (List, Set, etc)
CollectionPart	Hibernate understands mapping a collection into 4 parts The key - the foreign-key defining the association to the owner The element - for Maps this is analogous to the value The index - the List/array index or Map key The collection-id - this is only relevant for id-bag mappings
CompositeIdentifierMapping	Mapping for a composite identifier
Discriminable	Anything that has a discriminator associated with it.
DiscriminatedAssociationModelPart	A discriminated association.
DiscriminatorMapping	Mapping of a discriminator, for either entity or association (ANY) discrimination.
DiscriminatorType<O>	Union of ConvertedBasicType and BasicDomainType capabilities.
DiscriminatorValueDetails	Details for a particular discriminator value.
EmbeddableDiscriminatorMapping	Details about the discriminator for an embeddable hierarchy.
EmbeddableMappingType	Describes an embeddable - the actual type
EmbeddableMappingType.ConcreteEmbeddableType
EmbeddableValuedModelPart	Describes the mapping of an embeddable (composite).
EntityAssociationMapping	Commonality between `many-to-one`, `one-to-one` and `any`, as well as entity-valued collection elements and map-keys
EntityDiscriminatorMapping	Details about the discriminator for an entity hierarchy.
EntityIdentifierMapping	Describes the mapping of an entity's identifier.
EntityMappingType	Mapping of an entity
EntityMappingType.ConstraintOrderedTableConsumer
EntityRowIdMapping	Mapping of a row-id
EntityValuedModelPart	Entity-valued model part ManyToOne OneToOne entity-valued collection element entity-valued Map key
EntityVersionMapping	Describes the mapping of an entity's version
FilterRestrictable	Things that can have associated Filter declarations.
ForeignKeyDescriptor	Descriptor for foreign-keys
ForeignKeyDescriptor.Side
JdbcMapping	Describes the mapping for things which can be expressed in a SQL query.
JdbcMappingContainer	Container for one-or-more JdbcMappings
ManagedMappingType	Mapping-model corollary to ManagedType
MappingModelCreationLogging	Logger used during mapping-model creation
MappingModelExpressible<T>	Something that can be expressible at the mapping model level.
MappingType	Common descriptor for types in the mapping model - entities, embeddables, String, Integer, etc
ModelPart	Base descriptor, within the mapping model, for any part of the application's domain model: an attribute, an entity identifier, collection elements, and so on.
ModelPart.JdbcValueBiConsumer<X,Y>	Functional interface for consuming the JDBC values, along with two values of type X and Y.
ModelPart.JdbcValueConsumer	Functional interface for consuming the JDBC values.
ModelPartContainer	Access to a group of ModelPart by name or for iteration.
NaturalIdLogging	Logging related to natural-id operations
NaturalIdMapping	Mapping for an entity's natural-id, if one is defined.
NonAggregatedIdentifierMapping	A "non-aggregated" composite identifier, which means that the entity itself does not define a singular representation of its identifier like an aggregated mapping does.
NonAggregatedIdentifierMapping.IdentifierValueMapper	Think of an AttributeConverter for id values to account for representation difference between virtual and id-class mappings
NonTransientException	Marker interface for exceptions thrown during mapping-model creation which are not transient errors - they will never succeed
OwnedValuedModelPart	Marker interface for valued model parts that have a declaring/owner type.
PluralAttributeMapping	Mapping of a plural (collection-valued) attribute
PluralAttributeMapping.IndexMetadata
PluralAttributeMapping.PredicateConsumer
PropertyBasedMapping	Describes an attribute with a property access.
Restrictable	Things that can have Where, and/or Filter applied to them.
SelectableConsumer	Consumer used to visit selectable (column/formula) mappings
SelectableMapping	Mapping of a selectable (column/formula)
SelectableMappings	A container for multiple selectable (column, formula) mappings.
SingularAttributeMapping	Mapping for a singular (non-collection) attribute.
SoftDeletableModelPart	Model part which can be soft-deleted
SoftDeleteMapping	Metadata about the indicator column for entities and collections enabled for soft delete
SqlExpressible	Unifying contract for things that are capable of being an expression in the SQL AST.
SqlTypedMapping	Models the type of a thing that can be used as an expression in a SQL query
TableDetails	Details about a table
TableDetails.KeyColumn	Details about a column within the key group
TableDetails.KeyColumnConsumer
TableDetails.KeyDetails	Details about the primary key of a table
ValuedModelPart	Describes a ModelPart that is also a ValueMapping (and therefore also a SelectableMappings).
ValueMapping	Describes a mapping related to any part of the app's domain model, for example, an attribute, an entity identifier, collection elements, etc.
VirtualModelPart	Marker interface for parts of the application domain model that do not actually exist in the model classes.
WhereRestrictable	Things which can have Where declarations - entities and collections

Class Summary

Class	Description
AssociationKey	Used as part of circularity detection
AttributeMappingsMap.Builder
DefaultDiscriminatorConverter<O,R>	Implements the default discriminator assignment strategy defined by JPA, that is, the discriminator value is the JPA (unqualified) entity name.
DiscriminatorConverter<O,R>
EmbeddableDiscriminatorConverter<O,R>	Handles conversion of discriminator values for embeddable subtype classes to their domain typed form.
MappedDiscriminatorConverter<O,R>	Conversion of discriminator values between the entity name/Class domain form and its generally CHARACTER or INTEGER based relational form
MappingModelHelper
SelectableConsumer.MutableSelectableMapping
SelectablePath	The path for a selectable.

Enum Summary

Enum	Description
CollectionPart.Nature
EntityIdentifierMapping.Nature	The style of identifier used.
ForeignKeyDescriptor.Nature