com.atlassian.confluence.search.contentnames
Interface ContentNameSearcher

All Known Implementing Classes:

LuceneContentNameSearcher

public interface ContentNameSearcher

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

Method Summary

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

Method Detail

search

java.util.Map<Category,java.util.List<SearchResult>> search(java.util.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:

java.lang.IllegalArgumentException - if the supplied queryTokens are empty

See Also:

ResultTemplate.DEFAULT, QueryTokenizer

search

java.util.Map<Category,java.util.List<SearchResult>> search(java.util.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:

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

See Also:

QueryTokenizer

search

java.util.Map<Category,java.util.List<SearchResult>> search(java.util.List<QueryToken> queryTokens,
                                                            ResultTemplate grouping,
                                                            java.lang.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:

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

See Also:

QueryTokenizer

search

java.util.Map<Category,java.util.List<SearchResult>> search(java.util.List<QueryToken> queryTokens,
                                                            ResultTemplate grouping,
                                                            java.util.Set<Attachment.Type> attachmentTypes,
                                                            java.lang.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.

attachmentTypes - attachment types to filter attachments on

Returns:

results keyed by the grouping they are for.

Throws:

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

See Also:

QueryTokenizer

search

java.util.Map<Category,java.util.List<SearchResult>> search(java.util.List<QueryToken> queryTokens,
                                                            ResultTemplate grouping,
                                                            java.util.Set<Attachment.Type> attachmentTypes,
                                                            boolean searchParentName,
                                                            int startIndex,
                                                            java.lang.Integer pageSize,
                                                            java.util.Map<java.lang.String,java.lang.Object> params,
                                                            java.lang.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 - the start index to search from

pageSize - the number of results to return from the startIndex

params - additional parameters to apply to the search

spaceKeys - the spaces to include in the search

Returns:

searchNoCategorisation

java.util.List<SearchResult> searchNoCategorisation(java.util.List<QueryToken> queryTokens,
                                                    ResultTemplate results,
                                                    java.util.Set<Attachment.Type> attachmentTypes,
                                                    boolean searchParentName,
                                                    int startIndex,
                                                    java.lang.Integer pageSize,
                                                    java.util.Map<java.lang.String,java.lang.Object> params,
                                                    java.lang.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 - the start index to search from

pageSize - the number of results to return from the startIndex

params - additional parameters to apply to the search

spaceKeys - the spaces to include in the search

Returns: