com.flowable.indexing.query.builder

Class FilteredFullTextSearchQueryBuilder

java.lang.Object

com.flowable.indexing.query.builder.FilteredFullTextSearchQueryBuilder

All Implemented Interfaces:

ElasticsearchQueryBuilder

public class FilteredFullTextSearchQueryBuilder
extends Object
implements ElasticsearchQueryBuilder

NOTE: THIS IS NOT A FULL FLEDGED QUERY BUILDER (yet). Currently, allows to build an Elasticsearch query that follows the following pattern: - A bool query with - An optional query to do full text matching - a filter with must/should/mustNot clauses Examples: - conversation filters, based on various tags, with or without searchText. = contact filters, based on various variables that need to be set, with or without searchText

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	FilteredFullTextSearchQueryBuilder.Aggregation
class	FilteredFullTextSearchQueryBuilder.BoolFilterClause Nested bool filter, eg: "must_not": [ { "bool": { "filter": [ { "terms": { "groups": [ "clientAdvisor" ] } }, { "term": { "state": "ACTIVE" } } ] } } ]
static interface	FilteredFullTextSearchQueryBuilder.Clause
class	FilteredFullTextSearchQueryBuilder.DateAggregation
class	FilteredFullTextSearchQueryBuilder.DateRangeClause
class	FilteredFullTextSearchQueryBuilder.FieldClause
static class	FilteredFullTextSearchQueryBuilder.HistogramInterval
class	FilteredFullTextSearchQueryBuilder.NestedTermBasedSortClause
class	FilteredFullTextSearchQueryBuilder.SortClause
class	FilteredFullTextSearchQueryBuilder.TermClause
class	FilteredFullTextSearchQueryBuilder.TermsClause

Field Summary

Fields

Modifier and Type	Field and Description
protected List<FilteredFullTextSearchQueryBuilder.Aggregation>	aggregations
protected com.fasterxml.jackson.databind.node.ObjectNode	customQuery
protected List<String>	existsClauses
protected Long	from
protected boolean	fullTextAndSemantics
protected String	fullTextSearchField
protected String	fullTextSearchText
protected Integer	minimumShouldMatch
protected List<FilteredFullTextSearchQueryBuilder.Clause>	mustClauses
protected List<FilteredFullTextSearchQueryBuilder.Clause>	mustNotClauses
protected List<String>	notExistsClauses
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected List<FilteredFullTextSearchQueryBuilder.Clause>	shouldClauses
protected Long	size
protected List<FilteredFullTextSearchQueryBuilder.SortClause>	sortClauses

Constructor Summary

Constructors

