IndexField (Hibernate Search Engine 6.1.3.Final API)

All Superinterfaces:

EventContextProvider, IndexFieldDescriptor, IndexNode<SC>, SearchIndexNodeContext<SC>

All Known Subinterfaces:

IndexObjectField<SC,NT,C,F>, IndexValueField<SC,NT,C>

All Known Implementing Classes:

AbstractIndexField, AbstractIndexObjectField, AbstractIndexValueField
```
public interface IndexField<SC extends SearchIndexScope<?>,C extends IndexCompositeNode<SC,?,?>>
extends IndexNode<SC>, IndexFieldDescriptor
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`C`	`parent()`
`C`	`toComposite()`
`IndexObjectField<SC,?,C,?>`	`toObjectField()`
`IndexValueField<SC,?,C>`	`toValueField()`

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

Methods inherited from interface org.hibernate.search.engine.backend.metamodel.IndexFieldDescriptor
absolutePath, isObjectField, isValueField, multiValued, multiValuedInRoot, relativeName

Methods inherited from interface org.hibernate.search.engine.backend.document.model.spi.IndexNode
inclusion, multiValuedInRoot

Methods inherited from interface org.hibernate.search.engine.search.common.spi.SearchIndexNodeContext
absolutePath, absolutePathComponents, isComposite, isValueField, nestedDocumentPath, nestedPathHierarchy, queryElement, relativeEventContext

- Method Detail
  - toComposite
```
C toComposite()
```
    Specified by:
    
    toComposite in interface IndexNode<SC extends SearchIndexScope<?>>
    
    Specified by:
    
    toComposite in interface SearchIndexNodeContext<SC extends SearchIndexScope<?>>
  - toObjectField
```
IndexObjectField<SC,?,C,?> toObjectField()
```
    Specified by:
    
    toObjectField in interface IndexFieldDescriptor
    
    Specified by:
    
    toObjectField in interface IndexNode<SC extends SearchIndexScope<?>>
    
    Returns:
    
    This field as an IndexObjectFieldDescriptor, if possible. Never null.
  - toValueField
```
IndexValueField<SC,?,C> toValueField()
```
    Specified by:
    
    toValueField in interface IndexFieldDescriptor
    
    Specified by:
    
    toValueField in interface IndexNode<SC extends SearchIndexScope<?>>
    
    Specified by:
    
    toValueField in interface SearchIndexNodeContext<SC extends SearchIndexScope<?>>
    
    Returns:
    
    This field as an IndexValueFieldDescriptor, if possible. Never null.
  - parent
```
C parent()
```
    Specified by:
    
    parent in interface IndexFieldDescriptor
    
    Returns:
    
    The parent of this field, either the index root or an object field.