org.hibernate.search.mapper.orm.scope

Interface SearchScope<E>

Type Parameters:

E - A supertype of all types in this scope.

All Known Subinterfaces:

SearchScope<E>

public interface SearchScope<E>

Represents a set of types and the corresponding indexes, allowing to build search-related objects (query, predicate, ...) taking into account the relevant indexes and their metadata (underlying technology, field types, ...).

Method Summary

Modifier and Type	Method and Description
MassIndexer	massIndexer() Create a MassIndexer for the indexes mapped to types in this scope, or to any of their sub-types.
SearchPredicateFactory	predicate() Initiate the building of a search predicate.
SearchProjectionFactory<EntityReference,E>	projection() Initiate the building of a search projection that will be valid for the indexes in this scope.
HibernateOrmSearchQueryHitTypeStep<E>	search() Initiate the building of a search query.
SearchSortFactory	sort() Initiate the building of a search sort.
SearchWriter	writer() Create a SearchWriter for the indexes mapped to types in this scope, or to any of their sub-types.

Method Detail

search

HibernateOrmSearchQueryHitTypeStep<E> search()

Initiate the building of a search query.

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

Returns:

The initial step of a DSL where the search query can be defined.

See Also:

HibernateOrmSearchQueryHitTypeStep

predicate

SearchPredicateFactory predicate()

Initiate the building of a search predicate.

The predicate will only be valid for search queries created using this scope or a wider scope.

Note this method is only necessary if you do not want to use lambda expressions, since you can define predicates with lambdas within the search query DSL, removing the need to create separate objects to represent the predicates.

Returns:

A predicate factory.

See Also:

SearchPredicateFactory

sort

SearchSortFactory sort()

Initiate the building of a search sort.

The sort will only be valid for search queries created using this scope or a wider scope.

Note this method is only necessary if you do not want to use lambda expressions, since you can define sorts with lambdas within the search query DSL, removing the need to create separate objects to represent the sorts.

Returns:

A sort factory.

See Also:

SearchSortFactory

projection

SearchProjectionFactory<EntityReference,E> projection()

Initiate the building of a search projection that will be valid for the indexes in this scope.

The projection will only be valid for search queries created using this scope or a wider scope.

Note this method is only necessary if you do not want to use lambda expressions, since you can SearchQueryHitTypeStep.asProjection(Function) define projections with lambdas} within the search query DSL, removing the need to create separate objects to represent the projections.

Returns:

A projection factory.

See Also:

SearchProjectionFactory

writer

SearchWriter writer()

Create a SearchWriter for the indexes mapped to types in this scope, or to any of their sub-types.

Returns:

A SearchWriter.

massIndexer

MassIndexer massIndexer()

Create a MassIndexer for the indexes mapped to types in this scope, or to any of their sub-types.

MassIndexer instances cannot be reused.

Returns:

A MassIndexer.