Hibernate Core 3.6.10.Final · org.hibernate.cfg.Configuration

Modifier and Type	Class and Description
private static class	Configuration.CacheHolder
protected class	Configuration.MappingsImpl Deprecated as a consequence of `ExtendedMappings` being deprecated. Internal implementation of the Mappings interface giving access to the Configuration's internal `metadata repository` state (`Configuration#classes`, `Configuration#tables`, etc).
protected class	Configuration.MetadataSourceQueue
pack-priv class	Configuration.ObjectNameNormalizerImpl

Modifier and Type	Field and Description
private Map<String, AnyMetaDef>	anyMetaDefs
public static final String	ARTEFACT_PROCESSING_ORDER
protected List<AuxiliaryDatabaseObject>	auxiliaryDatabaseObjects
private List<Configuration.CacheHolder>	caches
protected Map<String, PersistentClass>	classes
private Map<String, AnnotatedClassType>	classTypes
protected Map<String, Collection>	collections
protected Map<K, V>	columnNameBindingPerTable
public static final MetadataSourceType[]	DEFAULT_ARTEFACT_PROCESSING_ORDER
public static final String	DEFAULT_CACHE_CONCURRENCY_STRATEGY Setting used to give the name of the default `org.hibernate.annotations.CacheConcurrencyStrategy` to use when either `@Cacheable` or `@Cache` is used.
private Set<String>	defaultNamedGenerators
private Set<String>	defaultNamedNativeQueryNames
private Set<String>	defaultNamedQueryNames
private Set<String>	defaultSqlResultSetMappingNames
private EntityNotFoundDelegate	entityNotFoundDelegate
private EntityResolver	entityResolver
private EntityTuplizerFactory	entityTuplizerFactory
private EventListeners	eventListeners
protected Map<ExtendsQueueEntry, ?>	extendsQueue
protected Map<String, FetchProfile>	fetchProfiles
protected Map<String, FilterDefinition>	filterDefinitions
private Map<String, Properties>	generatorTables
private DefaultIdentifierGeneratorFactory	identifierGeneratorFactory
protected Map<String, String>	imports
private boolean	inSecondPass
private Interceptor	interceptor
private boolean	isDefaultProcessed
private boolean	isValidatorNotPresentLogged
private Map<String, Map<String, Join>>	joins
private static final String	LEGACY_VALIDATOR_EVENT_LISTENER
private static Logger	log
private Map<String, String>	mappedByResolver
private Map<Class<?>, MappedSuperclass>	mappedSuperClasses
private transient Mapping	mapping
private List<MetadataSourceType>	metadataSourcePrecedence
protected Configuration.MetadataSourceQueue	metadataSourceQueue
private Map<String, IdGenerator>	namedGenerators
protected Map<String, NamedQueryDefinition>	namedQueries
protected Map<String, NamedSQLQueryDefinition>	namedSqlQueries
protected NamingStrategy	namingStrategy
pack-priv final ObjectNameNormalizer	normalizer
private PersisterClassProvider	persisterClassProvider
private Properties	properties
private Map<XClass, Map<String, PropertyData>>	propertiesAnnotatedWithIdAndToOne
private Map<XClass, Map<String, PropertyData>>	propertiesAnnotatedWithMapsId
protected List<Mappings.PropertyReference>	propertyReferences
private Map<String, String>	propertyRefResolver
private transient ReflectionManager	reflectionManager
private static final String	SEARCH_EVENT_LISTENER_REGISTERER_CLASS
private static final String	SEARCH_STARTUP_CLASS Class name of the class needed to enable Search.
private static final String	SEARCH_STARTUP_METHOD Method to call to enable Search.
protected List<SecondPass>	secondPasses
private SessionFactoryObserver	sessionFactoryObserver
protected final SettingsFactory	settingsFactory
private boolean	specjProprietarySyntaxEnabled
protected Map<String, SQLFunction>	sqlFunctions
protected Map<String, ResultSetMappingDefinition>	sqlResultSetMappings
protected Map<K, V>	tableNameBinding
protected Map<String, Table>	tables
protected Map<String, TypeDef>	typeDefs
private TypeResolver	typeResolver
private Map<Table, List<UniqueConstraintHolder>>	uniqueConstraintHoldersByTable
public static final String	USE_NEW_ID_GENERATOR_MAPPINGS Setting which indicates whether or not the new `org.hibernate.id.IdentifierGenerator` are used for AUTO, TABLE and SEQUENCE.
protected transient XMLHelper	xmlHelper

Access	Constructor and Description
protected	Configuration(SettingsFactory settingsFactory)
public	Configuration()

Method Summary

