Package org.hibernate.boot.spi

Class AbstractDelegatingMetadataBuildingOptions

java.lang.Object

org.hibernate.boot.spi.AbstractDelegatingMetadataBuildingOptions

All Implemented Interfaces:

JpaOrmXmlPersistenceUnitDefaultAware, MetadataBuildingOptions

public abstract class AbstractDelegatingMetadataBuildingOptions
extends Object
implements MetadataBuildingOptions, JpaOrmXmlPersistenceUnitDefaultAware

Convenience base class for custom implementors of MetadataBuildingOptions using delegation.

Nested Class Summary

Nested classes/interfaces inherited from interface org.hibernate.boot.spi.JpaOrmXmlPersistenceUnitDefaultAware

JpaOrmXmlPersistenceUnitDefaultAware.JpaOrmXmlPersistenceUnitDefaults

Constructor Summary

Constructors

Constructor	Description
AbstractDelegatingMetadataBuildingOptions(MetadataBuildingOptions delegate)

Method Summary

Modifier and Type	Method	Description
void	apply(PersistenceUnitMetadata persistenceUnitMetadata)
void	apply(JpaOrmXmlPersistenceUnitDefaultAware.JpaOrmXmlPersistenceUnitDefaults jpaOrmXmlPersistenceUnitDefaults)	Apply the orm.xml-defined persistence-unit-defaults values.
boolean	createImplicitDiscriminatorsForJoinedInheritance()	Whether we should do discrimination implicitly joined subclass style inheritance when no discriminator info is provided.
protected MetadataBuildingOptions	delegate()
List<BasicTypeRegistration>	getBasicTypeRegistrations()	Access the list of BasicType registrations.
ColumnOrderingStrategy	getColumnOrderingStrategy()
List<CompositeUserType<?>>	getCompositeUserTypes()	Access the list of CompositeUserType registrations.
TimeZoneStorageStrategy	getDefaultTimeZoneStorage()
AccessType	getImplicitCacheAccessType()	Access to any implicit cache AccessType.
ImplicitNamingStrategy	getImplicitNamingStrategy()
MappingDefaults	getMappingDefaults()	Access to the MappingDefaults.
PhysicalNamingStrategy	getPhysicalNamingStrategy()
String	getSchemaCharset()
StandardServiceRegistry	getServiceRegistry()	Access to the StandardServiceRegistry.
SharedCacheMode	getSharedCacheMode()	Access to the SharedCacheMode to determine if the second-level cache is enabled.
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	isXmlFormatMapperLegacyFormatEnabled()	Whether to use the legacy format for serializing/deserializing XML data.
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?

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hibernate.boot.spi.MetadataBuildingOptions

getManagedTypeRepresentationResolver, getPersistentCollectionRepresentationResolver

Constructor Details

AbstractDelegatingMetadataBuildingOptions

public AbstractDelegatingMetadataBuildingOptions(MetadataBuildingOptions delegate)

Method Details

delegate

protected MetadataBuildingOptions delegate()

getServiceRegistry

public StandardServiceRegistry getServiceRegistry()

Description copied from interface: MetadataBuildingOptions

Access to the StandardServiceRegistry.

Specified by:

getServiceRegistry in interface MetadataBuildingOptions

getMappingDefaults

public MappingDefaults getMappingDefaults()

Description copied from interface: MetadataBuildingOptions

Access to the MappingDefaults.

Specified by:

getMappingDefaults in interface MetadataBuildingOptions

getDefaultTimeZoneStorage

public TimeZoneStorageStrategy getDefaultTimeZoneStorage()

Specified by:

getDefaultTimeZoneStorage in interface MetadataBuildingOptions

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

public TimeZoneSupport getTimeZoneSupport()

Specified by:

getTimeZoneSupport in interface MetadataBuildingOptions

Returns:

the TimeZoneSupport of the configured Dialect

See Also:

• Dialect.getTimeZoneSupport()

getWrapperArrayHandling

public WrapperArrayHandling getWrapperArrayHandling()

Specified by:

getWrapperArrayHandling in interface MetadataBuildingOptions

Returns:

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

See Also:

• MappingSettings.WRAPPER_ARRAY_HANDLING

getBasicTypeRegistrations

public List<BasicTypeRegistration> getBasicTypeRegistrations()

Description copied from interface: MetadataBuildingOptions

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[])

Specified by:

getBasicTypeRegistrations in interface MetadataBuildingOptions

Returns:

The BasicTypes registrations

getCompositeUserTypes

public List<CompositeUserType<?>> getCompositeUserTypes()

Description copied from interface: MetadataBuildingOptions

Access the list of CompositeUserType registrations.

Specified by:

getCompositeUserTypes in interface MetadataBuildingOptions

getTypeConfiguration

public TypeConfiguration getTypeConfiguration()

Specified by:

getTypeConfiguration in interface MetadataBuildingOptions

Returns:

the TypeConfiguration belonging to the BootstrapContext

getImplicitNamingStrategy

public ImplicitNamingStrategy getImplicitNamingStrategy()

Specified by:

getImplicitNamingStrategy in interface MetadataBuildingOptions

See Also:

• MappingSettings.IMPLICIT_NAMING_STRATEGY

getPhysicalNamingStrategy

public PhysicalNamingStrategy getPhysicalNamingStrategy()

Specified by:

getPhysicalNamingStrategy in interface MetadataBuildingOptions

See Also:

• MappingSettings.PHYSICAL_NAMING_STRATEGY

getColumnOrderingStrategy

public ColumnOrderingStrategy getColumnOrderingStrategy()

Specified by:

getColumnOrderingStrategy in interface MetadataBuildingOptions

See Also:

• MappingSettings.COLUMN_ORDERING_STRATEGY

getSharedCacheMode

public SharedCacheMode getSharedCacheMode()

Description copied from interface: MetadataBuildingOptions

Access to the SharedCacheMode to determine if the second-level cache is enabled.

Specified by:

getSharedCacheMode in interface MetadataBuildingOptions

Returns:

The SharedCacheMode

See Also:

• CacheSettings.JAKARTA_SHARED_CACHE_MODE

getImplicitCacheAccessType

public AccessType getImplicitCacheAccessType()

Description copied from interface: MetadataBuildingOptions

Access to any implicit cache AccessType.

Specified by:

getImplicitCacheAccessType in interface MetadataBuildingOptions

Returns:

The implicit cache AccessType

See Also:

• CacheSettings.DEFAULT_CACHE_CONCURRENCY_STRATEGY

isMultiTenancyEnabled

public boolean isMultiTenancyEnabled()

Description copied from interface: MetadataBuildingOptions

Is multi-tenancy enabled?

Multi-tenancy is enabled implicitly if a MultiTenantConnectionProvider is available.

Specified by:

isMultiTenancyEnabled in interface MetadataBuildingOptions

Returns:

true is multi-tenancy is enabled

See Also:

• MultiTenancySettings.MULTI_TENANT_CONNECTION_PROVIDER

ignoreExplicitDiscriminatorsForJoinedInheritance

public boolean ignoreExplicitDiscriminatorsForJoinedInheritance()

Description copied from interface: MetadataBuildingOptions

Whether explicit discriminator declarations should be ignored for joined subclass style inheritance.

Specified by:

ignoreExplicitDiscriminatorsForJoinedInheritance in interface MetadataBuildingOptions

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

public boolean createImplicitDiscriminatorsForJoinedInheritance()

Description copied from interface: MetadataBuildingOptions

Whether we should do discrimination implicitly joined subclass style inheritance when no discriminator info is provided.

Specified by:

createImplicitDiscriminatorsForJoinedInheritance in interface MetadataBuildingOptions

Returns:

true indicates we should do discrimination; false we should not.

See Also:

• MetadataBuilder.enableImplicitDiscriminatorsForJoinedSubclassSupport(boolean)
• MappingSettings.IMPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS

shouldImplicitlyForceDiscriminatorInSelect

public boolean shouldImplicitlyForceDiscriminatorInSelect()

Description copied from interface: MetadataBuildingOptions

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.

Specified by:

shouldImplicitlyForceDiscriminatorInSelect in interface MetadataBuildingOptions

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

public boolean useNationalizedCharacterData()

Description copied from interface: MetadataBuildingOptions

Should we use nationalized variants of character data by default?

For example, should NVARCHAR be used in preference to VARCHAR?

Specified by:

useNationalizedCharacterData in interface MetadataBuildingOptions

Returns:

true if nationalized character data should be used by default; false otherwise.

See Also:

• MetadataBuilder.enableGlobalNationalizedCharacterDataSupport(boolean)
• MappingSettings.USE_NATIONALIZED_CHARACTER_DATA

isNoConstraintByDefault

public boolean isNoConstraintByDefault()

Description copied from interface: MetadataBuildingOptions

Should we disable constraint creation when ConstraintMode.PROVIDER_DEFAULT?

Specified by:

isNoConstraintByDefault in interface MetadataBuildingOptions

Returns:

true if we should not create constraints by default; false if we should.

See Also:

• ConstraintMode.PROVIDER_DEFAULT
• SchemaToolingSettings.HBM2DDL_DEFAULT_CONSTRAINT_MODE

apply

public void apply(JpaOrmXmlPersistenceUnitDefaultAware.JpaOrmXmlPersistenceUnitDefaults jpaOrmXmlPersistenceUnitDefaults)

Description copied from interface: JpaOrmXmlPersistenceUnitDefaultAware

Apply the orm.xml-defined persistence-unit-defaults values.

Specified by:

apply in interface JpaOrmXmlPersistenceUnitDefaultAware

Parameters:

jpaOrmXmlPersistenceUnitDefaults - The persistence-unit-defaults values

apply

public void apply(PersistenceUnitMetadata persistenceUnitMetadata)

Specified by:

apply in interface JpaOrmXmlPersistenceUnitDefaultAware

getSchemaCharset

public String getSchemaCharset()

Specified by:

getSchemaCharset in interface MetadataBuildingOptions

See Also:

• SchemaToolingSettings.HBM2DDL_CHARSET_NAME

isXmlMappingEnabled

public boolean isXmlMappingEnabled()

Specified by:

isXmlMappingEnabled in interface MetadataBuildingOptions

See Also:

• MappingSettings.XML_MAPPING_ENABLED

isAllowExtensionsInCdi

public boolean isAllowExtensionsInCdi()

Description copied from interface: MetadataBuildingOptions

Check to see if extensions can be hosted in CDI

Specified by:

isAllowExtensionsInCdi in interface MetadataBuildingOptions

isXmlFormatMapperLegacyFormatEnabled

public boolean isXmlFormatMapperLegacyFormatEnabled()

Description copied from interface: MetadataBuildingOptions

Whether to use the legacy format for serializing/deserializing XML data.

Specified by:

isXmlFormatMapperLegacyFormatEnabled in interface MetadataBuildingOptions

See Also:

• MappingSettings.XML_FORMAT_MAPPER_LEGACY_FORMAT