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

Interface IndexSchemaFieldTemplateOptionsStep<S extends IndexSchemaFieldTemplateOptionsStep<?>>

Type Parameters:

S - The "self" type (the actual exposed type of this step).

public interface IndexSchemaFieldTemplateOptionsStep<S extends IndexSchemaFieldTemplateOptionsStep<?>>

The final step in the definition of a field template in the index schema, where options can be set.

Method Summary

Modifier and Type	Method and Description
S	matchingPathGlob(String pathGlob) Restrict the field template to only fields whose path matches the given glob pattern.
S	multiValued() Mark the field as multi-valued.

Method Detail

matchingPathGlob

S matchingPathGlob(String pathGlob)

Restrict the field template to only fields whose path matches the given glob pattern.

Calling this method multiple times will only erase previously defined globs.

Parameters:

pathGlob - A glob pattern that paths must match. The wildcard * can be used to represent any string. The pattern is relative to the index schema element on which this template was created.

Returns:

this, for method chaining.

multiValued

S multiValued()

Mark the field as multi-valued.

This informs the backend that this field may contain multiple values for a single parent document or object.

Returns:

this, for method chaining.