Interface StandardDataQueryBuilder.AggregationList

All Known Implementing Classes:

StandardDataQueryBuilderImpl.AggregationListImpl

Enclosing interface:

StandardDataQueryBuilder

public static interface StandardDataQueryBuilder.AggregationList

Method Summary

Modifier and Type	Method	Description
StandardDataQueryBuilder.AggregationList	avgFieldValue(String aggregationName, String fieldName)	Adds an aggregation that will calculate the average of a direct numeric field.
StandardDataQueryBuilder.AggregationList	avgNestedFieldFiltered(String aggregationName, String nestedPath, String filterField, String filterValue, String fieldName)	Avg aggregation on a numeric field inside an ES nested object, with the document selection restricted by a filter on another field of the same nested object (e.g. only nested objects where type=tool).
StandardDataQueryBuilder.AggregationList	avgVariableValue(String aggregationName, String variableName)	Adds an aggregation that will calculate the average value of a numeric variable with the given name.
StandardDataQueryBuilder.AggregationList	countActive(String aggregationName)	Adds an aggregation that will count the active instances.
StandardDataQueryBuilder.AggregationList	countByIdField(String aggregationNane)	Adds an aggregation that will do a cardinality aggregation on the id field, which gives back an approximation of the amount of documents.
StandardDataQueryBuilder.AggregationList	countCompleted(String aggregationName)	Adds an aggregation that will count the completed instances.
StandardDataQueryBuilder.AggregationList	countDistinctFieldValue(String aggregationName, String fieldName)	Cardinality (distinct count) aggregation on a keyword field.
StandardDataQueryBuilder.AggregationList	countStarted(String aggregationName)	Adds an aggregation that will count the started instances.
StandardDataQueryBuilder.AggregationList	distributionBusinessStatus(String aggregationName, int size)	Adds an aggregation that will create a distribution (i.e. buckets) of the possible values of the business status field.
StandardDataQueryBuilder.AggregationList	distributionParentScopeBusinessStatus(String aggregationName, int size)	Adds an aggregation that will create a distribution (i.e. buckets) of the possible values of the parent scope business status field.
StandardDataQueryBuilder.AggregationList	distributionRootScopeBusinessStatus(String aggregationName, int size)	Adds an aggregation that will create a distribution (i.e. buckets) of the possible values of the root scope business status field.
StandardDataQueryBuilder.AggregationList	distributionVariableValue(String aggregationName, String variableName, int size)	Adds an aggregation that will create a distribution (i.e. buckets) of the possible text values of a variable.
StandardDataQueryBuilder.AggregationList	groupByDateCompleted(String aggregationName, String interval)	Adds an aggregation that will group the results by date started The interval can be day, week, month, quarter or year
StandardDataQueryBuilder.AggregationList	groupByDateStarted(String aggregationName, String interval)	Adds an aggregation that will group the results by end time The interval can be day, week, month, quarter or year
StandardDataQueryBuilder.AggregationList	groupByDateStartedAndField(String aggregationName, String interval, String fieldName, int size, String order)	Date histogram on startTime with a terms sub-aggregation on the given keyword field.
StandardDataQueryBuilder.AggregationList	groupByDateStartedAndFieldWithSumField(String aggregationName, String interval, String fieldName, int size, String sumFieldName, String order)	Date histogram on startTime with a terms sub-aggregation on a keyword field and a sum leaf-aggregation on a numeric field per term.
StandardDataQueryBuilder.AggregationList	groupByDateStartedWithAvgField(String aggregationName, String interval, String fieldName)	Date histogram on startTime with an avg sub-aggregation on the given numeric field.
StandardDataQueryBuilder.AggregationList	groupByDateStartedWithAvgNestedFieldFiltered(String aggregationName, String nestedPath, String filterField, String filterValue, String fieldName, String interval)	Date histogram on startTime with an avg sub-aggregation over a numeric field inside an ES nested object, with the document selection restricted by a filter on another field of the same nested object.
StandardDataQueryBuilder.AggregationList	groupByDateStartedWithPercentileField(String aggregationName, String interval, String fieldName, double percent)	Date histogram on startTime with a single-percentile sub-aggregation on a numeric field.
StandardDataQueryBuilder.AggregationList	groupByDateStartedWithSumField(String aggregationName, String interval, String fieldName)	Date histogram on startTime with a sum sub-aggregation on the given numeric field.
StandardDataQueryBuilder.AggregationList	groupByDefinitionKey(String aggregationName)	Adds an aggregation that will group the results by definition key.
StandardDataQueryBuilder.AggregationList	groupByDefinitionKeyAndState(String aggregationName)	Adds an aggregation that will group the results by definition key and its state (completed/active).
StandardDataQueryBuilder.AggregationList	groupByField(String aggregationName, String fieldName, int size)	Adds a terms aggregation on a keyword field.
StandardDataQueryBuilder.AggregationList	groupByFieldWithAvgField(String aggregationName, String fieldName, int size, String avgFieldName)	Terms aggregation on a keyword field with an avg sub-aggregation on the given numeric field.
StandardDataQueryBuilder.AggregationList	groupByFieldWithAvgField(String aggregationName, String fieldName, int size, String avgFieldName, String order)	Same as groupByFieldWithAvgField(String, String, int, String) but with explicit bucket ordering; see groupByFieldWithSumField(String, String, int, String, String) for accepted order values.
StandardDataQueryBuilder.AggregationList	groupByFieldWithSumField(String aggregationName, String fieldName, int size, String sumFieldName)	Terms aggregation on a keyword field with a sum sub-aggregation on the given numeric field.
StandardDataQueryBuilder.AggregationList	groupByFieldWithSumField(String aggregationName, String fieldName, int size, String sumFieldName, String order)	Same as groupByFieldWithSumField(String, String, int, String) but with explicit bucket ordering.
StandardDataQueryBuilder.AggregationList	groupByNestedField(String aggregationName, String nestedPath, String fieldName, int size)	Adds a terms aggregation on a keyword field inside an ES nested object.
StandardDataQueryBuilder.AggregationList	groupByNestedFieldFiltered(String aggregationName, String nestedPath, String filterField, String filterValue, String fieldName, int size)	Terms aggregation on a keyword field inside an ES nested object, with the bucket selection restricted by a filter on another field of the same nested object (e.g. only nested objects where type=tool).
StandardDataQueryBuilder.AggregationList	groupByNestedFieldFiltered(String aggregationName, String nestedPath, String filterField, String filterValue, String fieldName, int size, String order)	Same as groupByNestedFieldFiltered(String, String, String, String, String, int) but with a configurable sort direction on the inner terms aggregation by _count.
StandardDataQueryBuilder.AggregationList	groupByNestedFieldFilteredWithAvgField(String aggregationName, String nestedPath, String filterField, String filterValue, String fieldName, int size, String avgFieldName)	Mirror of groupByNestedFieldFilteredWithSumField(String, String, String, String, String, int, String) using avg instead of sum.
StandardDataQueryBuilder.AggregationList	groupByNestedFieldFilteredWithAvgField(String aggregationName, String nestedPath, String filterField, String filterValue, String fieldName, int size, String avgFieldName, String order)	Same as groupByNestedFieldFilteredWithAvgField(String, String, String, String, String, int, String) but with explicit bucket ordering.
StandardDataQueryBuilder.AggregationList	groupByNestedFieldFilteredWithPercentileField(String aggregationName, String nestedPath, String filterField, String filterValue, String fieldName, int size, String percentileFieldName, double percent)	Mirror of groupByNestedFieldFilteredWithSumField(String, String, String, String, String, int, String) using a single-percentile sub-aggregation.
StandardDataQueryBuilder.AggregationList	groupByNestedFieldFilteredWithPercentileField(String aggregationName, String nestedPath, String filterField, String filterValue, String fieldName, int size, String percentileFieldName, double percent, String order)	Same as groupByNestedFieldFilteredWithPercentileField(String, String, String, String, String, int, String, double) but with explicit bucket ordering.
StandardDataQueryBuilder.AggregationList	groupByNestedFieldFilteredWithSumField(String aggregationName, String nestedPath, String filterField, String filterValue, String fieldName, int size, String sumFieldName)	Terms aggregation on a keyword field inside an ES nested object, restricted by a filter on a sibling field of that nested object, with a sum sub-aggregation on a numeric field within the same nested context.
StandardDataQueryBuilder.AggregationList	groupByNestedFieldFilteredWithSumField(String aggregationName, String nestedPath, String filterField, String filterValue, String fieldName, int size, String sumFieldName, String order)	Same as groupByNestedFieldFilteredWithSumField(String, String, String, String, String, int, String) but with explicit bucket ordering; see groupByFieldWithSumField(String, String, int, String, String) for accepted order values.
StandardDataQueryBuilder.AggregationList	maxFieldValue(String aggregationName, String fieldName)	Adds an aggregation that will calculate the max of a direct numeric field.
StandardDataQueryBuilder.AggregationList	maxVariableValue(String aggregationName, String variableName)	Adds an aggregation that will calculate the maximum value of a numeric variable with the given name.
StandardDataQueryBuilder.AggregationList	minFieldValue(String aggregationName, String fieldName)	Adds an aggregation that will calculate the min of a direct numeric field.
StandardDataQueryBuilder.AggregationList	minVariableValue(String aggregationName, String variableName)	Adds an aggregation that will calculate the minimum value of a numeric variable with the given name.
StandardDataQueryBuilder.AggregationList	percentileFieldValue(String aggregationName, String fieldName, double percent)	Single-percentile aggregation on a numeric field.
StandardDataQueryBuilder.AggregationList	stddevVariableValue(String aggregationName, String variableName)	Adds an aggregation that will calculate the standard deviation of a numeric variable with the given name.
StandardDataQueryBuilder.AggregationList	sumFieldValue(String aggregationName, String fieldName)	Adds an aggregation that will calculate the sum of a direct numeric field.
StandardDataQueryBuilder.AggregationList	sumVariableValue(String aggregationName, String variableName)	Adds an aggregation that will calculate the sum of a numeric variable with the given name.

