SearchIndexNodeContext (Hibernate Search Engine 6.1.3.Final API)

Type Parameters:

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

All Superinterfaces:

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 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

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`String`	`absolutePath()`
`String[]`	`absolutePathComponents()`
`boolean`	`isComposite()`
`boolean`	`isValueField()`
`default String`	`nestedDocumentPath()`
`List<String>`	`nestedPathHierarchy()`
`<T> T`	`queryElement(SearchQueryElementTypeKey<T> key, SC searchContext)`
`EventContext`	`relativeEventContext()`
`SearchIndexCompositeNodeContext<SC>`	`toComposite()`
`SearchIndexValueFieldContext<SC>`	`toValueField()`

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

Method Detail

relativeEventContext
```
EventContext relativeEventContext()
```

isComposite
```
boolean isComposite()
```

isValueField
```
boolean isValueField()
```

toComposite

SearchIndexCompositeNodeContext<SC> toComposite()

toValueField

SearchIndexValueFieldContext<SC> toValueField()

absolutePath
```
String absolutePath()
```

absolutePathComponents
```
String[] absolutePathComponents()
```

nestedPathHierarchy
```
List<String> nestedPathHierarchy()
```

nestedDocumentPath
```
default String nestedDocumentPath()
```

queryElement

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