Constructor and Description
FilteredFullTextSearchQueryBuilder(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
FilteredFullTextSearchQueryBuilder(com.fasterxml.jackson.databind.ObjectMapper objectMapper, com.fasterxml.jackson.databind.node.ObjectNode customQuery)

Method Summary

Modifier and Type	Method and Description
void	applyQueryParameters(Map<String,Object> queryParameters)
String	build()
com.fasterxml.jackson.databind.node.ObjectNode	buildJson()
FilteredFullTextSearchQueryBuilder	dateHistogramAggregation(String aggregationName, String field, FilteredFullTextSearchQueryBuilder.HistogramInterval interval)
FilteredFullTextSearchQueryBuilder	existsTerm(String field)
FilteredFullTextSearchQueryBuilder	from(long from)
protected void	generateClauses(com.fasterxml.jackson.databind.node.ObjectNode boolNode, String type, List<FilteredFullTextSearchQueryBuilder.Clause> clauses)
FilteredFullTextSearchQueryBuilder	minimumShouldMatch(int minimumShouldMatch)
FilteredFullTextSearchQueryBuilder.BoolFilterClause	mustBoolFilter()
FilteredFullTextSearchQueryBuilder	mustDateRange(String dateField, Date start, Date end)
FilteredFullTextSearchQueryBuilder.BoolFilterClause	mustNotBoolFilter()
FilteredFullTextSearchQueryBuilder	mustNotDateRange(String dateField, Date start, Date end)
FilteredFullTextSearchQueryBuilder	mustNotTerm(String field, Object value)
FilteredFullTextSearchQueryBuilder	mustNotTerms(String field, List values)
FilteredFullTextSearchQueryBuilder	mustTerm(String field, Object value)
FilteredFullTextSearchQueryBuilder	mustTerms(String field, List values)
FilteredFullTextSearchQueryBuilder	nestedTermBasedSortAscending(String field, String nestedPath, String nestedTermField, String nestedTermValue)
FilteredFullTextSearchQueryBuilder	nestedTermBasedSortDescending(String field, String nestedPath, String nestedTermField, String nestedTermValue)
FilteredFullTextSearchQueryBuilder	notExistsTerm(String field)
FilteredFullTextSearchQueryBuilder	searchText(String field, String searchText) OR semantics by default for searching.
FilteredFullTextSearchQueryBuilder	searchTextAndSemantics(String field, String searchText)
FilteredFullTextSearchQueryBuilder.BoolFilterClause	shouldBoolFilter()
FilteredFullTextSearchQueryBuilder	shouldDateRange(String dateField, Instant start, Instant end)
FilteredFullTextSearchQueryBuilder	shouldTerm(String field, Object value)
FilteredFullTextSearchQueryBuilder	shouldTerms(String field, List values)
FilteredFullTextSearchQueryBuilder	size(long size)
FilteredFullTextSearchQueryBuilder	sortAscending(String field)
FilteredFullTextSearchQueryBuilder	sortDescending(String field)

Methods inherited from class java.lang.Object

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

Field Detail

objectMapper

protected com.fasterxml.jackson.databind.ObjectMapper objectMapper

from

protected Long from

size

protected Long size

fullTextSearchField

protected String fullTextSearchField

fullTextSearchText

protected String fullTextSearchText

fullTextAndSemantics

protected boolean fullTextAndSemantics

customQuery

protected com.fasterxml.jackson.databind.node.ObjectNode customQuery

mustClauses

protected List<FilteredFullTextSearchQueryBuilder.Clause> mustClauses

shouldClauses

protected List<FilteredFullTextSearchQueryBuilder.Clause> shouldClauses

mustNotClauses

protected List<FilteredFullTextSearchQueryBuilder.Clause> mustNotClauses

existsClauses

protected List<String> existsClauses

notExistsClauses

protected List<String> notExistsClauses

minimumShouldMatch

protected Integer minimumShouldMatch

sortClauses

protected List<FilteredFullTextSearchQueryBuilder.SortClause> sortClauses

aggregations

protected List<FilteredFullTextSearchQueryBuilder.Aggregation> aggregations

Constructor Detail

FilteredFullTextSearchQueryBuilder

public FilteredFullTextSearchQueryBuilder(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

FilteredFullTextSearchQueryBuilder

public FilteredFullTextSearchQueryBuilder(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                                          com.fasterxml.jackson.databind.node.ObjectNode customQuery)

Method Detail

from

public FilteredFullTextSearchQueryBuilder from(long from)

size

public FilteredFullTextSearchQueryBuilder size(long size)

searchText

public FilteredFullTextSearchQueryBuilder searchText(String field,
                                                     String searchText)

OR semantics by default for searching. Use searchTextAndSemantics(String, String) otherwise.

searchTextAndSemantics

public FilteredFullTextSearchQueryBuilder searchTextAndSemantics(String field,
                                                                 String searchText)

mustTerms

public FilteredFullTextSearchQueryBuilder mustTerms(String field,
                                                    List values)

mustTerm

public FilteredFullTextSearchQueryBuilder mustTerm(String field,
                                                   Object value)

mustDateRange

public FilteredFullTextSearchQueryBuilder mustDateRange(String dateField,
                                                        Date start,
                                                        Date end)

mustBoolFilter

public FilteredFullTextSearchQueryBuilder.BoolFilterClause mustBoolFilter()

existsTerm

public FilteredFullTextSearchQueryBuilder existsTerm(String field)

notExistsTerm

public FilteredFullTextSearchQueryBuilder notExistsTerm(String field)

shouldTerms

public FilteredFullTextSearchQueryBuilder shouldTerms(String field,
                                                      List values)

shouldTerm

public FilteredFullTextSearchQueryBuilder shouldTerm(String field,
                                                     Object value)

shouldDateRange

public FilteredFullTextSearchQueryBuilder shouldDateRange(String dateField,
                                                          Instant start,
                                                          Instant end)

shouldBoolFilter

public FilteredFullTextSearchQueryBuilder.BoolFilterClause shouldBoolFilter()

mustNotTerms

public FilteredFullTextSearchQueryBuilder mustNotTerms(String field,
                                                       List values)

mustNotTerm

public FilteredFullTextSearchQueryBuilder mustNotTerm(String field,
                                                      Object value)

mustNotDateRange

public FilteredFullTextSearchQueryBuilder mustNotDateRange(String dateField,
                                                           Date start,
                                                           Date end)

mustNotBoolFilter

public FilteredFullTextSearchQueryBuilder.BoolFilterClause mustNotBoolFilter()

minimumShouldMatch

public FilteredFullTextSearchQueryBuilder minimumShouldMatch(int minimumShouldMatch)

sortAscending

public FilteredFullTextSearchQueryBuilder sortAscending(String field)

sortDescending

public FilteredFullTextSearchQueryBuilder sortDescending(String field)

nestedTermBasedSortAscending

public FilteredFullTextSearchQueryBuilder nestedTermBasedSortAscending(String field,
                                                                       String nestedPath,
                                                                       String nestedTermField,
                                                                       String nestedTermValue)

nestedTermBasedSortDescending

public FilteredFullTextSearchQueryBuilder nestedTermBasedSortDescending(String field,
                                                                        String nestedPath,
                                                                        String nestedTermField,
                                                                        String nestedTermValue)

dateHistogramAggregation

public FilteredFullTextSearchQueryBuilder dateHistogramAggregation(String aggregationName,
                                                                   String field,
                                                                   FilteredFullTextSearchQueryBuilder.HistogramInterval interval)

applyQueryParameters

public void applyQueryParameters(Map<String,Object> queryParameters)

Specified by:

applyQueryParameters in interface ElasticsearchQueryBuilder

build

public String build()

buildJson

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

generateClauses

protected void generateClauses(com.fasterxml.jackson.databind.node.ObjectNode boolNode,
                               String type,
                               List<FilteredFullTextSearchQueryBuilder.Clause> clauses)