com.lucidworks.search.dsl.request.query

Class TextQuery

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

com.lucidworks.search.dsl.request.query.ChangableValueQuery

com.lucidworks.search.dsl.request.query.TextQuery

public class TextQuery
extends ChangableValueQuery

A query allowing search on a text string. The flexibility provided by this query makes it an ideal wrapper for unstructured query terms (such as come from a user-facing search bar).

TextQuery supports several options for controlling how this text is used, most prominently which fields should be searched against and if/how proximity searching should be performed. See individual options for more details.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE

Constructor Summary

Constructors

Constructor and Description
TextQuery(List<KeyAndBoost> fields, List<KeyAndBoost> phraseFields, Integer phraseSlop, String minimumShouldMatch, Integer queryPhraseSlop, String value)

Method Summary

Modifier and Type	Method and Description
TextQuery	clone()
List<KeyAndBoost>	getFields()
String	getMinimumShouldMatch()
List<KeyAndBoost>	getPhraseFields()
Integer	getPhraseSlop()
Integer	getQueryPhraseSlop()
String	getValue()
void	setFields(List<KeyAndBoost> fields)
void	setValue(String value)

Methods inherited from class com.lucidworks.search.dsl.request.query.AbstractLeafQuery

getChildQueries, replaceChildQuery

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

TextQuery

public TextQuery(List<KeyAndBoost> fields,
                 List<KeyAndBoost> phraseFields,
                 Integer phraseSlop,
                 String minimumShouldMatch,
                 Integer queryPhraseSlop,
                 String value)

Method Detail

getFields

public List<KeyAndBoost> getFields()

Returns:

the fields to search for the supplied text, along with per-field boosts indicating the relative importance of each field.

getPhraseFields

public List<KeyAndBoost> getPhraseFields()

Returns:

the fields to phrase-search for the supplied text, along with per-field boosts indicating the relative importance of each field.

getMinimumShouldMatch

public String getMinimumShouldMatch()

Returns:

an expression signifying how many query terms in getValue() must be present for a document to be considered a match.

May be specified as a positive integer (indicating the number of terms in absolute terms), a negative integer (indicating the number of terms relative to the total), a positive percentage (indicating the percent of query terms that must be present), or a negative percentage (indicting the percent of query terms that may be absent).

If not specified, assumed default is "1"

getPhraseSlop

public Integer getPhraseSlop()

Returns:

the "slop" used when detecting phrase matches for the entire value. Slop is a measure of how flexible phrase searches should be in matching documents - each unit of slop represents a movement of one token relative to another that is needed for a phrase query to match text in an underlying document. The higher the number, the more forgiving phrase searches are.

getQueryPhraseSlop

public Integer getQueryPhraseSlop()

Returns:

the "slop" used when evaluating phrase queries explicitly included in the provided value. (As opposed to phraseSlop which designates the slop used for matching the complete query string).

See Also:

getPhraseSlop()

setValue

public void setValue(String value)

Specified by:

setValue in class ChangableValueQuery

getValue

public String getValue()

Specified by:

getValue in class ChangableValueQuery

Returns:

a text string containing the query terms to search.

setFields

public void setFields(List<KeyAndBoost> fields)

clone

public TextQuery clone()

Specified by:

clone in class ChangableValueQuery