org.elasticsearch.index.query
Class MoreLikeThisQueryBuilder

java.lang.Object
  org.elasticsearch.index.query.BaseQueryBuilder
      org.elasticsearch.index.query.MoreLikeThisQueryBuilder

All Implemented Interfaces:

ToXContent, BoostableQueryBuilder<MoreLikeThisQueryBuilder>, QueryBuilder

public class MoreLikeThisQueryBuilder
extends BaseQueryBuilder
implements BoostableQueryBuilder<MoreLikeThisQueryBuilder>

A more like this query that finds documents that are "like" the provided likeText(String) which is checked against the fields the query is constructed with.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

MoreLikeThisQueryBuilder()
Constructs a new more like this query which uses the "_all" field.

MoreLikeThisQueryBuilder(String... fields)
Sets the field names that will be used when generating the 'More Like This' query.

Method Summary

MoreLikeThisQueryBuilder	analyzer(String analyzer) The analyzer that will be used to analyze the text.
MoreLikeThisQueryBuilder	boost(float boost) Sets the boost for this query.
MoreLikeThisQueryBuilder	boostTerms(float boostTerms) Sets the boost factor to use when boosting terms.
protected void	doXContent(XContentBuilder builder, ToXContent.Params params)
MoreLikeThisQueryBuilder	likeText(String likeText) The text to use in order to find documents that are "like" this.
MoreLikeThisQueryBuilder	maxDocFreq(int maxDocFreq) Set the maximum frequency in which words may still appear.
MoreLikeThisQueryBuilder	maxQueryTerms(int maxQueryTerms) Sets the maximum number of query terms that will be included in any generated query.
MoreLikeThisQueryBuilder	maxWordLen(int maxWordLen) Sets the maximum word length above which words will be ignored.
MoreLikeThisQueryBuilder	minDocFreq(int minDocFreq) Sets the frequency at which words will be ignored which do not occur in at least this many docs.
MoreLikeThisQueryBuilder	minTermFreq(int minTermFreq) The frequency below which terms will be ignored in the source doc.
MoreLikeThisQueryBuilder	minWordLen(int minWordLen) Sets the minimum word length below which words will be ignored.
MoreLikeThisQueryBuilder	percentTermsToMatch(float percentTermsToMatch) The percentage of terms to match.
MoreLikeThisQueryBuilder	stopWords(String... stopWords) Set the set of stopwords.

Methods inherited from class org.elasticsearch.index.query.BaseQueryBuilder

buildAsBytes, buildAsBytes, toString, toXContent

Methods inherited from class java.lang.Object

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

Constructor Detail

MoreLikeThisQueryBuilder

public MoreLikeThisQueryBuilder()

Constructs a new more like this query which uses the "_all" field.

MoreLikeThisQueryBuilder

public MoreLikeThisQueryBuilder(String... fields)

Sets the field names that will be used when generating the 'More Like This' query.

Parameters:

fields - the field names that will be used when generating the 'More Like This' query.

Method Detail

likeText

public MoreLikeThisQueryBuilder likeText(String likeText)

The text to use in order to find documents that are "like" this.

percentTermsToMatch

public MoreLikeThisQueryBuilder percentTermsToMatch(float percentTermsToMatch)

The percentage of terms to match. Defaults to 0.3.

minTermFreq

public MoreLikeThisQueryBuilder minTermFreq(int minTermFreq)

The frequency below which terms will be ignored in the source doc. The default frequency is 2.

maxQueryTerms

public MoreLikeThisQueryBuilder maxQueryTerms(int maxQueryTerms)

Sets the maximum number of query terms that will be included in any generated query. Defaults to 25.

stopWords

public MoreLikeThisQueryBuilder stopWords(String... stopWords)

Set the set of stopwords.

Any word in this set is considered "uninteresting" and ignored. Even if your Analyzer allows stopwords, you might want to tell the MoreLikeThis code to ignore them, as for the purposes of document similarity it seems reasonable to assume that "a stop word is never interesting".

minDocFreq

public MoreLikeThisQueryBuilder minDocFreq(int minDocFreq)

Sets the frequency at which words will be ignored which do not occur in at least this many docs. Defaults to 5.

maxDocFreq

public MoreLikeThisQueryBuilder maxDocFreq(int maxDocFreq)

Set the maximum frequency in which words may still appear. Words that appear in more than this many docs will be ignored. Defaults to unbounded.

minWordLen

public MoreLikeThisQueryBuilder minWordLen(int minWordLen)

Sets the minimum word length below which words will be ignored. Defaults to 0.

maxWordLen

public MoreLikeThisQueryBuilder maxWordLen(int maxWordLen)

Sets the maximum word length above which words will be ignored. Defaults to unbounded (0).

boostTerms

public MoreLikeThisQueryBuilder boostTerms(float boostTerms)

Sets the boost factor to use when boosting terms. Defaults to 1.

analyzer

public MoreLikeThisQueryBuilder analyzer(String analyzer)

The analyzer that will be used to analyze the text. Defaults to the analyzer associated with the fied.

boost

public MoreLikeThisQueryBuilder boost(float boost)

Description copied from interface: BoostableQueryBuilder

Sets the boost for this query. Documents matching this query will (in addition to the normal weightings) have their score multiplied by the boost provided.

Specified by:

boost in interface BoostableQueryBuilder<MoreLikeThisQueryBuilder>

doXContent

protected void doXContent(XContentBuilder builder,
                          ToXContent.Params params)
                   throws IOException

Specified by:

doXContent in class BaseQueryBuilder

Throws:

IOException