Package com.flowable.indexing.query.builder.standard

Class StandardDataQueryBuilderImpl

java.lang.Object

com.flowable.indexing.query.builder.standard.StandardDataQueryBuilderImpl

All Implemented Interfaces:

StandardDataQueryBuilder

public class StandardDataQueryBuilderImpl
extends Object
implements StandardDataQueryBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StandardDataQueryBuilderImpl.AggregationListImpl
static class	StandardDataQueryBuilderImpl.FilterImpl
static class	StandardDataQueryBuilderImpl.FilterListImpl

Nested classes/interfaces inherited from interface com.flowable.indexing.query.builder.standard.StandardDataQueryBuilder

StandardDataQueryBuilder.AggregationList, StandardDataQueryBuilder.Filter, StandardDataQueryBuilder.FilterList

Field Summary

Fields

Modifier and Type	Field	Description
protected StandardDataQueryBuilderImpl.AggregationListImpl	aggregationList
protected List<StandardDataQueryBuilder.FilterList>	andFilters
protected static int	DEFAULT_SIZE
protected List<String>	fields
protected boolean	forceSource
protected Collection<String>	groupIdentityLinks
protected String	index
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected List<StandardDataQueryBuilder.FilterList>	orFilters
protected boolean	returnAggregations
protected boolean	returnResults
protected List<Object>	searchAfter
protected int	size
protected List<StandardDataQuerySortValue>	sortValues
protected int	start
protected String	tenantId
protected Collection<String>	userIdentityLinks
protected List<org.apache.commons.lang3.tuple.Pair<String,String>>	variableNameAndTypes

Constructor Summary

Constructors

