Package com.atlassian.confluence.search.contentnames

Interface ContentNameSearcher

public interface ContentNameSearcher

Search for Confluence content by its name (for Pages we search title, for users, we search full names, etc.).

Method Summary

Modifier and Type	Method	Description
default Map<Category,List<SearchResult>>	search(List<QueryToken> queryTokens)	Search and expect results using the Confluence default ResultTemplate.
default Map<Category,List<SearchResult>>	search(List<QueryToken> queryTokens, ResultTemplate grouping)	Search returning results meeting the specified ResultTemplate.
default Map<Category,List<SearchResult>>	search(List<QueryToken> queryTokens, ResultTemplate grouping, String... spaceKeys)	Search returning results in the specified space and ResultTemplate
Map<Category,List<SearchResult>>	search(List<QueryToken> queryTokens, ResultTemplate grouping, Set<Attachment.Type> attachmentTypes, boolean searchParentName, int startIndex, Integer pageSize, Map<String,Object> params, String... spaceKeys)	Search returning results in the specified space and ResultTemplate include pagination and search parent name support.
default Map<Category,List<SearchResult>>	search(List<QueryToken> queryTokens, ResultTemplate resultTemplate, Set<Attachment.Type> attachmentTypes, String... spaceKeys)	Search returning results in the specified space and ResultTemplate
List<SearchResult>	searchNoCategorisation(List<QueryToken> queryTokens, ResultTemplate results, Set<Attachment.Type> attachmentTypes, boolean searchParentName, int startIndex, Integer pageSize, Map<String,Object> params, String... spaceKeys)	Search returning results in the specified space and ResultTemplate include pagination and search parent name support.

Method Detail

search

default Map<Category,List<SearchResult>> search(List<QueryToken> queryTokens)

Search and expect results using the Confluence default ResultTemplate.

Parameters:

queryTokens - the parsed tokens to search with.

Returns:

results keyed by the grouping they are for.

Throws:

IllegalArgumentException - if the supplied queryTokens are empty

See Also:

ResultTemplate.DEFAULT, QueryTokenizer

search

default Map<Category,List<SearchResult>> search(List<QueryToken> queryTokens,
                                                      ResultTemplate grouping)

Search returning results meeting the specified ResultTemplate.

Parameters:

queryTokens - the parsed tokens to search with.

grouping - the grouping of the results you require.

Returns:

results keyed by the grouping they are for.

Throws:

IllegalArgumentException - if the supplied queryTokens are empty or the supplied grouping is null.

See Also:

QueryTokenizer

search

default Map<Category,List<SearchResult>> search(List<QueryToken> queryTokens,
                                                      ResultTemplate grouping,
                                                      String... spaceKeys)

Search returning results in the specified space and ResultTemplate

Parameters:

queryTokens - the parsed tokens to search with.

grouping - the grouping of the results you require.

Returns:

results keyed by the grouping they are for.

Throws:

IllegalArgumentException - if the supplied queryTokens are empty or the supplied grouping is null.

See Also:

QueryTokenizer

search

default Map<Category,List<SearchResult>> search(List<QueryToken> queryTokens,
                                                      ResultTemplate resultTemplate,
                                                      Set<Attachment.Type> attachmentTypes,
                                                      String... spaceKeys)

Search returning results in the specified space and ResultTemplate

Parameters:

queryTokens - the parsed tokens to search with.

resultTemplate - the grouping of the results you require.

attachmentTypes - attachment types to filter attachments on

Returns:

results keyed by the grouping they are for.

Throws:

IllegalArgumentException - if the supplied queryTokens are empty or the supplied grouping is null.

See Also:

QueryTokenizer

search

Map<Category,List<SearchResult>> search(List<QueryToken> queryTokens,
                                              ResultTemplate grouping,
                                              Set<Attachment.Type> attachmentTypes,
                                              boolean searchParentName,
                                              int startIndex,
                                              Integer pageSize,
                                              Map<String,Object> params,
                                              String... spaceKeys)

Search returning results in the specified space and ResultTemplate include pagination and search parent name support.

Parameters:

queryTokens - the parsed tokens to search with.

grouping - the grouping of the results you require.

attachmentTypes - attachment types to filter attachments on

searchParentName - also applies the search to the parent name of the object (e.g. page name)

startIndex - ignored

pageSize - ignored

params - additional parameters to apply to the search

spaceKeys - the spaces to include in the search

Returns:

searchNoCategorisation

List<SearchResult> searchNoCategorisation(List<QueryToken> queryTokens,
                                          ResultTemplate results,
                                          Set<Attachment.Type> attachmentTypes,
                                          boolean searchParentName,
                                          int startIndex,
                                          Integer pageSize,
                                          Map<String,Object> params,
                                          String... spaceKeys)

Search returning results in the specified space and ResultTemplate include pagination and search parent name support. Results are not grouped.

Parameters:

queryTokens - the parsed tokens to search with.

attachmentTypes - attachment types to filter attachments on

searchParentName - also applies the search to the parent name of the object (e.g. page name)

startIndex - ignored

pageSize - ignored

params - additional parameters to apply to the search

spaceKeys - the spaces to include in the search

Returns: