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 Type	Method	Description
boolean	createImplicitDiscriminatorsForJoinedInheritance()	Whether we should do discrimination implicitly joined subclass style inheritance when no discriminator info is provided.
default boolean	disallowExtensionsInCdi()	Deprecated, for removal: This API element is subject to removal in a future version. Use isAllowExtensionsInCdi()
List<BasicTypeRegistration>	getBasicTypeRegistrations()	Access the list of BasicType registrations.
ColumnOrderingStrategy	getColumnOrderingStrategy()
List<CompositeUserType<?>>	getCompositeUserTypes()	Access the list of CompositeUserType registrations.
TimeZoneStorageStrategy	getDefaultTimeZoneStorage()
IdentifierGeneratorFactory	getIdentifierGeneratorFactory()	The service implementing IdentifierGeneratorFactory.
AccessType	getImplicitCacheAccessType()	Access to any implicit cache AccessType.
ImplicitNamingStrategy	getImplicitNamingStrategy()
default ManagedTypeRepresentationResolver	getManagedTypeRepresentationResolver()
MappingDefaults	getMappingDefaults()	Access to the MappingDefaults.
default CollectionSemanticsResolver	getPersistentCollectionRepresentationResolver()
PhysicalNamingStrategy	getPhysicalNamingStrategy()
default String	getSchemaCharset()
StandardServiceRegistry	getServiceRegistry()	Access to the StandardServiceRegistry.
SharedCacheMode	getSharedCacheMode()	Access to the SharedCacheMode to determine if the second-level cache is enabled.
List<MetadataSourceType>	getSourceProcessOrdering()	Retrieve the ordering in which sources should be processed.
TimeZoneSupport	getTimeZoneSupport()
TypeConfiguration	getTypeConfiguration()
WrapperArrayHandling	getWrapperArrayHandling()
boolean	ignoreExplicitDiscriminatorsForJoinedInheritance()	Whether explicit discriminator declarations should be ignored for joined subclass style inheritance.
boolean	isAllowExtensionsInCdi()	Check to see if extensions can be hosted in CDI
boolean	isMultiTenancyEnabled()	Is multi-tenancy enabled?
boolean	isNoConstraintByDefault()	Should we disable constraint creation when ConstraintMode.PROVIDER_DEFAULT?
boolean	isSpecjProprietarySyntaxEnabled()
default boolean	isXmlMappingEnabled()
boolean	shouldImplicitlyForceDiscriminatorInSelect()	Whether we should implicitly force discriminators into SQL selects.
boolean	useNationalizedCharacterData()	Should we use nationalized variants of character data by default?

Method Details

getServiceRegistry

StandardServiceRegistry getServiceRegistry()

Access to the StandardServiceRegistry.

getMappingDefaults

MappingDefaults getMappingDefaults()

Access to the MappingDefaults.

getIdentifierGeneratorFactory

IdentifierGeneratorFactory getIdentifierGeneratorFactory()

The service implementing IdentifierGeneratorFactory.

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 configured Dialect

See Also:

• MappingSettings.TIMEZONE_DEFAULT_STORAGE
• Dialect.getTimeZoneSupport()

getTimeZoneSupport

TimeZoneSupport getTimeZoneSupport()

Returns:

the TimeZoneSupport of the configured Dialect

See Also:

• Dialect.getTimeZoneSupport()

getWrapperArrayHandling

WrapperArrayHandling getWrapperArrayHandling()

Returns:

the WrapperArrayHandling to use for wrapper arrays Byte[] and Character[].

See Also:

• MappingSettings.WRAPPER_ARRAY_HANDLING

getManagedTypeRepresentationResolver

default ManagedTypeRepresentationResolver getManagedTypeRepresentationResolver()

getPersistentCollectionRepresentationResolver

default CollectionSemanticsResolver getPersistentCollectionRepresentationResolver()

getBasicTypeRegistrations

List<BasicTypeRegistration> getBasicTypeRegistrations()

Access the list of BasicType registrations.

These are the BasicTypes explicitly registered via calls to:

• MetadataBuilder.applyBasicType(org.hibernate.type.BasicType)
• MetadataBuilder.applyBasicType(org.hibernate.type.BasicType, String[])
• MetadataBuilder.applyBasicType(org.hibernate.usertype.UserType, String[])

Returns:

The BasicTypes registrations

getCompositeUserTypes

List<CompositeUserType<?>> getCompositeUserTypes()

Access the list of CompositeUserType 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 the SharedCacheMode 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 cache AccessType.

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 the BootstrapContext

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 to VARCHAR?

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 when ConstraintMode.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()

See Also:

• SchemaToolingSettings.HBM2DDL_CHARSET_NAME

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.

Use isAllowExtensionsInCdi()

Check to see if extensions can be hosted in CDI