com.atlassian.confluence.search.contentnames.lucene
Class LuceneContentNameSearcher

java.lang.Object
  com.atlassian.confluence.search.contentnames.lucene.LuceneContentNameSearcher

All Implemented Interfaces:

ContentNameSearcher

public class LuceneContentNameSearcher
extends Object
implements ContentNameSearcher

Field Summary

static String	CONTENT_NAME_UNSTEMMED_FIELD
static int	MAX_RESULTS
static String	PARENT_TITLE_UNSTEMMED_FIELD

Constructor Summary

LuceneContentNameSearcher(ContentNameScorer contentNameScorer, ResultCategoriser resultCategoriser, ResultConverter resultConverter)

Method Summary

Map<Category,List<SearchResult>>	search(List<QueryToken> queryTokens) Search and expect results using the Confluence default 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, 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
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.

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT_NAME_UNSTEMMED_FIELD

public static final String CONTENT_NAME_UNSTEMMED_FIELD

See Also:

Constant Field Values

PARENT_TITLE_UNSTEMMED_FIELD

public static final String PARENT_TITLE_UNSTEMMED_FIELD

See Also:

Constant Field Values

MAX_RESULTS

public static final int MAX_RESULTS

See Also:

Constant Field Values

Constructor Detail

LuceneContentNameSearcher

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

Method Detail

search

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

Description copied from interface: ContentNameSearcher

Search and expect results using the Confluence default ResultTemplate.

Specified by:

search in interface ContentNameSearcher

Parameters:

queryTokens - the parsed tokens to search with.

Returns:

results keyed by the grouping they are for.

See Also:

ResultTemplate.DEFAULT, QueryTokenizer

search

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

Description copied from interface: ContentNameSearcher

Search returning results meeting the specified ResultTemplate.

Specified by:

search in interface ContentNameSearcher

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.

See Also:

QueryTokenizer

search

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

Description copied from interface: ContentNameSearcher

Search returning results in the specified space and ResultTemplate

Specified by:

search in interface ContentNameSearcher

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.

See Also:

QueryTokenizer

search

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

Description copied from interface: ContentNameSearcher

Search returning results in the specified space and ResultTemplate

Specified by:

search in interface ContentNameSearcher

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.

See Also:

QueryTokenizer

search

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)

Description copied from interface: ContentNameSearcher

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

Specified by:

search in interface ContentNameSearcher

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

Returns:

searchNoCategorisation

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)

Description copied from interface: ContentNameSearcher

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

Specified by:

searchNoCategorisation in interface ContentNameSearcher

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: