java.lang.Object
- org.hibernate.search.mapper.orm.scope.impl.SearchScopeImpl<E>

All Implemented Interfaces:: SearchScope<E>

public class SearchScopeImpl<E>
extends Object
implements SearchScope<E>

Constructor Summary

Constructors
Constructor	Description
`SearchScopeImpl(HibernateOrmScopeMappingContext mappingContext, TenancyConfiguration tenancyConfiguration, PojoScopeDelegate<EntityReference,E,HibernateOrmScopeIndexedTypeContext<? extends E>> delegate)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SearchAggregationFactory`	`aggregation()`	Initiate the building of a search aggregation that will be valid for the indexes in this scope.
`<T> T`	`extension(IndexScopeExtension<T> extension)`	Extend the current search scope with the given extension, resulting in an extended search scope offering backend-specific utilities.
`SearchHighlighterFactory`	`highlighter()`	Initiate the building of a highlighter that will be valid for the indexes in this scope.
`Set<? extends SearchIndexedEntity<? extends E>>`	`includedTypes()`
`MassIndexer`	`massIndexer()`	Create a `MassIndexer` for the indexes mapped to types in this scope, or to any of their sub-types.
`MassIndexer`	`massIndexer(String tenantId)`	Create a `MassIndexer` for the indexes mapped to types in this scope, or to any of their sub-types.
`MassIndexer`	`massIndexer(Set<String> tenantIds)`	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.
`SearchSchemaManager`	`schemaManager()`	Create a `SearchSchemaManager` for the indexes mapped to types in this scope, or to any of their sub-types.
`PojoScopeSchemaManager`	`schemaManagerDelegate()`
`SearchQuerySelectStep<?,EntityReference,E,SearchLoadingOptionsStep,?,?>`	`search(HibernateOrmScopeSessionContext sessionContext, HibernateOrmSelectionLoadingContext.Builder loadingContextBuilder)`
`SearchSortFactory`	`sort()`	Initiate the building of a search sort.
`SearchWorkspace`	`workspace()`	Create a `SearchWorkspace` for the indexes mapped to types in this scope, or to any of their sub-types.
`SearchWorkspace`	`workspace(String tenantId)`	Create a `SearchWorkspace` for the indexes mapped to types in this scope, or to any of their sub-types.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SearchScopeImpl
```
public SearchScopeImpl(HibernateOrmScopeMappingContext mappingContext,
                       TenancyConfiguration tenancyConfiguration,
                       PojoScopeDelegate<EntityReference,E,HibernateOrmScopeIndexedTypeContext<? extends E>> delegate)
```
- Method Detail
  - search
```
public SearchQuerySelectStep<?,EntityReference,E,SearchLoadingOptionsStep,?,?> search(HibernateOrmScopeSessionContext sessionContext,
                                                                                                                    HibernateOrmSelectionLoadingContext.Builder loadingContextBuilder)
```
  - predicate
```
public SearchPredicateFactory predicate()
```
    Description copied from interface: SearchScope
    
    Initiate the building of a search predicate.
    The predicate will only be valid for search queries created using this scope or another scope instance targeting the same indexes.
    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.
    
    Specified by:
    
    predicate in interface SearchScope<E>
    
    Returns:
    
    A predicate factory.
    
    See Also:
    
    SearchPredicateFactory
  - sort
```
public SearchSortFactory sort()
```
    Description copied from interface: SearchScope
    
    Initiate the building of a search sort.
    The sort will only be valid for search queries created using this scope or another scope instance targeting the same indexes. 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.
    
    Specified by:
    
    sort in interface SearchScope<E>
    
    Returns:
    
    A sort factory.
    
    See Also:
    
    SearchSortFactory
  - projection
```
public SearchProjectionFactory<EntityReference,E> projection()
```
    Description copied from interface: SearchScope
    
    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 another scope instance targeting the same indexes.
    Note this method is only necessary if you do not want to use lambda expressions, since you can SearchQuerySelectStep.select(Function) define projections with lambdas} within the search query DSL, removing the need to create separate objects to represent the projections.
    
    Specified by:
    
    projection in interface SearchScope<E>
    
    Returns:
    
    A projection factory.
    
    See Also:
    
    SearchProjectionFactory
  - aggregation
```
public SearchAggregationFactory aggregation()
```
    Description copied from interface: SearchScope
    
    Initiate the building of a search aggregation that will be valid for the indexes in this scope.
    The aggregation will only be usable in search queries created using this scope or another scope instance targeting the same indexes.
    Note this method is only necessary if you do not want to use lambda expressions, since you can SearchQueryOptionsStep.aggregation(AggregationKey, SearchAggregation) define aggregations with lambdas} within the search query DSL, removing the need to create separate objects to represent the aggregation.
    
    Specified by:
    
    aggregation in interface SearchScope<E>
    
    Returns:
    
    An aggregation factory.
    
    See Also:
    
    SearchAggregationFactory
  - highlighter
```
public SearchHighlighterFactory highlighter()
```
    Description copied from interface: SearchScope
    
    Initiate the building of a highlighter that will be valid for the indexes in this scope.
    The highlighter will only be valid for search queries created using this scope or another scope instance targeting the same indexes.
    Note this method is only necessary if you do not want to use lambda expressions, since you can define highlighters with lambdas within the search query DSL, removing the need to create separate objects to represent the projections.
    
    Specified by:
    
    highlighter in interface SearchScope<E>
    
    Returns:
    
    A highlighter factory.
  - schemaManager
```
public SearchSchemaManager schemaManager()
```
    Description copied from interface: SearchScope
    
    Create a SearchSchemaManager for the indexes mapped to types in this scope, or to any of their sub-types.
    
    Specified by:
    
    schemaManager in interface SearchScope<E>
    
    Returns:
    
    A SearchSchemaManager.
  - workspace
```
public SearchWorkspace workspace()
```
    Description copied from interface: SearchScope
    
    Create a SearchWorkspace for the indexes mapped to types in this scope, or to any of their sub-types.
    This method only works for single-tenant applications. If multi-tenancy is enabled, use SearchScope.workspace(String) instead.
    
    Specified by:
    
    workspace in interface SearchScope<E>
    
    Returns:
    
    A SearchWorkspace.
  - workspace
```
public SearchWorkspace workspace(String tenantId)
```
    Description copied from interface: SearchScope
    
    Create a SearchWorkspace for the indexes mapped to types in this scope, or to any of their sub-types.
    This method only works for multi-tenant applications. If multi-tenancy is disabled, use SearchScope.workspace() instead.
    
    Specified by:
    
    workspace in interface SearchScope<E>
    
    Parameters:
    
    tenantId - The identifier of the tenant whose index content should be targeted.
    
    Returns:
    
    A SearchWorkspace.
  - massIndexer
```
public MassIndexer massIndexer()
```
    Description copied from interface: SearchScope
    
    Create a MassIndexer for the indexes mapped to types in this scope, or to any of their sub-types.
    This method primarily is intended for single-tenant applications. If multi-tenancy is enabled, consider using SearchScope.massIndexer(String)/SearchScope.massIndexer(Set) instead. In case this method is used in multi-tenant environment - MassIndexer for all configured tenants will be created.
    MassIndexer instances cannot be reused.
    
    Specified by:
    
    massIndexer in interface SearchScope<E>
    
    Returns:
    
    A MassIndexer.
  - massIndexer
```
public MassIndexer massIndexer(String tenantId)
```
    Description copied from interface: SearchScope
    
    Create a MassIndexer for the indexes mapped to types in this scope, or to any of their sub-types.
    This method only works for multi-tenant applications. If multi-tenancy is disabled, use SearchScope.massIndexer() instead.
    MassIndexer instances cannot be reused.
    
    Specified by:
    
    massIndexer in interface SearchScope<E>
    
    Parameters:
    
    tenantId - The identifier of the tenant whose index content should be targeted.
    
    Returns:
    
    A MassIndexer.
  - massIndexer
```
public MassIndexer massIndexer(Set<String> tenantIds)
```
    Description copied from interface: SearchScope
    
    Create a MassIndexer for the indexes mapped to types in this scope, or to any of their sub-types.
    This method works for both single- and multi-tenant applications. If multi-tenancy is disabled, simply keep the set of tenants empty.
    MassIndexer instances cannot be reused.
    
    Specified by:
    
    massIndexer in interface SearchScope<E>
    
    Parameters:
    
    tenantIds - The tenants identifiers whose index content should be targeted. If empty, all tenants will be targeted.
    
    Returns:
    
    A MassIndexer.
  - includedTypes
```
public Set<? extends SearchIndexedEntity<? extends E>> includedTypes()
```
    Specified by:
    
    includedTypes in interface SearchScope<E>
    
    Returns:
    
    A set containing one SearchIndexedEntity for each indexed entity in this scope.
  - extension
```
public <T> T extension(IndexScopeExtension<T> extension)
```
    Description copied from interface: SearchScope
    
    Extend the current search scope with the given extension, resulting in an extended search scope offering backend-specific utilities.
    
    Specified by:
    
    extension in interface SearchScope<E>
    
    Type Parameters:
    
    T - The type of search scope provided by the extension.
    
    Parameters:
    
    extension - The extension to apply.
    
    Returns:
    
    The extended search scope.
  - schemaManagerDelegate
```
public PojoScopeSchemaManager schemaManagerDelegate()
```

Class SearchScopeImpl<E>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SearchScopeImpl

Method Detail

search

predicate

sort

projection

aggregation

highlighter

schemaManager

workspace

workspace

massIndexer

massIndexer

massIndexer

includedTypes

extension

schemaManagerDelegate