Package com.atlassian.confluence.internal.search

Class DecoratedSearchManager.DecoratedSearch

java.lang.Object
com.atlassian.confluence.internal.search.DecoratedSearchManager.DecoratedSearch
All Implemented Interfaces:
ISearch
Enclosing class:
DecoratedSearchManager
protected static class DecoratedSearchManager.DecoratedSearch extends Object implements ISearch

  • Method Details

    • getQuery

      public @NonNull SearchQuery getQuery()
      Specified by:
      getQuery in interface ISearch
      Returns:
      the non-null query component of the search

    • getSort

      public SearchSort getSort()
      Specified by:
      getSort in interface ISearch
      Returns:
      the sort component of the search

    • getStartOffset

      public int getStartOffset()
      Specified by:
      getStartOffset in interface ISearch
      Returns:
      the start offset (0 based).

    • getLimit

      public int getLimit()
      Specified by:
      getLimit in interface ISearch
      Returns:
      the maximum page size (positive).

    • getSearchType

      public String getSearchType()
      Description copied from interface: ISearch
      Returns type of search e.g. SiteSearch, RecentUpdate, NetworkFeed, BlogUpdate, which can be used by search manager to switch between different implementations to support incremental roll out.
      Specified by:
      getSearchType in interface ISearch
      Returns:
      type of search

    • getHighlight

      public Optional<HightlightParams> getHighlight()
      Description copied from interface: ISearch
      Provides indication as well as pre/post tag whether query terms should be highlighted in title and body of a search result. See SearchResult.getDisplayTitleWithHighlights() and SearchResult.getResultExcerptWithHighlights().
      Specified by:
      getHighlight in interface ISearch

    • isExplain

      public boolean isExplain()
      Specified by:
      isExplain in interface ISearch

    • generatesToken

      public boolean generatesToken()
      Description copied from interface: ISearch
      Specifies whether the resulting SearchResults.getNextPageSearch() will be generated with a token. A search token allows additional searching to be performed against a specific version of the index.

      Note: for backward compatibility reason, this value only applies to OpenSearch where it's especially costly to generate a token for every search request. On Lucene, this value is currently ignored, i.e. it will continue to generate a token for every search request. This may change in the future, so if you require a token, you should make this return true.

      Specified by:
      generatesToken in interface ISearch
      Returns:
      true if SearchResults.getNextPageSearch() should be generated with a token

    • getSearchIndexes

      public EnumSet<SearchIndex> getSearchIndexes()
      Description copied from interface: ISearch
      IMPORTANT: Use the new getIndices method instead. Specifies which indexes should be targeted for this particular search.
      Specified by:
      getSearchIndexes in interface ISearch

    • getIndices

      public List<Index> getIndices()
      Specified by:
      getIndices in interface ISearch
      Returns:
      a list of indexes should be targeted

    • toBuilder

      public ISearch.Builder<DecoratedSearchManager.DecoratedSearch> toBuilder()
      Specified by:
      toBuilder in interface ISearch
      Returns:
      a builder that's initialised with the values of the current search object