Package org.hibernate.search.engine.search.common.spi

Interface SearchIndexScope<S extends SearchIndexScope<?>>

Type Parameters:

S - The self type, i.e. the exposed type of this scope.

All Superinterfaces:

EventContextProvider

All Known Subinterfaces:

SearchAggregationIndexScope<S>, SearchPredicateIndexScope<S>, SearchProjectionIndexScope<S>, SearchQueryIndexScope<S>, SearchSortIndexScope<S>

All Known Implementing Classes:

AbstractSearchIndexScope

public interface SearchIndexScope<S extends SearchIndexScope<?>>
extends EventContextProvider

Information about indexes targeted by search, be it in a projection, a predicate, a sort, ...

Method Summary

Modifier and Type	Method	Description
SearchIndexNodeContext<?>	child(SearchIndexCompositeNodeContext<?> parent, String name)
<T> T	fieldQueryElement(String fieldPath, SearchQueryElementTypeKey<T> key)
Set<String>	hibernateSearchIndexNames()
SearchIndexIdentifierContext	identifier()
<T> T	rootQueryElement(SearchQueryElementTypeKey<T> key)
String	toAbsolutePath(String relativeFieldPath)
ToDocumentValueConvertContext	toDocumentValueConvertContext()
S	withRoot(String objectFieldPath)

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

eventContext

Method Detail

hibernateSearchIndexNames

Set<String> hibernateSearchIndexNames()

toDocumentValueConvertContext

ToDocumentValueConvertContext toDocumentValueConvertContext()

withRoot

S withRoot(String objectFieldPath)

toAbsolutePath

String toAbsolutePath(String relativeFieldPath)

identifier

SearchIndexIdentifierContext identifier()

child

SearchIndexNodeContext<?> child(SearchIndexCompositeNodeContext<?> parent,
                                String name)

rootQueryElement

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

fieldQueryElement

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