Class StandardDataQueryTransformerServiceImpl

java.lang.Object

com.flowable.indexing.query.builder.standard.StandardDataQueryTransformerServiceImpl

All Implemented Interfaces:

StandardDataQueryTransformerService

public class StandardDataQueryTransformerServiceImpl
extends Object
implements StandardDataQueryTransformerService

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	DEFAULT_DISTRIBUTION_SIZE
protected String	GROUP_BY_DATE_DEFAULT_VALUE
protected final List<String>	GROUP_BY_DATE_FIELD_OPTIONS
protected StandardDataQueryInputValuesTransformer	inputValuesTransformer
protected tools.jackson.databind.ObjectMapper	objectMapper
protected StandardDataQuerySafeQueryTransformer	standardDataQuerySafeQueryTransformer

Constructor Summary

Constructors

Constructor	Description
StandardDataQueryTransformerServiceImpl(StandardDataQueryInputValuesTransformer inputValuesTransformer, StandardDataQuerySafeQueryTransformer standardDataQuerySafeQueryTransformer, tools.jackson.databind.ObjectMapper objectMapper)

Method Summary

Modifier and Type	Method	Description
protected StandardDataQueryBuilder	createQueryBuilder(QueryDefinitionModel queryDefinitionModel, Map<String, tools.jackson.databind.JsonNode> queryPayload)
protected String	getGroupByOptionValue(Map<String, tools.jackson.databind.JsonNode> queryPayload)
protected String	mapSortableField(QueryDefinitionModel queryDefinitionModel, String fieldName)
protected void	processFilter(Map<String, tools.jackson.databind.JsonNode> queryPayload, StandardDataQueryBuilder queryBuilder, StandardDataQueryConfiguration.Filter filter, StandardDataQueryBuilder.FilterList filterList)
protected void	requireFieldName(StandardDataQueryConfiguration.Aggregation aggregation)
protected void	requireFilterField(StandardDataQueryConfiguration.Aggregation aggregation)
protected void	requireFilterValue(StandardDataQueryConfiguration.Aggregation aggregation)
protected void	requireNestedPath(StandardDataQueryConfiguration.Aggregation aggregation)
protected void	requirePercent(StandardDataQueryConfiguration.Aggregation aggregation)
protected void	requireSubAggregationFieldName(StandardDataQueryConfiguration.Aggregation aggregation)
protected void	transformAdditionalBooleanFieldFilter(StandardDataQueryBuilder.FilterList root, tools.jackson.databind.JsonNode member, String field, String operator)
protected void	transformAdditionalFieldFilter(StandardDataQueryBuilder.FilterList root, tools.jackson.databind.JsonNode member)
protected void	transformAdditionalFilters(StandardDataQueryBuilder.FilterList root, tools.jackson.databind.JsonNode members)
protected void	transformAdditionalFiltersDefinition(Map<String, tools.jackson.databind.JsonNode> queryPayload, StandardDataQueryBuilder queryBuilder)	Reads the optional additionalFilters block and ANDs it on top of the declared query.
protected void	transformAdditionalNumericFieldFilter(StandardDataQueryBuilder.FilterList root, tools.jackson.databind.JsonNode member, String field, String operator)
protected void	transformAdditionalStringFieldFilter(StandardDataQueryBuilder.FilterList root, tools.jackson.databind.JsonNode member, String field, String operator)
protected void	transformAdditionalVariableFilter(StandardDataQueryBuilder.FilterList root, tools.jackson.databind.JsonNode member)
protected void	transformAggregations(StandardDataQueryBuilder queryBuilder, Map<String, tools.jackson.databind.JsonNode> queryPayload, StandardDataQueryConfiguration standardDataQueryConfiguration)
protected void	transformPagingParameters(Map<String, tools.jackson.databind.JsonNode> queryPayload, StandardDataQueryBuilder queryBuilder, StandardDataQueryConfiguration standardDataQueryConfiguration)
protected void	transformProcessFilterDefinition(Map<String, tools.jackson.databind.JsonNode> queryPayload, StandardDataQueryBuilder queryBuilder, StandardDataQueryConfiguration standardDataQueryConfiguration)
protected void	transformResponseDefinition(StandardDataQueryBuilder queryBuilder, StandardDataQueryConfiguration standardDataQueryConfiguration)
protected void	transformSortingParameters(QueryDefinitionModel queryDefinitionModel, Map<String, tools.jackson.databind.JsonNode> queryPayload, StandardDataQueryBuilder queryBuilder, StandardDataQueryConfiguration standardDataQueryConfiguration)
tools.jackson.databind.JsonNode	transformToElasticsearchQuery(QueryDefinitionModel queryDefinitionModel, Map<String, tools.jackson.databind.JsonNode> queryPayload)	Transforms the given QueryDefinitionModel to an Elasticsearch JSON query, using the provided payload.
StandardDataQueryBuilder	transformToElasticsearchQueryBuilder(QueryDefinitionModel queryDefinitionModel, Map<String, tools.jackson.databind.JsonNode> queryPayload)	Similar to StandardDataQueryTransformerService.transformToElasticsearchQuery(QueryDefinitionModel, Map), but doesn't yet build the JSON for the query.
protected boolean	transformVariableValueFilter(StandardDataQueryBuilder.FilterList filterList, tools.jackson.databind.JsonNode variableValueFilter)
protected boolean	transformVariableValueFilterOperation(StandardDataQueryBuilder.Filter filter, tools.jackson.databind.JsonNode filterEntry)
protected String	validateOrder(String order, String aggregationName, boolean hasSubAggregation)	Verifies that an order value is one of countAsc, countDesc, valueAsc or valueDesc.
protected StandardDataQueryConfiguration	validateQueryDefinitionModel(QueryDefinitionModel queryDefinitionModel)

