Package org.hibernate.search.backend.lucene.scope.model.impl

Class LuceneSearchIndexScopeImpl

java.lang.Object

org.hibernate.search.engine.backend.scope.spi.AbstractSearchIndexScope<LuceneSearchIndexScopeImpl,LuceneIndexModel,LuceneSearchIndexNodeContext,LuceneSearchIndexCompositeNodeContext>

org.hibernate.search.backend.lucene.scope.model.impl.LuceneSearchIndexScopeImpl

All Implemented Interfaces:

LuceneSearchAggregationIndexScope<LuceneSearchIndexScopeImpl>, LuceneSearchIndexScope<LuceneSearchIndexScopeImpl>, LuceneSearchPredicateIndexScope<LuceneSearchIndexScopeImpl>, LuceneSearchProjectionIndexScope<LuceneSearchIndexScopeImpl>, LuceneSearchQueryIndexScope<LuceneSearchIndexScopeImpl>, LuceneSearchSortIndexScope<LuceneSearchIndexScopeImpl>, SearchAggregationIndexScope<LuceneSearchIndexScopeImpl>, SearchIndexScope<LuceneSearchIndexScopeImpl>, SearchPredicateIndexScope<LuceneSearchIndexScopeImpl>, SearchProjectionIndexScope<LuceneSearchIndexScopeImpl>, SearchQueryIndexScope<LuceneSearchIndexScopeImpl>, SearchSortIndexScope<LuceneSearchIndexScopeImpl>, EventContextProvider

public final class LuceneSearchIndexScopeImpl
extends AbstractSearchIndexScope<LuceneSearchIndexScopeImpl,LuceneIndexModel,LuceneSearchIndexNodeContext,LuceneSearchIndexCompositeNodeContext>
implements LuceneSearchIndexScope<LuceneSearchIndexScopeImpl>, LuceneSearchQueryIndexScope<LuceneSearchIndexScopeImpl>

Field Summary

Fields inherited from class org.hibernate.search.engine.backend.scope.spi.AbstractSearchIndexScope

mappingContext

Constructor Summary

Constructors

Constructor	Description
LuceneSearchIndexScopeImpl(BackendMappingContext mappingContext, SearchBackendContext backendContext, LuceneAnalysisDefinitionRegistry analysisDefinitionRegistry, MultiTenancyStrategy multiTenancyStrategy, TimingSource timingSource, Set<? extends LuceneScopeIndexManagerContext> indexManagerContexts)

Method Summary

Modifier and Type	Method	Description
LuceneSearchAggregationBuilderFactory	aggregationBuilders()
LuceneSearchAggregationFactory	aggregationFactory()
LuceneAnalysisDefinitionRegistry	analysisDefinitionRegistry()
protected LuceneSearchIndexNodeContext	createMultiIndexSearchObjectFieldContext(String absolutePath, List<LuceneSearchIndexNodeContext> fieldForEachIndex)
protected LuceneSearchIndexCompositeNodeContext	createMultiIndexSearchRootContext(List<LuceneSearchIndexCompositeNodeContext> rootForEachIndex)
protected LuceneSearchIndexNodeContext	createMultiIndexSearchValueFieldContext(String absolutePath, List<LuceneSearchIndexNodeContext> fieldForEachIndex)
TimeoutManager	createTimeoutManager(Long timeout, TimeUnit timeUnit, boolean exceptionOnTimeout)
org.apache.lucene.search.Query	filterOrNull(String tenantId)
boolean	hasNestedDocuments()
SearchHighlighterFactory	highlighterFactory()
Collection<LuceneScopeIndexManagerContext>	indexes()
Map<String,? extends LuceneSearchIndexContext>	mappedTypeNameToIndex()
LuceneSearchPredicateBuilderFactory	predicateBuilders()
LuceneSearchPredicateFactory	predicateFactory()
LuceneSearchProjectionBuilderFactory	projectionBuilders()
<R, E> LuceneSearchProjectionFactory<R,E>	projectionFactory()
<P> LuceneSearchQueryBuilder<P>	select(BackendSessionContext sessionContext, SearchLoadingContextBuilder<?,?> loadingContextBuilder, SearchProjection<P> projection)
protected LuceneSearchIndexScopeImpl	self()
LuceneSearchSortBuilderFactory	sortBuilders()
LuceneSearchSortFactory	sortFactory()
LuceneSearchIndexScopeImpl	withRoot(String objectFieldPath)

