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

Interface IndexSchemaElement

All Known Subinterfaces:

IndexSchemaObjectField

public interface IndexSchemaElement

An element of the index schema, allowing the definition of child fields.

Method Summary

Modifier and Type	Method and Description
<F> IndexSchemaFieldOptionsStep<?,IndexFieldReference<F>>	field(String relativeFieldName, Function<? super IndexFieldTypeFactory,? extends IndexFieldTypeFinalStep<F>> typeContributor) Add a field to this index schema element with the type to be defined by the given function.
<F> IndexSchemaFieldOptionsStep<?,IndexFieldReference<F>>	field(String relativeFieldName, IndexFieldType<F> type) Add a field to this index schema element with the given type.
default <F> IndexSchemaFieldOptionsStep<?,IndexFieldReference<F>>	field(String relativeFieldName, IndexFieldTypeFinalStep<F> dslFinalStep) Add a field to this index schema element with the given almost-built type.
default IndexSchemaObjectField	objectField(String relativeFieldName) Add an object field to this index schema element with the default storage type.
IndexSchemaObjectField	objectField(String relativeFieldName, ObjectFieldStorage storage) Add an object field to this index schema element with the given storage type.

Method Detail

field

<F> IndexSchemaFieldOptionsStep<?,IndexFieldReference<F>> field(String relativeFieldName,
                                                                IndexFieldType<F> type)

Add a field to this index schema element with the given type.

Type Parameters:

F - The type of values held by the field.

Parameters:

relativeFieldName - The relative name of the new field.

type - The type of the new field.

Returns:

A DSL step where the field can be defined in more details, and where a a reference to the field can be obtained.

field

default <F> IndexSchemaFieldOptionsStep<?,IndexFieldReference<F>> field(String relativeFieldName,
                                                                        IndexFieldTypeFinalStep<F> dslFinalStep)

Add a field to this index schema element with the given almost-built type.

Type Parameters:

F - The type of values held by the field.

Parameters:

relativeFieldName - The relative name of the new field.

dslFinalStep - A final step in the index field type DSL allowing the retrieval of an IndexFieldType.

Returns:

A DSL step where the field can be defined in more details, and where a a reference to the field can be obtained.

field

<F> IndexSchemaFieldOptionsStep<?,IndexFieldReference<F>> field(String relativeFieldName,
                                                                Function<? super IndexFieldTypeFactory,? extends IndexFieldTypeFinalStep<F>> typeContributor)

Add a field to this index schema element with the type to be defined by the given function.

Best used with lambda expressions.

Type Parameters:

F - The type of accessors for the new field.

Parameters:

relativeFieldName - The relative name of the new field.

typeContributor - A function that will use the factory passed in parameter to create a type, returning the final step in the predicate DSL. Should generally be a lambda expression.

Returns:

A DSL step where the field can be defined in more details, and where a a reference to the field can be obtained.

objectField

default IndexSchemaObjectField objectField(String relativeFieldName)

Add an object field to this index schema element with the default storage type.

Parameters:

relativeFieldName - The relative name of the new field.

Returns:

An IndexSchemaObjectField, where the field can be defined in more details, in particular by adding new child fields to it, and where ultimately a a reference to the field can be obtained.

objectField

IndexSchemaObjectField objectField(String relativeFieldName,
                                   ObjectFieldStorage storage)

Add an object field to this index schema element with the given storage type.

Parameters:

relativeFieldName - The relative name of the new field.

storage - The storage type.

Returns:

An IndexSchemaObjectField, where the field can be defined in more details, in particular by adding new child fields to it, and where ultimately a a reference to the field can be obtained.

See Also:

ObjectFieldStorage