Methods inherited from class Object

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

Field Details

GROUP_BY_DATE_FIELD_OPTIONS

protected final List<String> GROUP_BY_DATE_FIELD_OPTIONS

GROUP_BY_DATE_DEFAULT_VALUE

protected String GROUP_BY_DATE_DEFAULT_VALUE

DEFAULT_DISTRIBUTION_SIZE

protected static final int DEFAULT_DISTRIBUTION_SIZE

See Also:

• Constant Field Values

inputValuesTransformer

protected StandardDataQueryInputValuesTransformer inputValuesTransformer

standardDataQuerySafeQueryTransformer

protected StandardDataQuerySafeQueryTransformer standardDataQuerySafeQueryTransformer

objectMapper

protected tools.jackson.databind.ObjectMapper objectMapper

Constructor Details

StandardDataQueryTransformerServiceImpl

public StandardDataQueryTransformerServiceImpl(StandardDataQueryInputValuesTransformer inputValuesTransformer,
 StandardDataQuerySafeQueryTransformer standardDataQuerySafeQueryTransformer,
 tools.jackson.databind.ObjectMapper objectMapper)

Method Details

transformToElasticsearchQueryBuilder

public StandardDataQueryBuilder transformToElasticsearchQueryBuilder(QueryDefinitionModel queryDefinitionModel,
 Map<String, tools.jackson.databind.JsonNode> queryPayload)

Description copied from interface: StandardDataQueryTransformerService

Similar to StandardDataQueryTransformerService.transformToElasticsearchQuery(QueryDefinitionModel, Map), but doesn't yet build the JSON for the query. This is useful if changes need to be done to the returned StandardDataQueryBuilder. For example, when exporting all data of a query, this method is used to reuse the filter part, but change the paging until all data is returned.

Specified by:

transformToElasticsearchQueryBuilder in interface StandardDataQueryTransformerService

transformToElasticsearchQuery

public tools.jackson.databind.JsonNode transformToElasticsearchQuery(QueryDefinitionModel queryDefinitionModel,
 Map<String, tools.jackson.databind.JsonNode> queryPayload)

Description copied from interface: StandardDataQueryTransformerService

Transforms the given QueryDefinitionModel to an Elasticsearch JSON query, using the provided payload.

Specified by:

transformToElasticsearchQuery in interface StandardDataQueryTransformerService

createQueryBuilder

protected StandardDataQueryBuilder createQueryBuilder(QueryDefinitionModel queryDefinitionModel,
 Map<String, tools.jackson.databind.JsonNode> queryPayload)

validateQueryDefinitionModel

protected StandardDataQueryConfiguration validateQueryDefinitionModel(QueryDefinitionModel queryDefinitionModel)

transformPagingParameters

protected void transformPagingParameters(Map<String, tools.jackson.databind.JsonNode> queryPayload,
 StandardDataQueryBuilder queryBuilder,
 StandardDataQueryConfiguration standardDataQueryConfiguration)

transformSortingParameters

protected void transformSortingParameters(QueryDefinitionModel queryDefinitionModel,
 Map<String, tools.jackson.databind.JsonNode> queryPayload,
 StandardDataQueryBuilder queryBuilder,
 StandardDataQueryConfiguration standardDataQueryConfiguration)

