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

java.lang.Object
  extended by com.atlassian.confluence.search.contentnames.lucene.LuceneContentNameSearcher
All Implemented Interfaces:
ContentNameSearcher

public class LuceneContentNameSearcher
extends java.lang.Object
implements ContentNameSearcher


Field Summary
static java.lang.String CONTENT_NAME_UNSTEMMED_FIELD
           
static java.lang.String PARENT_TITLE_UNSTEMMED_FIELD
           
 
Constructor Summary
LuceneContentNameSearcher(ContentNameScorer contentNameScorer, ResultConverter resultConverter, CategoryMapperFactory categoryMapperFactory)
           
 
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 resultTemplate, 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 resultTemplate, 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 resultTemplate, 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.
 
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 java.lang.String CONTENT_NAME_UNSTEMMED_FIELD
See Also:
Constant Field Values

PARENT_TITLE_UNSTEMMED_FIELD

public static final java.lang.String PARENT_TITLE_UNSTEMMED_FIELD
See Also:
Constant Field Values
Constructor Detail

LuceneContentNameSearcher

public LuceneContentNameSearcher(ContentNameScorer contentNameScorer,
                                 ResultConverter resultConverter,
                                 CategoryMapperFactory categoryMapperFactory)
Method Detail

search

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


Copyright © 2003-2014 Atlassian. All Rights Reserved.