com.kii.cloud.analytics.aggregationresult

Class ResultQuery

java.lang.Object

com.kii.cloud.analytics.aggregationresult.ResultQuery

public class ResultQuery
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResultQuery.Builder

Constructor Summary

Constructors

Constructor and Description
ResultQuery() Deprecated. Use one of the following method to create a ResultQuery builder and call ResultQuery.Builder.build() to get an instance. builderWithGroupingKey(String) Create a builder with grouping key added in it. builderWithDateRange(DateRange) Create a builder with date range added in it. builderWithFilter(Filter) Create a builder with filter added in it.

Method Summary

Methods

Modifier and Type	Method and Description
static ResultQuery.Builder	builderWithDateRange(DateRange dateRange) Create Builder with the date range.
static ResultQuery.Builder	builderWithFilter(Filter filter) Create Builder with the filter.
static ResultQuery.Builder	builderWithGroupingKey(java.lang.String groupingKey) Create Builder with the grouping key.
DateRange	getDateRange() Get date range of result.
Filter	getFilter() Get grouping key.
java.lang.String	getGroupingKey() Get filter of results
void	setDateRange(DateRange dateRange) Deprecated. Use ResultQuery.Builder.withDateRange(DateRange) to create result query with dateRange.
void	setFilter(Filter filter) Deprecated. Use ResultQuery.Builder.withFilter(Filter) to create result query with filter.
void	setGrouping(java.lang.String groupingKey) Deprecated. Use ResultQuery.Builder.withGroupingKey(String) to create result query with grouping key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResultQuery

public ResultQuery()

Deprecated. Use one of the following method to create a ResultQuery builder and call ResultQuery.Builder.build() to get an instance.

builderWithGroupingKey(String) Create a builder with grouping key added in it.

builderWithDateRange(DateRange) Create a builder with date range added in it.

builderWithFilter(Filter) Create a builder with filter added in it.

Method Detail

setGrouping

public void setGrouping(java.lang.String groupingKey)

Deprecated. Use ResultQuery.Builder.withGroupingKey(String) to create result query with grouping key.

Set grouping key. used to filter result in one grouping specified on aggregation rule.

Parameters:

groupingKey -

setFilter

public void setFilter(Filter filter)

Deprecated. Use ResultQuery.Builder.withFilter(Filter) to create result query with filter.

Set filter of results

Parameters:

filter -

setDateRange

public void setDateRange(DateRange dateRange)

Deprecated. Use ResultQuery.Builder.withDateRange(DateRange) to create result query with dateRange.

Set date range of result

Parameters:

dateRange - DateRange that contains start and end date.

getFilter

public Filter getFilter()

Get grouping key. used to filter result in one grouping specified on aggregation rule.

getGroupingKey

public java.lang.String getGroupingKey()

Get filter of results

getDateRange

public DateRange getDateRange()

Get date range of result.

Returns:

dateRange DateRange that contains start and end date.

builderWithFilter

public static ResultQuery.Builder builderWithFilter(Filter filter)

Create Builder with the filter.

Parameters:

filter -

Returns:

Builder instance.

Throws:

java.lang.IllegalArgumentException - when the filter is null.

builderWithGroupingKey

public static ResultQuery.Builder builderWithGroupingKey(java.lang.String groupingKey)

Create Builder with the grouping key.

Parameters:

groupingKey - used to filter result in one grouping specified on aggregation rule.

Returns:

Builder instance.

Throws:

java.lang.IllegalArgumentException - Thrown if groupingKey is invalid. For the explanation of validation rules, refer to KiiEvent.validateKey(String) or KiiEvent.isValidKey(String).

builderWithDateRange

public static ResultQuery.Builder builderWithDateRange(DateRange dateRange)

Create Builder with the date range.

Parameters:

dateRange - DateRange that contains start and end date.

Returns:

Builder instance.

Throws:

java.lang.IllegalArgumentException - when the dateRange is null.