org.hibernate.search.mapper.javabean.session

Interface SearchSession

All Superinterfaces:

AutoCloseable

public interface SearchSession
extends AutoCloseable

Method Summary

Modifier and Type	Method and Description
void	close() Execute any pending work in the main work plan and release any resource held by this session.
SearchWorkPlan	getMainWorkPlan()
default SearchScope	scope(Class<?> type) Create a SearchScope limited to the given type.
SearchScope	scope(Collection<? extends Class<?>> types) Create a SearchScope limited to the given types.
default SearchQueryResultDefinitionContext	search(Class<?> type) Initiate the building of a search query.
default SearchQueryResultDefinitionContext	search(Collection<? extends Class<?>> types) Initiate the building of a search query.

Method Detail

close

void close()

Execute any pending work in the main work plan and release any resource held by this session.

Specified by:

close in interface AutoCloseable

search

default SearchQueryResultDefinitionContext search(Class<?> type)

Initiate the building of a search query.

The query will target the indexes mapped to the given type, or to any of its sub-types.

Parameters:

type - An indexed type, or a supertype of all indexed types that will be targeted by the search query.

Returns:

A context allowing to define the search query, and ultimately get the resulting query.

See Also:

SearchQueryResultDefinitionContext

search

default SearchQueryResultDefinitionContext search(Collection<? extends Class<?>> types)

Initiate the building of a search query.

The query will target the indexes mapped to the given types, or to any of their sub-types.

Parameters:

types - A collection of indexed types, or supertypes of all indexed types that will be targeted by the search query.

Returns:

A context allowing to define the search query, and ultimately get the resulting query.

See Also:

SearchQueryResultDefinitionContext

scope

default SearchScope scope(Class<?> type)

Create a SearchScope limited to the given type.

Parameters:

type - A type to include in the scope.

Returns:

The created scope.

See Also:

SearchScope

scope

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

Create a SearchScope limited to the given types.

Parameters:

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

Returns:

The created scope.

See Also:

SearchScope

getMainWorkPlan

SearchWorkPlan getMainWorkPlan()

Returns:

The main work plan for this session. It will be executed upon closing this session.