Package org.hibernate.boot.spi
Interface MetadataBuildingOptions
-
- All Known Implementing Classes:
AbstractDelegatingMetadataBuildingOptions
public interface MetadataBuildingOptions
Describes the options used while building the Metadata object (duringMetadataBuilder.build()
processing).- Since:
- 5.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description boolean
createImplicitDiscriminatorsForJoinedInheritance()
Whether we should do discrimination implicitly joined subclass style inheritance when no discriminator info is provided.ArchiveDescriptorFactory
getArchiveDescriptorFactory()
Deprecated.UseBootstrapContext.getArchiveDescriptorFactory()
instead.java.util.List<AttributeConverterInfo>
getAttributeConverters()
Deprecated.UseBootstrapContext.getAttributeConverters()
insteadjava.util.List<AuxiliaryDatabaseObject>
getAuxiliaryDatabaseObjectList()
Deprecated.UseBootstrapContext.getAuxiliaryDatabaseObjectList()
instead.java.util.List<BasicTypeRegistration>
getBasicTypeRegistrations()
Access the list of BasicType registrations.java.util.List<CacheRegionDefinition>
getCacheRegionDefinitions()
Deprecated.UseBootstrapContext.getClassmateContext()
instead.IdGeneratorStrategyInterpreter
getIdGenerationTypeInterpreter()
AccessType
getImplicitCacheAccessType()
Access to any implicit cache AccessType.ImplicitNamingStrategy
getImplicitNamingStrategy()
org.jboss.jandex.IndexView
getJandexView()
Deprecated.UseBootstrapContext.getJandexView()
instead.MappingDefaults
getMappingDefaults()
Access to the mapping defaults.MultiTenancyStrategy
getMultiTenancyStrategy()
Access to the MultiTenancyStrategy for this environment.PhysicalNamingStrategy
getPhysicalNamingStrategy()
org.hibernate.annotations.common.reflection.ReflectionManager
getReflectionManager()
Deprecated.UseBootstrapContext.getReflectionManager()
instead, The plan is to remove firstgetReflectionManager()
keepingBootstrapContext.getReflectionManager()
till the migration from Hibernate Commons Annotations to Jandex.ScanEnvironment
getScanEnvironment()
Deprecated.UseBootstrapContext.getScanEnvironment()
instead.java.lang.Object
getScanner()
Deprecated.UseBootstrapContext.getScanner()
instead.ScanOptions
getScanOptions()
Deprecated.UseBootstrapContext.getScanOptions()
instead.default java.lang.String
getSchemaCharset()
StandardServiceRegistry
getServiceRegistry()
Access to the service registry.SharedCacheMode
getSharedCacheMode()
Access to the SharedCacheMode for determining whether we should perform second level caching or not.java.util.List<MetadataSourceType>
getSourceProcessOrdering()
Retrieve the ordering in which sources should be processed.java.util.Map<java.lang.String,SQLFunction>
getSqlFunctions()
Deprecated.UseBootstrapContext.getSqlFunctions()
instead.java.lang.ClassLoader
getTempClassLoader()
Deprecated.UseBootstrapContext.getJpaTempClassLoader()
instead.boolean
ignoreExplicitDiscriminatorsForJoinedInheritance()
Whether explicit discriminator declarations should be ignored for joined subclass style inheritance.boolean
isSpecjProprietarySyntaxEnabled()
boolean
shouldImplicitlyForceDiscriminatorInSelect()
Whether we should implicitly force discriminators into SQL selects.boolean
useNationalizedCharacterData()
Should we use nationalized variants of character data (e.g.
-
-
-
Method Detail
-
getServiceRegistry
StandardServiceRegistry getServiceRegistry()
Access to the service registry.- Returns:
- The service registry
-
getMappingDefaults
MappingDefaults getMappingDefaults()
Access to the mapping defaults.- Returns:
- The mapping defaults
-
getBasicTypeRegistrations
java.util.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, java.lang.String[])
MetadataBuilder.applyBasicType(org.hibernate.usertype.CompositeUserType, java.lang.String[])
- Returns:
- The BasicType registrations
-
getReflectionManager
@Deprecated org.hibernate.annotations.common.reflection.ReflectionManager getReflectionManager()
Deprecated.UseBootstrapContext.getReflectionManager()
instead, The plan is to remove firstgetReflectionManager()
keepingBootstrapContext.getReflectionManager()
till the migration from Hibernate Commons Annotations to Jandex.Retrieve the Hibernate Commons Annotations ReflectionManager to use.- Returns:
- The Hibernate Commons Annotations ReflectionManager to use.
-
getJandexView
@Deprecated org.jboss.jandex.IndexView getJandexView()
Deprecated.UseBootstrapContext.getJandexView()
instead.Access to the Jandex index passed by call toMetadataBuilder.applyIndexView(org.jboss.jandex.IndexView)
, if any.- Returns:
- The Jandex index
-
getScanOptions
@Deprecated ScanOptions getScanOptions()
Deprecated.UseBootstrapContext.getScanOptions()
instead.Access to the options to be used for scanning- Returns:
- The scan options
-
getScanEnvironment
@Deprecated ScanEnvironment getScanEnvironment()
Deprecated.UseBootstrapContext.getScanEnvironment()
instead.Access to the environment for scanning. Consider this temporary; see discussion onScanEnvironment
- Returns:
- The scan environment
-
getScanner
@Deprecated java.lang.Object getScanner()
Deprecated.UseBootstrapContext.getScanner()
instead.Access to the Scanner to be used for scanning. Can be:- A Scanner instance
- A Class reference to the Scanner implementor
- A String naming the Scanner implementor
- Returns:
- The scanner
-
getArchiveDescriptorFactory
@Deprecated ArchiveDescriptorFactory getArchiveDescriptorFactory()
Deprecated.UseBootstrapContext.getArchiveDescriptorFactory()
instead.Access to the ArchiveDescriptorFactory to be used for scanning- Returns:
- The ArchiveDescriptorFactory
-
getTempClassLoader
@Deprecated java.lang.ClassLoader getTempClassLoader()
Deprecated.UseBootstrapContext.getJpaTempClassLoader()
instead.Access the temporary ClassLoader passed to us as defined byPersistenceUnitInfo.getNewTempClassLoader()
, if any.- Returns:
- The tempo ClassLoader
-
getImplicitNamingStrategy
ImplicitNamingStrategy getImplicitNamingStrategy()
-
getPhysicalNamingStrategy
PhysicalNamingStrategy getPhysicalNamingStrategy()
-
getSharedCacheMode
SharedCacheMode getSharedCacheMode()
Access to the SharedCacheMode for determining whether we should perform second level caching or not.- Returns:
- The SharedCacheMode
-
getImplicitCacheAccessType
AccessType getImplicitCacheAccessType()
Access to any implicit cache AccessType.- Returns:
- The implicit cache AccessType
-
getMultiTenancyStrategy
MultiTenancyStrategy getMultiTenancyStrategy()
Access to the MultiTenancyStrategy for this environment.- Returns:
- The MultiTenancyStrategy
-
getIdGenerationTypeInterpreter
IdGeneratorStrategyInterpreter getIdGenerationTypeInterpreter()
-
getCacheRegionDefinitions
@Deprecated java.util.List<CacheRegionDefinition> getCacheRegionDefinitions()
Deprecated.UseBootstrapContext.getClassmateContext()
instead.Access to all explicit cache region mappings.- Returns:
- Explicit cache region mappings.
-
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)
,AvailableSettings.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)
,AvailableSettings.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:
AvailableSettings.FORCE_DISCRIMINATOR_IN_SELECTS_BY_DEFAULT
-
useNationalizedCharacterData
boolean useNationalizedCharacterData()
Should we use nationalized variants of character data (e.g. NVARCHAR rather than VARCHAR) by default?- Returns:
true
if nationalized character data should be used by default;false
otherwise.- See Also:
MetadataBuilder.enableGlobalNationalizedCharacterDataSupport(boolean)
,AvailableSettings.USE_NATIONALIZED_CHARACTER_DATA
-
isSpecjProprietarySyntaxEnabled
boolean isSpecjProprietarySyntaxEnabled()
-
getSourceProcessOrdering
java.util.List<MetadataSourceType> getSourceProcessOrdering()
Retrieve the ordering in which sources should be processed.- Returns:
- The order in which sources should be processed.
-
getSchemaCharset
default java.lang.String getSchemaCharset()
-
getSqlFunctions
@Deprecated java.util.Map<java.lang.String,SQLFunction> getSqlFunctions()
Deprecated.UseBootstrapContext.getSqlFunctions()
instead.Access to any SQL functions explicitly registered with the MetadataBuilder. This does not include Dialect defined functions, etc.- Returns:
- The SQLFunctions registered through MetadataBuilder
-
getAuxiliaryDatabaseObjectList
@Deprecated java.util.List<AuxiliaryDatabaseObject> getAuxiliaryDatabaseObjectList()
Deprecated.UseBootstrapContext.getAuxiliaryDatabaseObjectList()
instead.Access to any AuxiliaryDatabaseObject explicitly registered with the MetadataBuilder. This does not include AuxiliaryDatabaseObject defined in mappings.- Returns:
- The AuxiliaryDatabaseObject registered through MetadataBuilder
-
getAttributeConverters
@Deprecated java.util.List<AttributeConverterInfo> getAttributeConverters()
Deprecated.UseBootstrapContext.getAttributeConverters()
insteadAccess to collected AttributeConverter definitions.- Returns:
- The AttributeConverterInfo registered through MetadataBuilder
-
-