SearchResultSet (Gemma 1.31.5 API)

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractSet<SearchResult<T>>
  - - ubic.gemma.core.search.SearchResultSet<T>

All Implemented Interfaces:

Iterable<SearchResult<T>>, Collection<SearchResult<T>>, Set<SearchResult<T>>
```
public class SearchResultSet<T extends Identifiable>
extends AbstractSet<SearchResult<T>>
```
This is a special kind of set designed for holding SearchResult.
If a better result is added to the set, it replaces the existing one. If the original result had a non-null SearchResult#getResultObject(), it is transferred over so that it won't need to be filled later on if needed.
The collection also honor the SearchSettings#getMaxResults() value, rejecting any new result unless replacing an existing one.

Author:

poirigui

- Constructor Summary
  
  Constructors
  Constructor Description
  
  SearchResultSet(SearchSettings settings)
  
  SearchResultSet(SearchSettings settings, int initialCapacity)
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  boolean add(SearchResult<T> t)
  
  Iterator<SearchResult<T>> iterator()
  
  int size()
  - Methods inherited from class java.util.AbstractSet
    equals, hashCode, removeAll
  - Methods inherited from class java.util.AbstractCollection
    addAll, clear, contains, containsAll, isEmpty, remove, retainAll, toArray, toArray, toString
  - Methods inherited from class java.lang.Object
    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  - Methods inherited from interface java.util.Collection
    parallelStream, removeIf, stream
  - Methods inherited from interface java.lang.Iterable
    forEach
  - Methods inherited from interface java.util.Set
    addAll, clear, contains, containsAll, isEmpty, remove, retainAll, spliterator, toArray, toArray

- Constructor Detail
  - SearchResultSet
```
public SearchResultSet(SearchSettings settings)
```
  - SearchResultSet
```
public SearchResultSet(SearchSettings settings,
                       int initialCapacity)
```
- Method Detail
  - iterator
```
public Iterator<SearchResult<T>> iterator()
```
    Specified by:
    
    iterator in interface Collection<T extends Identifiable>
    
    Specified by:
    
    iterator in interface Iterable<T extends Identifiable>
    
    Specified by:
    
    iterator in interface Set<T extends Identifiable>
    
    Specified by:
    
    iterator in class AbstractCollection<SearchResult<T extends Identifiable>>
  - size
```
public int size()
```
    Specified by:
    
    size in interface Collection<T extends Identifiable>
    
    Specified by:
    
    size in interface Set<T extends Identifiable>
    
    Specified by:
    
    size in class AbstractCollection<SearchResult<T extends Identifiable>>
  - add
```
public boolean add(SearchResult<T> t)
```
    Specified by:
    
    add in interface Collection<T extends Identifiable>
    
    Specified by:
    
    add in interface Set<T extends Identifiable>
    
    Overrides:
    
    add in class AbstractCollection<SearchResult<T extends Identifiable>>