Package org.hibernate.search.engine.backend.types.dsl

Interface StringIndexFieldTypeOptionsStep<S extends StringIndexFieldTypeOptionsStep<?>>

Type Parameters:
S - The "self" type (the actual exposed type of this step).
All Superinterfaces:
IndexFieldTypeConverterStep<S,String>, IndexFieldTypeFinalStep<String>, IndexFieldTypeOptionsStep<S,String>, SearchableProjectableIndexFieldTypeOptionsStep<S,String>, StandardIndexFieldTypeOptionsStep<S,String>
public interface StringIndexFieldTypeOptionsStep<S extends StringIndexFieldTypeOptionsStep<?>> extends StandardIndexFieldTypeOptionsStep<S,String>
The initial and final step in a "string" index field type definition, where optional parameters can be set.

  • Method Details

    • analyzer

      S analyzer(String analyzerName)
      Define the type as analyzed.

      Incompatible with normalizer(String).

      Parameters:
      analyzerName - The name of an analyzer to apply to values before indexing and when querying the index. See the reference documentation for more information about analyzers and how to define them.
      Returns:
      this, for method chaining.

    • searchAnalyzer

      S searchAnalyzer(String searchAnalyzerName)
      Overrides analyzer(java.lang.String) to use for query parameters at search time.

      A search analyzer can only be set if an analyzer was set through analyzer(String).

      Parameters:
      searchAnalyzerName - The name of an analyzer to apply to values when querying the index only. It overrides the analyzer(String) when querying the index. See the reference documentation for more information about analyzers and how to define them.
      Returns:
      this, for method chaining.

    • normalizer

      S normalizer(String normalizerName)
      Define the type as normalized.

      Incompatible with analyzer(String).

      Parameters:
      normalizerName - The name of a normalizer to apply to values before indexing and when querying the index. See the reference documentation for more information about normalizers and how to define them.
      Returns:
      this, for method chaining.

    • norms

      S norms(Norms norms)
      Parameters:
      norms - Whether index-time scoring information for the field should be stored or not.
      Returns:
      this, for method chaining.
      See Also:

    • termVector

      S termVector(TermVector termVector)
      Parameters:
      termVector - The term vector storing strategy.
      Returns:
      this, for method chaining.
      See Also:

    • highlightable

      S highlightable(Collection<Highlightable> highlightable)
      Parameters:
      highlightable - Whether highlighting is supported and if so which highlighter types can be applied. Pass Collections.singleton(Highlightable.NO) to disable highlighting.
      Returns:
      this, for method chaining.
      See Also: