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:
org.hibernate.search.util.common.reporting.spi.EventContextProvider
All Known Subinterfaces:
IndexCompositeNode<SC,NT,F>, IndexField<SC,C>, IndexNode<SC>, IndexObjectField<SC,NT,C,F>, IndexValueField<SC,NT,C>, SearchIndexCompositeNodeContext<SC>, SearchIndexValueFieldContext<SC>
All Known Implementing Classes:
AbstractIndexField, AbstractIndexNode, AbstractIndexObjectField, AbstractIndexRoot, AbstractIndexValueField, AbstractMultiIndexSearchIndexCompositeNodeContext, AbstractMultiIndexSearchIndexNodeContext, AbstractMultiIndexSearchIndexValueFieldContext
public interface SearchIndexNodeContext<SC extends SearchIndexScope<?>> extends org.hibernate.search.util.common.reporting.spi.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 Details

    • relativeEventContext

      org.hibernate.search.util.common.reporting.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

      org.hibernate.search.util.common.SearchException cannotUseQueryElement(SearchQueryElementTypeKey<?> key, String hint, Exception causeOrNull)