Top Description Fields Constructors Methods
org.hibernate.boot.spi

public abstract Class AbstractDelegatingMetadataBuildingOptions

extends Object
implements MetadataBuildingOptions, JpaOrmXmlPersistenceUnitDefaultAware
Class Inheritance
All Implemented Interfaces
org.hibernate.boot.spi.JpaOrmXmlPersistenceUnitDefaultAware, org.hibernate.boot.spi.MetadataBuildingOptions
Annotations
@SuppressWarnings:unused
Imports
java.util.List, org.hibernate.HibernateException, .TimeZoneStorageStrategy, org.hibernate.boot.model.naming.ImplicitNamingStrategy, .PhysicalNamingStrategy, org.hibernate.boot.model.relational.ColumnOrderingStrategy, org.hibernate.boot.registry.StandardServiceRegistry, org.hibernate.cache.spi.access.AccessType, org.hibernate.cfg.MetadataSourceType, org.hibernate.dialect.TimeZoneSupport, org.hibernate.id.factory.IdentifierGeneratorFactory, org.hibernate.type.WrapperArrayHandling, org.hibernate.type.spi.TypeConfiguration, org.hibernate.usertype.CompositeUserType, jakarta.persistence.SharedCacheMode
Convenience base class for custom implementors of MetadataBuildingOptions using delegation.
Authors
Gunnar Morling, Steve Ebersole

Field Summary

Modifier and TypeField and Description
private final MetadataBuildingOptions
delegate

Constructor Summary

AccessConstructor and Description
public
AbstractDelegatingMetadataBuildingOptions(MetadataBuildingOptions delegate)

Method Summary

Modifier and TypeMethod and Description
public void
apply(JpaOrmXmlPersistenceUnitDefaultAware.JpaOrmXmlPersistenceUnitDefaults
The persistence-unit-defaults values
jpaOrmXmlPersistenceUnitDefaults)

Implements org.hibernate.boot.spi.JpaOrmXmlPersistenceUnitDefaultAware.apply.

Apply the orm.xml-defined persistence-unit-defaults values.
public boolean
createImplicitDiscriminatorsForJoinedInheritance()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.createImplicitDiscriminatorsForJoinedInheritance.

Whether we should do discrimination implicitly joined subclass style inheritance when no discriminator info is provided.
protected MetadataBuildingOptions
delegate()

public List<BasicTypeRegistration>
getBasicTypeRegistrations()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getBasicTypeRegistrations.

Access the list of org.hibernate.type.BasicType registrations.
public ColumnOrderingStrategy
getColumnOrderingStrategy()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getColumnOrderingStrategy.

public List<CompositeUserType<?>>
getCompositeUserTypes()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getCompositeUserTypes.

Access the list of CompositeUserType registrations.
public TimeZoneStorageStrategy
getDefaultTimeZoneStorage()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getDefaultTimeZoneStorage.

public IdentifierGeneratorFactory
getIdentifierGeneratorFactory()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getIdentifierGeneratorFactory.

The service implementing IdentifierGeneratorFactory.
public AccessType
getImplicitCacheAccessType()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getImplicitCacheAccessType.

Access to any implicit cache AccessType.
public ImplicitNamingStrategy
getImplicitNamingStrategy()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getImplicitNamingStrategy.

public MappingDefaults
getMappingDefaults()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getMappingDefaults.

Access to the MappingDefaults.
public PhysicalNamingStrategy
getPhysicalNamingStrategy()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getPhysicalNamingStrategy.

public String
getSchemaCharset()

Overrides default org.hibernate.boot.spi.MetadataBuildingOptions.getSchemaCharset.

public StandardServiceRegistry
getServiceRegistry()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getServiceRegistry.

Access to the StandardServiceRegistry.
public SharedCacheMode
getSharedCacheMode()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getSharedCacheMode.

Access to the SharedCacheMode to determine if the second-level cache is enabled.
public List<MetadataSourceType>
getSourceProcessOrdering()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getSourceProcessOrdering.

Retrieve the ordering in which sources should be processed.
public TimeZoneSupport
getTimeZoneSupport()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getTimeZoneSupport.

public TypeConfiguration
getTypeConfiguration()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getTypeConfiguration.

public WrapperArrayHandling
getWrapperArrayHandling()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getWrapperArrayHandling.

public boolean
ignoreExplicitDiscriminatorsForJoinedInheritance()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.ignoreExplicitDiscriminatorsForJoinedInheritance.

Whether explicit discriminator declarations should be ignored for joined subclass style inheritance.
public boolean
isAllowExtensionsInCdi()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.isAllowExtensionsInCdi.

Check to see if extensions can be hosted in CDI
public boolean
isMultiTenancyEnabled()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.isMultiTenancyEnabled.

Is multi-tenancy enabled?
public boolean
isNoConstraintByDefault()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.isNoConstraintByDefault.

