io.keen.client.java.result.FunnelResult 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;

/**
 * Represents the results from a Funnel analysis. This includes both the results of each FunnelStep
 * and optionally the 'actor_property's at each step, if requested.
 *
 * @author baumatron
 */
public class FunnelResult extends QueryResult {
    /**
     * The results of the funnel query
     */
    private final ListResult funnelResult;

    /**
     * If provided, the list of actor property values
     * for funnel steps that have specified the 'with_actors'
     * special property.
     */
    private final ListResult actorsResult;

    /**
     * Constructs a FunnelResult given the funnel query result and optionally
     * the actor field value results.
     * 
     * @param result        The ListResult for the funnel query.
     * @param actorsResult  Optionally, the actor property value result.
     */
    public FunnelResult(ListResult result, ListResult actorsResult) {
        
        if (null == result) {
            throw new IllegalArgumentException("No result value provided");
        }

        this.funnelResult = result;
        this.actorsResult = actorsResult;
    }

    /**
     * 
     * @return The ListResult for the actors property in the result response.
     */
    public ListResult getActorsResult() { return this.actorsResult; }

    /**
     * 
     * @return The ListResult containing the results of the funnel query.
     */
    public ListResult getFunnelResult() { return this.funnelResult; }
}