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, .Map, javax.persistence.SharedCacheMode, org.hibernate.HibernateException, .MultiTenancyStrategy, org.hibernate.annotations.common.reflection.ReflectionManager, org.hibernate.boot.AttributeConverterInfo, .CacheRegionDefinition, org.hibernate.boot.archive.scan.spi.ScanEnvironment, .ScanOptions, org.hibernate.boot.archive.spi.ArchiveDescriptorFactory, org.hibernate.boot.model.IdGeneratorStrategyInterpreter, org.hibernate.boot.model.naming.ImplicitNamingStrategy, .PhysicalNamingStrategy, org.hibernate.boot.model.relational.AuxiliaryDatabaseObject, org.hibernate.boot.registry.StandardServiceRegistry, org.hibernate.cache.spi.access.AccessType, org.hibernate.cfg.MetadataSourceType, org.hibernate.dialect.function.SQLFunction, org.jboss.jandex.IndexView
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 ArchiveDescriptorFactory
getArchiveDescriptorFactory()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getArchiveDescriptorFactory.

Access to the ArchiveDescriptorFactory to be used for scanning
public List<AttributeConverterInfo>
getAttributeConverters()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getAttributeConverters.

Access to collected AttributeConverter definitions.
public List<AuxiliaryDatabaseObject>
getAuxiliaryDatabaseObjectList()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getAuxiliaryDatabaseObjectList.

Access to any AuxiliaryDatabaseObject explicitly registered with the MetadataBuilder.
public List<BasicTypeRegistration>
getBasicTypeRegistrations()

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

Access the list of BasicType registrations.
public List<CacheRegionDefinition>
getCacheRegionDefinitions()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getCacheRegionDefinitions.

Access to all explicit cache region mappings.
public IdGeneratorStrategyInterpreter
getIdGenerationTypeInterpreter()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getIdGenerationTypeInterpreter.

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 IndexView
getJandexView()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getJandexView.

Access to the Jandex index passed by call to org.hibernate.boot.MetadataBuilder#applyIndexView(org.jboss.jandex.IndexView), if any.
public MappingDefaults
getMappingDefaults()

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

Access to the mapping defaults.
public MultiTenancyStrategy
getMultiTenancyStrategy()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getMultiTenancyStrategy.

Access to the MultiTenancyStrategy for this environment.
public PhysicalNamingStrategy
getPhysicalNamingStrategy()

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

public ReflectionManager
getReflectionManager()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getReflectionManager.

Retrieve the Hibernate Commons Annotations ReflectionManager to use.
public ScanEnvironment
getScanEnvironment()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getScanEnvironment.

Access to the environment for scanning.
public Object
getScanner()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getScanner.

Access to the Scanner to be used for scanning.
public ScanOptions
getScanOptions()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getScanOptions.

Access to the options to be used for scanning
public String
getSchemaCharset()

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

public StandardServiceRegistry
getServiceRegistry()

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

Access to the service registry.
public SharedCacheMode
getSharedCacheMode()

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

Access to the SharedCacheMode for determining whether we should perform second level caching or not.
public List<MetadataSourceType>
getSourceProcessOrdering()

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

Retrieve the ordering in which sources should be processed.
public Map<String, SQLFunction>
getSqlFunctions()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getSqlFunctions.

Access to any SQL functions explicitly registered with the MetadataBuilder.
public ClassLoader
getTempClassLoader()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getTempClassLoader.

Access the temporary ClassLoader passed to us as defined by javax.persistence.spi.PersistenceUnitInfo#getNewTempClassLoader(), if any.
public boolean
ignoreExplicitDiscriminatorsForJoinedInheritance()

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

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

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

Should we create constraint by 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 (e.g. NVARCHAR rather than VARCHAR) 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()
getArchiveDescriptorFactoryback to summary
public ArchiveDescriptorFactory getArchiveDescriptorFactory()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getArchiveDescriptorFactory.

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

Access to the ArchiveDescriptorFactory to be used for scanning

Returns:ArchiveDescriptorFactory

The ArchiveDescriptorFactory

Annotations
@Override
getAttributeConvertersback to summary
public List<AttributeConverterInfo> getAttributeConverters()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getAttributeConverters.

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

