elastic.js
Version:
Javascript API for ElasticSearch DSL
276 lines (223 loc) • 8.78 kB
JavaScript
/**
@class
<p>The more_like_this_field query is the same as the more_like_this query,
except it runs against a single field.</p>
@name ejs.MoreLikeThisFieldQuery
@ejs query
@borrows ejs.QueryMixin._type as _type
@borrows ejs.QueryMixin.toJSON as toJSON
@desc
<p>Constructs a query where each documents returned are “like” provided text</p>
@param {String} field The field to run the query against.
@param {String} likeText The text to find documents like it.
*/
ejs.MoreLikeThisFieldQuery = function (field, likeText) {
var
_common = ejs.QueryMixin('mlt_field'),
query = _common.toJSON();
query.mlt_field[field] = {
like_text: likeText
};
return extend(_common, {
/**
The field to run the query against.
@member ejs.MoreLikeThisFieldQuery
@param {String} f A single field name.
@returns {Object} returns <code>this</code> so that calls can be chained.
*/
field: function (f) {
var oldValue = query.mlt_field[field];
if (f == null) {
return field;
}
delete query.mlt_field[field];
field = f;
query.mlt_field[f] = oldValue;
return this;
},
/**
The text to find documents like
@member ejs.MoreLikeThisFieldQuery
@param {String} s A text string.
@returns {Object} returns <code>this</code> so that calls can be chained.
*/
likeText: function (txt) {
if (txt == null) {
return query.mlt_field[field].like_text;
}
query.mlt_field[field].like_text = txt;
return this;
},
/**
The percentage of terms to match on (float value).
Defaults to 0.3 (30 percent).
@member ejs.MoreLikeThisFieldQuery
@param {Double} percent A double value between 0 and 1.
@returns {Object} returns <code>this</code> so that calls can be chained.
*/
percentTermsToMatch: function (percent) {
if (percent == null) {
return query.mlt_field[field].percent_terms_to_match;
}
query.mlt_field[field].percent_terms_to_match = percent;
return this;
},
/**
The frequency below which terms will be ignored in the source doc.
The default frequency is 2.
@member ejs.MoreLikeThisFieldQuery
@param {Integer} freq A positive integer value.
@returns {Object} returns <code>this</code> so that calls can be chained.
*/
minTermFreq: function (freq) {
if (freq == null) {
return query.mlt_field[field].min_term_freq;
}
query.mlt_field[field].min_term_freq = freq;
return this;
},
/**
The maximum number of query terms that will be included in any
generated query. Defaults to 25.
@member ejs.MoreLikeThisFieldQuery
@param {Integer} max A positive integer value.
@returns {Object} returns <code>this</code> so that calls can be chained.
*/
maxQueryTerms: function (max) {
if (max == null) {
return query.mlt_field[field].max_query_terms;
}
query.mlt_field[field].max_query_terms = max;
return this;
},
/**
An array of stop words. 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”.
@member ejs.MoreLikeThisFieldQuery
@param {Array} stopWords An array of string stopwords
@returns {Object} returns <code>this</code> so that calls can be chained.
*/
stopWords: function (stopWords) {
if (stopWords == null) {
return query.mlt_field[field].stop_words;
}
query.mlt_field[field].stop_words = stopWords;
return this;
},
/**
The frequency at which words will be ignored which do not occur in
at least this many docs. Defaults to 5.
@member ejs.MoreLikeThisFieldQuery
@param {Integer} min A positive integer value.
@returns {Object} returns <code>this</code> so that calls can be chained.
*/
minDocFreq: function (min) {
if (min == null) {
return query.mlt_field[field].min_doc_freq;
}
query.mlt_field[field].min_doc_freq = min;
return this;
},
/**
The maximum frequency in which words may still appear. Words that
appear in more than this many docs will be ignored.
Defaults to unbounded.
@member ejs.MoreLikeThisFieldQuery
@param {Integer} max A positive integer value.
@returns {Object} returns <code>this</code> so that calls can be chained.
*/
maxDocFreq: function (max) {
if (max == null) {
return query.mlt_field[field].max_doc_freq;
}
query.mlt_field[field].max_doc_freq = max;
return this;
},
/**
The minimum word length below which words will be ignored.
Defaults to 0.
@member ejs.MoreLikeThisFieldQuery
@param {Integer} len A positive integer value.
@returns {Object} returns <code>this</code> so that calls can be chained.
*/
minWordLen: function (len) {
if (len == null) {
return query.mlt_field[field].min_word_len;
}
query.mlt_field[field].min_word_len = len;
return this;
},
/**
The maximum word length above which words will be ignored.
Defaults to unbounded (0).
@member ejs.MoreLikeThisFieldQuery
@param {Integer} len A positive integer value.
@returns {Object} returns <code>this</code> so that calls can be chained.
*/
maxWordLen: function (len) {
if (len == null) {
return query.mlt_field[field].max_word_len;
}
query.mlt_field[field].max_word_len = len;
return this;
},
/**
The analyzer that will be used to analyze the text. Defaults to the
analyzer associated with the field.
@member ejs.MoreLikeThisFieldQuery
@param {String} analyzerName The name of the analyzer.
@returns {Object} returns <code>this</code> so that calls can be chained.
*/
analyzer: function (analyzerName) {
if (analyzerName == null) {
return query.mlt_field[field].analyzer;
}
query.mlt_field[field].analyzer = analyzerName;
return this;
},
/**
Sets the boost factor to use when boosting terms.
Defaults to 1.
@member ejs.MoreLikeThisFieldQuery
@param {Double} boost A positive <code>double</code> value.
@returns {Object} returns <code>this</code> so that calls can be chained.
*/
boostTerms: function (boost) {
if (boost == null) {
return query.mlt_field[field].boost_terms;
}
query.mlt_field[field].boost_terms = boost;
return this;
},
/**
Should the <code>Query</code> fail when an unsupported field
is specified. Defaults to true.
@member ejs.MoreLikeThisFieldQuery
@param {Boolean} trueFalse A boolean value
@returns {Object} returns <code>this</code> so that calls can be chained.
*/
failOnUnsupportedField: function (trueFalse) {
if (trueFalse == null) {
return query.mlt_field[field].fail_on_unsupported_field;
}
query.mlt_field[field].fail_on_unsupported_field = trueFalse;
return this;
},
/**
Sets the boost value of the <code>Query</code>.
@member ejs.MoreLikeThisFieldQuery
@param {Double} boost A positive <code>double</code> value.
@returns {Object} returns <code>this</code> so that calls can be chained.
*/
boost: function (boost) {
if (boost == null) {
return query.mlt_field[field].boost;
}
query.mlt_field[field].boost = boost;
return this;
}
});
};