com.lucidworks.search.dsl.request.query

Class BoostQuery

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.BoostQuery

public class BoostQuery
extends Query

A boost query. Boosts getQuery()

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE

Constructor Summary

Constructors

Constructor and Description
BoostQuery(Query boostedQuery, Double boost)

Method Summary

Modifier and Type	Method and Description
BoostQuery	clone()
Double	getBoost()
List<Query>	getChildQueries() Returns all the children of the query in question.
Query	getQuery()
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	setBoost(double boost)

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

BoostQuery

public BoostQuery(Query boostedQuery,
                  Double boost)

Method Detail

getQuery

public Query getQuery()

Returns:

a query to be boosted

getBoost

public Double getBoost()

Returns:

a boost value

setBoost

public void setBoost(double boost)

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 BoostQuery clone()

Specified by:

clone in class Query