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

Interface SearchIndexNodeContext<SC extends SearchIndexScope<?>>

Type Parameters:

SC - The type of the backend-specific search scope.

All Superinterfaces:

EventContextProvider

All Known Subinterfaces:

ElasticsearchIndexCompositeNode, ElasticsearchIndexField, ElasticsearchIndexNode, ElasticsearchSearchIndexCompositeNodeContext, ElasticsearchSearchIndexNodeContext, ElasticsearchSearchIndexValueFieldContext<F>, IndexCompositeNode<SC,NT,F>, IndexField<SC,C>, IndexNode<SC>, IndexObjectField<SC,NT,C,F>, IndexValueField<SC,NT,C>, LuceneIndexCompositeNode, LuceneIndexField, LuceneIndexNode, LuceneSearchIndexCompositeNodeContext, LuceneSearchIndexNodeContext, LuceneSearchIndexValueFieldContext<F>, SearchIndexCompositeNodeContext<SC>, SearchIndexValueFieldContext<SC>

All Known Implementing Classes:

AbstractIndexField, AbstractIndexNode, AbstractIndexObjectField, AbstractIndexRoot, AbstractIndexValueField, AbstractMultiIndexSearchIndexCompositeNodeContext, AbstractMultiIndexSearchIndexNodeContext, AbstractMultiIndexSearchIndexValueFieldContext, ElasticsearchIndexObjectField, ElasticsearchIndexRoot, ElasticsearchIndexValueField, ElasticsearchMultiIndexSearchIndexCompositeNodeContext, ElasticsearchMultiIndexSearchIndexValueFieldContext, LuceneIndexObjectField, LuceneIndexRoot, LuceneIndexValueField, LuceneMultiIndexSearchIndexCompositeNodeContext, LuceneMultiIndexSearchIndexValueFieldContext

public interface SearchIndexNodeContext<SC extends SearchIndexScope<?>>
extends EventContextProvider

Information about an index node targeted by search, be it the index root, a value field or an object field.

This is used in predicates, projections, sorts, ...

Method Summary

Modifier and Type	Method	Description
String	absolutePath()
String[]	absolutePathComponents()
SearchException	cannotUseQueryElement(SearchQueryElementTypeKey<?> key, String hint, Exception causeOrNull)
String	closestMultiValuedParentAbsolutePath()
boolean	isComposite()
boolean	isObjectField()
boolean	isValueField()
boolean	multiValued()
boolean	multiValuedInRoot()
default String	nestedDocumentPath()
List<String>	nestedPathHierarchy()
<T> T	queryElement(SearchQueryElementTypeKey<T> key, SC searchContext)
EventContext	relativeEventContext()
SearchIndexCompositeNodeContext<SC>	toComposite()
SearchIndexCompositeNodeContext<SC>	toObjectField()
SearchIndexValueFieldContext<SC>	toValueField()

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

eventContext

Method Details

relativeEventContext

EventContext relativeEventContext()

isComposite

boolean isComposite()

isObjectField

boolean isObjectField()

isValueField

boolean isValueField()

toComposite

SearchIndexCompositeNodeContext<SC> toComposite()

toObjectField

SearchIndexCompositeNodeContext<SC> toObjectField()

toValueField

SearchIndexValueFieldContext<SC> toValueField()

absolutePath

String absolutePath()

absolutePathComponents

String[] absolutePathComponents()

nestedPathHierarchy

List<String> nestedPathHierarchy()

nestedDocumentPath

default String nestedDocumentPath()

closestMultiValuedParentAbsolutePath

String closestMultiValuedParentAbsolutePath()

multiValued

boolean multiValued()

multiValuedInRoot

boolean multiValuedInRoot()

queryElement

<T> T queryElement(SearchQueryElementTypeKey<T> key,
 SC searchContext)

cannotUseQueryElement

SearchException cannotUseQueryElement(SearchQueryElementTypeKey<?> key,
 String hint,
 Exception causeOrNull)