Package com.polarion.platform.persistence

Interface IIndexSearch

public interface IIndexSearch
Builder interface providing the methods to configure and execute index searches.
Since:
3.23.4

  • Method Details

    • indexName

      @NotNull IIndexSearch indexName(@NotNull String indexName)
      The index name. This is a mandatory property. Only the last value is used when the method is called more than once.

    • query

      @NotNull IIndexSearch query(@Nullable String query)
      Lucene query. Only the last value is used when the method is called more than once.

    • sort

      @NotNull IIndexSearch sort(@Nullable String sort)
      Specifies the sort order for the search results using a Lucene sort string. If the sort string is null, search results are sorted by relevance. (They are ranked based on their relevance to the query.)

      If a sort string is provided, it determines the sorting criteria as follows:
      • Use ~[sort field] to sort in descending order.
      • Use [sort field] to sort in ascending order.
      • Multiple criteria can be specified by separating them with spaces. The first criterion is applied first.

      For example:
      • sort="severity ~updated" will sort the results by severity in ascending order and by updated in descending order.
      In this example, results are first sorted by severity in ascending order. For items with the same severity, they are further sorted by updated in descending order.

    • baseline

      @NotNull IIndexSearch baseline(@Nullable String revision)
      Revision of the baseline that the search should be executed for. Only the last value is used when the method is called more than once.

    • limit

      @NotNull IIndexSearch limit(int limit)
      The maximum number of items to be returned, -1 for unlimited. Only the last value is used when the method is called more than once.

    • offset

      @NotNull IIndexSearch offset(int offset)
      The number of first items to exclude from the result list. If the offset exceeds the total number of objects, an empty list is returned. Only the last value is used when the method is called more than once.

    • result

      @NotNull IIndexSearchResult result()