Package org.hibernate.search.engine.backend.document.model.spi

Interface IndexField<SC extends SearchIndexScope<?>,C extends IndexCompositeNode<SC,?,?>>

All Superinterfaces:

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

All Known Subinterfaces:

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

All Known Implementing Classes:

AbstractIndexField, AbstractIndexObjectField, AbstractIndexValueField, ElasticsearchIndexObjectField, ElasticsearchIndexValueField, LuceneIndexObjectField, LuceneIndexValueField

public interface IndexField<SC extends SearchIndexScope<?>,C extends IndexCompositeNode<SC,?,?>>
extends IndexNode<SC>, IndexFieldDescriptor

Method Summary

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

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

inclusion

Methods inherited from interface org.hibernate.search.engine.search.common.spi.SearchIndexNodeContext

absolutePath, absolutePathComponents, cannotUseQueryElement, closestMultiValuedParentAbsolutePath, isComposite, isObjectField, isValueField, multiValued, multiValuedInRoot, nestedDocumentPath, nestedPathHierarchy, queryElement, relativeEventContext

Method Details

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

Specified by:

toObjectField in interface SearchIndexNodeContext<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.