net.ravendb.client.documents.queries.GenericQueryResult Maven / Gradle / Ivy

Go to download
package net.ravendb.client.documents.queries;

import java.util.Map;

public class GenericQueryResult extends QueryResultBase {
    private int totalResults;
    private long longTotalResults;
    private Integer cappedMaxResults;
    private int skippedResults;
    private Map> highlightings;
    private Map explanations;
    private long durationInMs;
    private long resultSize;

    /**
     * Gets the total results for this query
     * @return Total results for given query
     */
    public int getTotalResults() {
        return totalResults;
    }

    /**
     * Sets the total results for this query
     * @param totalResults Sets the total results
     */
    public void setTotalResults(int totalResults) {
        this.totalResults = totalResults;
    }

    /**
     * Gets the total results as long for this query
     * @return Total results as long for this query
     */
    public long getLongTotalResults() {
        return longTotalResults;
    }

    /**
     * Sets the total results as long for this query
     * @param longTotalResults Total result as long for this query
     */
    public void setLongTotalResults(long longTotalResults) {
        this.longTotalResults = longTotalResults;
    }

    /**
     * Gets the total results for the query, taking into account the
     * offset / limit clauses for this query
     * @return Total results
     */
    public Integer getCappedMaxResults() {
        return cappedMaxResults;
    }

    /**
     * Sets the total results for the query, taking into account the
     * offset / limit clauses for this query
     * @param cappedMaxResults total results
     */
    public void setCappedMaxResults(Integer cappedMaxResults) {
        this.cappedMaxResults = cappedMaxResults;
    }

    /**
     * Gets the skipped results
     * @return Amount of skipped results
     */
    public int getSkippedResults() {
        return skippedResults;
    }

    /**
     * Sets the skipped results
     * @param skippedResults Sets the skipped results
     */
    public void setSkippedResults(int skippedResults) {
        this.skippedResults = skippedResults;
    }

    /**
     * @return Highlighter results (if requested).
     */
    public Map> getHighlightings() {
        return highlightings;
    }

    /**
     * @param highlightings Highlighter results (if requested).
     */
    public void setHighlightings(Map> highlightings) {
        this.highlightings = highlightings;
    }

    /**
     * @return Explanations (if requested).
     */
    public Map getExplanations() {
        return explanations;
    }

    /**
     * @param explanations Explanations (if requested).
     */
    public void setExplanations(Map explanations) {
        this.explanations = explanations;
    }

    /**
     * The duration of actually executing the query server side
     * @return Query duration in milliseconds
     */
    public long getDurationInMs() {
        return durationInMs;
    }

    /**
     * The duration of actually executing the query server side
     * @param durationInMs Sets the query duration
     */
    public void setDurationInMs(long durationInMs) {
        this.durationInMs = durationInMs;
    }

    /**
     * The size of the request which were sent from the server.
     * This value is the _uncompressed_ size.
     * @deprecated ResultSize is not supported anymore. Will be removed in next major version of the product.
     * @return uncompressed result size
     */
    @Deprecated
    public long getResultSize() {
        return resultSize;
    }

    /**
     * The size of the request which were sent from the server.
     * This value is the _uncompressed_ size.
     * @deprecated ResultSize is not supported anymore. Will be removed in next major version of the product.
     * @param resultSize Sets the result size
     */
    @Deprecated
    public void setResultSize(long resultSize) {
        this.resultSize = resultSize;
    }

}