public class

LuceneContentNameSearcher

extends Object
implements ContentNameSearcher
java.lang.Object
   ↳ com.atlassian.confluence.search.contentnames.lucene.LuceneContentNameSearcher

Summary

Constants
String CONTENT_NAME_UNSTEMMED_FIELD
int MAX_RESULTS
String PARENT_TITLE_UNSTEMMED_FIELD
Public Constructors
LuceneContentNameSearcher(ContentNameScorer contentNameScorer, ResultCategoriser resultCategoriser, ResultConverter resultConverter)
Public Methods
Map<Category, List<SearchResult>> search(List<QueryToken> queryTokens, ResultTemplate resultTemplate, 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.
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
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)
Search returning results meeting the specified ResultTemplate.
Map<Category, List<SearchResult>> search(List<QueryToken> queryTokens)
Search and expect results using the Confluence default ResultTemplate.
List<SearchResult> searchNoCategorisation(List<QueryToken> queryTokens, ResultTemplate resultTemplate, 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.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.confluence.search.contentnames.ContentNameSearcher

Constants

public static final String CONTENT_NAME_UNSTEMMED_FIELD

Constant Value: "content-name-unstemmed"

public static final int MAX_RESULTS

Constant Value: 50 (0x00000032)

public static final String PARENT_TITLE_UNSTEMMED_FIELD

Constant Value: "parent-title-unstemmed"

Public Constructors

public LuceneContentNameSearcher (ContentNameScorer contentNameScorer, ResultCategoriser resultCategoriser, ResultConverter resultConverter)

Public Methods

public Map<Category, List<SearchResult>> search (List<QueryToken> queryTokens, ResultTemplate resultTemplate, 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.
resultTemplate 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

public 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.

public 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.

public 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.

public 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.

public List<SearchResult> searchNoCategorisation (List<QueryToken> queryTokens, ResultTemplate resultTemplate, 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 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