Constructor	Description
StandardDataQueryBuilderImpl(String index, com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Summary

Modifier and Type	Method	Description
StandardDataQueryBuilder.AggregationList	aggregations()	Define one or more aggregations for the results of this query.
StandardDataQueryBuilder.FilterList	and()	Configures the root logical operator of the query to be AND.
com.fasterxml.jackson.databind.node.ObjectNode	build()	Builds the query that is ready to be passed into Elasticsearch.
protected void	buildAvgVariableValueAggregations(com.fasterxml.jackson.databind.node.ObjectNode aggsNode, StandardDataQueryBuilderImpl.AggregationListImpl aggregationList)
protected void	buildCountActiveAggregations(com.fasterxml.jackson.databind.node.ObjectNode aggsNode, StandardDataQueryBuilderImpl.AggregationListImpl aggregationList)
protected void	buildCountByIdAggregations(com.fasterxml.jackson.databind.node.ObjectNode aggsNode, StandardDataQueryBuilderImpl.AggregationListImpl aggregationList)
protected void	buildCountCompletedAggregations(com.fasterxml.jackson.databind.node.ObjectNode aggsNode, StandardDataQueryBuilderImpl.AggregationListImpl aggregationList)
protected void	buildCountStartedAggregations(com.fasterxml.jackson.databind.node.ObjectNode aggsNode, StandardDataQueryBuilderImpl.AggregationListImpl aggregationList)
protected void	buildDistributionVariableValueAggregations(com.fasterxml.jackson.databind.node.ObjectNode aggsNode, StandardDataQueryBuilderImpl.AggregationListImpl aggregationList)
protected void	buildGroupByDateCompletedAggregations(com.fasterxml.jackson.databind.node.ObjectNode aggsNode, StandardDataQueryBuilderImpl.AggregationListImpl aggregationList)
protected void	buildGroupByDateStartedAggregations(com.fasterxml.jackson.databind.node.ObjectNode aggsNode, StandardDataQueryBuilderImpl.AggregationListImpl aggregationList)
protected void	buildGroupByDefinitionKeyAggregations(com.fasterxml.jackson.databind.node.ObjectNode aggsNode, StandardDataQueryBuilderImpl.AggregationListImpl aggregationList)
protected void	buildGroupByDefinitionKeyAndStateAggregations(com.fasterxml.jackson.databind.node.ObjectNode aggsNode, StandardDataQueryBuilderImpl.AggregationListImpl aggregationList)
protected void	buildMaxVariableValueAggregations(com.fasterxml.jackson.databind.node.ObjectNode aggsNode, StandardDataQueryBuilderImpl.AggregationListImpl aggregationList)
protected void	buildMinVariableValueAggregations(com.fasterxml.jackson.databind.node.ObjectNode aggsNode, StandardDataQueryBuilderImpl.AggregationListImpl aggregationList)
protected void	buildSingleNumericVariableAggregation(com.fasterxml.jackson.databind.node.ObjectNode aggsNode, String aggregationName, String aggregationOperator, String variableName)
protected void	buildStddevVariableValueAggregations(com.fasterxml.jackson.databind.node.ObjectNode aggsNode, StandardDataQueryBuilderImpl.AggregationListImpl aggregationList)
protected void	buildSumVariableValueAggregations(com.fasterxml.jackson.databind.node.ObjectNode aggsNode, StandardDataQueryBuilderImpl.AggregationListImpl aggregationList)
protected com.fasterxml.jackson.databind.node.ObjectNode	createFilteredVariableAggregation(com.fasterxml.jackson.databind.node.ObjectNode aggsNode, String aggregationName, String variableName)
StandardDataQueryBuilder	fields(List<String> fields)	When results are returned, this will make sure only the fields in the passed list are returned.
StandardDataQueryBuilder	forceSourceToBeReturned()	By default, when setting a size, the source won't be returned.
List<StandardDataQueryBuilder.FilterList>	getAndFilters()
protected String	getDefinitionKeyField()
protected String	getDefinitionNameKeywordField()
String	getIndex()
List<StandardDataQueryBuilder.FilterList>	getOrFilters()
protected String	getStartTimeField()
StandardDataQueryBuilder	groupIdentityLinks(Collection<String> groupIds)	If set, will limit the returned data to only return data that the users with given groups have access to.
protected static boolean	hasFilters(StandardDataQueryBuilder.FilterList filterList)
protected static boolean	hasFilters(StandardDataQueryBuilderImpl queryBuilder)
protected boolean	hasSafeQuerySettings()
protected boolean	isCaseInstanceQuery()
protected boolean	isProcessInstanceQuery()
protected boolean	isTaskQuery()
protected boolean	isWorkQuery()
StandardDataQueryBuilder.FilterList	or()	Configures the root logical operator of the query to be OR.
StandardDataQueryBuilderImpl	pageSize(int size)	Queries built by this builder by default don't return any 'hits'.
StandardDataQueryBuilder	returnNoAggregations()	The query won't do any aggregations, even if they are configured.
StandardDataQueryBuilder	returnResults()	The query won't return any results, which is useful if only the aggregation is relevant.
StandardDataQueryBuilder	searchAfter(List<Object> searchAfter)	Use for alternative paging by providing from where the querying should start.
StandardDataQueryBuilder	sort(List<StandardDataQuerySortValue> sortValues)	Sorts the results given the field names and asc/desc in the provided parameter.
StandardDataQueryBuilder	start(int start)	When using paging, this sets the start number of the page.
StandardDataQueryBuilder	tenantId(String tenantId)	Sets the tenantId, which will limit what results are returned from the query.
StandardDataQueryBuilder	userIdentityLinks(Collection<String> userIds)	If set, will limit the returned data to only return data that the users with given ids have access to.
StandardDataQueryBuilder	variables(List<org.apache.commons.lang3.tuple.Pair<String,String>> variableNameAndTypes)	When the results are returned, also these variables will be fetched.

Methods inherited from class java.lang.Object

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

Field Details

index

protected String index

objectMapper

protected com.fasterxml.jackson.databind.ObjectMapper objectMapper

returnResults

protected boolean returnResults

returnAggregations

protected boolean returnAggregations

DEFAULT_SIZE

protected static int DEFAULT_SIZE

start

protected int start

size

protected int size

fields

protected List<String> fields

variableNameAndTypes

protected List<org.apache.commons.lang3.tuple.Pair<String,String>> variableNameAndTypes

tenantId

protected String tenantId

userIdentityLinks

protected Collection<String> userIdentityLinks

groupIdentityLinks

protected Collection<String> groupIdentityLinks

forceSource

protected boolean forceSource

andFilters

protected List<StandardDataQueryBuilder.FilterList> andFilters

orFilters

protected List<StandardDataQueryBuilder.FilterList> orFilters

sortValues

protected List<StandardDataQuerySortValue> sortValues

searchAfter

protected List<Object> searchAfter

aggregationList

protected StandardDataQueryBuilderImpl.AggregationListImpl aggregationList

Constructor Details

StandardDataQueryBuilderImpl

public StandardDataQueryBuilderImpl(String index,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Details

returnResults

public StandardDataQueryBuilder returnResults()

Description copied from interface: StandardDataQueryBuilder

The query won't return any results, which is useful if only the aggregation is relevant.

Specified by:

returnResults in interface StandardDataQueryBuilder

returnNoAggregations

public StandardDataQueryBuilder returnNoAggregations()

Description copied from interface: StandardDataQueryBuilder

The query won't do any aggregations, even if they are configured. This is useful when reusing a query for e.g. CSV export, where the agregation are irrelevant.

Specified by:

returnNoAggregations in interface StandardDataQueryBuilder

forceSourceToBeReturned

public StandardDataQueryBuilder forceSourceToBeReturned()

Description copied from interface: StandardDataQueryBuilder

By default, when setting a size, the source won't be returned. If this method is called, this forces that the source is returned in the hits. It means no 'fields' will be returned though.

Specified by:

forceSourceToBeReturned in interface StandardDataQueryBuilder

start

public StandardDataQueryBuilder start(int start)

Description copied from interface: StandardDataQueryBuilder

When using paging, this sets the start number of the page.

Specified by:

start in interface StandardDataQueryBuilder

pageSize

public StandardDataQueryBuilderImpl pageSize(int size)

Queries built by this builder by default don't return any 'hits'. Hits, in context of Elasticsearch, are the full json documents of indexed data. If this method is called, the passed number of hits will be returned (if there are that many).

Specified by:

pageSize in interface StandardDataQueryBuilder

fields

public StandardDataQueryBuilder fields(List<String> fields)

Description copied from interface: StandardDataQueryBuilder

When results are returned, this will make sure only the fields in the passed list are returned. By default, all fields are returned.

Specified by:

fields in interface StandardDataQueryBuilder

variables

public StandardDataQueryBuilder variables(List<org.apache.commons.lang3.tuple.Pair<String,String>> variableNameAndTypes)

Description copied from interface: StandardDataQueryBuilder

When the results are returned, also these variables will be fetched.

Specified by:

variables in interface StandardDataQueryBuilder

tenantId

public StandardDataQueryBuilder tenantId(String tenantId)

Description copied from interface: StandardDataQueryBuilder

Sets the tenantId, which will limit what results are returned from the query. If set, will add the tenantId as requirement and add an AND with any filter set on the root level of this query.

Specified by:

tenantId in interface StandardDataQueryBuilder

userIdentityLinks

public StandardDataQueryBuilder userIdentityLinks(Collection<String> userIds)

Description copied from interface: StandardDataQueryBuilder

If set, will limit the returned data to only return data that the users with given ids have access to. Flowable adds automatically the user identitylink for every type of user: assignee, owner, participant, watcher and candidate user to the index.

Specified by:

userIdentityLinks in interface StandardDataQueryBuilder

groupIdentityLinks

public StandardDataQueryBuilder groupIdentityLinks(Collection<String> groupIds)

Description copied from interface: StandardDataQueryBuilder

If set, will limit the returned data to only return data that the users with given groups have access to. Flowable adds automatically the group identitylink for every type of group: candidate group, watcher and participant group.

Specified by:

groupIdentityLinks in interface StandardDataQueryBuilder

and

public StandardDataQueryBuilder.FilterList and()

Description copied from interface: StandardDataQueryBuilder

Configures the root logical operator of the query to be AND.

Specified by:

and in interface StandardDataQueryBuilder

or

public StandardDataQueryBuilder.FilterList or()

Description copied from interface: StandardDataQueryBuilder

Configures the root logical operator of the query to be OR.

Specified by:

or in interface StandardDataQueryBuilder

sort

public StandardDataQueryBuilder sort(List<StandardDataQuerySortValue> sortValues)

Description copied from interface: StandardDataQueryBuilder

Sorts the results given the field names and asc/desc in the provided parameter.

Specified by:

sort in interface StandardDataQueryBuilder

searchAfter

public StandardDataQueryBuilder searchAfter(List<Object> searchAfter)

Description copied from interface: StandardDataQueryBuilder

Use for alternative paging by providing from where the querying should start.

Specified by:

searchAfter in interface StandardDataQueryBuilder

aggregations

public StandardDataQueryBuilder.AggregationList aggregations()

Description copied from interface: StandardDataQueryBuilder

Define one or more aggregations for the results of this query.

Specified by:

aggregations in interface StandardDataQueryBuilder

getDefinitionKeyField

protected String getDefinitionKeyField()

getDefinitionNameKeywordField

protected String getDefinitionNameKeywordField()

build

public com.fasterxml.jackson.databind.node.ObjectNode build()

Builds the query that is ready to be passed into Elasticsearch.

Specified by:

build in interface StandardDataQueryBuilder

buildCountByIdAggregations

protected void buildCountByIdAggregations(com.fasterxml.jackson.databind.node.ObjectNode aggsNode,
 StandardDataQueryBuilderImpl.AggregationListImpl aggregationList)

buildCountStartedAggregations

protected void buildCountStartedAggregations(com.fasterxml.jackson.databind.node.ObjectNode aggsNode,
 StandardDataQueryBuilderImpl.AggregationListImpl aggregationList)

buildCountCompletedAggregations

protected void buildCountCompletedAggregations(com.fasterxml.jackson.databind.node.ObjectNode aggsNode,
 StandardDataQueryBuilderImpl.AggregationListImpl aggregationList)

buildCountActiveAggregations

protected void buildCountActiveAggregations(com.fasterxml.jackson.databind.node.ObjectNode aggsNode,
 StandardDataQueryBuilderImpl.AggregationListImpl aggregationList)

buildGroupByDefinitionKeyAggregations

protected void buildGroupByDefinitionKeyAggregations(com.fasterxml.jackson.databind.node.ObjectNode aggsNode,
 StandardDataQueryBuilderImpl.AggregationListImpl aggregationList)

buildGroupByDefinitionKeyAndStateAggregations

protected void buildGroupByDefinitionKeyAndStateAggregations(com.fasterxml.jackson.databind.node.ObjectNode aggsNode,
 StandardDataQueryBuilderImpl.AggregationListImpl aggregationList)

buildGroupByDateStartedAggregations

protected void buildGroupByDateStartedAggregations(com.fasterxml.jackson.databind.node.ObjectNode aggsNode,
 StandardDataQueryBuilderImpl.AggregationListImpl aggregationList)

buildGroupByDateCompletedAggregations

protected void buildGroupByDateCompletedAggregations(com.fasterxml.jackson.databind.node.ObjectNode aggsNode,
 StandardDataQueryBuilderImpl.AggregationListImpl aggregationList)

buildMaxVariableValueAggregations

protected void buildMaxVariableValueAggregations(com.fasterxml.jackson.databind.node.ObjectNode aggsNode,
 StandardDataQueryBuilderImpl.AggregationListImpl aggregationList)

buildMinVariableValueAggregations

protected void buildMinVariableValueAggregations(com.fasterxml.jackson.databind.node.ObjectNode aggsNode,
 StandardDataQueryBuilderImpl.AggregationListImpl aggregationList)

buildAvgVariableValueAggregations

protected void buildAvgVariableValueAggregations(com.fasterxml.jackson.databind.node.ObjectNode aggsNode,
 StandardDataQueryBuilderImpl.AggregationListImpl aggregationList)

buildStddevVariableValueAggregations

protected void buildStddevVariableValueAggregations(com.fasterxml.jackson.databind.node.ObjectNode aggsNode,
 StandardDataQueryBuilderImpl.AggregationListImpl aggregationList)

buildSumVariableValueAggregations

protected void buildSumVariableValueAggregations(com.fasterxml.jackson.databind.node.ObjectNode aggsNode,
 StandardDataQueryBuilderImpl.AggregationListImpl aggregationList)

buildDistributionVariableValueAggregations

protected void buildDistributionVariableValueAggregations(com.fasterxml.jackson.databind.node.ObjectNode aggsNode,
 StandardDataQueryBuilderImpl.AggregationListImpl aggregationList)

buildSingleNumericVariableAggregation

protected void buildSingleNumericVariableAggregation(com.fasterxml.jackson.databind.node.ObjectNode aggsNode,
 String aggregationName,
 String aggregationOperator,
 String variableName)

createFilteredVariableAggregation

protected com.fasterxml.jackson.databind.node.ObjectNode createFilteredVariableAggregation(com.fasterxml.jackson.databind.node.ObjectNode aggsNode,
 String aggregationName,
 String variableName)

hasSafeQuerySettings

protected boolean hasSafeQuerySettings()

getIndex

public String getIndex()

getAndFilters

public List<StandardDataQueryBuilder.FilterList> getAndFilters()

getOrFilters

public List<StandardDataQueryBuilder.FilterList> getOrFilters()

getStartTimeField

protected String getStartTimeField()

hasFilters

protected static boolean hasFilters(StandardDataQueryBuilderImpl queryBuilder)

hasFilters

protected static boolean hasFilters(StandardDataQueryBuilder.FilterList filterList)

isTaskQuery

protected boolean isTaskQuery()

isWorkQuery

protected boolean isWorkQuery()

isProcessInstanceQuery

protected boolean isProcessInstanceQuery()

isCaseInstanceQuery

protected boolean isCaseInstanceQuery()