com.lucidworks.search.dsl.request.query

Class CompoundQuery

java.lang.Object

com.lucidworks.search.dsl.DslBase

com.lucidworks.search.dsl.request.DslCloneable

com.lucidworks.search.dsl.request.query.Query

com.lucidworks.search.dsl.request.query.CompoundQuery

public class CompoundQuery
extends Query

A multi-clause query that merges the result sets of independent subqueries CompoundQuery wraps an arbitrary number of subqueries. Each clause is specified as a "must", "mustNot", or "should" - indicating how the subquery result set impacts the result set of the compound whole.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompoundQuery.Operator

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE

Constructor Summary

Constructors

Constructor and Description
CompoundQuery(String minimumNumberShouldMatch, List<Query> must, List<Query> should, List<Query> mustNot, List<MinimumMatch> minimumMatch)

Method Summary

Modifier and Type	Method and Description
CompoundQuery	clone()
List<Query>	getChildQueries() Returns all the children of the query in question.
List<MinimumMatch>	getMinimumMatch()
String	getMinimumNumberShouldMatch() Deprecated.
List<Query>	getMust()
List<Query>	getMustNot()
List<Query>	getShould()
boolean	isEmptyQuery()
boolean	removeChildQuery(Query toRemove) Remove 'toRemove', if 'toRemove' is currently a child of this Query object.
boolean	replaceChildQuery(Query toReplace, Query replacement) Swap 'replacement' in as a replacement, if 'toReplace' is currently a child of this Query object.
void	setMinimumNumberShouldMatch(String minimumNumberShouldMatch) Deprecated.

Methods inherited from class com.lucidworks.search.dsl.request.DslCloneable

clone, deepClone

Methods inherited from class com.lucidworks.search.dsl.DslBase

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

CompoundQuery

public CompoundQuery(String minimumNumberShouldMatch,
                     List<Query> must,
                     List<Query> should,
                     List<Query> mustNot,
                     List<MinimumMatch> minimumMatch)

Method Detail

getMinimumNumberShouldMatch

@Deprecated
public String getMinimumNumberShouldMatch()

Deprecated.

setMinimumNumberShouldMatch

@Deprecated
public void setMinimumNumberShouldMatch(String minimumNumberShouldMatch)

Deprecated.

getMust

public List<Query> getMust()

Returns:

query clauses which need to be matched in order for a document to match the overall CompoundQuery

getShould

public List<Query> getShould()

Returns:

query clauses which are preferable but not strictly required to match the overall CompoundQuery.

When "must" clauses are present, "should" clauses primarily affect scoring (and as a result, default sorting). When "must" clauses are absent but "should" clauses are present, documents must match at least one "should" clause to be included in the overall result set.

getMustNot

public List<Query> getMustNot()

Returns:

query clauses which disqualify documents from matching the overall CompoundQuery. Matching a single "mustNot" clause removes the document in question from the overall result set.

If a CompoundQuery contains only "mustNot" queries, the overall results are computed as if a "must" MatchAllQuery was specified.

getMinimumMatch

public List<MinimumMatch> getMinimumMatch()

getChildQueries

public List<Query> getChildQueries()

Description copied from class: Query

Returns all the children of the query in question. The returned List is provided as a copy - changes made to it do not impact the originating Query object in any way.

Specified by:

getChildQueries in class Query

replaceChildQuery

public boolean replaceChildQuery(Query toReplace,
                                 Query replacement)

Description copied from class: Query

Swap 'replacement' in as a replacement, if 'toReplace' is currently a child of this Query object. Because a tree of Query objects might conceivably have repeated clauses, this method is implemented to test 'toReplace' using reference-equality instead of value-equality.

Specified by:

replaceChildQuery in class Query

Returns:

true if a replacement was made, false otherwise.

removeChildQuery

public boolean removeChildQuery(Query toRemove)

Description copied from class: Query

Remove 'toRemove', if 'toRemove' is currently a child of this Query object. Because a tree of Query objects might conceivably have repeated clauses, this method is implemented to test 'toRemove' using reference-equality instead of value-equality.

Specified by:

removeChildQuery in class Query

Returns:

true if a removal was made, false otherwise.

isEmptyQuery

public boolean isEmptyQuery()

Specified by:

isEmptyQuery in class Query

Returns:

true if this query is now essentially "empty" (doesn't affect query logic at all) and can now be removed from the query tree. This can happen, for example, if all child queries were removed and the query logic depends on having at least one child query.

clone

public CompoundQuery clone()

Specified by:

clone in class Query