Methods inherited from class org.hibernate.search.engine.backend.scope.spi.AbstractSearchIndexScope

child, eventContext, field, fieldQueryElement, hibernateSearchIndexNames, identifier, indexesAndRootEventContext, mappedTypeContexts, mappingContext, projectionRegistry, root, rootQueryElement, toAbsolutePath, toDocumentValueConvertContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hibernate.search.util.common.reporting.spi.EventContextProvider

eventContext

Methods inherited from interface org.hibernate.search.backend.lucene.search.common.impl.LuceneSearchIndexScope

child

Methods inherited from interface org.hibernate.search.engine.search.common.spi.SearchIndexScope

fieldQueryElement, hibernateSearchIndexNames, identifier, mappingContext, rootQueryElement, toAbsolutePath, toDocumentValueConvertContext

Methods inherited from interface org.hibernate.search.engine.search.projection.spi.SearchProjectionIndexScope

mappedTypeContexts, projectionRegistry

Constructor Details

LuceneSearchIndexScopeImpl

public LuceneSearchIndexScopeImpl(BackendMappingContext mappingContext,
 SearchBackendContext backendContext,
 LuceneAnalysisDefinitionRegistry analysisDefinitionRegistry,
 MultiTenancyStrategy multiTenancyStrategy,
 TimingSource timingSource,
 Set<? extends LuceneScopeIndexManagerContext> indexManagerContexts)

Method Details

self

protected LuceneSearchIndexScopeImpl self()

Specified by:

self in class AbstractSearchIndexScope<LuceneSearchIndexScopeImpl,LuceneIndexModel,LuceneSearchIndexNodeContext,LuceneSearchIndexCompositeNodeContext>

withRoot

public LuceneSearchIndexScopeImpl withRoot(String objectFieldPath)

Specified by:

withRoot in interface SearchIndexScope<LuceneSearchIndexScopeImpl>

predicateBuilders

public LuceneSearchPredicateBuilderFactory predicateBuilders()

Specified by:

predicateBuilders in interface LuceneSearchPredicateIndexScope<LuceneSearchIndexScopeImpl>

Specified by:

predicateBuilders in interface SearchPredicateIndexScope<LuceneSearchIndexScopeImpl>

sortBuilders

public LuceneSearchSortBuilderFactory sortBuilders()

Specified by:

sortBuilders in interface LuceneSearchSortIndexScope<LuceneSearchIndexScopeImpl>

Specified by:

sortBuilders in interface SearchSortIndexScope<LuceneSearchIndexScopeImpl>

projectionBuilders

public LuceneSearchProjectionBuilderFactory projectionBuilders()

Specified by:

projectionBuilders in interface LuceneSearchProjectionIndexScope<LuceneSearchIndexScopeImpl>

Specified by:

projectionBuilders in interface SearchProjectionIndexScope<LuceneSearchIndexScopeImpl>

aggregationBuilders

public LuceneSearchAggregationBuilderFactory aggregationBuilders()

Specified by:

aggregationBuilders in interface LuceneSearchAggregationIndexScope<LuceneSearchIndexScopeImpl>

Specified by:

aggregationBuilders in interface SearchAggregationIndexScope<LuceneSearchIndexScopeImpl>

select

public <P> LuceneSearchQueryBuilder<P> select(BackendSessionContext sessionContext,
 SearchLoadingContextBuilder<?,?> loadingContextBuilder,
 SearchProjection<P> projection)

Specified by:

select in interface LuceneSearchQueryIndexScope<LuceneSearchIndexScopeImpl>

Specified by:

select in interface SearchQueryIndexScope<LuceneSearchIndexScopeImpl>

predicateFactory

public LuceneSearchPredicateFactory predicateFactory()

Specified by:

predicateFactory in interface LuceneSearchQueryIndexScope<LuceneSearchIndexScopeImpl>

