Package org.hibernate.boot.spi
Interface MetadataBuildingOptions
- All Known Implementing Classes:
AbstractDelegatingMetadataBuildingOptions
,MetadataBuilderImpl.MetadataBuildingOptionsImpl
,MockSessionFactory
,ProcessorSessionFactory
public interface MetadataBuildingOptions
Describes the options used while building the
Metadata
object during MetadataBuilder.build()
processing.- Since:
- 5.0
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Whether we should do discrimination implicitly joined subclass style inheritance when no discriminator info is provided.default boolean
Deprecated, for removal: This API element is subject to removal in a future version.Access the list ofBasicType
registrations.Access the list ofCompositeUserType
registrations.The service implementingIdentifierGeneratorFactory
.Access to any implicit cacheAccessType
.Access to theMappingDefaults
.default CollectionSemanticsResolver
default String
Access to theStandardServiceRegistry
.Access to theSharedCacheMode
to determine if the second-level cache is enabled.Retrieve the ordering in which sources should be processed.boolean
Whether explicit discriminator declarations should be ignored for joined subclass style inheritance.boolean
Check to see if extensions can be hosted in CDIboolean
Is multi-tenancy enabled?boolean
Should we disable constraint creation whenConstraintMode.PROVIDER_DEFAULT
?boolean
default boolean
boolean
Whether we should implicitly force discriminators into SQL selects.boolean
Should we use nationalized variants of character data by default?
-
Method Details
-
getServiceRegistry
StandardServiceRegistry getServiceRegistry()Access to theStandardServiceRegistry
. -
getMappingDefaults
MappingDefaults getMappingDefaults()Access to theMappingDefaults
. -
getIdentifierGeneratorFactory
IdentifierGeneratorFactory getIdentifierGeneratorFactory()The service implementingIdentifierGeneratorFactory
.- Implementation Note:
- Almost always a
StandardIdentifierGeneratorFactory
.
-
getDefaultTimeZoneStorage
TimeZoneStorageStrategy getDefaultTimeZoneStorage()- Returns:
- the
TimeZoneStorageStrategy
determined by the global configuration property and the time zone support of the configuredDialect
- See Also:
-
getTimeZoneSupport
TimeZoneSupport getTimeZoneSupport()- Returns:
- the
TimeZoneSupport
of the configuredDialect
- See Also:
-
getWrapperArrayHandling
WrapperArrayHandling getWrapperArrayHandling()- Returns:
- the
WrapperArrayHandling
to use for wrapper arraysByte[]
andCharacter[]
. - See Also:
-
getManagedTypeRepresentationResolver
-
getPersistentCollectionRepresentationResolver
-
getBasicTypeRegistrations
List<BasicTypeRegistration> getBasicTypeRegistrations()Access the list ofBasicType
registrations.These are the
BasicTypes
explicitly registered via calls to:- Returns:
- The
BasicTypes
registrations
-
getCompositeUserTypes
List<CompositeUserType<?>> getCompositeUserTypes()Access the list ofCompositeUserType
registrations. -
getImplicitNamingStrategy
ImplicitNamingStrategy getImplicitNamingStrategy()- See Also:
-
getPhysicalNamingStrategy
PhysicalNamingStrategy getPhysicalNamingStrategy()- See Also:
-
getColumnOrderingStrategy
ColumnOrderingStrategy getColumnOrderingStrategy()- See Also:
-
getImplicitCacheAccessType
AccessType getImplicitCacheAccessType()Access to any implicit cacheAccessType
.- Returns:
- The implicit cache
AccessType
- See Also:
-
isMultiTenancyEnabled
boolean isMultiTenancyEnabled()Is multi-tenancy enabled?Multi-tenancy is enabled implicitly if a
MultiTenantConnectionProvider
is available.- Returns:
true
is multi-tenancy is enabled- See Also:
-
getTypeConfiguration
TypeConfiguration getTypeConfiguration()- Returns:
- the
TypeConfiguration
belonging to theBootstrapContext
-
ignoreExplicitDiscriminatorsForJoinedInheritance
boolean ignoreExplicitDiscriminatorsForJoinedInheritance()Whether explicit discriminator declarations should be ignored for joined subclass style inheritance.- Returns:
true
indicates they should be ignored;false
indicates they should not be ignored.- See Also:
-
createImplicitDiscriminatorsForJoinedInheritance
boolean createImplicitDiscriminatorsForJoinedInheritance()Whether we should do discrimination implicitly joined subclass style inheritance when no discriminator info is provided.- Returns:
true
indicates we should do discrimination;false
we should not.- See Also:
-
shouldImplicitlyForceDiscriminatorInSelect
boolean shouldImplicitlyForceDiscriminatorInSelect()Whether we should implicitly force discriminators into SQL selects. By default, Hibernate will not. This can be specified per discriminator in the mapping as well.- Returns:
true
indicates we should force the discriminator in selects for any mappings which do not say explicitly.- See Also:
-
useNationalizedCharacterData
boolean useNationalizedCharacterData()Should we use nationalized variants of character data by default?For example, should
NVARCHAR
be used in preference toVARCHAR
?- Returns:
true
if nationalized character data should be used by default;false
otherwise.- See Also:
-
isSpecjProprietarySyntaxEnabled
boolean isSpecjProprietarySyntaxEnabled() -
isNoConstraintByDefault
boolean isNoConstraintByDefault()Should we disable constraint creation whenConstraintMode.PROVIDER_DEFAULT
?- Returns:
true
if we should not create constraints by default;false
if we should.- See Also:
-
getSourceProcessOrdering
List<MetadataSourceType> getSourceProcessOrdering()Retrieve the ordering in which sources should be processed.- Returns:
- The order in which sources should be processed.
- See Also:
-
getSchemaCharset
-
isXmlMappingEnabled
default boolean isXmlMappingEnabled()- See Also:
-
isAllowExtensionsInCdi
boolean isAllowExtensionsInCdi()Check to see if extensions can be hosted in CDI -
disallowExtensionsInCdi
Deprecated, for removal: This API element is subject to removal in a future version.Check to see if extensions can be hosted in CDI
-
isAllowExtensionsInCdi()