Package org.hibernate.search.engine.backend.scope.spi

Class AbstractSearchIndexScope<SR,S extends SearchQueryIndexScope<SR,?>,M extends AbstractIndexModel<?,? extends C,? extends N>,N extends SearchIndexNodeContext<? super S>,C extends SearchIndexCompositeNodeContext<? super S>>

java.lang.Object

org.hibernate.search.engine.backend.scope.spi.AbstractSearchIndexScope<SR,S,M,N,C>

All Implemented Interfaces:

SearchAggregationIndexScope<S>, SearchIndexScope<S>, SearchPredicateIndexScope<S>, SearchProjectionIndexScope<S>, SearchQueryIndexScope<SR,S>, SearchSortIndexScope<S>, org.hibernate.search.util.common.reporting.spi.EventContextProvider

public abstract class AbstractSearchIndexScope<SR,S extends SearchQueryIndexScope<SR,?>,M extends AbstractIndexModel<?,? extends C,? extends N>,N extends SearchIndexNodeContext<? super S>,C extends SearchIndexCompositeNodeContext<? super S>>
extends Object
implements SearchIndexScope<S>, SearchQueryIndexScope<SR,S>

Field Summary

Fields

Modifier and Type	Field	Description
protected final BackendMappingContext	mappingContext
protected final Class<SR>	rootScopeType

Constructor Summary

Constructors

Modifier	Constructor	Description
	AbstractSearchIndexScope(BackendMappingContext mappingContext, Class<SR> rootScopeType, Set<? extends M> indexModels)
protected	AbstractSearchIndexScope(AbstractSearchIndexScope<SR,S,M,N,C> parentScope, C overriddenRoot)

Method Summary

Modifier and Type	Method	Description
final N	child(SearchIndexCompositeNodeContext<?> parent, String name)
protected abstract N	createMultiIndexSearchObjectFieldContext(String absolutePath, List<N> fieldForEachIndex)
protected abstract C	createMultiIndexSearchRootContext(List<C> rootForEachIndex)
protected abstract N	createMultiIndexSearchValueFieldContext(String absolutePath, List<N> fieldForEachIndex)
org.hibernate.search.util.common.reporting.EventContext	eventContext()
protected N	field(String fieldPath)
final <T> T	fieldQueryElement(String fieldPath, SearchQueryElementTypeKey<T> key)
final Set<String>	hibernateSearchIndexNames()
SearchIndexIdentifierContext	identifier()
protected final org.hibernate.search.util.common.reporting.EventContext	indexesAndRootEventContext()
List<? extends ProjectionMappedTypeContext>	mappedTypeContexts()
BackendMappingContext	mappingContext()
ProjectionRegistry	projectionRegistry()
protected C	root()
final <T> T	rootQueryElement(SearchQueryElementTypeKey<T> key)
protected abstract S	self()
String	toAbsolutePath(String relativeFieldPath)
final ToDocumentValueConvertContext	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.engine.search.aggregation.spi.SearchAggregationIndexScope

aggregationBuilders

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

withRoot

Methods inherited from interface org.hibernate.search.engine.search.predicate.spi.SearchPredicateIndexScope

predicateBuilders

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

projectionBuilders

Methods inherited from interface org.hibernate.search.engine.search.query.spi.SearchQueryIndexScope

aggregationFactory, highlighterFactory, predicateFactory, projectionFactory, select, sortFactory

Methods inherited from interface org.hibernate.search.engine.search.sort.spi.SearchSortIndexScope

sortBuilders

Field Details

mappingContext

protected final BackendMappingContext mappingContext

rootScopeType

protected final Class<SR> rootScopeType

Constructor Details

AbstractSearchIndexScope

public AbstractSearchIndexScope(BackendMappingContext mappingContext,
 Class<SR> rootScopeType,
 Set<? extends M> indexModels)

AbstractSearchIndexScope

protected AbstractSearchIndexScope(AbstractSearchIndexScope<SR,S,M,N,C> parentScope,
 C overriddenRoot)

Method Details

mappingContext

public BackendMappingContext mappingContext()

Specified by:

mappingContext in interface SearchIndexScope<SR>

eventContext

public org.hibernate.search.util.common.reporting.EventContext eventContext()

Specified by:

eventContext in interface org.hibernate.search.util.common.reporting.spi.EventContextProvider

indexesAndRootEventContext

protected final org.hibernate.search.util.common.reporting.EventContext indexesAndRootEventContext()

self

protected abstract S self()

toDocumentValueConvertContext

public final ToDocumentValueConvertContext toDocumentValueConvertContext()

Specified by:

toDocumentValueConvertContext in interface SearchIndexScope<SR>

hibernateSearchIndexNames

public final Set<String> hibernateSearchIndexNames()

Specified by:

hibernateSearchIndexNames in interface SearchIndexScope<SR>

toAbsolutePath

public String toAbsolutePath(String relativeFieldPath)

Specified by:

toAbsolutePath in interface SearchIndexScope<SR>

identifier

public SearchIndexIdentifierContext identifier()

Specified by:

identifier in interface SearchIndexScope<SR>

root

protected C root()

field

protected N field(String fieldPath)

child

public final N child(SearchIndexCompositeNodeContext<?> parent,
 String name)

Specified by:

child in interface SearchIndexScope<SR>

rootQueryElement

public final <T> T rootQueryElement(SearchQueryElementTypeKey<T> key)

Specified by:

rootQueryElement in interface SearchIndexScope<SR>

fieldQueryElement

public final <T> T fieldQueryElement(String fieldPath,
 SearchQueryElementTypeKey<T> key)

Specified by:

fieldQueryElement in interface SearchIndexScope<SR>

projectionRegistry

public ProjectionRegistry projectionRegistry()

Specified by:

projectionRegistry in interface SearchProjectionIndexScope<SR>

mappedTypeContexts

public List<? extends ProjectionMappedTypeContext> mappedTypeContexts()

Specified by:

mappedTypeContexts in interface SearchProjectionIndexScope<SR>

createMultiIndexSearchRootContext

protected abstract C createMultiIndexSearchRootContext(List<C> rootForEachIndex)

createMultiIndexSearchValueFieldContext

protected abstract N createMultiIndexSearchValueFieldContext(String absolutePath,
 List<N> fieldForEachIndex)

createMultiIndexSearchObjectFieldContext

protected abstract N createMultiIndexSearchObjectFieldContext(String absolutePath,
 List<N> fieldForEachIndex)