Method Details

countByIdField

StandardDataQueryBuilder.AggregationList countByIdField(String aggregationNane)

Adds an aggregation that will do a cardinality aggregation on the id field, which gives back an approximation of the amount of documents.

countCompleted

StandardDataQueryBuilder.AggregationList countCompleted(String aggregationName)

Adds an aggregation that will count the completed instances.

countActive

StandardDataQueryBuilder.AggregationList countActive(String aggregationName)

Adds an aggregation that will count the active instances.

countStarted

StandardDataQueryBuilder.AggregationList countStarted(String aggregationName)

Adds an aggregation that will count the started instances.

groupByDefinitionKey

StandardDataQueryBuilder.AggregationList groupByDefinitionKey(String aggregationName)

Adds an aggregation that will group the results by definition key.

groupByDefinitionKeyAndState

StandardDataQueryBuilder.AggregationList groupByDefinitionKeyAndState(String aggregationName)

Adds an aggregation that will group the results by definition key and its state (completed/active).

groupByDateCompleted

StandardDataQueryBuilder.AggregationList groupByDateCompleted(String aggregationName,
 String interval)

Adds an aggregation that will group the results by date started The interval can be day, week, month, quarter or year

groupByDateStarted

StandardDataQueryBuilder.AggregationList groupByDateStarted(String aggregationName,
 String interval)

Adds an aggregation that will group the results by end time The interval can be day, week, month, quarter or year

maxVariableValue

StandardDataQueryBuilder.AggregationList maxVariableValue(String aggregationName,
 String variableName)

Adds an aggregation that will calculate the maximum value of a numeric variable with the given name.

minVariableValue

StandardDataQueryBuilder.AggregationList minVariableValue(String aggregationName,
 String variableName)

Adds an aggregation that will calculate the minimum value of a numeric variable with the given name.

avgVariableValue

StandardDataQueryBuilder.AggregationList avgVariableValue(String aggregationName,
 String variableName)

Adds an aggregation that will calculate the average value of a numeric variable with the given name.

stddevVariableValue

StandardDataQueryBuilder.AggregationList stddevVariableValue(String aggregationName,
 String variableName)

Adds an aggregation that will calculate the standard deviation of a numeric variable with the given name.

sumVariableValue

StandardDataQueryBuilder.AggregationList sumVariableValue(String aggregationName,
 String variableName)

Adds an aggregation that will calculate the sum of a numeric variable with the given name.

distributionVariableValue

StandardDataQueryBuilder.AggregationList distributionVariableValue(String aggregationName,
 String variableName,
 int size)

Adds an aggregation that will create a distribution (i.e. buckets) of the possible text values of a variable. E.g. { 'a': 23, 'b': 12, 'c': 3} The results are ordered by value (most occurrences first)

sumFieldValue

StandardDataQueryBuilder.AggregationList sumFieldValue(String aggregationName,
 String fieldName)

Adds an aggregation that will calculate the sum of a direct numeric field.

avgFieldValue

StandardDataQueryBuilder.AggregationList avgFieldValue(String aggregationName,
 String fieldName)

Adds an aggregation that will calculate the average of a direct numeric field.

maxFieldValue

StandardDataQueryBuilder.AggregationList maxFieldValue(String aggregationName,
 String fieldName)

Adds an aggregation that will calculate the max of a direct numeric field.

minFieldValue

StandardDataQueryBuilder.AggregationList minFieldValue(String aggregationName,
 String fieldName)

Adds an aggregation that will calculate the min of a direct numeric field.

groupByField

StandardDataQueryBuilder.AggregationList groupByField(String aggregationName,
 String fieldName,
 int size)

Adds a terms aggregation on a keyword field.

groupByNestedField

StandardDataQueryBuilder.AggregationList groupByNestedField(String aggregationName,
 String nestedPath,
 String fieldName,
 int size)

Adds a terms aggregation on a keyword field inside an ES nested object. Generates a nested wrapper around the terms aggregation.

countDistinctFieldValue

StandardDataQueryBuilder.AggregationList countDistinctFieldValue(String aggregationName,
 String fieldName)

Cardinality (distinct count) aggregation on a keyword field.

groupByDateStartedWithSumField

StandardDataQueryBuilder.AggregationList groupByDateStartedWithSumField(String aggregationName,
 String interval,
 String fieldName)

Date histogram on startTime with a sum sub-aggregation on the given numeric field.

groupByDateStartedWithAvgField

StandardDataQueryBuilder.AggregationList groupByDateStartedWithAvgField(String aggregationName,
 String interval,
 String fieldName)

Date histogram on startTime with an avg sub-aggregation on the given numeric field.

groupByDateStartedAndField

StandardDataQueryBuilder.AggregationList groupByDateStartedAndField(String aggregationName,
 String interval,
 String fieldName,
 int size,
 String order)

Date histogram on startTime with a terms sub-aggregation on the given keyword field.

groupByDateStartedAndFieldWithSumField

StandardDataQueryBuilder.AggregationList groupByDateStartedAndFieldWithSumField(String aggregationName,
 String interval,
 String fieldName,
 int size,
 String sumFieldName,
 String order)

Date histogram on startTime with a terms sub-aggregation on a keyword field and a sum leaf-aggregation on a numeric field per term.

groupByFieldWithSumField

StandardDataQueryBuilder.AggregationList groupByFieldWithSumField(String aggregationName,
 String fieldName,
 int size,
 String sumFieldName)

Terms aggregation on a keyword field with a sum sub-aggregation on the given numeric field.

groupByFieldWithSumField

StandardDataQueryBuilder.AggregationList groupByFieldWithSumField(String aggregationName,
 String fieldName,
 int size,
 String sumFieldName,
 String order)

Same as groupByFieldWithSumField(String, String, int, String) but with explicit bucket ordering. Accepted order values: countDesc (default), countAsc, valueDesc (top-N by sub-agg sum) and valueAsc. Selecting value-based ordering also bumps shard_size to compensate for the terms-aggregation accuracy loss documented by Elasticsearch.

groupByNestedFieldFiltered

StandardDataQueryBuilder.AggregationList groupByNestedFieldFiltered(String aggregationName,
 String nestedPath,
 String filterField,
 String filterValue,
 String fieldName,
 int size)

Terms aggregation on a keyword field inside an ES nested object, with the bucket selection restricted by a filter on another field of the same nested object (e.g. only nested objects where type=tool). Generates nested > filter > terms aggregation.

groupByNestedFieldFiltered

StandardDataQueryBuilder.AggregationList groupByNestedFieldFiltered(String aggregationName,
 String nestedPath,
 String filterField,
 String filterValue,
 String fieldName,
 int size,
 String order)

Same as groupByNestedFieldFiltered(String, String, String, String, String, int) but with a configurable sort direction on the inner terms aggregation by _count. Use "asc" to surface least-used buckets, or "desc" for the default most-used behaviour.

avgNestedFieldFiltered

StandardDataQueryBuilder.AggregationList avgNestedFieldFiltered(String aggregationName,
 String nestedPath,
 String filterField,
 String filterValue,
 String fieldName)

Avg aggregation on a numeric field inside an ES nested object, with the document selection restricted by a filter on another field of the same nested object (e.g. only nested objects where type=tool). Generates nested > filter > avg aggregation.

groupByDateStartedWithAvgNestedFieldFiltered

StandardDataQueryBuilder.AggregationList groupByDateStartedWithAvgNestedFieldFiltered(String aggregationName,
 String nestedPath,
 String filterField,
 String filterValue,
 String fieldName,
 String interval)

Date histogram on startTime with an avg sub-aggregation over a numeric field inside an ES nested object, with the document selection restricted by a filter on another field of the same nested object. Generates date_histogram > nested > filter > avg aggregation.

groupByFieldWithAvgField

StandardDataQueryBuilder.AggregationList groupByFieldWithAvgField(String aggregationName,
 String fieldName,
 int size,
 String avgFieldName)

Terms aggregation on a keyword field with an avg sub-aggregation on the given numeric field. Mirror of groupByFieldWithSumField(String, String, int, String).

groupByFieldWithAvgField

StandardDataQueryBuilder.AggregationList groupByFieldWithAvgField(String aggregationName,
 String fieldName,
 int size,
 String avgFieldName,
 String order)

Same as groupByFieldWithAvgField(String, String, int, String) but with explicit bucket ordering; see groupByFieldWithSumField(String, String, int, String, String) for accepted order values.

percentileFieldValue

StandardDataQueryBuilder.AggregationList percentileFieldValue(String aggregationName,
 String fieldName,
 double percent)

Single-percentile aggregation on a numeric field. Returns one value via values.<percent> in the result.

groupByDateStartedWithPercentileField

StandardDataQueryBuilder.AggregationList groupByDateStartedWithPercentileField(String aggregationName,
 String interval,
 String fieldName,
 double percent)

Date histogram on startTime with a single-percentile sub-aggregation on a numeric field. Generates date_histogram > percentiles aggregation.

groupByNestedFieldFilteredWithSumField

StandardDataQueryBuilder.AggregationList groupByNestedFieldFilteredWithSumField(String aggregationName,
 String nestedPath,
 String filterField,
 String filterValue,
 String fieldName,
 int size,
 String sumFieldName)

Terms aggregation on a keyword field inside an ES nested object, restricted by a filter on a sibling field of that nested object, with a sum sub-aggregation on a numeric field within the same nested context. Generates nested > filter > terms > sum aggregation.

groupByNestedFieldFilteredWithSumField

StandardDataQueryBuilder.AggregationList groupByNestedFieldFilteredWithSumField(String aggregationName,
 String nestedPath,
 String filterField,
 String filterValue,
 String fieldName,
 int size,
 String sumFieldName,
 String order)

Same as groupByNestedFieldFilteredWithSumField(String, String, String, String, String, int, String) but with explicit bucket ordering; see groupByFieldWithSumField(String, String, int, String, String) for accepted order values.

groupByNestedFieldFilteredWithAvgField

StandardDataQueryBuilder.AggregationList groupByNestedFieldFilteredWithAvgField(String aggregationName,
 String nestedPath,
 String filterField,
 String filterValue,
 String fieldName,
 int size,
 String avgFieldName)

Mirror of groupByNestedFieldFilteredWithSumField(String, String, String, String, String, int, String) using avg instead of sum.

groupByNestedFieldFilteredWithAvgField

StandardDataQueryBuilder.AggregationList groupByNestedFieldFilteredWithAvgField(String aggregationName,
 String nestedPath,
 String filterField,
 String filterValue,
 String fieldName,
 int size,
 String avgFieldName,
 String order)

Same as groupByNestedFieldFilteredWithAvgField(String, String, String, String, String, int, String) but with explicit bucket ordering.

groupByNestedFieldFilteredWithPercentileField

StandardDataQueryBuilder.AggregationList groupByNestedFieldFilteredWithPercentileField(String aggregationName,
 String nestedPath,
 String filterField,
 String filterValue,
 String fieldName,
 int size,
 String percentileFieldName,
 double percent)

Mirror of groupByNestedFieldFilteredWithSumField(String, String, String, String, String, int, String) using a single-percentile sub-aggregation.

groupByNestedFieldFilteredWithPercentileField

StandardDataQueryBuilder.AggregationList groupByNestedFieldFilteredWithPercentileField(String aggregationName,
 String nestedPath,
 String filterField,
 String filterValue,
 String fieldName,
 int size,
 String percentileFieldName,
 double percent,
 String order)

Same as groupByNestedFieldFilteredWithPercentileField(String, String, String, String, String, int, String, double) but with explicit bucket ordering. For valueAsc/valueDesc, ordering is on the requested percentile value.

distributionBusinessStatus

StandardDataQueryBuilder.AggregationList distributionBusinessStatus(String aggregationName,
 int size)

Adds an aggregation that will create a distribution (i.e. buckets) of the possible values of the business status field. E.g. { 'OPEN': 23, 'CLOSED': 12, 'IN_PROGRESS': 3} The results are ordered by value (most occurrences first)

distributionParentScopeBusinessStatus

StandardDataQueryBuilder.AggregationList distributionParentScopeBusinessStatus(String aggregationName,
 int size)

Adds an aggregation that will create a distribution (i.e. buckets) of the possible values of the parent scope business status field. This is the business status of the directly owning case/process and is available on scopes that are nested under a parent (including tasks, which inherit it from their owning case/process). E.g. { 'OPEN': 23, 'CLOSED': 12, 'IN_PROGRESS': 3} The results are ordered by value (most occurrences first)

distributionRootScopeBusinessStatus

StandardDataQueryBuilder.AggregationList distributionRootScopeBusinessStatus(String aggregationName,
 int size)

Adds an aggregation that will create a distribution (i.e. buckets) of the possible values of the root scope business status field. This is the business status of the top-level case/process and is available on scopes that are nested under a root (including tasks, which inherit it from their root case/process). E.g. { 'OPEN': 23, 'CLOSED': 12, 'IN_PROGRESS': 3} The results are ordered by value (most occurrences first)