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

Interface IndexSchemaFieldFinalStep<R>

Type Parameters:

R - The reference type.

All Known Subinterfaces:

IndexSchemaFieldOptionsStep<S,R>, IndexSchemaObjectField

public interface IndexSchemaFieldFinalStep<R>

The final step in the definition of a field in the index schema, where a reference to the field can be retrieved.

Method Summary

Modifier and Type	Method	Description
R	toReference()	Create a reference to this field for use when indexing.

Method Details

toReference

R toReference()

Create a reference to this field for use when indexing.

Returns:

The reference to use when indexing.

See Also:

• DocumentElement.addValue(IndexFieldReference, Object)
• DocumentElement.addObject(IndexObjectFieldReference)
• DocumentElement.addNullObject(IndexObjectFieldReference)