com.atlassian.confluence.search.v2

Class DefaultSearchWithToken

java.lang.Object

com.atlassian.confluence.search.v2.DefaultSearchWithToken

All Implemented Interfaces:

ISearch, SearchWithToken

public class DefaultSearchWithToken
extends Object
implements SearchWithToken

Constructor Summary

Constructors

Constructor and Description
DefaultSearchWithToken(ISearch delegate, long searchToken)

Method Summary

Modifier and Type	Method and Description
Optional<HightlightParams>	getHighlight() Provides indication as well as pre/post tag whether query terms should be highlighted in title and body of a search result.
int	getLimit()
SearchQuery	getQuery()
ResultFilter	getResultFilter() Returns the result filter component of the search.
SearchFilter	getSearchFilter()
EnumSet<SearchIndex>	getSearchIndexes() Specifies which indexes should be targeted for this particular search.
long	getSearchToken()
String	getSearchType() Returns type of search e.g.
SearchSort	getSort()
int	getStartOffset()
boolean	isExplain()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultSearchWithToken

public DefaultSearchWithToken(ISearch delegate,
                              long searchToken)

Method Detail

getSearchToken

public long getSearchToken()

Specified by:

getSearchToken in interface SearchWithToken

Returns:

a search token that allows additional searching to be performed against a specific version of the index (perhaps older version).

getQuery

public SearchQuery getQuery()

Specified by:

getQuery in interface ISearch

Returns:

the query component of the search

getSort

public SearchSort getSort()

Specified by:

getSort in interface ISearch

Returns:

the sort component of the search

getSearchFilter

public SearchFilter getSearchFilter()

Specified by:

getSearchFilter in interface ISearch

Returns:

the search filter component of the search

getResultFilter

public ResultFilter getResultFilter()

Description copied from interface: ISearch

Returns the result filter component of the search.

Note: if a non-null ResultFilter is returned here, it will override ISearch.getStartOffset() and ISearch.getLimit()

Specified by:

getResultFilter in interface ISearch

Returns:

the result filter 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

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

getSearchIndexes

public EnumSet<SearchIndex> getSearchIndexes()

Description copied from interface: ISearch

Specifies which indexes should be targeted for this particular search.

Specified by:

getSearchIndexes in interface ISearch