Should we disable constraint creation when jakarta.persistence.ConstraintMode#PROVIDER_DEFAULT?
public boolean
isSpecjProprietarySyntaxEnabled()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.isSpecjProprietarySyntaxEnabled.

public boolean
isXmlMappingEnabled()

Overrides default org.hibernate.boot.spi.MetadataBuildingOptions.isXmlMappingEnabled.

public boolean
shouldImplicitlyForceDiscriminatorInSelect()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.shouldImplicitlyForceDiscriminatorInSelect.

Whether we should implicitly force discriminators into SQL selects.
public boolean
useNationalizedCharacterData()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.useNationalizedCharacterData.

Should we use nationalized variants of character data by default?
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

delegateback to summary
private final MetadataBuildingOptions delegate

Constructor Detail

AbstractDelegatingMetadataBuildingOptionsback to summary
public AbstractDelegatingMetadataBuildingOptions(MetadataBuildingOptions delegate)

Method Detail

applyback to summary
public void apply(JpaOrmXmlPersistenceUnitDefaultAware.JpaOrmXmlPersistenceUnitDefaults jpaOrmXmlPersistenceUnitDefaults)

Implements org.hibernate.boot.spi.JpaOrmXmlPersistenceUnitDefaultAware.apply.

Doc from org.hibernate.boot.spi.JpaOrmXmlPersistenceUnitDefaultAware.apply.

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

Parameters
jpaOrmXmlPersistenceUnitDefaults:JpaOrmXmlPersistenceUnitDefaultAware.JpaOrmXmlPersistenceUnitDefaults

The persistence-unit-defaults values

Annotations
@Override
createImplicitDiscriminatorsForJoinedInheritanceback to summary
public boolean createImplicitDiscriminatorsForJoinedInheritance()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.createImplicitDiscriminatorsForJoinedInheritance.

Doc from org.hibernate.boot.spi.MetadataBuildingOptions.createImplicitDiscriminatorsForJoinedInheritance.

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

Returns:boolean

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

Annotations
@Override
delegateback to summary
protected MetadataBuildingOptions delegate()
getBasicTypeRegistrationsback to summary
public List<BasicTypeRegistration> getBasicTypeRegistrations()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getBasicTypeRegistrations.

Doc from org.hibernate.boot.spi.MetadataBuildingOptions.getBasicTypeRegistrations.

Access the list of org.hibernate.type.BasicType registrations.

These are the BasicTypes explicitly registered via calls to:

Returns:List<BasicTypeRegistration>

The BasicTypes registrations

Annotations
@Override
getColumnOrderingStrategyback to summary
public ColumnOrderingStrategy getColumnOrderingStrategy()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getColumnOrderingStrategy.

Annotations
@Override
getCompositeUserTypesback to summary
public List<CompositeUserType<?>> getCompositeUserTypes()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getCompositeUserTypes.

Doc from org.hibernate.boot.spi.MetadataBuildingOptions.getCompositeUserTypes.

Access the list of CompositeUserType registrations.

Annotations
@Override
getDefaultTimeZoneStorageback to summary
public TimeZoneStorageStrategy getDefaultTimeZoneStorage()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getDefaultTimeZoneStorage.

Returns:TimeZoneStorageStrategy

Doc from org.hibernate.boot.spi.MetadataBuildingOptions.getDefaultTimeZoneStorage.

the TimeZoneStorageStrategy determined by the global configuration property and the time zone support of the configured org.hibernate.dialect.Dialect

Annotations
@Override
getIdentifierGeneratorFactoryback to summary
public IdentifierGeneratorFactory getIdentifierGeneratorFactory()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getIdentifierGeneratorFactory.

Doc from org.hibernate.boot.spi.MetadataBuildingOptions.getIdentifierGeneratorFactory.

The service implementing IdentifierGeneratorFactory.

Annotations
@Override
getImplicitCacheAccessTypeback to summary
public AccessType getImplicitCacheAccessType()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getImplicitCacheAccessType.

Doc from org.hibernate.boot.spi.MetadataBuildingOptions.getImplicitCacheAccessType.

Access to any implicit cache AccessType.

Returns:AccessType

The implicit cache AccessType

Annotations
@Override
getImplicitNamingStrategyback to summary
public ImplicitNamingStrategy getImplicitNamingStrategy()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getImplicitNamingStrategy.

Annotations
@Override
getMappingDefaultsback to summary
public MappingDefaults getMappingDefaults()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getMappingDefaults.

Doc from org.hibernate.boot.spi.MetadataBuildingOptions.getMappingDefaults.

Access to the MappingDefaults.

Annotations
@Override
getPhysicalNamingStrategyback to summary
public PhysicalNamingStrategy getPhysicalNamingStrategy()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getPhysicalNamingStrategy.

