IndexCompositeElementDescriptor (Hibernate Search Engine 6.1.0.CR1 API)

All Known Subinterfaces:

IndexCompositeNode<SC,NT,F>, IndexObjectField<SC,NT,C,F>, IndexObjectFieldDescriptor

All Known Implementing Classes:

AbstractIndexObjectField, AbstractIndexRoot
```
public interface IndexCompositeElementDescriptor
```
A composite element in the index.
Composite elements are either the root or an object field.

See Also:

IndexObjectFieldDescriptor

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`isObjectField()`
`boolean`	`isRoot()`
`Collection<? extends IndexFieldDescriptor>`	`staticChildren()`	Get all statically-defined, direct child fields for this element.
`Map<String,? extends IndexFieldDescriptor>`	`staticChildrenByName()`	Get all statically-defined, direct child fields for this element, mapped by their `relative name`.
`IndexObjectFieldDescriptor`	`toObjectField()`

- Method Detail
  - isRoot
```
boolean isRoot()
```
    Returns:
    
    true if this element represents the root of the index.
  - isObjectField
```
boolean isObjectField()
```
    Returns:
    
    true if this element represents an object field. In that case, toObjectField() can be called safely (it won't throw an exception).
  - toObjectField
```
IndexObjectFieldDescriptor toObjectField()
```
    Returns:
    
    This element as an IndexObjectFieldDescriptor, if possible. Never null.
    
    Throws:
    
    SearchException - If this element does not represent an object field.
  - staticChildren
```
Collection<? extends IndexFieldDescriptor> staticChildren()
```
    Get all statically-defined, direct child fields for this element.
    Only statically-defined fields are returned; fields created dynamically through templates are not included in the collection.
    
    Returns:
    
    A collection containing all static child fields.
  - staticChildrenByName
```
Map<String,? extends IndexFieldDescriptor> staticChildrenByName()
```
    Get all statically-defined, direct child fields for this element, mapped by their relative name.
    Only statically-defined fields are returned; fields created dynamically through templates are not included in the map.
    
    Returns:
    
    A map containing all static child fields.