org.hibernate.search.mapper.orm.mapping

Interface SearchMapping

public interface SearchMapping

The Hibernate Search mapping between the Hibernate ORM model and the backend(s).

Provides entry points to Hibernate Search operations that are not tied to a specific ORM session.

Method Summary

Modifier and Type	Method and Description
Collection<? extends SearchIndexedEntity>	allIndexedEntities()
Backend	getBackend(String backendName)
IndexManager	getIndexManager(String indexName)
SearchIndexedEntity	indexedEntity(Class<?> entityType)
SearchIndexedEntity	indexedEntity(String entityName)
default <T> SearchScope<T>	scope(Class<T> type) Create a SearchScope limited to the given type.
<T> SearchScope<T>	scope(Class<T> expectedSuperType, Collection<String> entityNames) Create a SearchScope limited to entity types referenced by their name.
default <T> SearchScope<T>	scope(Class<T> expectedSuperType, String entityName) Create a SearchScope limited to entity types referenced by their name.
<T> SearchScope<T>	scope(Collection<? extends Class<? extends T>> types) Create a SearchScope limited to the given types.
javax.persistence.EntityManagerFactory	toEntityManagerFactory()
SessionFactory	toOrmSessionFactory()

Method Detail

scope

default <T> SearchScope<T> scope(Class<T> type)

Create a SearchScope limited to the given type.

Type Parameters:

T - A type to include in the scope.

Parameters:

type - A type to include in the scope.

Returns:

The created scope.

See Also:

SearchScope

scope

<T> SearchScope<T> scope(Collection<? extends Class<? extends T>> types)

Create a SearchScope limited to the given types.

Type Parameters:

T - A supertype of all types to include in the scope.

Parameters:

types - A collection of types to include in the scope.

Returns:

The created scope.

See Also:

SearchScope

scope

default <T> SearchScope<T> scope(Class<T> expectedSuperType,
                                 String entityName)

Create a SearchScope limited to entity types referenced by their name.

Type Parameters:

T - A supertype of all entity types to include in the scope.

Parameters:

expectedSuperType - A supertype of all entity types to include in the scope.

entityName - An entity name. See Entity.name().

Returns:

The created scope.

See Also:

SearchScope

scope

<T> SearchScope<T> scope(Class<T> expectedSuperType,
                         Collection<String> entityNames)

Create a SearchScope limited to entity types referenced by their name.

Type Parameters:

T - A supertype of all entity types to include in the scope.

Parameters:

expectedSuperType - A supertype of all entity types to include in the scope.

entityNames - A collection of entity names. See Entity.name().

Returns:

The created scope.

See Also:

SearchScope

toEntityManagerFactory

javax.persistence.EntityManagerFactory toEntityManagerFactory()

Returns:

The underlying EntityManagerFactory used by this SearchMapping.

toOrmSessionFactory

SessionFactory toOrmSessionFactory()

Returns:

The underlying SessionFactory used by this SearchMapping.

indexedEntity

SearchIndexedEntity indexedEntity(Class<?> entityType)

Parameters:

entityType - The type of an indexed entity. This must be the exact type; passing the type of a mapped-superclass for example will not work.

Returns:

A SearchIndexedEntity for the indexed entity with the exact given type.

Throws:

SearchException - If the type does not match any indexed entity.

indexedEntity

SearchIndexedEntity indexedEntity(String entityName)

Parameters:

entityName - The name of an indexed entity. See Entity.name().

Returns:

A SearchIndexedEntity for the indexed entity with the given name.

Throws:

SearchException - If the name does not match any indexed entity.

allIndexedEntities

Collection<? extends SearchIndexedEntity> allIndexedEntities()

Returns:

A collection containing one SearchIndexedEntity for each indexed entity

getIndexManager

IndexManager getIndexManager(String indexName)

Parameters:

indexName - The key to get the required IndexManager instance.

Returns:

The index manager for the index having indexName as name.

getBackend

Backend getBackend(String backendName)

Parameters:

backendName - The key to get the required Backend instance.

Returns:

The backend having backendName as name.