org.hibernate.engine
Interface SessionFactoryImplementor

All Superinterfaces:

Mapping, Referenceable, Serializable, SessionFactory

All Known Implementing Classes:

SessionFactoryImpl

public interface SessionFactoryImplementor
extends Mapping, SessionFactory

Defines the internal contract between the SessionFactory and other parts of Hibernate such as implementors of Type.

Author:

Gavin King

See Also:

SessionFactory, SessionFactoryImpl

Method Summary

Map	getAllSecondLevelCacheRegions() Get a map of all the second level cache regions currently maintained in this session factory.
CollectionPersister	getCollectionPersister(String role) Get the persister object for a collection role.
Set<String>	getCollectionRolesByEntityParticipant(String entityName) Retrieves a set of all the collection roles in which the given entity is a participant, as either an index or an element.
ConnectionProvider	getConnectionProvider() Get the connection provider
Dialect	getDialect() Get the SQL dialect.
EntityNotFoundDelegate	getEntityNotFoundDelegate()
EntityPersister	getEntityPersister(String entityName) Get the persister for the named entity
SessionFactoryObserver	getFactoryObserver() Return the SessionFactoryObserver attached to the SessionFactory if any
FetchProfile	getFetchProfile(String name) Retrieve fetch profile by name.
IdentifierGenerator	getIdentifierGenerator(String rootEntityName) Get the identifier generator for the hierarchy
String[]	getImplementors(String className) Get the names of all persistent classes that implement/extend the given interface/class
String	getImportedClassName(String name) Get a class name, using query language imports
Interceptor	getInterceptor() Get the factory scoped interceptor for this factory.
NamedQueryDefinition	getNamedQuery(String queryName)
NamedSQLQueryDefinition	getNamedSQLQuery(String queryName)
Properties	getProperties() Get a copy of the Properties used to configure this session factory.
QueryCache	getQueryCache() Get the default query cache
QueryCache	getQueryCache(String regionName) Get a particular named query cache, or the default cache
QueryPlanCache	getQueryPlanCache()
ResultSetMappingDefinition	getResultSetMapping(String name)
String[]	getReturnAliases(String queryString) Get the return aliases of a query
Type[]	getReturnTypes(String queryString) Get the return types of a query
Region	getSecondLevelCacheRegion(String regionName) Get a named second-level cache region
Settings	getSettings()
SQLExceptionConverter	getSQLExceptionConverter() Retrieves the SQLExceptionConverter in effect for this SessionFactory.
SQLFunctionRegistry	getSqlFunctionRegistry()
StatisticsImplementor	getStatisticsImplementor() Statistics SPI
TransactionManager	getTransactionManager() Get the JTA transaction manager
TypeResolver	getTypeResolver() Retrieve the Type resolver associated with this factory.
UpdateTimestampsCache	getUpdateTimestampsCache() Get the cache of table update timestamps
Session	openSession(Connection connection, boolean flushBeforeCompletionEnabled, boolean autoCloseSessionEnabled, ConnectionReleaseMode connectionReleaseMode) Open a session conforming to the given parameters.
Session	openTemporarySession() Get a nontransactional "current" session for Hibernate EntityManager

Methods inherited from interface org.hibernate.engine.Mapping

getIdentifierGeneratorFactory, getIdentifierPropertyName, getIdentifierType, getReferencedPropertyType

Methods inherited from interface org.hibernate.SessionFactory

close, containsFetchProfileDefinition, evict, evict, evictCollection, evictCollection, evictEntity, evictEntity, evictQueries, evictQueries, getAllClassMetadata, getAllCollectionMetadata, getCache, getClassMetadata, getClassMetadata, getCollectionMetadata, getCurrentSession, getDefinedFilterNames, getFilterDefinition, getStatistics, getTypeHelper, isClosed, openSession, openSession, openSession, openSession, openStatelessSession, openStatelessSession

Methods inherited from interface javax.naming.Referenceable

getReference

Method Detail

getTypeResolver

TypeResolver getTypeResolver()

Retrieve the Type resolver associated with this factory.

Returns:

The type resolver

getProperties

Properties getProperties()

Get a copy of the Properties used to configure this session factory.

Returns:

The properties.

getEntityPersister

EntityPersister getEntityPersister(String entityName)
                                   throws MappingException

Get the persister for the named entity

Parameters:

entityName - The name of the entity for which to retrieve the persister.

Returns:

The persister

Throws:

MappingException - Indicates persister could not be found with that name.

getCollectionPersister

CollectionPersister getCollectionPersister(String role)
                                           throws MappingException

Get the persister object for a collection role.

