IndexFieldDescriptor (Hibernate Search Engine 6.0.0.Beta8 API)

All Known Subinterfaces:

IndexObjectFieldDescriptor, IndexValueFieldDescriptor
```
public interface IndexFieldDescriptor
```
A field in the index.

See Also:

IndexValueFieldDescriptor, IndexObjectFieldDescriptor

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`absolutePath()`
`default boolean`	`isMultiValued()` Deprecated. Use `multiValued()` instead.
`boolean`	`isObjectField()`
`boolean`	`isValueField()`
`boolean`	`multiValued()`
`IndexCompositeElementDescriptor`	`parent()`
`String`	`relativeName()`
`IndexObjectFieldDescriptor`	`toObjectField()`
`IndexValueFieldDescriptor`	`toValueField()`

- Method Detail
  - isObjectField
```
boolean isObjectField()
```
    Returns:
    
    true if this field is an object field. In that case, toObjectField() can be called safely (it won't throw an exception).
  - isValueField
```
boolean isValueField()
```
    Returns:
    
    true if this field is a value field. In that case, toValueField() can be called safely (it won't throw an exception).
  - toObjectField
```
IndexObjectFieldDescriptor toObjectField()
```
    Returns:
    
    This field as an IndexObjectFieldDescriptor, if possible. Never null.
    
    Throws:
    
    SearchException - If this field is not an object field.
  - toValueField
```
IndexValueFieldDescriptor toValueField()
```
    Returns:
    
    This field as an IndexValueFieldDescriptor, if possible. Never null.
    
    Throws:
    
    SearchException - If this field is not a value field.
  - parent
```
IndexCompositeElementDescriptor parent()
```
    Returns:
    
    The parent of this field, either the index root or an object field.
  - relativeName
```
String relativeName()
```
    Returns:
    
    The name of this field relative to its parent.
  - absolutePath
```
String absolutePath()
```
    Returns:
    
    The absolute, dot-separated path of this field.
  - multiValued
```
boolean multiValued()
```
    Returns:
    
    true if this field can have multiple values in the same parent document.
  - isMultiValued
```
@Deprecated
default boolean isMultiValued()
```
    Deprecated. Use multiValued() instead.
    
    Returns:
    
    true if this field can have multiple values in the same parent document.

Interface IndexFieldDescriptor

Method Summary

Method Detail

isObjectField

isValueField

toObjectField

toValueField

parent

relativeName

absolutePath

multiValued

isMultiValued