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
Interface Summary Interface Description AggregatedIdentifierMappingAn "aggregated" composite identifier, which is another way to say that the identifier is represented as an embeddable. AssociationCommonality for an association, mainly details relative to the foreign-key AttributeMappingDescribes an attribute at the mapping model level. AttributeMappingsListThis 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, this is essentially an immutable Map of AttributeMapping(s), allowing iteration of all mappings but also retrieval by name (a String key).
AttributeMetadata BasicEntityIdentifierMappingMapping for a simple, single-column identifier BasicValuedMappingAny basic-typed ValueMapping. BasicValuedModelPartDescribes a ModelPart which is a basic value, either a
Basicattribute a basic-valued collection part
BindableContract for things at the domain mapping level that can be bound into a JDBC
Bindable.JdbcValuesBiConsumer<X,Y>Functional interface for consuming the JDBC values, along with two values of type
Bindable.JdbcValuesConsumerFunctional interface for consuming the JDBC values. CollectionIdentifierDescriptorDescriptor for the collection identifier. CollectionMappingType<C>MappingType descriptor for the collection Java type (List, Set, etc) CollectionPartHibernate 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 CompositeIdentifierMappingMapping for a composite identifier DiscriminableAnything that has a discriminator associated with it. DiscriminatedAssociationModelPartA discriminated association. DiscriminatorMapping DiscriminatorType<O> DiscriminatorValueDetailsDetails for a particular discriminator value. EmbeddableMappingTypeDescribes an embeddable - the actual type EmbeddableValuedModelPartDescribes the mapping of an embeddable (composite). EntityAssociationMappingCommonality between `many-to-one`, `one-to-one` and `any`, as well as entity-valued collection elements and map-keys EntityDiscriminatorMappingDetails about the discriminator for an entity hierarchy. EntityIdentifierMappingDescribes the mapping of an entity's identifier. EntityMappingTypeMapping of an entity EntityMappingType.ConstraintOrderedTableConsumer EntityRowIdMappingMapping of a row-id EntityValuedModelPart EntityVersionMappingDescribes the mapping of an entity's version FilterRestrictableThings that can have associated
ForeignKeyDescriptorDescriptor for foreign-keys ForeignKeyDescriptor.Side JdbcMappingDescribes the mapping for things which can be expressed in a SQL query. JdbcMappingContainerContainer for one-or-more JdbcMappings ManagedMappingTypeMapping-model corollary to
MappingModelCreationLoggingLogger used during mapping-model creation MappingModelExpressible<T>Something that can be expressible at the mapping model level. MappingTypeCommon descriptor for types in the mapping model - entities, embeddables, String, Integer, etc ModelPartBase 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
ModelPart.JdbcValueConsumerFunctional interface for consuming the JDBC values. ModelPartContainerAccess to a group of ModelPart by name or for iteration. NaturalIdLoggingLogging related to natural-id operations NaturalIdMappingMapping for an entity's natural-id, if one is defined. NonAggregatedIdentifierMappingA "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.IdentifierValueMapperThink of an AttributeConverter for id values to account for representation difference between virtual and id-class mappings NonTransientExceptionMarker interface for exceptions thrown during mapping-model creation which are not transient errors - they will never succeed OwnedValuedModelPartMarker interface for valued model parts that have a declaring/owner type. PluralAttributeMappingMapping of a plural (collection-valued) attribute PluralAttributeMapping.IndexMetadata PluralAttributeMapping.PredicateConsumer PropertyBasedMappingDescribes an attribute with a property access. Restrictable SelectableConsumerConsumer used to visit selectable (column/formula) mappings SelectableMappingMapping of a selectable (column/formula) SelectableMappingsA container for multiple selectable (column, formula) mappings. SingularAttributeMappingMapping for a singular (non-collection) attribute. SoftDeletableModelPartModel part which can be soft-deleted SoftDeleteMappingMetadata about the indicator column for entities and collections enabled for soft delete SqlExpressibleUnifying contract for things that are capable of being an expression in the SQL AST. SqlTypedMappingModels the type of a thing that can be used as an expression in a SQL query TableDetailsDetails about a table TableDetails.KeyColumnDetails about a column within the key group TableDetails.KeyColumnConsumer TableDetails.KeyDetailsDetails about the primary key of a table ValuedModelPartDescribes a ModelPart that is also a ValueMapping (and therefore also a SelectableMappings). ValueMappingDescribes a mapping related to any part of the app's domain model, for example, an attribute, an entity identifier, collection elements, etc. VirtualModelPartMarker interface for parts of the application domain model that do not actually exist in the model classes. WhereRestrictableThings which can have
Wheredeclarations - entities and collections
Class Summary Class Description AssociationKeyUsed 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> 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 SelectablePathThe path for a selectable.
Enum Summary Enum Description CollectionPart.Nature EntityIdentifierMapping.NatureThe style of identifier used. ForeignKeyDescriptor.Nature