Package com.atlassian.confluence.search.v2

Interface ISearch

  • All Known Subinterfaces:
    SearchWithToken
    All Known Implementing Classes:
    AbstractSearch, ChangesSearch, ContentSearch, CustomSearch, DefaultSearch, DefaultSearchWithToken
    public interface ISearch
    A representation of a search to be performed. Searches are immutable, and consist of these parts:
    1. The SearchIndex(s) to perform the search on.
    2. The SearchQuery to be performed.
    3. The SearchSort describing the order to apply to the results.
    4. The zero-based startOffset of the results of the search.
    5. The limit or maximum number of results to return.
    6. isExplain indicating whether or not to provide explanation for the query.
    7. The HighlightParams describing how to highlight the search.
    WARNING: SearchIndex(s), startOffset, limit, and isExplain must be provided. The rest can be null, or empty (if a Collection) or not present (if an Optional).

    Implementations of this interface will provide fields which are relied upon by Confluence's V2 search API.

    It is recommended to extend AbstractSearch when providing a concrete implementation of this interface.

    See Also:
    SearchIndexAccessor, SearchManager, AbstractSearch

    • Method Detail

      • getQuery

        @NonNull SearchQuery getQuery()
        Returns:
        the non-null query component of the search

      • getSort

        SearchSort getSort()
        Returns:
        the sort component of the search

      • getStartOffset

        int getStartOffset()
        Returns:
        the start offset (0 based).

      • getLimit

        int getLimit()
        Returns:
        the maximum page size (positive).

      • getSearchType

        default String getSearchType()
        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.
        Returns:
        type of search

      • isExplain

        default boolean isExplain()

      • getSearchIndexes

        default EnumSet<SearchIndex> getSearchIndexes()
        IMPORTANT: Use the new getIndices method instead. Specifies which indexes should be targeted for this particular search.

      • getIndices

        default List<Index> getIndices()
        Returns:
        a list of indexes should be targeted
        Since:
        8.7.0

      • getSearchAfter

        default List<String> getSearchAfter()
        This method is only relevant to OpenSearch. It does not have any effect if querying against Lucene.
        Returns:
        a list of sorted field values
        Since:
        8.7.0

      • withSearchAfter

        default ISearch withSearchAfter​(List<String> searchAfter)
        This method is only relevant to OpenSearch. A class must implement this method. Otherwise, it will have no effect on the search results.
        Parameters:
        searchAfter - the searchAfter parameter
        Returns:
        a new ISearch containing the searchAfter parameter
        Since:
        8.7.0

      • withIndices

        default ISearch withIndices​(List<Index> indices)
        This method is only applicable for CustomSearch and DefaultSearch A class must implement this method. Otherwise, it will have no effect on the search results.
        Parameters:
        indices - the indices to search from
        Returns:
        a new ISearch containing the new indices
        Since:
        8.7.0

      • withQuery

        default ISearch withQuery​(SearchQuery query)
        A class must implement this method. Otherwise, UnsupportedOperationException will be thrown.
        Parameters:
        query - the query to be added to the search object
        Returns:
        a new ISearch containing the new query
        Throws:
        UnsupportedOperationException - if the class does not implement this method
        Since:
        8.7.0