Package org.hibernate.search.mapper.pojo.standalone.mapping

Interface SearchMapping

All Known Subinterfaces:

CloseableSearchMapping

@Incubating
public interface SearchMapping

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

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

Method Summary

Modifier and Type	Method	Description
Collection<? extends SearchIndexedEntity<?>>	allIndexedEntities()
Backend	backend()
Backend	backend(String backendName)
static SearchMappingBuilder	builder()
static SearchMappingBuilder	builder(MethodHandles.Lookup lookup)
SearchSession	createSession()
SearchSessionBuilder	createSessionWithOptions()
<E> SearchIndexedEntity<E>	indexedEntity(Class<E> entityType)
SearchIndexedEntity<?>	indexedEntity(String entityName)
IndexManager	indexManager(String indexName)
default <T> SearchScope<T>	scope(Class<T> type)	Create a SearchScope limited to the given type.
<T> SearchScope<T>	scope(Collection<? extends Class<? extends T>> types)	Create a SearchScope limited to the given types.

Method Details

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

createSession

SearchSession createSession()

Returns:

A new session allowing to index or search for entities.

See Also:

• createSessionWithOptions()

createSessionWithOptions

SearchSessionBuilder createSessionWithOptions()

Returns:

A session builder allowing to more finely configure the new session.

See Also:

• createSession()

indexedEntity

<E> SearchIndexedEntity<E> indexedEntity(Class<E> entityType)

Type Parameters:

E - The type of an indexed entity.

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 StandalonePojoMappingConfigurationContext.addEntityType(Class, String).

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

indexManager

IndexManager indexManager(String indexName)

Parameters:

indexName - The name of an index. See Indexed.index().

Returns:

The index manager for the index having indexName as name.

backend

Backend backend()

Returns:

The default backend, if any.

backend

Backend backend(String backendName)

Parameters:

backendName - The name of a backend. See Indexed.backend().

Returns:

The backend having backendName as name.

builder

static SearchMappingBuilder builder()

Returns:

A SearchMapping builder.

builder

static SearchMappingBuilder builder(MethodHandles.Lookup lookup)

Parameters:

lookup - A MethodHandles.Lookup to perform reflection on entities.

Returns:

A SearchMapping builder.