com.atlassian.confluence.search.v2.lucene
Class LuceneSearchResults

java.lang.Object
  extended by com.atlassian.confluence.search.v2.lucene.LuceneSearchResults
All Implemented Interfaces:
SearchResults

public class LuceneSearchResults
extends java.lang.Object
implements SearchResults


Constructor Summary
LuceneSearchResults(java.util.List luceneResult, int unfilteredResultsCount)
           
 
Method Summary
 java.util.List getAll()
          Creates a new list containing all returned search results.
 int getUnfilteredResultsCount()
          Get the number of search results before being passed through any filter.
 java.util.Iterator iterator()
          Gets an iterator to run through the returned search results.
 int size()
          Get the number of search results included in this object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LuceneSearchResults

public LuceneSearchResults(java.util.List luceneResult,
                           int unfilteredResultsCount)
Method Detail

getUnfilteredResultsCount

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)

Specified by:
getUnfilteredResultsCount in interface SearchResults
Returns:
the number of search results before filtering takes place

size

public int size()
Description copied from interface: SearchResults
Get the number of search results included in this object.

Specified by:
size in interface SearchResults
Returns:
the number of search results returned

iterator

public java.util.Iterator iterator()
Description copied from interface: SearchResults
Gets an iterator to run through the returned search results.

Specified by:
iterator in interface SearchResults
Returns:
an iterator over the search results

getAll

public java.util.List getAll()
Description copied from interface: SearchResults
Creates a new list containing all returned search results.

Specified by:
getAll in interface SearchResults
Returns:
a new list containing all returned search results


Copyright © 2003-2008 Atlassian Pty Ltd. All Rights Reserved.