Package com.atlassian.jira.search.query

Interface SpanNearQuery

All Superinterfaces:
Query
All Known Implementing Classes:
DefaultSpanNearQuery
@PublicApi public interface SpanNearQuery extends Query
A span near query
Since:
11.0

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    field()
    Returns the name of the field to search.
    boolean
    inOrder()
    Indicates whether the matching values must appear in the specified order.
    int
    slop()
    Returns the maximum number of intervening unmatched positions (slop) allowed between matching values.
    List<String>
    values()
    Returns the list of values to search for within the field.

    Methods inherited from interface com.atlassian.jira.search.Query

    named

  • Method Details

    • field

      String field()
      Returns the name of the field to search.
      Returns:
      the field name, never null or empty

    • values

      List<String> values()
      Returns the list of values to search for within the field.
      Returns:
      a non-empty list of non-null, non-empty values

    • slop

      int slop()
      Returns the maximum number of intervening unmatched positions (slop) allowed between matching values.

      Sensible values are non-negative integers, typically between 0 (exact adjacency) and 100. Excessively large slop values may impact performance and relevance.

      Returns:
      the slop value, must be >= 0

    • inOrder

      boolean inOrder()
      Indicates whether the matching values must appear in the specified order.
      Returns:
      true if values must appear in order, false otherwise