SearchResults.java

package gov.nysenate.openleg.model.search;

import gov.nysenate.openleg.dao.base.LimitOffset;
import gov.nysenate.openleg.dao.base.PaginatedList;

import java.util.List;
import java.util.stream.Collectors;

/**
 * Represents the basic structure of a search response with additional information such
 * as the total number of results matched as well as a LimitOffset reference to keep track
 * of pagination.
 *
 * @param <ResultType> The type of the result (should typically be an identifier such as BillId, AgendaId, etc).
 */
public class SearchResults<ResultType>
{
    /** The total number of results available. */
    private int totalResults;

    /** A list of the selected results. */
    private List<SearchResult<ResultType>> results;

    /** The limit offset value used to generate the results listing. */
    private LimitOffset limitOffset;

    /** --- Constructors --- */

    public SearchResults(int totalResults, List<SearchResult<ResultType>> results, LimitOffset limitOffset) {
        this.totalResults = totalResults;
        this.results = results;
        this.limitOffset = limitOffset;
    }

    /** --- Methods --- */

    public boolean hasResults() {
        return (totalResults > 0);
    }

    /** --- Overrides --- */

    @Override
    public String toString() {
        return "SearchResults{" + "resultCount=" + totalResults + ", results=" + results + ", limitOffset=" + limitOffset + '}';
    }

    /** --- Functional Getters/Setters --- */

    public PaginatedList<ResultType> toPaginatedList() {
        return new PaginatedList<>(totalResults, limitOffset,
                results.stream().map(SearchResult::getResult).collect(Collectors.toList()));
    }

    public List<ResultType> getRawResults() {
        return results.stream()
                .map(SearchResult::getResult)
                .collect(Collectors.toList());
    }

    /** --- Basic Getters/Setters --- */

    public int getTotalResults() {
        return totalResults;
    }

    public List<SearchResult<ResultType>> getResults() {
        return results;
    }

    public LimitOffset getLimitOffset() {
        return limitOffset;
    }
}