Annotations
@Override
getSchemaCharsetback to summary
public String getSchemaCharset()

Overrides default org.hibernate.boot.spi.MetadataBuildingOptions.getSchemaCharset.

Annotations
@Override
getServiceRegistryback to summary
public StandardServiceRegistry getServiceRegistry()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getServiceRegistry.

Doc from org.hibernate.boot.spi.MetadataBuildingOptions.getServiceRegistry.

Access to the StandardServiceRegistry.

Annotations
@Override
getSharedCacheModeback to summary
public SharedCacheMode getSharedCacheMode()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getSharedCacheMode.

Doc from org.hibernate.boot.spi.MetadataBuildingOptions.getSharedCacheMode.

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

Returns:SharedCacheMode

The SharedCacheMode

Annotations
@Override
getSourceProcessOrderingback to summary
public List<MetadataSourceType> getSourceProcessOrdering()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getSourceProcessOrdering.

Doc from org.hibernate.boot.spi.MetadataBuildingOptions.getSourceProcessOrdering.

Retrieve the ordering in which sources should be processed.

Returns:List<MetadataSourceType>

The order in which sources should be processed.

Annotations
@Override
getTimeZoneSupportback to summary
public TimeZoneSupport getTimeZoneSupport()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getTimeZoneSupport.

Returns:TimeZoneSupport

Doc from org.hibernate.boot.spi.MetadataBuildingOptions.getTimeZoneSupport.

the TimeZoneSupport of the configured org.hibernate.dialect.Dialect

Annotations
@Override
getTypeConfigurationback to summary
public TypeConfiguration getTypeConfiguration()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getTypeConfiguration.

Returns:TypeConfiguration

Doc from org.hibernate.boot.spi.MetadataBuildingOptions.getTypeConfiguration.

the TypeConfiguration belonging to the BootstrapContext

Annotations
@Override
getWrapperArrayHandlingback to summary
public WrapperArrayHandling getWrapperArrayHandling()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getWrapperArrayHandling.

Returns:WrapperArrayHandling

Doc from org.hibernate.boot.spi.MetadataBuildingOptions.getWrapperArrayHandling.

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

Annotations
@Override
ignoreExplicitDiscriminatorsForJoinedInheritanceback to summary
public boolean ignoreExplicitDiscriminatorsForJoinedInheritance()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.ignoreExplicitDiscriminatorsForJoinedInheritance.

Doc from org.hibernate.boot.spi.MetadataBuildingOptions.ignoreExplicitDiscriminatorsForJoinedInheritance.

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

Returns:boolean

true indicates they should be ignored; false indicates they should not be ignored.

Annotations
@Override
isAllowExtensionsInCdiback to summary
public boolean isAllowExtensionsInCdi()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.isAllowExtensionsInCdi.

Doc from org.hibernate.boot.spi.MetadataBuildingOptions.isAllowExtensionsInCdi.

Check to see if extensions can be hosted in CDI

Annotations
@Override
isMultiTenancyEnabledback to summary
public boolean isMultiTenancyEnabled()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.isMultiTenancyEnabled.

Doc from org.hibernate.boot.spi.MetadataBuildingOptions.isMultiTenancyEnabled.

Is multi-tenancy enabled?

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

Returns:boolean

true is multi-tenancy is enabled

Annotations
@Override
isNoConstraintByDefaultback to summary
public boolean isNoConstraintByDefault()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.isNoConstraintByDefault.

Doc from org.hibernate.boot.spi.MetadataBuildingOptions.isNoConstraintByDefault.

Should we disable constraint creation when jakarta.persistence.ConstraintMode#PROVIDER_DEFAULT?

Returns:boolean

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

Annotations
@Override
isSpecjProprietarySyntaxEnabledback to summary
public boolean isSpecjProprietarySyntaxEnabled()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.isSpecjProprietarySyntaxEnabled.

Annotations
@Override
isXmlMappingEnabledback to summary
public boolean isXmlMappingEnabled()

Overrides default org.hibernate.boot.spi.MetadataBuildingOptions.isXmlMappingEnabled.

Annotations
@Override
shouldImplicitlyForceDiscriminatorInSelectback to summary
public boolean shouldImplicitlyForceDiscriminatorInSelect()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.shouldImplicitlyForceDiscriminatorInSelect.

Doc from org.hibernate.boot.spi.MetadataBuildingOptions.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:boolean

true indicates we should force the discriminator in selects for any mappings which do not say explicitly.

Annotations
@Override
useNationalizedCharacterDataback to summary
public boolean useNationalizedCharacterData()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.useNationalizedCharacterData.

Doc from org.hibernate.boot.spi.MetadataBuildingOptions.useNationalizedCharacterData.

Should we use nationalized variants of character data by default?

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

Returns:boolean

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

Annotations
@Override