io.keen.client.java.result.IntervalResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of keen-client-api-query Show documentation

Java Query Client API for Keen IO

There is a newer version: 6.0.0

Show newest version

package io.keen.client.java.result;

import java.util.Map;
import java.util.Collections;

import io.keen.client.java.AbsoluteTimeframe;

/**
 * IntervalResult is for if Interval properties were specified in the query.
 * If so, this object contains a Map that consist of 
 * 
 * AbsoluteTimeframe, which contains the timeframe as specified by the Interval
 * QueryResult, which is the result of the query as grouped by each timeframe
 * 
 *  *
 * @author claireyoung
 * @since 1.0.0, 07/06/15
 */
public class IntervalResult extends QueryResult {

    private final Map results;

    /**
     * @param results the result map of AbsoluteTimeframes to the QueryResult.
     */
    public IntervalResult(Map results) {
        this.results = Collections.unmodifiableMap(results);
    }

    /**
     * @return  {@code true}
     */
    @Override
    public boolean isIntervalResult() {
        return true;
    }

    /**
     * @return map of AbsoluteTimeframe to QueryResult objects
     */
    @Override
    public Map getIntervalResults() {
        return results;
    }

}