Package org.hibernate.metamodel.mapping

Hibernate's run-time mapping model. This model defines the mapping of the application's domain model to database objects (tables, columns, etc).

"Implementation Specification:"

This entire package is considered an SPI and incubating at the moment

"Implementation Note:"

At the moment, this mapping model is built on top of the org.hibernate.persister package.

Interface Summary

Interface	Description
Association	Commonality for an association, mainly details relative to the foreign-key
AttributeMapping	Describes an attribute at the mapping model level.
AttributeMetadata
AttributeMetadataAccess	Provides access to details about an attribute specific to a particular entity in the hierarchy.
BasicEntityIdentifierMapping	Mapping for a simple 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.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 Map's 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
Discriminatable	Things that have a discriminator associated with it.
DiscriminatedAssociationModelPart	A discriminated association.
EmbeddableMappingType	Describes an embeddable - the actual type
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
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
GeneratedValueResolver	Generalized contract covering an attribute's generation handling
JdbcMapping	Models the type of a thing that can be used as an expression in a SQL query
JdbcMappingContainer	Container for one-or-more JdbcMappings
ManagedMappingType	Commonality in regards to the mapping type system for all managed domain types - entity types, mapped-superclass types, composite types, etc
MappingModelCreationLogger	Logger used during mapping-model creation
MappingModelExpressible<T>	Something that can be expressible at the mapping model level.
MappingModelVisitor
MappingType	Parts of the ModelPart hierarchy that are type descriptors, as opposed to attributes e.g.
MappingTypedModelPart
ModelPart	Describes a mapping related to any part of the app's domain model - e.g.
ModelPart.JdbcValueConsumer
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 EmbeddedId 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
PluralAttributeMapping	Mapping of a plural (collection-valued) attribute
PluralAttributeMapping.IndexMetadata
PropertyBasedMapping	Describes an attribute with a property access.
Queryable	Defines a mapping model contract for things that can be queried in the HQL, Criteria, etc sense.
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.
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
ValueMapping	Describes a mapping related to any part of the app's domain model - e.g.
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
InDatabaseGeneratedValueResolver	GeneratedValueResolver impl for in-db generation.
InMemoryGeneratedValueResolver	GeneratedValueResolver impl for in-memory generation
MappingModelHelper
MappingModelWalker

Enum Summary

Enum	Description
CollectionPart.Nature
ForeignKeyDescriptor.Nature