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 theMetadata
object duringMetadataBuilder.build()
processing.- Since:
- 5.0
-
-
Method Summary
-
-
-
Method Detail
-
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:
MappingSettings.TIMEZONE_DEFAULT_STORAGE
,Dialect.getTimeZoneSupport()
-
getTimeZoneSupport
TimeZoneSupport getTimeZoneSupport()
- Returns:
- the
TimeZoneSupport
of the configuredDialect
- See Also:
Dialect.getTimeZoneSupport()
-
getWrapperArrayHandling
WrapperArrayHandling getWrapperArrayHandling()
- Returns:
- the
WrapperArrayHandling
to use for wrapper arraysByte[]
andCharacter[]
. - See Also:
MappingSettings.WRAPPER_ARRAY_HANDLING
-
getManagedTypeRepresentationResolver
default ManagedTypeRepresentationResolver getManagedTypeRepresentationResolver()
-
getPersistentCollectionRepresentationResolver
default CollectionSemanticsResolver 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:
MappingSettings.IMPLICIT_NAMING_STRATEGY
-
getPhysicalNamingStrategy
PhysicalNamingStrategy getPhysicalNamingStrategy()
- See Also:
MappingSettings.PHYSICAL_NAMING_STRATEGY
-
getColumnOrderingStrategy
ColumnOrderingStrategy getColumnOrderingStrategy()
- See Also:
MappingSettings.COLUMN_ORDERING_STRATEGY
-
getSharedCacheMode
SharedCacheMode getSharedCacheMode()
Access to theSharedCacheMode
to determine if the second-level cache is enabled.- Returns:
- The
SharedCacheMode
- See Also:
CacheSettings.JAKARTA_SHARED_CACHE_MODE
-
getImplicitCacheAccessType
AccessType getImplicitCacheAccessType()
Access to any implicit cacheAccessType
.- Returns:
- The implicit cache
AccessType
- See Also:
CacheSettings.DEFAULT_CACHE_CONCURRENCY_STRATEGY
-
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:
MultiTenancySettings.MULTI_TENANT_CONNECTION_PROVIDER
-
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:
MetadataBuilder.enableExplicitDiscriminatorsForJoinedSubclassSupport(boolean)
,MappingSettings.IGNORE_EXPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS
-
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:
MetadataBuilder.enableImplicitDiscriminatorsForJoinedSubclassSupport(boolean)
,MappingSettings.IMPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS
-
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:
MappingSettings.FORCE_DISCRIMINATOR_IN_SELECTS_BY_DEFAULT
-
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:
MetadataBuilder.enableGlobalNationalizedCharacterDataSupport(boolean)
,MappingSettings.USE_NATIONALIZED_CHARACTER_DATA
-
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:
ConstraintMode.PROVIDER_DEFAULT
,SchemaToolingSettings.HBM2DDL_DEFAULT_CONSTRAINT_MODE
-
getSourceProcessOrdering
List<MetadataSourceType> getSourceProcessOrdering()
Retrieve the ordering in which sources should be processed.- Returns:
- The order in which sources should be processed.
- See Also:
MappingSettings.ARTIFACT_PROCESSING_ORDER
-
getSchemaCharset
default String getSchemaCharset()
-
isXmlMappingEnabled
default boolean isXmlMappingEnabled()
- See Also:
MappingSettings.XML_MAPPING_ENABLED
-
isAllowExtensionsInCdi
boolean isAllowExtensionsInCdi()
Check to see if extensions can be hosted in CDI
-
disallowExtensionsInCdi
@Deprecated(forRemoval=true) default boolean 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
-
-