Package org.hibernate.search.engine.search.predicate.dsl

Interface PhrasePredicateFieldStep<SR,N extends PhrasePredicateFieldMoreStep<SR,?,?>>

Type Parameters:
SR - Scope root type.
N - The type of the next step.
public interface PhrasePredicateFieldStep<SR,N extends PhrasePredicateFieldMoreStep<SR,?,?>>
The initial step in a "phrase" predicate definition, where the target field can be set.

  • Method Summary

    Modifier and Type
    Method
    Description
    default N
    field(String fieldPath)
    Target the given field in the phrase predicate.
    default N
    field(PhrasePredicateFieldReference<? super SR,?> fieldReference)
    Target the given field in the phrase predicate.
    N
    fields(String... fieldPaths)
    Target the given fields in the phrase predicate.
    default N
    fields(PhrasePredicateFieldReference<? super SR,?>... fields)
    Target the given fields in the phrase predicate.

  • Method Details

    • field

      default N field(String fieldPath)
      Target the given field in the phrase predicate.

      Only text fields are supported.

      Multiple fields may be targeted by the same predicate: the predicate will match if any targeted field matches.

      When targeting multiple fields, those fields must have compatible types. Please refer to the reference documentation for more information.

      Parameters:
      fieldPath - The path to the index field to apply the predicate on.
      Returns:
      The next step.

    • fields

      N fields(String... fieldPaths)
      Target the given fields in the phrase predicate.

      Only text fields are supported.

      Equivalent to field(String) followed by multiple calls to PhrasePredicateFieldMoreStep.field(String), the only difference being that calls to MultiFieldPredicateFieldBoostStep.boost(float) and other field-specific settings on the returned step will only need to be done once and will apply to all the fields passed to this method.

      Parameters:
      fieldPaths - The paths to the index fields to apply the predicate on.
      Returns:
      The next step.
      See Also:

    • field

      @Incubating default N field(PhrasePredicateFieldReference<? super SR,?> fieldReference)
      Target the given field in the phrase predicate.

      Only text fields are supported.

      Multiple fields may be targeted by the same predicate: the predicate will match if any targeted field matches.

      When targeting multiple fields, those fields must have compatible types. Please refer to the reference documentation for more information.

      Parameters:
      fieldReference - The field reference representing a definition of the index field to apply the predicate on.
      Returns:
      The next step.
      See Also:

    • fields

      @Incubating default N fields(PhrasePredicateFieldReference<? super SR,?>... fields)
      Target the given fields in the phrase predicate.

      Only text fields are supported.

      Equivalent to field(PhrasePredicateFieldReference) followed by multiple calls to PhrasePredicateFieldMoreStep.field(PhrasePredicateFieldReference), the only difference being that calls to MultiFieldPredicateFieldBoostStep.boost(float) and other field-specific settings on the returned step will only need to be done once and will apply to all the fields passed to this method.

      Parameters:
      fields - The field references representing paths to the index fields to apply the predicate on.
      Returns:
      The next step.
      See Also: