public class

LuceneSearchResults

extends Object
implements SearchResults
java.lang.Object
   ↳ com.atlassian.confluence.search.v2.lucene.LuceneSearchResults

Summary

Fields
public static final LuceneSearchResults EMPTY_RESULTS
Public Constructors
LuceneSearchResults(List<? extends SearchResult> luceneResult, int unfilteredResultsCount)
Public Methods
List<SearchResult> getAll()
Creates a new list containing all returned search results.
List<String> getSearchWords()
int getUnfilteredResultsCount()
Get the number of search results before being passed through any filter.
Iterator<SearchResult> iterator()
Gets an iterator to run through the returned search results.
void setSearchWords(List<String> searchWords)
int size()
Get the number of search results included in this object.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.confluence.search.v2.SearchResults
From interface java.lang.Iterable

Fields

public static final LuceneSearchResults EMPTY_RESULTS

Public Constructors

public LuceneSearchResults (List<? extends SearchResult> luceneResult, int unfilteredResultsCount)

Public Methods

public List<SearchResult> getAll ()

Creates a new list containing all returned search results.

Returns
  • a new list containing all returned search results

public List<String> getSearchWords ()

public int getUnfilteredResultsCount ()

Get the number of search results before being passed through any filter. (i.e. to get the total number of results before taking only the first ten)

Returns
  • the number of search results before filtering takes place

public Iterator<SearchResult> iterator ()

Gets an iterator to run through the returned search results.

Returns
  • an iterator over the search results

public void setSearchWords (List<String> searchWords)

public int size ()

Get the number of search results included in this object.

Returns
  • the number of search results returned