Modifier and Type	Method and Description
private XmlDocument	add(InputSource inputSource, String originType, String originName)
private XmlDocument	add(InputSource inputSource, Origin origin)
public void	add(XmlDocument metadataXml)
private XmlDocument	add(InputStream inputStream, final String type, final String name)
public Configuration	Returns: this (for method chaining) addAnnotatedClass(Class<T> The class containing annotations annotatedClass) Read metadata from the annotations associated with this class.
public void	addAuxiliaryDatabaseObject(AuxiliaryDatabaseObject object)
public Configuration	Returns: this (for method chaining purposes) addCacheableFile(File The cacheable mapping file to be added. xmlFile) Add a cached mapping file.
public Configuration	Returns: this (for method chaining purposes) addCacheableFile(String The name of the file to be added. This must be in a form useable to simply construct a `java.io.File` instance. xmlFile) Add a cacheable mapping file.
public Configuration	Returns: The dom "deserialized" from the cached file. addCacheableFileStrictly(File The xml file, not the bin! xmlFile) INTENDED FOR TESTSUITE USE ONLY!
public Configuration	Returns: this (for method chaining purposes) addClass(Class<T> The mapped class persistentClass) Read a mapping as an application resource using the convention that a class named `foo.bar.Foo` is mapped by a file `foo/bar/Foo.hbm.xml` which can be resolved as a classpath resource.
public Configuration	Returns: this (for method chaining purposes) addDirectory(File The directory dir) Read all mapping documents from a directory tree.
public Configuration	Returns: this (for method chaining purposes) addDocument(Document The DOM document doc) Read mappings from a DOM `Document`
public void	addFetchProfile(FetchProfile fetchProfile)
public Configuration	Returns: this (for method chaining purposes) addFile(String a path to a file xmlFile) Read mappings from a particular XML file
public Configuration	Returns: this (for method chaining purposes) addFile(final File a path to a file xmlFile) Read mappings from a particular XML file
public void	addFilterDefinition(FilterDefinition definition)
public Configuration	Returns: this (for method chaining purposes) addInputStream(InputStream The input stream containing a DOM. xmlInputStream) Read mappings from an `java.io.InputStream`.
public Configuration	Returns: this (for method chaining purposes) addJar(File a jar file jar) Read all mappings from a jar file Assumes that any file named `*.hbm.xml` is a mapping document.
public Configuration	Returns: this (for method chaining) addPackage(String java package name packageName) Read package-level metadata.
public Configuration	Returns: this for method chaining addProperties(Properties The properties to add. extraProperties) Add the given properties to ours.
private void	addProperties(Element parent)
public Configuration	Returns: this (for method chaining purposes) addResource(String The resource name resourceName, ClassLoader The class loader to use. classLoader) Read mappings as a application resource (i.e. classpath lookup).
public Configuration	Returns: this (for method chaining purposes) addResource(String The resource name resourceName) Read mappings as a application resourceName (i.e. classpath lookup) trying different class loaders.
public void	addSqlFunction(String functionName, SQLFunction function)
public Configuration	Returns: this (for method chaining purposes) addURL(URL The url for the mapping document to be read. url) Read mappings from a `URL`
public Configuration	Returns: this (for method chaining purposes) addXML(String an XML string xml) Read mappings from a `String`
private void	applyBeanValidationConstraintsOnDDL()
private void	applyCacheConcurrencyStrategy(Configuration.CacheHolder holder)
private void	applyCollectionCacheConcurrencyStrategy(Configuration.CacheHolder holder)
private void	applyConstraintsToDDL()
private void	applyHibernateValidatorLegacyConstraintsOnDDL()
public Mapping	buildMapping()
public void	buildMappings() Call this to ensure the mappings are fully compiled/built.
private void	buildRecursiveOrderedFkSecondPasses(List<FkSecondPass> The list containing the `FkSecondPass instances ready for processing.` `orderedFkSecondPasses,` `Map<String, Set<FkSecondPass>> Our lookup data structure to determine dependencies between tablesisADependencyOf, String Table name to start recursive algorithm.startTable, String The current table name used to check for 'new' dependencies.currentTable)` `Recursively builds a list of FkSecondPass instances ready to be processed in this order.`
public SessionFactory	Returns: The build `SessionFactory` buildSessionFactory() Create a `SessionFactory` using the properties and mappings in this configuration.
public Settings	Returns: The build settings buildSettings() Create an object-oriented view of the configuration properties
public Settings	buildSettings(Properties props)
private Settings	buildSettingsInternal(Properties props)
private void	buildUniqueKeyFromColumnNames(Table table, String keyName, String[] columnNames)
public Configuration	Returns: this for method chaining configure() Use the mappings and properties specified in an application resource named `hibernate.cfg.xml`.
public Configuration	Returns: this for method chaining configure(String The resource to use resource) Use the mappings and properties specified in the given application resource.
public Configuration	Returns: this for method chaining configure(URL URL from which you wish to load the configuration url) Use the mappings and properties specified in the given document.
public Configuration	Returns: this for method chaining configure(File File from which you wish to load the configuration configFile) Use the mappings and properties specified in the given application file.
public Configuration	Returns: A configuration configured via the `Document` configure(Document an XML document from which you wish to load the configuration document) Use the mappings and properties specified in the given XML document.
public Mappings	Returns: The created mappings createMappings() Create a new `Mappings` to add class and collection mappings to.
private void	createReflectionManager()
private void	createReflectionManager(MetadataProvider metadataProvider)
private File	determineCachedDomFile(File xmlFile)
private List<MetadataSourceType>	determineMetadataSourcePrecedence()
protected Configuration	Returns: this for method chaining doConfigure(InputStream The input stream from which to read stream, String The name to use in warning/error messages resourceName) Configure this configuration's state from the contents of the given input stream.
protected Configuration	Returns: this for method chaining doConfigure(Document The dom4j document doc) Parse a dom4j document conforming to the Hibernate Configuration DTD (`hibernate-configuration-3.0.dtd`) and use its information to configure this `Configuration`'s state
private void	enableBeanValidation()
private void	enableHibernateSearch() Tries to automatically register Hibernate Search event listeners by locating the appropriate bootstrap class and calling the `enableHibernateSearch` method.
private void	enableLegacyHibernateValidator()
protected ExtendsQueueEntry	findPossibleExtends()
public String[]	Returns: The sequence of DDL commands to drop the schema objects generateDropSchemaScript(Dialect The dialect for which to generate the drop script dialect) Generate DDL for dropping tables
public String[]	Returns: The sequence of DDL commands to create the schema objects generateSchemaCreationScript(Dialect The dialect for which to generate the creation script dialect)
public String[]	Returns: The sequence of DDL commands to apply the schema objects generateSchemaUpdateScript(Dialect The dialect for which to generate the creation script dialect, DatabaseMetadata The database catalog information for the database to be updated; needed to work out what should be created/altered databaseMetadata)
public PersistentClass	Returns: the entity mapping information getClassMapping(String An entity name. entityName) Get the mapping for a particular entity
public Iterator<PersistentClass>	Returns: Iterator of the entity mappings currently contained in the configuration. getClassMappings() Iterate the entity mappings
public Collection	Returns: The collection mapping information getCollectionMapping(String a collection role role) Get the mapping for a particular collection role
public Iterator<E>	Returns: Iterator of the collection mappings currently contained in the configuration. getCollectionMappings() Iterate the collection mappings
protected InputStream	Returns: The stream getConfigurationInputStream(String The resource to locate resource) Get the configuration file as an `InputStream`.
public EntityNotFoundDelegate	Returns: The user-supplied delegate getEntityNotFoundDelegate() Retrieve the user-supplied delegate to handle non-existent entity scenarios.
public EntityResolver	getEntityResolver()
public EntityTuplizerFactory	getEntityTuplizerFactory()
public EventListeners	getEventListeners()
public Map<K, V>	getFilterDefinitions()
private List<FkSecondPass>	Returns: Returns a list of all `secondPasses` instances which are a instance of `FkSecondPass`. getFKSecondPassesOnly()
public DefaultIdentifierGeneratorFactory	Returns: This configuration's IdentifierGeneratorFactory. getIdentifierGeneratorFactory() Retrieve the IdentifierGeneratorFactory in effect for this configuration.
public Map<String, String>	Returns: a mapping from "import" names to fully qualified class names getImports() Get the query language imports
private EventListeners	getInitializedEventListeners()
public Interceptor	Returns: The current `Interceptor` getInterceptor() Rterieve the configured `Interceptor`.
public Iterator<MappedSuperclass>	Returns: iterator over the MappedSuperclass mapping currently contained in the configuration. getMappedSuperclassMappings() Iterate the mapped super class mappings EXPERIMENTAL Consider this API as PRIVATE
public Map<String, NamedQueryDefinition>	getNamedQueries()
public Map<K, V>	getNamedSQLQueries()
public NamingStrategy	getNamingStrategy()
public PersisterClassProvider	getPersisterClassProvider()
public Properties	Returns: all properties getProperties() Get all properties
public String	Returns: The value curently associated with that property name; may be null. getProperty(String The name of the property propertyName) Get a property value by name
public ReflectionManager	getReflectionManager()
pack-priv RootClass	getRootClassMapping(String clazz)
public SessionFactoryObserver	getSessionFactoryObserver()
public Map<K, V>	getSqlFunctions()
public Map<K, V>	getSqlResultSetMappings()
public Iterator<Table>	Returns: Iterator of the table mappings currently contained in the configuration. getTableMappings() Iterate the table mappings
public TypeResolver	getTypeResolver()
private static boolean	isOrmXml(XmlDocument xmlDocument)
public Iterator<E>	iterateFetchProfiles()
private Iterator<IdentifierGenerator>	iterateGenerators(Dialect dialect)
public Configuration	Returns: this for ethod chaining mergeProperties(Properties The properties to merge properties) Adds the incoming properties to the internal properties structure, as long as the internal structure does not already contain an entry for the given key.
private void	originalSecondPassCompile()
private void	parseEvent(Element element)
private void	parseListener(Element element)
private void	parseMappingElement(Element mappingElement, String name)
private List<MetadataSourceType>	parsePrecedence(String s)
private void	parseSecurity(Element secNode)
private void	parseSessionFactory(Element sfNode, String name)
private void	processEndOfQueue(List<FkSecondPass> endOfQueueFkSecondPasses)
private int	processExtendsQueue()
private void	processFkSecondPassInOrder() Processes FKSecondPass instances trying to resolve any graph circularity (ie PK made of a many to one linking to an entity having a PK made of a ManyToOne ...).
private void	processSecondPassesOfType(Class<? extends SecondPass> type)
private void	readObject(ObjectInputStream ois)
public void	registerTypeOverride(BasicType The type to register. type) Allows registration of a type into the type registry.
public void	registerTypeOverride(UserType type, String[] keys)
public void	registerTypeOverride(CompositeUserType type, String[] keys)
protected void	reset()
protected void	secondPassCompile()
protected void	secondPassCompileForeignKeys(Table table, Set<E> done)
public Configuration	Returns: this for method chaining setCacheConcurrencyStrategy(String The name of the entity to which we shoudl associate these cache settings entityName, String The cache strategy to use concurrencyStrategy) Set up a cache for an entity class
public Configuration	Returns: this for method chaining setCacheConcurrencyStrategy(String The name of the entity to which we should associate these cache settings entityName, String The cache strategy to use concurrencyStrategy, String The name of the cache region to use region) Set up a cache for an entity class, giving an explicit region name
public void	setCacheConcurrencyStrategy(String entityName, String concurrencyStrategy, String region, boolean cacheLazyProperty)
public Configuration	Returns: this for method chaining setCollectionCacheConcurrencyStrategy(String The name of the collection to which we should associate these cache settings collectionRole, String The cache strategy to use concurrencyStrategy) Set up a cache for a collection role
public void	Returns: this for method chaining setCollectionCacheConcurrencyStrategy(String The name of the collection to which we should associate these cache settings collectionRole, String The cache strategy to use concurrencyStrategy, String The name of the cache region to use region) Set up a cache for a collection role, giving an explicit region name
public void	setEntityNotFoundDelegate(EntityNotFoundDelegate The delegate to use entityNotFoundDelegate) Specify a user-supplied delegate to be used to handle scenarios where an entity could not be located by specified id. This is mainly intended for EJB3 implementations to be able to control how proxy initialization errors should be handled...
public void	setEntityResolver(EntityResolver entity resolver to use entityResolver) Set a custom entity resolver.
public Configuration	Returns: this for method chaining setInterceptor(Interceptor The `Interceptor` to use for the `built` `SessionFactory`. interceptor) Set the current `Interceptor`
public void	setListener(String type, String listener)
public void	setListener(String type, Object listener)
public void	setListeners(String type, String[] listenerClasses)
public void	setListeners(String type, Object[] listeners)
public Configuration	Returns: this for method chaining setNamingStrategy(NamingStrategy the NamingStrategy to set namingStrategy) Set a custom naming strategy
public Configuration	setPersisterClassProvider(PersisterClassProvider implementation persisterClassProvider) Defines a custom persister class provider.
public void	setPrecedence(String precedence)
public Configuration	Returns: this for method chaining setProperties(Properties The new set of properties properties) Specify a completely new set of properties
public Configuration	Returns: this for method chaining setProperty(String The name of the property to set propertyName, String The new property value value) Set a property value by name
public void	setSessionFactoryObserver(SessionFactoryObserver sessionFactoryObserver)
private void	validate()
public void	validateSchema(Dialect dialect, DatabaseMetadata databaseMetadata)
private void	writeObject(ObjectOutputStream out)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

public Class Configuration

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary