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

Go to download
package io.keen.client.java.result;

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

/**
 * GroupByResult is for if Group By properties were specified in the query.
 * If so, this object contains a Map that consist of 
 * 
 * Group, which contains the unique property/values
 * QueryResult, which is the result of the query as grouped by Group
 * 
 *
 * @author claireyoung
 * @since 1.0.0, 07/06/15
 */
public class GroupByResult extends QueryResult {
    private final Map results;

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

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

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

}