Parameters:

role - The role (name) of the collection for which to retrieve the persister.

Returns:

The persister

Throws:

MappingException - Indicates persister could not be found with that role.

getDialect

Dialect getDialect()

Get the SQL dialect.

Shorthand for getSettings().Settings.getDialect()

Returns:

The dialect

getInterceptor

Interceptor getInterceptor()

Get the factory scoped interceptor for this factory.

Returns:

The factory scope interceptor, or null if none.

getQueryPlanCache

QueryPlanCache getQueryPlanCache()

getReturnTypes

Type[] getReturnTypes(String queryString)
                      throws HibernateException

Get the return types of a query

Throws:

HibernateException

getReturnAliases

String[] getReturnAliases(String queryString)
                          throws HibernateException

Get the return aliases of a query

Throws:

HibernateException

getConnectionProvider

ConnectionProvider getConnectionProvider()

Get the connection provider

getImplementors

String[] getImplementors(String className)
                         throws MappingException

Get the names of all persistent classes that implement/extend the given interface/class

Throws:

MappingException

getImportedClassName

String getImportedClassName(String name)

Get a class name, using query language imports

getTransactionManager

TransactionManager getTransactionManager()

Get the JTA transaction manager

getQueryCache

QueryCache getQueryCache()

Get the default query cache

getQueryCache

QueryCache getQueryCache(String regionName)
                         throws HibernateException

Get a particular named query cache, or the default cache

Parameters:

regionName - the name of the cache region, or null for the default query cache

Returns:

the existing cache, or a newly created cache if none by that region name

Throws:

HibernateException

getUpdateTimestampsCache

UpdateTimestampsCache getUpdateTimestampsCache()

Get the cache of table update timestamps

getStatisticsImplementor

StatisticsImplementor getStatisticsImplementor()

Statistics SPI

getNamedQuery

NamedQueryDefinition getNamedQuery(String queryName)

getNamedSQLQuery

NamedSQLQueryDefinition getNamedSQLQuery(String queryName)

getResultSetMapping

ResultSetMappingDefinition getResultSetMapping(String name)

getIdentifierGenerator

IdentifierGenerator getIdentifierGenerator(String rootEntityName)

Get the identifier generator for the hierarchy

getSecondLevelCacheRegion

Region getSecondLevelCacheRegion(String regionName)

Get a named second-level cache region

Parameters:

regionName - The name of the region to retrieve.

Returns:

The region

getAllSecondLevelCacheRegions

Map getAllSecondLevelCacheRegions()

Get a map of all the second level cache regions currently maintained in this session factory. The map is structured with the region name as the key and the Region instances as the values.

Returns:

The map of regions

getSQLExceptionConverter

SQLExceptionConverter getSQLExceptionConverter()

Retrieves the SQLExceptionConverter in effect for this SessionFactory.

Returns:

The SQLExceptionConverter for this SessionFactory.

getSettings

Settings getSettings()

openTemporarySession

Session openTemporarySession()
                             throws HibernateException

Get a nontransactional "current" session for Hibernate EntityManager

Throws:

HibernateException

openSession

Session openSession(Connection connection,
                    boolean flushBeforeCompletionEnabled,
                    boolean autoCloseSessionEnabled,
                    ConnectionReleaseMode connectionReleaseMode)
                    throws HibernateException

Open a session conforming to the given parameters. Used mainly by JTASessionContext for current session processing.

Parameters:

connection - The external jdbc connection to use, if one (i.e., optional).

flushBeforeCompletionEnabled - Should the session be auto-flushed prior to transaction completion?

autoCloseSessionEnabled - Should the session be auto-closed after transaction completion?

connectionReleaseMode - The release mode for managed jdbc connections.

Returns:

An appropriate session.

Throws:

HibernateException

getCollectionRolesByEntityParticipant

Set<String> getCollectionRolesByEntityParticipant(String entityName)

Retrieves a set of all the collection roles in which the given entity is a participant, as either an index or an element.

Parameters:

entityName - The entity name for which to get the collection roles.

Returns:

set of all the collection roles in which the given entityName participates.

getEntityNotFoundDelegate

EntityNotFoundDelegate getEntityNotFoundDelegate()

getSqlFunctionRegistry

SQLFunctionRegistry getSqlFunctionRegistry()

getFetchProfile

FetchProfile getFetchProfile(String name)

Retrieve fetch profile by name.

Parameters:

name - The name of the profile to retrieve.

Returns:

The profile definition

getFactoryObserver

SessionFactoryObserver getFactoryObserver()

Return the SessionFactoryObserver attached to the SessionFactory if any

Returns: