Class StandardDataQueryConfigurationImpl.AggregationImpl

java.lang.Object

com.flowable.platform.engine.impl.deployer.StandardDataQueryConfigurationImpl.AggregationImpl

All Implemented Interfaces:

StandardDataQueryConfiguration.Aggregation

Enclosing class:

StandardDataQueryConfigurationImpl

public static class StandardDataQueryConfigurationImpl.AggregationImpl
extends Object
implements StandardDataQueryConfiguration.Aggregation

Field Summary

Fields

Modifier and Type	Field	Description
protected String	fieldName
protected String	filterField
protected String	filterValue
protected String	name
protected String	nestedPath
protected String	order
protected Double	percent
protected Integer	size
protected String	subAggregationFieldName
protected String	type
protected String	variableName

Constructor Summary

Constructors

Constructor	Description
AggregationImpl(String name, String type)

Method Summary

Modifier and Type	Method	Description
String	getFieldName()	For direct-field aggregations (e.g. sumFieldValue, groupByField, groupByNestedField): the ES document field name (e.g.
String	getFilterField()	For nested-field aggregations with an inner term filter (e.g.
String	getFilterValue()	For nested-field aggregations with an inner term filter (see StandardDataQueryConfiguration.Aggregation.getFilterField()): the value the filter field must match.
String	getName()
String	getNestedPath()	For groupByNestedField: the ES nested path (e.g.
String	getOrder()	For terms-bucket aggregations (e.g.
Double	getPercent()	For percentile-based aggregations (e.g.
Integer	getSize()
String	getSubAggregationFieldName()	For composite aggregations with a numeric sub-aggregation (sum, avg or percentile inside a terms bucket): the ES document field the sub-aggregation operates on.
String	getType()
String	getVariableName()	For variable-based aggregations (e.g. sumVariableValue): the variable name as stored in the variables nested array.
void	setFieldName(String fieldName)
void	setFilterField(String filterField)
void	setFilterValue(String filterValue)
void	setName(String name)
void	setNestedPath(String nestedPath)
void	setOrder(String order)
void	setPercent(Double percent)
void	setSize(Integer size)
void	setSubAggregationFieldName(String subAggregationFieldName)
void	setType(String type)
void	setVariableName(String variableName)

Methods inherited from class Object

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

Field Details

name

protected String name

type

protected String type

variableName

protected String variableName

fieldName

protected String fieldName

nestedPath

protected String nestedPath

subAggregationFieldName

protected String subAggregationFieldName

filterField

protected String filterField

filterValue

protected String filterValue

size

protected Integer size

percent

protected Double percent

order

protected String order

Constructor Details

AggregationImpl

public AggregationImpl(String name,
 String type)

Method Details

getName

public String getName()

Specified by:

getName in interface StandardDataQueryConfiguration.Aggregation

setName

public void setName(String name)

getType

public String getType()

Specified by:

getType in interface StandardDataQueryConfiguration.Aggregation

setType

public void setType(String type)

getVariableName

public String getVariableName()

Description copied from interface: StandardDataQueryConfiguration.Aggregation

For variable-based aggregations (e.g. sumVariableValue): the variable name as stored in the variables nested array. Generates a nested ES query to reach the variable value.

Specified by:

getVariableName in interface StandardDataQueryConfiguration.Aggregation

setVariableName

public void setVariableName(String variableName)

getFieldName

public String getFieldName()

Description copied from interface: StandardDataQueryConfiguration.Aggregation

For direct-field aggregations (e.g. sumFieldValue, groupByField, groupByNestedField): the ES document field name (e.g. totalTokenCount, agentDefinitionKey). Produces a simple {"sum": {"field": "..."}} or {"terms": {"field": "..."}} query without any nesting wrapper — unlike variableName which always needs the variables nested path.

Specified by:

getFieldName in interface StandardDataQueryConfiguration.Aggregation

setFieldName

public void setFieldName(String fieldName)

getNestedPath

public String getNestedPath()

Description copied from interface: StandardDataQueryConfiguration.Aggregation

For groupByNestedField: the ES nested path (e.g. exchanges) that wraps the terms aggregation. Required in addition to fieldName when the target field lives inside a nested object.

Specified by:

getNestedPath in interface StandardDataQueryConfiguration.Aggregation

setNestedPath

public void setNestedPath(String nestedPath)

getSubAggregationFieldName

public String getSubAggregationFieldName()

Description copied from interface: StandardDataQueryConfiguration.Aggregation

For composite aggregations with a numeric sub-aggregation (sum, avg or percentile inside a terms bucket): the ES document field the sub-aggregation operates on. Authored in JSON as subAggregationFieldName.

Specified by:

getSubAggregationFieldName in interface StandardDataQueryConfiguration.Aggregation

setSubAggregationFieldName

public void setSubAggregationFieldName(String subAggregationFieldName)

getFilterField

public String getFilterField()

Description copied from interface: StandardDataQueryConfiguration.Aggregation

For nested-field aggregations with an inner term filter (e.g. groupByNestedFieldFiltered, avgNestedFieldFiltered, groupByDateStartedWithAvgNestedFieldFiltered): the field name (within the nested object) to apply the term filter on.

Specified by:

getFilterField in interface StandardDataQueryConfiguration.Aggregation

setFilterField

public void setFilterField(String filterField)

getFilterValue

public String getFilterValue()

Description copied from interface: StandardDataQueryConfiguration.Aggregation

For nested-field aggregations with an inner term filter (see StandardDataQueryConfiguration.Aggregation.getFilterField()): the value the filter field must match.

Specified by:

getFilterValue in interface StandardDataQueryConfiguration.Aggregation

setFilterValue

public void setFilterValue(String filterValue)

getSize

public Integer getSize()

Specified by:

getSize in interface StandardDataQueryConfiguration.Aggregation

setSize

public void setSize(Integer size)

getPercent

public Double getPercent()

Description copied from interface: StandardDataQueryConfiguration.Aggregation

For percentile-based aggregations (e.g. percentileFieldValue, groupByDateStartedWithPercentileField, groupByNestedFieldFilteredWithPercentileField): the single percentile to compute (e.g. 50.0, 95.0, 99.0).

Specified by:

getPercent in interface StandardDataQueryConfiguration.Aggregation

setPercent

public void setPercent(Double percent)

getOrder

public String getOrder()

Description copied from interface: StandardDataQueryConfiguration.Aggregation

For terms-bucket aggregations (e.g. groupByNestedFieldFiltered): the order direction used by the underlying terms aggregation. Either "asc" or "desc"; defaults to "desc". Note that ES still uses the bucket _count to order, only the direction is configurable here.

Specified by:

getOrder in interface StandardDataQueryConfiguration.Aggregation

setOrder

public void setOrder(String order)