Package com.flowable.platform.api.repository

Class BaseQueryDefinitionModel

java.lang.Object

com.flowable.platform.api.repository.BaseQueryDefinitionModel

All Implemented Interfaces:

QueryDefinitionModel

public class BaseQueryDefinitionModel
extends Object
implements QueryDefinitionModel

Field Summary

Fields

Modifier and Type	Field	Description
protected com.fasterxml.jackson.databind.JsonNode	configuration
protected com.fasterxml.jackson.databind.JsonNode	customFilter
protected String	description
protected String	key
protected String	name
protected Map<String,QueryParameter>	parameters
protected Map<String,QuerySortParameter>	sortParameters
protected String	sourceIndex
protected StandardDataQueryConfiguration	standardDataQueryConfiguration
protected String	subType
protected String	templateContent
protected String	templateFilter
protected String	templateResource
protected String	type
protected String	versionTimestamp

Constructor Summary

Constructors

Constructor	Description
BaseQueryDefinitionModel()

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	getConfiguration()	A configuration field that can be used for various use cases not covered by the other fields.
com.fasterxml.jackson.databind.JsonNode	getCustomFilter()	Returns the JsonNode that will be used as input to compose a safe ES query.
String	getDescription()	Returns the optional description of this query definition, describing where and how it might be used.
String	getKey()	Returns the business key usually used to reference or lookup a query definition regardless of its version.
String	getName()	Returns the name of this query definition.
Map<String,QueryParameter>	getParameters()	A query can have 0 or more parameters that are resolved at runtime.
Map<String,QuerySortParameter>	getSortParameters()	Besides regular parameters, a query can expose parameters used specifically for sorting.
String	getSourceIndex()	Returns the name of the index on which the query will be performed on.
StandardDataQueryConfiguration	getStandardDataQueryConfiguration()	Returns the parsed Java version of the QueryDefinitionModel.getConfiguration().
String	getSubType()
String	getTemplateContent()	Returns the template content that will be used to parse to a ES query by a template engine.
String	getTemplateFilter()	Returns the template content that will be used to first parse by a template engine and then use as input to compose a safe ES query.
String	getTemplateResource()	Returns the resource that will be used to parse to a ES query by a template engine.
String	getType()	Allows to distinguish between different types of query models
boolean	isCustomQueryTemplateQueryModel()
boolean	isLegacyQueryModelWithTemplateResource()
boolean	isQueryBuilderQuery()
boolean	isSafeQueryTemplateQueryModel()
void	setConfiguration(com.fasterxml.jackson.databind.JsonNode configuration)
void	setCustomFilter(com.fasterxml.jackson.databind.JsonNode customFilter)
void	setDescription(String description)
void	setKey(String key)
void	setName(String name)
void	setParameters(Map<String,QueryParameter> parameters)
void	setSortParameters(Map<String,QuerySortParameter> sortParameters)
void	setSourceIndex(String sourceIndex)
void	setStandardDataQueryConfiguration(StandardDataQueryConfiguration standardDataQueryConfiguration)
void	setSubType(String subType)
void	setTemplateContent(String templateContent)
void	setTemplateFilter(String templateFilter)
void	setTemplateResource(String templateResource)
void	setType(String type)

Methods inherited from class java.lang.Object

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

Field Details

key

protected String key

name

protected String name

description

protected String description

sourceIndex

protected String sourceIndex

type

protected String type

subType

protected String subType

versionTimestamp

protected String versionTimestamp

customFilter

protected com.fasterxml.jackson.databind.JsonNode customFilter

templateFilter

protected String templateFilter

templateResource

protected String templateResource

templateContent

protected String templateContent

sortParameters

protected Map<String,QuerySortParameter> sortParameters

parameters

protected Map<String,QueryParameter> parameters

configuration

protected com.fasterxml.jackson.databind.JsonNode configuration

standardDataQueryConfiguration

protected StandardDataQueryConfiguration standardDataQueryConfiguration

Constructor Details

BaseQueryDefinitionModel

public BaseQueryDefinitionModel()

Method Details

getKey

public String getKey()

Description copied from interface: QueryDefinitionModel

Returns the business key usually used to reference or lookup a query definition regardless of its version.

Specified by:

getKey in interface QueryDefinitionModel

setKey

public void setKey(String key)

getName

public String getName()

Description copied from interface: QueryDefinitionModel

Returns the name of this query definition.

Specified by:

getName in interface QueryDefinitionModel

setName

public void setName(String name)

getDescription

