com.atlassian.confluence.search.v2.lucene
Interface LuceneSearcher

All Known Implementing Classes:

LuceneSearcherImpl

public interface LuceneSearcher

Responsible for performing a lucene search.

Method Summary

LuceneSearchResults	search(org.apache.lucene.search.Query query, org.apache.lucene.search.Sort sort, org.apache.lucene.search.Filter searchFilter, LuceneResultFilter resultFilter) Deprecated. since 4.0 - use @see search(Query query, Sort sort, Filter searchFilter, LuceneResultFilter resultFilter, Set requestedFields) or com.atlassian.confluence.search.v2.SearchManager
LuceneSearchResults	search(org.apache.lucene.search.Query query, org.apache.lucene.search.Sort sort, org.apache.lucene.search.Filter searchFilter, LuceneResultFilter resultFilter, java.util.Set<java.lang.String> requestedFields) Performs a lucene search.

Method Detail

search

LuceneSearchResults search(org.apache.lucene.search.Query query,
                           org.apache.lucene.search.Sort sort,
                           org.apache.lucene.search.Filter searchFilter,
                           LuceneResultFilter resultFilter,
                           java.util.Set<java.lang.String> requestedFields)

Performs a lucene search.

Parameters:

query - the query to run

sort - the sort to perform sorting by

searchFilter - the filter that is run during the search

resultFilter - the filter that is run after a search once the results have returned

requestedFields - - the fields to load into the search result, if this is null or empty all fields will be loaded

Returns:

search results

search

@Deprecated
LuceneSearchResults search(org.apache.lucene.search.Query query,
                                      org.apache.lucene.search.Sort sort,
                                      org.apache.lucene.search.Filter searchFilter,
                                      LuceneResultFilter resultFilter)

Deprecated. since 4.0 - use @see search(Query query, Sort sort, Filter searchFilter, LuceneResultFilter resultFilter, Set requestedFields) or com.atlassian.confluence.search.v2.SearchManager

Performs a lucene search, loading all fields into the search result. It is more performant to specify which fields are required from the search result if they are known ahead of time.

Parameters:

query - the query to run

sort - the sort to perform sorting by

searchFilter - the filter that is run during the search

resultFilter - the filter that is run after a search once the results have returned

Returns:

search results