Specified by:

predicateFactory in interface SearchQueryIndexScope<LuceneSearchIndexScopeImpl>

sortFactory

public LuceneSearchSortFactory sortFactory()

Specified by:

sortFactory in interface LuceneSearchQueryIndexScope<LuceneSearchIndexScopeImpl>

Specified by:

sortFactory in interface SearchQueryIndexScope<LuceneSearchIndexScopeImpl>

projectionFactory

public <R,
E> LuceneSearchProjectionFactory<R,E> projectionFactory()

Specified by:

projectionFactory in interface LuceneSearchQueryIndexScope<LuceneSearchIndexScopeImpl>

Specified by:

projectionFactory in interface SearchQueryIndexScope<LuceneSearchIndexScopeImpl>

aggregationFactory

public LuceneSearchAggregationFactory aggregationFactory()

Specified by:

aggregationFactory in interface LuceneSearchQueryIndexScope<LuceneSearchIndexScopeImpl>

Specified by:

aggregationFactory in interface SearchQueryIndexScope<LuceneSearchIndexScopeImpl>

highlighterFactory

public SearchHighlighterFactory highlighterFactory()

Specified by:

highlighterFactory in interface SearchQueryIndexScope<LuceneSearchIndexScopeImpl>

analysisDefinitionRegistry

public LuceneAnalysisDefinitionRegistry analysisDefinitionRegistry()

Specified by:

analysisDefinitionRegistry in interface LuceneSearchIndexScope<LuceneSearchIndexScopeImpl>

filterOrNull

public org.apache.lucene.search.Query filterOrNull(String tenantId)

Specified by:

filterOrNull in interface LuceneSearchQueryIndexScope<LuceneSearchIndexScopeImpl>

createTimeoutManager

public TimeoutManager createTimeoutManager(Long timeout,
 TimeUnit timeUnit,
 boolean exceptionOnTimeout)

Specified by:

createTimeoutManager in interface LuceneSearchQueryIndexScope<LuceneSearchIndexScopeImpl>

indexes

public Collection<LuceneScopeIndexManagerContext> indexes()

Specified by:

indexes in interface LuceneSearchQueryIndexScope<LuceneSearchIndexScopeImpl>

mappedTypeNameToIndex

public Map<String,? extends LuceneSearchIndexContext> mappedTypeNameToIndex()

Specified by:

mappedTypeNameToIndex in interface LuceneSearchQueryIndexScope<LuceneSearchIndexScopeImpl>

hasNestedDocuments

public boolean hasNestedDocuments()

Specified by:

hasNestedDocuments in interface LuceneSearchQueryIndexScope<LuceneSearchIndexScopeImpl>

createMultiIndexSearchRootContext

protected LuceneSearchIndexCompositeNodeContext createMultiIndexSearchRootContext(List<LuceneSearchIndexCompositeNodeContext> rootForEachIndex)

Specified by:

createMultiIndexSearchRootContext in class AbstractSearchIndexScope<LuceneSearchIndexScopeImpl,LuceneIndexModel,LuceneSearchIndexNodeContext,LuceneSearchIndexCompositeNodeContext>

createMultiIndexSearchValueFieldContext

protected LuceneSearchIndexNodeContext createMultiIndexSearchValueFieldContext(String absolutePath,
 List<LuceneSearchIndexNodeContext> fieldForEachIndex)

Specified by:

createMultiIndexSearchValueFieldContext in class AbstractSearchIndexScope<LuceneSearchIndexScopeImpl,LuceneIndexModel,LuceneSearchIndexNodeContext,LuceneSearchIndexCompositeNodeContext>

createMultiIndexSearchObjectFieldContext

protected LuceneSearchIndexNodeContext createMultiIndexSearchObjectFieldContext(String absolutePath,
 List<LuceneSearchIndexNodeContext> fieldForEachIndex)

Specified by:

createMultiIndexSearchObjectFieldContext in class AbstractSearchIndexScope<LuceneSearchIndexScopeImpl,LuceneIndexModel,LuceneSearchIndexNodeContext,LuceneSearchIndexCompositeNodeContext>