public String getDescription()

Description copied from interface: QueryDefinitionModel

Returns the optional description of this query definition, describing where and how it might be used.

Specified by:

getDescription in interface QueryDefinitionModel

setDescription

public void setDescription(String description)

getSourceIndex

public String getSourceIndex()

Description copied from interface: QueryDefinitionModel

Returns the name of the index on which the query will be performed on.

Specified by:

getSourceIndex in interface QueryDefinitionModel

setSourceIndex

public void setSourceIndex(String sourceIndex)

getType

public String getType()

Description copied from interface: QueryDefinitionModel

Allows to distinguish between different types of query models

Specified by:

getType in interface QueryDefinitionModel

setType

public void setType(String type)

getSubType

public String getSubType()

Specified by:

getSubType in interface QueryDefinitionModel

See Also:

• for a set of predefined template query types

setSubType

public void setSubType(String subType)

getCustomFilter

public com.fasterxml.jackson.databind.JsonNode getCustomFilter()

Description copied from interface: QueryDefinitionModel

Returns the JsonNode that will be used as input to compose a safe ES query.

Specified by:

getCustomFilter in interface QueryDefinitionModel

setCustomFilter

public void setCustomFilter(com.fasterxml.jackson.databind.JsonNode customFilter)

getTemplateFilter

public String getTemplateFilter()

Description copied from interface: QueryDefinitionModel

Returns the template content that will be used to first parse by a template engine and then use as input to compose a safe ES query.

Specified by:

getTemplateFilter in interface QueryDefinitionModel

setTemplateFilter

public void setTemplateFilter(String templateFilter)

setTemplateResource

public void setTemplateResource(String templateResource)

getTemplateResource

public String getTemplateResource()

Description copied from interface: QueryDefinitionModel

Returns the resource that will be used to parse to a ES query by a template engine.

Specified by:

getTemplateResource in interface QueryDefinitionModel

setTemplateContent

public void setTemplateContent(String templateContent)

getTemplateContent

public String getTemplateContent()

Description copied from interface: QueryDefinitionModel

Returns the template content that will be used to parse to a ES query by a template engine.

Specified by:

getTemplateContent in interface QueryDefinitionModel

getParameters

public Map<String,QueryParameter> getParameters()

Description copied from interface: QueryDefinitionModel

A query can have 0 or more parameters that are resolved at runtime.

Specified by:

getParameters in interface QueryDefinitionModel

setParameters

public void setParameters(Map<String,QueryParameter> parameters)

getSortParameters

public Map<String,QuerySortParameter> getSortParameters()

Description copied from interface: QueryDefinitionModel

Besides regular parameters, a query can expose parameters used specifically for sorting.

Specified by:

getSortParameters in interface QueryDefinitionModel

setSortParameters

public void setSortParameters(Map<String,QuerySortParameter> sortParameters)

getConfiguration

public com.fasterxml.jackson.databind.JsonNode getConfiguration()

Description copied from interface: QueryDefinitionModel

A configuration field that can be used for various use cases not covered by the other fields.

Specified by:

getConfiguration in interface QueryDefinitionModel

setConfiguration

public void setConfiguration(com.fasterxml.jackson.databind.JsonNode configuration)

getStandardDataQueryConfiguration

public StandardDataQueryConfiguration getStandardDataQueryConfiguration()

Description copied from interface: QueryDefinitionModel

Returns the parsed Java version of the QueryDefinitionModel.getConfiguration(). Only non-null when QueryDefinitionModel.isQueryBuilderQuery() is true.

Specified by:

getStandardDataQueryConfiguration in interface QueryDefinitionModel

setStandardDataQueryConfiguration

public void setStandardDataQueryConfiguration(StandardDataQueryConfiguration standardDataQueryConfiguration)

isQueryBuilderQuery

public boolean isQueryBuilderQuery()

Specified by:

isQueryBuilderQuery in interface QueryDefinitionModel

isSafeQueryTemplateQueryModel

public boolean isSafeQueryTemplateQueryModel()

Specified by:

isSafeQueryTemplateQueryModel in interface QueryDefinitionModel

isCustomQueryTemplateQueryModel

public boolean isCustomQueryTemplateQueryModel()

Specified by:

isCustomQueryTemplateQueryModel in interface QueryDefinitionModel

isLegacyQueryModelWithTemplateResource

public boolean isLegacyQueryModelWithTemplateResource()

Specified by:

isLegacyQueryModelWithTemplateResource in interface QueryDefinitionModel