mapSortableField

protected String mapSortableField(QueryDefinitionModel queryDefinitionModel,
 String fieldName)

transformProcessFilterDefinition

protected void transformProcessFilterDefinition(Map<String, tools.jackson.databind.JsonNode> queryPayload,
 StandardDataQueryBuilder queryBuilder,
 StandardDataQueryConfiguration standardDataQueryConfiguration)

processFilter

protected void processFilter(Map<String, tools.jackson.databind.JsonNode> queryPayload,
 StandardDataQueryBuilder queryBuilder,
 StandardDataQueryConfiguration.Filter filter,
 StandardDataQueryBuilder.FilterList filterList)

transformVariableValueFilter

protected boolean transformVariableValueFilter(StandardDataQueryBuilder.FilterList filterList,
 tools.jackson.databind.JsonNode variableValueFilter)

transformVariableValueFilterOperation

protected boolean transformVariableValueFilterOperation(StandardDataQueryBuilder.Filter filter,
 tools.jackson.databind.JsonNode filterEntry)

transformAdditionalFiltersDefinition

protected void transformAdditionalFiltersDefinition(Map<String, tools.jackson.databind.JsonNode> queryPayload,
 StandardDataQueryBuilder queryBuilder)

Reads the optional additionalFilters block and ANDs it on top of the declared query. Meant to be used for e.g., datatable column filtering where the column matches an exposed document field. The frontend is the sole producer, so an unrecognized kind/fieldType/operator means the two have drifted: throw rather than silently return a wider result set than the filter asked for. A blank field or value carries nothing to filter on and is skipped.

transformAdditionalFilters

protected void transformAdditionalFilters(StandardDataQueryBuilder.FilterList root,
 tools.jackson.databind.JsonNode members)

transformAdditionalVariableFilter

protected void transformAdditionalVariableFilter(StandardDataQueryBuilder.FilterList root,
 tools.jackson.databind.JsonNode member)

transformAdditionalFieldFilter

protected void transformAdditionalFieldFilter(StandardDataQueryBuilder.FilterList root,
 tools.jackson.databind.JsonNode member)

transformAdditionalStringFieldFilter

protected void transformAdditionalStringFieldFilter(StandardDataQueryBuilder.FilterList root,
 tools.jackson.databind.JsonNode member,
 String field,
 String operator)

transformAdditionalNumericFieldFilter

protected void transformAdditionalNumericFieldFilter(StandardDataQueryBuilder.FilterList root,
 tools.jackson.databind.JsonNode member,
 String field,
 String operator)

transformAdditionalBooleanFieldFilter

protected void transformAdditionalBooleanFieldFilter(StandardDataQueryBuilder.FilterList root,
 tools.jackson.databind.JsonNode member,
 String field,
 String operator)

transformResponseDefinition

protected void transformResponseDefinition(StandardDataQueryBuilder queryBuilder,
 StandardDataQueryConfiguration standardDataQueryConfiguration)

transformAggregations

protected void transformAggregations(StandardDataQueryBuilder queryBuilder,
 Map<String, tools.jackson.databind.JsonNode> queryPayload,
 StandardDataQueryConfiguration standardDataQueryConfiguration)

requireFieldName

protected void requireFieldName(StandardDataQueryConfiguration.Aggregation aggregation)

requireNestedPath

protected void requireNestedPath(StandardDataQueryConfiguration.Aggregation aggregation)

requireSubAggregationFieldName

protected void requireSubAggregationFieldName(StandardDataQueryConfiguration.Aggregation aggregation)

validateOrder

protected String validateOrder(String order,
 String aggregationName,
 boolean hasSubAggregation)

Verifies that an order value is one of countAsc, countDesc, valueAsc or valueDesc. The converter normalises legacy asc/desc into the count-prefixed forms, so they should never reach this method. Returns the validated value (or null for the default).

Parameters:

hasSubAggregation - when false, value-based orderings are rejected because there is no sub-agg to order by.

requireFilterField

protected void requireFilterField(StandardDataQueryConfiguration.Aggregation aggregation)

requireFilterValue

protected void requireFilterValue(StandardDataQueryConfiguration.Aggregation aggregation)

requirePercent

protected void requirePercent(StandardDataQueryConfiguration.Aggregation aggregation)

getGroupByOptionValue

protected String getGroupByOptionValue(Map<String, tools.jackson.databind.JsonNode> queryPayload)