Access to collected AttributeConverter definitions.

Returns:List<AttributeConverterInfo>

The AttributeConverterInfo registered through MetadataBuilder

Annotations
@Override
getAuxiliaryDatabaseObjectListback to summary
public List<AuxiliaryDatabaseObject> getAuxiliaryDatabaseObjectList()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getAuxiliaryDatabaseObjectList.

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

Access to any AuxiliaryDatabaseObject explicitly registered with the MetadataBuilder. This does not include AuxiliaryDatabaseObject defined in mappings.

Returns:List<AuxiliaryDatabaseObject>

The AuxiliaryDatabaseObject registered through MetadataBuilder

Annotations
@Override
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 BasicType registrations. These are the BasicTypes explicitly registered via calls to:

Returns:List<BasicTypeRegistration>

The BasicType registrations

Annotations
@Override
getCacheRegionDefinitionsback to summary
public List<CacheRegionDefinition> getCacheRegionDefinitions()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getCacheRegionDefinitions.

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

Access to all explicit cache region mappings.

Returns:List<CacheRegionDefinition>

Explicit cache region mappings.

Annotations
@Override
getIdGenerationTypeInterpreterback to summary
public IdGeneratorStrategyInterpreter getIdGenerationTypeInterpreter()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getIdGenerationTypeInterpreter.

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
getJandexViewback to summary
public IndexView getJandexView()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getJandexView.

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

Access to the Jandex index passed by call to org.hibernate.boot.MetadataBuilder#applyIndexView(org.jboss.jandex.IndexView), if any.

Returns:IndexView

The Jandex index

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 mapping defaults.

Returns:MappingDefaults

The mapping defaults

Annotations
@Override
getMultiTenancyStrategyback to summary
public MultiTenancyStrategy getMultiTenancyStrategy()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getMultiTenancyStrategy.

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

Access to the MultiTenancyStrategy for this environment.

Returns:MultiTenancyStrategy

The MultiTenancyStrategy

Annotations
@Override
getPhysicalNamingStrategyback to summary
public PhysicalNamingStrategy getPhysicalNamingStrategy()

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

Annotations
@Override
getReflectionManagerback to summary
public ReflectionManager getReflectionManager()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getReflectionManager.

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

Retrieve the Hibernate Commons Annotations ReflectionManager to use.

Returns:ReflectionManager

The Hibernate Commons Annotations ReflectionManager to use.

Annotations
@Override
getScanEnvironmentback to summary
public ScanEnvironment getScanEnvironment()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getScanEnvironment.

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

Access to the environment for scanning. Consider this temporary; see discussion on ScanEnvironment

Returns:ScanEnvironment

The scan environment

Annotations
@Override
getScannerback to summary
public Object getScanner()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getScanner.

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

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:Object

The scanner

Annotations
@Override
getScanOptionsback to summary
public ScanOptions getScanOptions()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getScanOptions.

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

Access to the options to be used for scanning

Returns:ScanOptions

The scan options

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 service registry.

Returns:StandardServiceRegistry

The service registry

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 for determining whether we should perform second level caching or not.

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
getSqlFunctionsback to summary
public Map<String, SQLFunction> getSqlFunctions()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getSqlFunctions.

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

Access to any SQL functions explicitly registered with the MetadataBuilder. This does not include Dialect defined functions, etc.

Returns:Map<String, SQLFunction>

The SQLFunctions registered through MetadataBuilder

Annotations
@Override
getTempClassLoaderback to summary
public ClassLoader getTempClassLoader()

Implements org.hibernate.boot.spi.MetadataBuildingOptions.getTempClassLoader.

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

Access the temporary ClassLoader passed to us as defined by javax.persistence.spi.PersistenceUnitInfo#getNewTempClassLoader(), if any.

Returns:ClassLoader

The tempo ClassLoader

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
isNoConstraintByDefaultback to summary
public boolean isNoConstraintByDefault()

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

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

Should we create constraint by default?

Returns:boolean

true if not create constraint by default; false otherwise.

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 (e.g. NVARCHAR rather than VARCHAR) by default?

Returns:boolean

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

Annotations
@Override