SearchResult.java

package com.tyndalehouse.step.core.models.search;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import java.util.SortedSet;

import com.tyndalehouse.step.core.models.AbstractComplexSearch;
import com.tyndalehouse.step.core.models.LexiconSuggestion;
import com.tyndalehouse.step.core.service.impl.SearchType;

/**
 * 
 * @author chrisburrell
 */
public class SearchResult extends AbstractComplexSearch implements Serializable {
    private static final long serialVersionUID = 5408141957094432935L;
    private String query;
    private int total;
    private long timeTookToRetrieveScripture;
    private List<SearchEntry> results;
    private List<String> strongHighlights;
    private String order;
    private List<LexiconSuggestion> definitions;
    private String[] languageCode;
    private int pageSize;
    private int pageNumber;
    private String searchRestriction;

    /**
     * @return the query
     */
    public String getQuery() {
        return this.query;
    }

    /**
     * @param query the query to set
     */
    public void setQuery(final String query) {
        this.query = query;
    }

    /**
     * @return the results
     */
    public List<SearchEntry> getResults() {
        return this.results;
    }

    /**
     * @param results the results to set
     */
    public void setResults(final List<SearchEntry> results) {
        this.results = results;
    }

    /**
     * @return the timeTookToRetrieveScripture
     */
    public long getTimeTookToRetrieveScripture() {
        return this.timeTookToRetrieveScripture;
    }

    /**
     * @param timeTookToRetrieveScripture the timeTookToRetrieveScripture to set
     */
    public void setTimeTookToRetrieveScripture(final long timeTookToRetrieveScripture) {
        this.timeTookToRetrieveScripture = timeTookToRetrieveScripture;
    }

    /**
     * Adds a search entry to the list of results
     * 
     * @param result result to be added
     */
    public void addEntry(final SearchEntry result) {
        if (this.results == null) {
            this.results = new ArrayList<SearchEntry>();
        }

        this.results.add(result);
    }

    /**
     * @return the total
     */
    public int getTotal() {
        return this.total;
    }

    /**
     * @param total the total to set
     */
    public void setTotal(final int total) {
        this.total = total;
    }

    /**
     * @return the strongHighlights
     */
    public List<String> getStrongHighlights() {
        return this.strongHighlights;
    }

    /**
     * @param strongHighlights the strongHighlights to set
     */
    public void setStrongHighlights(final List<String> strongHighlights) {
        this.strongHighlights = strongHighlights;
    }

    /**
     * @return the order
     */
    public String getOrder() {
        return this.order;
    }

    /**
     * @param order the order to set
     */
    public void setOrder(final String order) {
        this.order = order;
    }

    /**
     * @return the definitions
     */
    public List<LexiconSuggestion> getDefinitions() {
        return this.definitions;
    }

    /**
     * @param definitions the definitions to set
     */
    public void setDefinitions(final List<LexiconSuggestion> definitions) {
        this.definitions = definitions;
    }

    /**
     * @param languages The languages that were searched across
     */
    public void setLanguageCode(final String[] languages) {
        this.languageCode = languages;
    }

    /**
     * @return the languages that were searched across
     */
    public String[] getLanguageCode() {
        return languageCode;
    }

    /**
     * @param pageSize the page size used in the search
     */
    public void setPageSize(final int pageSize) {
        this.pageSize = pageSize;
    }

    /**
     * @return the page size
     */
    public int getPageSize() {
        return pageSize;
    }

    /**
     * @param pageNumber sets the current page number
     */
    public void setPageNumber(final int pageNumber) {
        this.pageNumber = pageNumber;
    }

    /**
     * @return the page number
     */
    public int getPageNumber() {
        return pageNumber;
    }

    /**
     * @return the search restriction
     */
    public String getSearchRestriction() {
        return searchRestriction;
    }

    /**
     * @param searchRestriction the name for the search restriction
     */
    public void setSearchRestriction(String searchRestriction) {
        this.searchRestriction = searchRestriction;
    }
}