The DateHistogram facet works with time-based values by building a histogram across time
- intervals of the value field. Each value is rounded into an interval (or
- placed in a bucket), and statistics are provided per interval/bucket (count and total).
The DateHistogram facet works with time-based values by building a histogram across time
+ intervals of the value field. Each value is rounded into an interval (or
+ placed in a bucket), and statistics are provided per interval/bucket (count and total).
Facets are similar to SQL GROUP BY statements but perform much
- better. You can also construct several "groups" at once by simply
- specifying multiple facets.
Facets are similar to SQL GROUP BY statements but perform much
+ better. You can also construct several "groups" at once by simply
+ specifying multiple facets.
A facet which returns the N most frequent terms within a collection - or set of collections.
+ @desc +A facet which returns the N most frequent terms within a collection + or set of collections.
- @param {String} name The name which be used to refer to this facet. For instance, - the facet itself might utilize a field nameddoc_authors. Setting
- name to Authors would allow you to refer to the
- facet by that name, possibly simplifying some of the display logic.
+ @param {String} name The name which be used to refer to this facet. For instance,
+ the facet itself might utilize a field named doc_authors. Setting
+ name to Authors would allow you to refer to the
+ facet by that name, possibly simplifying some of the display logic.
- */
+ */
ejs.DateHistogramFacet = function (name) {
/**
- The internal facet object.
- @member ejs.DateHistogramFacet
- @property {Object} facet
- */
+ The internal facet object.
+ @member ejs.DateHistogramFacet
+ @property {Object} facet
+ */
var facet = {};
facet[name] = {
@@ -236,424 +346,424 @@
return {
/**
- Sets the field to be used to construct the this facet.
+ Sets the field to be used to construct the this facet.
- @member ejs.DateHistogramFacet
- @param {String} fieldName The field name whose data will be used to construct the facet.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.DateHistogramFacet
+ @param {String} fieldName The field name whose data will be used to construct the facet.
+ @returns {Object} returns this so that calls can be chained.
+ */
field: function (fieldName) {
if (fieldName == null) {
return facet[name].date_histogram.field;
}
-
+
facet[name].date_histogram.field = fieldName;
return this;
},
/**
- Allows you to specify a different key field to be used to group intervals.
+ Allows you to specify a different key field to be used to group intervals.
- @member ejs.DateHistogramFacet
- @param {String} fieldName The name of the field to be used.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.DateHistogramFacet
+ @param {String} fieldName The name of the field to be used.
+ @returns {Object} returns this so that calls can be chained.
+ */
keyField: function (fieldName) {
if (fieldName == null) {
return facet[name].date_histogram.key_field;
}
-
+
facet[name].date_histogram.key_field = fieldName;
return this;
},
-
- /**
- Allows you to specify a different value field to aggrerate over.
- @member ejs.DateHistogramFacet
- @param {String} fieldName The name of the field to be used.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Allows you to specify a different value field to aggrerate over.
+
+ @member ejs.DateHistogramFacet
+ @param {String} fieldName The name of the field to be used.
+ @returns {Object} returns this so that calls can be chained.
+ */
valueField: function (fieldName) {
if (fieldName == null) {
return facet[name].date_histogram.value_field;
}
-
+
facet[name].date_histogram.value_field = fieldName;
return this;
},
-
- /**
- Sets the bucket interval used to calculate the distribution.
- @member ejs.DateHistogramFacet
- @param {String} timeInterval The bucket interval. Valid values are year, month, week, day, hour, and minute.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the bucket interval used to calculate the distribution.
+
+ @member ejs.DateHistogramFacet
+ @param {String} timeInterval The bucket interval. Valid values are year, month, week, day, hour, and minute.
+ @returns {Object} returns this so that calls can be chained.
+ */
interval: function (timeInterval) {
if (timeInterval == null) {
return facet[name].date_histogram.interval;
}
-
+
facet[name].date_histogram.interval = timeInterval;
return this;
},
/**
- By default, time values are stored in UTC format.
+
By default, time values are stored in UTC format.
-
This method allows users to set a time zone value that is then used
- to compute intervals before rounding on the interval value. Equalivent to
-
-
- For example, to use EST you would set the value to This method allows users to set a time zone value that is then used
+ to compute intervals before rounding on the interval value. Equalivent to
+
- @member ejs.DateHistogramFacet
- @param {Integer} tz An offset value from UTC.
- @returns {Object} returns For example, to use EST you would set the value to By default, time values are stored in UTC format.
+ By default, time values are stored in UTC format.
- This method allows users to set a time zone value that is then used to
- compute intervals before rounding on the interval value. The value is an
- offset from UTC.
-
- For example, to use EST you would set the value to This method allows users to set a time zone value that is then used to
+ compute intervals before rounding on the interval value. The value is an
+ offset from UTC.
- @member ejs.DateHistogramFacet
- @param {Integer} tz An offset value from UTC.
- @returns {Object} returns For example, to use EST you would set the value to Enables large date interval conversions (day and up). Set to true to enable and then set the Enables large date interval conversions (day and up). Set to true to enable and then set the By default, time values are stored in UTC format.
+ By default, time values are stored in UTC format.
- This method allows users to set a time zone value that is then used to compute
- intervals after rounding on the interval value. The value is an offset from UTC.
- The tz offset value is simply added to the resulting bucket's date value.
-
- For example, to use EST you would set the value to This method allows users to set a time zone value that is then used to compute
+ intervals after rounding on the interval value. The value is an offset from UTC.
+ The tz offset value is simply added to the resulting bucket's date value.
- @member ejs.DateHistogramFacet
- @param {Integer} tz An offset value from UTC.
- @returns {Object} returns For example, to use EST you would set the value to The date histogram works on numeric values (since time is stored
- in milliseconds since the epoch in UTC).
+ The date histogram works on numeric values (since time is stored
+ in milliseconds since the epoch in UTC).
- But, sometimes, systems will store a different resolution (like seconds since UTC)
- in a numeric field. The factor parameter can be used to change the value in the field
- to milliseconds to actual do the relevant rounding, and then be applied again to get to
- the original unit. But, sometimes, systems will store a different resolution (like seconds since UTC)
+ in a numeric field. The factor parameter can be used to change the value in the field
+ to milliseconds to actual do the relevant rounding, and then be applied again to get to
+ the original unit. For example, when storing in a numeric field seconds resolution,
- the factor can be set to 1000.
+ For example, when storing in a numeric field seconds resolution,
+ the factor can be set to 1000.
- @member ejs.DateHistogramFacet
- @param {Integer} f The conversion factor.
- @returns {Object} returns Sets the type of ordering that will be performed on the date
- buckets. Valid values are:
-
- Sets the type of ordering that will be performed on the date
+ buckets. Valid values are:
+
+ Allows you to reduce the documents used for computing facet results. Allows you to reduce the documents used for computing facet results. Computes values across the entire index Computes values across the entire index Sets the mode the facet will use.
-
- Sets the mode the facet will use.
+
+ Computes values across the the specified scope Computes values across the the specified scope Enables caching of the Enables caching of the Sets the path to the nested document if faceting against a
- nested field. Sets the path to the nested document if faceting against a
+ nested field. Allows you to serialize this object into a JSON encoded string. Allows you to serialize this object into a JSON encoded string. Retrieves the internal Retrieves the internal The FilterFacet allows you to specify any valid The FilterFacet allows you to specify any valid Facets are similar to SQL Facets are similar to SQL A facet that return a count of the hits matching the given filter. A facet that return a count of the hits matching the given filter. Sets the filter to be used for this facet. Sets the filter to be used for this facet. Allows you to reduce the documents used for computing facet results. Allows you to reduce the documents used for computing facet results. Computes values across the entire index Computes values across the entire index Sets the mode the facet will use.
-
- Sets the mode the facet will use.
+
+ Computes values across the the specified scope Computes values across the the specified scope Enables caching of the Enables caching of the Sets the path to the nested document if faceting against a
- nested field. Sets the path to the nested document if faceting against a
+ nested field. Allows you to serialize this object into a JSON encoded string. Allows you to serialize this object into a JSON encoded string. Retrieves the internal Retrieves the internal The geoDistanceFacet facet provides information over a range of distances from a
- provided point. This includes the number of hits that fall within each range,
- along with aggregate information (like total). The geoDistanceFacet facet provides information over a range of distances from a
+ provided point. This includes the number of hits that fall within each range,
+ along with aggregate information (like total). Facets are similar to SQL Facets are similar to SQL A facet which provides information over a range of distances from a provided point. A facet which provides information over a range of distances from a provided point. Allows you to reduce the documents used for computing facet results. Allows you to reduce the documents used for computing facet results. Computes values across the entire index Computes values across the entire index Sets the mode the facet will use.
-
- Sets the mode the facet will use.
+
+ Computes values across the the specified scope Computes values across the the specified scope Enables caching of the Enables caching of the Sets the path to the nested document if faceting against a
- nested field. Sets the path to the nested document if faceting against a
+ nested field. Allows you to serialize this object into a JSON encoded string. Allows you to serialize this object into a JSON encoded string. Retrieves the internal Retrieves the internal The histogram facet works with numeric data by building a histogram across intervals
- of the field values. Each value is rounded into an interval (or placed in a
- bucket), and statistics are provided per interval/bucket (count and total). The histogram facet works with numeric data by building a histogram across intervals
+ of the field values. Each value is rounded into an interval (or placed in a
+ bucket), and statistics are provided per interval/bucket (count and total). Facets are similar to SQL Facets are similar to SQL A facet which returns the N most frequent terms within a collection
- or set of collections. A facet which returns the N most frequent terms within a collection
+ or set of collections. Allows you to reduce the documents used for computing facet results. Allows you to reduce the documents used for computing facet results. Computes values across the entire index Computes values across the entire index Sets the mode the facet will use.
-
- Sets the mode the facet will use.
+
+ Computes values across the the specified scope Computes values across the the specified scope Enables caching of the Enables caching of the Sets the path to the nested document if faceting against a
- nested field. Sets the path to the nested document if faceting against a
+ nested field. Allows you to serialize this object into a JSON encoded string. Allows you to serialize this object into a JSON encoded string. Retrieves the internal Retrieves the internal The QueryFacet facet allows you to specify any valid The QueryFacet facet allows you to specify any valid Facets are similar to SQL Facets are similar to SQL A facet that return a count of the hits matching the given query. A facet that return a count of the hits matching the given query. Sets the query to be used for this facet. Sets the query to be used for this facet. Allows you to reduce the documents used for computing facet results. Allows you to reduce the documents used for computing facet results. Computes values across the entire index Computes values across the entire index Sets the mode the facet will use.
-
- Sets the mode the facet will use.
+
+ Computes values across the the specified scope Computes values across the the specified scope Enables caching of the Enables caching of the Sets the path to the nested document if faceting against a
- nested field. Sets the path to the nested document if faceting against a
+ nested field. Allows you to serialize this object into a JSON encoded string. Allows you to serialize this object into a JSON encoded string. Retrieves the internal Retrieves the internal A RangeFacet allows you to specify a set of ranges and get both the number of docs (count) that
- fall within each range, and aggregated data based on the field, or another specified field. A RangeFacet allows you to specify a set of ranges and get both the number of docs (count) that
+ fall within each range, and aggregated data based on the field, or another specified field. Facets are similar to SQL Facets are similar to SQL A facet which provides information over a range of numeric intervals. A facet which provides information over a range of numeric intervals. Allows you to reduce the documents used for computing facet results. Allows you to reduce the documents used for computing facet results. Computes values across the entire index Computes values across the entire index Sets the mode the facet will use.
-
- Sets the mode the facet will use.
+
+ Computes values across the the specified scope Computes values across the the specified scope Enables caching of the Enables caching of the Sets the path to the nested document if faceting against a
- nested field. Sets the path to the nested document if faceting against a
+ nested field. Allows you to serialize this object into a JSON encoded string. Allows you to serialize this object into a JSON encoded string. Retrieves the internal Retrieves the internal A statistical facet allows you to compute statistical data over a numeric fields. Statistical data includes
- the count, total, sum of squares, mean (average), minimum, maximum, variance, and standard deviation. A statistical facet allows you to compute statistical data over a numeric fields. Statistical data includes
+ the count, total, sum of squares, mean (average), minimum, maximum, variance, and standard deviation. Facets are similar to SQL Facets are similar to SQL A facet which returns statistical information about a numeric field A facet which returns statistical information about a numeric field Allows you to reduce the documents used for computing facet results. Allows you to reduce the documents used for computing facet results. Computes values across the entire index Computes values across the entire index Sets the mode the facet will use.
-
- Sets the mode the facet will use.
+
+ Computes values across the the specified scope Computes values across the the specified scope Enables caching of the Enables caching of the Sets the path to the nested document if faceting against a
- nested field. Sets the path to the nested document if faceting against a
+ nested field. Allows you to serialize this object into a JSON encoded string. Allows you to serialize this object into a JSON encoded string. Retrieves the internal Retrieves the internal A termsStatsFacet allows you to compute statistics over an aggregate key (term). Essentially this
- facet provides the functionality of what is often refered to as a pivot table. A termsStatsFacet allows you to compute statistics over an aggregate key (term). Essentially this
+ facet provides the functionality of what is often refered to as a pivot table. Facets are similar to SQL Facets are similar to SQL A facet which computes statistical data based on an aggregate key. A facet which computes statistical data based on an aggregate key. Allows you to return all terms, even if the frequency count is 0. This should not be
- used on fields that contain a large number of unique terms because it could cause
- out-of-memory errors. Allows you to return all terms, even if the frequency count is 0. This should not be
+ used on fields that contain a large number of unique terms because it could cause
+ out-of-memory errors. Allows you to reduce the documents used for computing facet results. Allows you to reduce the documents used for computing facet results. Computes values across the entire index Computes values across the entire index Sets the mode the facet will use.
-
- Sets the mode the facet will use.
+
+ Computes values across the the specified scope Computes values across the the specified scope Enables caching of the Enables caching of the Sets the path to the nested document if faceting against a
- nested field. Sets the path to the nested document if faceting against a
+ nested field. Allows you to serialize this object into a JSON encoded string. Allows you to serialize this object into a JSON encoded string. Retrieves the internal Retrieves the internal A facet which returns the N most frequent terms within a collection
- or set of collections. Term facets are useful for building constructs
- which allow users to refine search results by filtering on terms returned
- by the facet. A facet which returns the N most frequent terms within a collection
+ or set of collections. Term facets are useful for building constructs
+ which allow users to refine search results by filtering on terms returned
+ by the facet. Facets are similar to SQL Facets are similar to SQL For more information on faceted navigation, see this Wikipedia article on
- Faceted ClassificationFor more information on faceted navigation, see this Wikipedia article on
+ Faceted ClassificationA facet which returns the N most frequent terms within a collection
- or set of collections. A facet which returns the N most frequent terms within a collection
+ or set of collections. Allows you to return all terms, even if the frequency count is 0. This should not be
- used on fields that contain a large number of unique terms because it could cause
- out-of-memory errors. Allows you to return all terms, even if the frequency count is 0. This should not be
+ used on fields that contain a large number of unique terms because it could cause
+ out-of-memory errors. Allows you to filter out unwanted facet entries. When passed
- a single term, it is appended to the list of currently excluded
- terms. If passed an array, it overwrites all existing values. Allows you to filter out unwanted facet entries. When passed
+ a single term, it is appended to the list of currently excluded
+ terms. If passed an array, it overwrites all existing values. Allows you to only include facet entries matching a specified regular expression. Allows you to only include facet entries matching a specified regular expression. Allows you to set the regular expression flags to be used
- with the Allows you to set the regular expression flags to be used
+ with the Allows you to reduce the documents used for computing facet results. Allows you to reduce the documents used for computing facet results. Computes values across the entire index Computes values across the entire index Sets the mode the facet will use.
-
- Sets the mode the facet will use.
+
+ Computes values across the the specified scope Computes values across the the specified scope Enables caching of the Enables caching of the Sets the path to the nested document if faceting against a
- nested field. Sets the path to the nested document if faceting against a
+ nested field. Allows you to serialize this object into a JSON encoded string. Allows you to serialize this object into a JSON encoded string. Retrieves the internal Retrieves the internal A A An existsFilter matches documents where the specified field is present
- and the field contains a legitimate value. An existsFilter matches documents where the specified field is present
+ and the field contains a legitimate value. A filter that restricts matched results/docs to a geographic bounding box described by
- the specified lon and lat coordinates. The format conforms with the GeoJSON specification. A filter that restricts matched results/docs to a geographic bounding box described by
+ the specified lon and lat coordinates. The format conforms with the GeoJSON specification. A filter that restricts matched results/docs to a given distance from the
- point of origin. The format conforms with the GeoJSON specification. A filter that restricts matched results/docs to a given distance from the
+ point of origin. The format conforms with the GeoJSON specification. A filter that restricts matched results/docs to a given distance range from the
- point of origin. The format conforms with the GeoJSON specification. A filter that restricts matched results/docs to a given distance range from the
+ point of origin. The format conforms with the GeoJSON specification. A filter for locating documents that fall within a polygon of points. Simply provide a lon/lat
- for each document as a Geo Point type. The format conforms with the GeoJSON specification. A filter for locating documents that fall within a polygon of points. Simply provide a lon/lat
+ for each document as a Geo Point type. The format conforms with the GeoJSON specification. Efficient filtering of documents containing shapes indexed using the
- geo_shape type. Efficient filtering of documents containing shapes indexed using the
+ geo_shape type. Much like the geo_shape type, the geo_shape filter uses a grid square
- representation of the filter shape to find those documents which have shapes
- that relate to the filter shape in a specified way. In order to do this, the
- field being queried must be of geo_shape type. The filter will use the same
- PrefixTree configuration as defined for the field. Much like the geo_shape type, the geo_shape filter uses a grid square
+ representation of the filter shape to find those documents which have shapes
+ that relate to the filter shape in a specified way. In order to do this, the
+ field being queried must be of geo_shape type. The filter will use the same
+ PrefixTree configuration as defined for the field. Sets the spatial strategy. Valid values are: Sets the spatial strategy. Valid values are: This is an advanced setting, use with care. This is an advanced setting, use with care. The has_child filter results in parent documents that have child docs
- matching the query being returned. The has_child filter results in parent documents that have child docs
+ matching the query being returned. The has_parent results in child documents that have parent docs matching
- the query being returned. The has_parent results in child documents that have parent docs matching
+ the query being returned. Filters documents that only have the provided ids. Note, this filter
- does not require the _id field to be indexed since it works using the
- _uid field. Filters documents that only have the provided ids. Note, this filter
+ does not require the _id field to be indexed since it works using the
+ _uid field. The indices filter can be used when executed across multiple indices,
- allowing to have a filter that executes only when executed on an index that
- matches a specific list of indices, and another filter that executes when it
- is executed on an index that does not match the listed indices. The indices filter can be used when executed across multiple indices,
+ allowing to have a filter that executes only when executed on an index that
+ matches a specific list of indices, and another filter that executes when it
+ is executed on an index that does not match the listed indices. A limit filter limits the number of documents (per shard) to execute on. A limit filter limits the number of documents (per shard) to execute on. This filter can be used to match on all the documents
- in a given set of collections and/or types. This filter can be used to match on all the documents
+ in a given set of collections and/or types. A filter that matches on all documents A filter that matches on all documents An missingFilter matches documents where the specified field contains no legitimate value. An missingFilter matches documents where the specified field contains no legitimate value. Nested filters allow you to search against content within objects that are
- embedded inside of other objects. It is similar to Nested filters allow you to search against content within objects that are
+ embedded inside of other objects. It is similar to
- The filter is executed against the nested objects / docs as if they were
- indexed as separate docs and resulting in the root
- parent doc (or parent nested mapping).
+ The filter is executed against the nested objects / docs as if they were
+ indexed as separate docs and resulting in the root
+ parent doc (or parent nested mapping). Constructs a filter that is capable of executing a filter against objects
- nested within a document. Constructs a filter that is capable of executing a filter against objects
+ nested within a document. A container Filter that excludes the documents matched by the
- contained filter. A container Filter that excludes the documents matched by the
+ contained filter. Filters documents with fields that have values within a certain numeric
- range. Similar to range filter, except that it works only with numeric
- values, and the filter execution works differently. The numeric range filter works by loading all the relevant field values
- into memory, and checking for the relevant docs if they satisfy the range
- requirements. This requires more memory since the numeric range data are
- loaded to memory, but can provide a significant increase in performance. Note, if the relevant field values have already been loaded to memory,
- for example because it was used in facets or was sorted on, then this
- filter should be used. Filters documents with fields that have values within a certain numeric
+ range. Similar to range filter, except that it works only with numeric
+ values, and the filter execution works differently. The numeric range filter works by loading all the relevant field values
+ into memory, and checking for the relevant docs if they satisfy the range
+ requirements. This requires more memory since the numeric range data are
+ loaded to memory, but can provide a significant increase in performance. Note, if the relevant field values have already been loaded to memory,
+ for example because it was used in facets or was sorted on, then this
+ filter should be used. Filters documents that have fields containing terms with a specified prefix (not analyzed). Similar
- to phrase query, except that it acts as a filter. Can be placed within queries that accept a filter. Filters documents that have fields containing terms with a specified prefix (not analyzed). Similar
+ to phrase query, except that it acts as a filter. Can be placed within queries that accept a filter. Wraps any query to be used as a filter. Can be placed within queries
- that accept a filter. Wraps any query to be used as a filter. Can be placed within queries
+ that accept a filter. The result of the filter is not cached by default. Set the cache
- parameter to true to cache the result of the filter. This is handy when the
- same query is used on several (many) other queries. Note, the process of caching the first execution is higher when not
- caching (since it needs to satisfy different queries). The result of the filter is not cached by default. Set the cache
+ parameter to true to cache the result of the filter. This is handy when the
+ same query is used on several (many) other queries. Note, the process of caching the first execution is higher when not
+ caching (since it needs to satisfy different queries). Matches documents with fields that have terms within a certain range. Matches documents with fields that have terms within a certain range. Filters documents that have a field value matching a regular expression.
- Based on Lucene 4.0 RegexpFilter which uses automaton to efficiently iterate
- over index terms. Filters documents that have a field value matching a regular expression.
+ Based on Lucene 4.0 RegexpFilter which uses automaton to efficiently iterate
+ over index terms. A filter allowing to define scripts as filters A filter allowing to define scripts as filters Constructs a filter for docs matching any of the terms added to this
- object. Unlike a RangeFilter this can be used for filtering on multiple
- terms that are not necessarily in a sequence. Constructs a filter for docs matching any of the terms added to this
+ object. Unlike a RangeFilter this can be used for filtering on multiple
+ terms that are not necessarily in a sequence. Filters documents that have fields that match any of the provided
- terms (not analyzed) Filters documents that have fields that match any of the provided
+ terms (not analyzed) A Filter that filters results by a specified index type. A Filter that filters results by a specified index type. The The Sets the routing value.
+ Sets the routing value.
- By default, the shard the document is placed on is controlled by using a
- hash of the document’s id value. For more explicit control, this routing value
- will be fed into the hash function used by the router. This option is valid during the following operations:
- By default, the shard the document is placed on is controlled by using a
+ hash of the document’s id value. For more explicit control, this routing value
+ will be fed into the hash function used by the router. This option is valid during the following operations:
+ Sets parent value for a child document. Sets parent value for a child document. When indexing a child document, the routing value is automatically set to be
- the same as it’s parent, unless the routing value is explicitly specified
- using the routing parameter. This option is valid during the following operations:
- When indexing a child document, the routing value is automatically set to be
+ the same as it’s parent, unless the routing value is explicitly specified
+ using the routing parameter. This option is valid during the following operations:
+ Sets timestamp of the document. Sets timestamp of the document. By default the timestamp will be set to the time the docuement was indexed. This option is valid during the following operations:
- By default the timestamp will be set to the time the docuement was indexed. This option is valid during the following operations:
+ preZone if possible. The
- value is an offset from UTC.-5.preZone if possible. The
+ value is an offset from UTC.this so that calls can be chained.
- */
+ -5.this so that calls can be chained.
+ */
timeZone: function (tz) {
if (tz == null) {
return facet[name].date_histogram.time_zone;
}
-
+
facet[name].date_histogram.time_zone = tz;
return this;
},
/**
- -5.this so that calls can be chained.
- */
+ -5.this so that calls can be chained.
+ */
preZone: function (tz) {
if (tz == null) {
return facet[name].date_histogram.pre_zone;
}
-
+
facet[name].date_histogram.pre_zone = tz;
return this;
},
-
- /**
- interval to an
- interval greater than a day.this so that calls can be chained.
- */
+ /**
+ interval to an
+ interval greater than a day.this so that calls can be chained.
+ */
preZoneAdjustLargeInterval: function (trueFalse) {
if (trueFalse == null) {
return facet[name].date_histogram.pre_zone_adjust_large_interval;
}
-
+
facet[name].date_histogram.pre_zone_adjust_large_interval = trueFalse;
return this;
},
-
+
/**
- -5.this so that calls can be chained.
- */
+ -5.this so that calls can be chained.
+ */
postZone: function (tz) {
if (tz == null) {
return facet[name].date_histogram.post_zone;
}
-
+
facet[name].date_histogram.post_zone = tz;
return this;
},
/**
- Set's a specific pre-rounding offset. Format is 1d, 1h, etc.
+ Set's a specific pre-rounding offset. Format is 1d, 1h, etc.
- @member ejs.DateHistogramFacet
- @param {String} offset The offset as a string (1d, 1h, etc)
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.DateHistogramFacet
+ @param {String} offset The offset as a string (1d, 1h, etc)
+ @returns {Object} returns this so that calls can be chained.
+ */
preOffset: function (offset) {
if (offset == null) {
return facet[name].date_histogram.pre_offset;
}
-
+
facet[name].date_histogram.pre_offset = offset;
return this;
},
-
- /**
- Set's a specific post-rounding offset. Format is 1d, 1h, etc.
- @member ejs.DateHistogramFacet
- @param {String} offset The offset as a string (1d, 1h, etc)
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Set's a specific post-rounding offset. Format is 1d, 1h, etc.
+
+ @member ejs.DateHistogramFacet
+ @param {String} offset The offset as a string (1d, 1h, etc)
+ @returns {Object} returns this so that calls can be chained.
+ */
postOffset: function (offset) {
if (offset == null) {
return facet[name].date_histogram.post_offset;
}
-
+
facet[name].date_histogram.post_offset = offset;
return this;
},
-
+
/**
- this so that calls can be chained.
- */
+ @member ejs.DateHistogramFacet
+ @param {Integer} f The conversion factor.
+ @returns {Object} returns this so that calls can be chained.
+ */
factor: function (f) {
if (f == null) {
return facet[name].date_histogram.factor;
}
-
+
facet[name].date_histogram.factor = f;
return this;
},
-
- /**
- Allows you modify the value field using a script. The modified value
- is then used to compute the statistical data.
- @member ejs.DateHistogramFacet
- @param {String} scriptCode A valid script string to execute.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Allows you modify the value field using a script. The modified value
+ is then used to compute the statistical data.
+
+ @member ejs.DateHistogramFacet
+ @param {String} scriptCode A valid script string to execute.
+ @returns {Object} returns this so that calls can be chained.
+ */
valueScript: function (scriptCode) {
if (scriptCode == null) {
return facet[name].date_histogram.value_script;
}
-
+
facet[name].date_histogram.value_script = scriptCode;
return this;
},
/**
-
-
time - the default, sort by the buckets start time in milliseconds.count - sort by the number of items in the buckettotal - sort by the sum/total of the items in the bucket
-
- @member ejs.DateHistogramFacet
- @param {String} o The ordering method: time, count, or total.
- @returns {Object} returns
this so that calls can be chained.
- */
+
+
time - the default, sort by the buckets start time in milliseconds.count - sort by the number of items in the buckettotal - sort by the sum/total of the items in the bucket
+
+ @member ejs.DateHistogramFacet
+ @param {String} o The ordering method: time, count, or total.
+ @returns {Object} returns
this so that calls can be chained.
+ */
order: function (o) {
if (o == null) {
return facet[name].date_histogram.order;
}
-
+
o = o.toLowerCase();
if (o === 'time' || o === 'count' || o === 'total') {
facet[name].date_histogram.order = o;
}
-
+
return this;
},
-
- /**
- The script language being used. Currently supported values are
- javascript, groovy, and mvel.
- @member ejs.DateHistogramFacet
- @param {String} language The language of the script.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ The script language being used. Currently supported values are
+ javascript, groovy, and mvel.
+
+ @member ejs.DateHistogramFacet
+ @param {String} language The language of the script.
+ @returns {Object} returns this so that calls can be chained.
+ */
lang: function (language) {
if (language == null) {
return facet[name].date_histogram.lang;
}
-
+
facet[name].date_histogram.lang = language;
return this;
},
/**
- Sets parameters that will be applied to the script. Overwrites
- any existing params.
+ Sets parameters that will be applied to the script. Overwrites
+ any existing params.
- @member ejs.DateHistogramFacet
- @param {Object} p An object where the keys are the parameter name and
- values are the parameter value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.DateHistogramFacet
+ @param {Object} p An object where the keys are the parameter name and
+ values are the parameter value.
+ @returns {Object} returns this so that calls can be chained.
+ */
params: function (p) {
if (p == null) {
return facet[name].date_histogram.params;
}
-
+
facet[name].date_histogram.params = p;
return this;
},
-
- /**
- Filter object.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Filter object.
+ @returns {Object} returns this so that calls can be chained.
+ */
facetFilter: function (oFilter) {
if (oFilter == null) {
return facet[name].facet_filter;
}
-
+
if (!isFilter(oFilter)) {
throw new TypeError('Argument must be a Filter');
}
-
+
facet[name].facet_filter = oFilter._self();
return this;
},
/**
- this so that calls can be chained.
- */
+ @member ejs.DateHistogramFacet
+ @param {Boolean} trueFalse Calculate facet counts globally or not.
+ @returns {Object} returns this so that calls can be chained.
+ */
global: function (trueFalse) {
if (trueFalse == null) {
return facet[name].global;
}
-
+
facet[name].global = trueFalse;
return this;
},
/**
-
-
collectorpost
-
- @member ejs.DateHistogramFacet
- @param {String} m The mode: collector or post.
- @returns {Object} returns
this so that calls can be chained.
- */
+
+
collectorpost
+
+ @member ejs.DateHistogramFacet
+ @param {String} m The mode: collector or post.
+ @returns {Object} returns
this so that calls can be chained.
+ */
mode: function (m) {
if (m == null) {
return facet[name].mode;
}
-
+
m = m.toLowerCase();
if (m === 'collector' || m === 'post') {
facet[name].mode = m;
}
-
+
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
scope: function (scope) {
return this;
},
-
- /**
- facetFilterthis so that calls can be chained.
- */
+ /**
+ facetFilterthis so that calls can be chained.
+ */
cacheFilter: function (trueFalse) {
if (trueFalse == null) {
return facet[name].cache_filter;
}
-
+
facet[name].cache_filter = trueFalse;
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
nested: function (path) {
if (path == null) {
return facet[name].nested;
}
-
+
facet[name].nested = path;
return this;
},
-
- /**
- facet object. This is typically used by
- internal API functions so use with caution.facet property.
- */
+ /**
+ facet object. This is typically used by
+ internal API functions so use with caution.facet property.
+ */
_self: function () {
return facet;
}
@@ -661,199 +771,199 @@
};
/**
- @class
- Filter and
- have the number of matching hits returned as the value.Filter and
+ have the number of matching hits returned as the value.GROUP BY statements but perform much
- better. You can also construct several "groups" at once by simply
- specifying multiple facets.GROUP BY statements but perform much
+ better. You can also construct several "groups" at once by simply
+ specifying multiple facets.doc_authors. Setting
- name to Authors would allow you to refer to the
- facet by that name, possibly simplifying some of the display logic.
+ @param {String} name The name which be used to refer to this facet. For instance,
+ the facet itself might utilize a field named doc_authors. Setting
+ name to Authors would allow you to refer to the
+ facet by that name, possibly simplifying some of the display logic.
- */
+ */
ejs.FilterFacet = function (name) {
/**
- The internal facet object.
- @member ejs.FilterFacet
- @property {Object} facet
- */
+ The internal facet object.
+ @member ejs.FilterFacet
+ @property {Object} facet
+ */
var facet = {};
facet[name] = {};
return {
/**
- Query object.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.FilterFacet
+ @param {Object} oFilter A valid Query object.
+ @returns {Object} returns this so that calls can be chained.
+ */
filter: function (oFilter) {
if (oFilter == null) {
return facet[name].filter;
}
-
+
if (!isFilter(oFilter)) {
throw new TypeError('Argument must be a Filter');
}
-
+
facet[name].filter = oFilter._self();
return this;
},
/**
- Filter object.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.FilterFacet
+ @param {Object} oFilter A valid Filter object.
+ @returns {Object} returns this so that calls can be chained.
+ */
facetFilter: function (oFilter) {
if (oFilter == null) {
return facet[name].facet_filter;
}
-
+
if (!isFilter(oFilter)) {
throw new TypeError('Argument must be a Filter');
}
-
+
facet[name].facet_filter = oFilter._self();
return this;
},
/**
- this so that calls can be chained.
- */
+ @member ejs.FilterFacet
+ @param {Boolean} trueFalse Calculate facet counts globally or not.
+ @returns {Object} returns this so that calls can be chained.
+ */
global: function (trueFalse) {
if (trueFalse == null) {
return facet[name].global;
}
-
+
facet[name].global = trueFalse;
return this;
},
-
+
/**
-
-
collectorpost
-
- @member ejs.FilterFacet
- @param {String} m The mode: collector or post.
- @returns {Object} returns
this so that calls can be chained.
- */
+
+
collectorpost
+
+ @member ejs.FilterFacet
+ @param {String} m The mode: collector or post.
+ @returns {Object} returns
this so that calls can be chained.
+ */
mode: function (m) {
if (m == null) {
return facet[name].mode;
}
-
+
m = m.toLowerCase();
if (m === 'collector' || m === 'post') {
facet[name].mode = m;
}
-
+
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
scope: function (scope) {
return this;
},
-
- /**
- facetFilterthis so that calls can be chained.
- */
+ /**
+ facetFilterthis so that calls can be chained.
+ */
cacheFilter: function (trueFalse) {
if (trueFalse == null) {
return facet[name].cache_filter;
}
-
+
facet[name].cache_filter = trueFalse;
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
nested: function (path) {
if (path == null) {
return facet[name].nested;
}
-
+
facet[name].nested = path;
return this;
},
-
- /**
- facet object. This is typically used by
- internal API functions so use with caution.facet property.
- */
+ /**
+ facet object. This is typically used by
+ internal API functions so use with caution.facet property.
+ */
_self: function () {
return facet;
}
@@ -861,45 +971,45 @@
};
/**
- @class
- GROUP BY statements but perform much
- better. You can also construct several "groups" at once by simply
- specifying multiple facets.GROUP BY statements but perform much
+ better. You can also construct several "groups" at once by simply
+ specifying multiple facets.doc_authors. Setting
- name to Authors would allow you to refer to the
- facet by that name, possibly simplifying some of the display logic.
+ @param {String} name The name which be used to refer to this facet. For instance,
+ the facet itself might utilize a field named doc_authors. Setting
+ name to Authors would allow you to refer to the
+ facet by that name, possibly simplifying some of the display logic.
- */
+ */
ejs.GeoDistanceFacet = function (name) {
/**
- The internal facet object.
- @member ejs.GeoDistanceFacet
- @property {Object} facet
- */
+ The internal facet object.
+ @member ejs.GeoDistanceFacet
+ @property {Object} facet
+ */
var facet = {},
- point = ejs.GeoPoint([0, 0]),
- field = 'location';
+ point = ejs.GeoPoint([0, 0]),
+ field = 'location';
facet[name] = {
geo_distance: {
@@ -911,16 +1021,16 @@
return {
/**
- Sets the document field containing the geo-coordinate to be used
- to calculate the distance. Defaults to "location".
+ Sets the document field containing the geo-coordinate to be used
+ to calculate the distance. Defaults to "location".
- @member ejs.GeoDistanceFacet
- @param {String} fieldName The field name whose data will be used to construct the facet.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoDistanceFacet
+ @param {String} fieldName The field name whose data will be used to construct the facet.
+ @returns {Object} returns this so that calls can be chained.
+ */
field: function (fieldName) {
var oldValue = facet[name].geo_distance[field];
-
+
if (fieldName == null) {
return field;
}
@@ -928,119 +1038,119 @@
delete facet[name].geo_distance[field];
field = fieldName;
facet[name].geo_distance[fieldName] = oldValue;
-
+
return this;
},
/**
- Sets the point of origin from where distances will be measured.
+ Sets the point of origin from where distances will be measured.
- @member ejs.GeoDistanceFacet
- @param {GeoPoint} p A valid GeoPoint object
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoDistanceFacet
+ @param {GeoPoint} p A valid GeoPoint object
+ @returns {Object} returns this so that calls can be chained.
+ */
point: function (p) {
if (p == null) {
return point;
}
-
+
if (!isGeoPoint(p)) {
throw new TypeError('Argument must be a GeoPoint');
}
-
+
point = p;
facet[name].geo_distance[field] = p._self();
return this;
},
/**
- Adds a new bounded range.
+ Adds a new bounded range.
- @member ejs.GeoDistanceFacet
- @param {Number} from The lower bound of the range
- @param {Number} to The upper bound of the range
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoDistanceFacet
+ @param {Number} from The lower bound of the range
+ @param {Number} to The upper bound of the range
+ @returns {Object} returns this so that calls can be chained.
+ */
addRange: function (from, to) {
if (arguments.length === 0) {
return facet[name].geo_distance.ranges;
}
-
+
facet[name].geo_distance.ranges.push({
from: from,
to: to
});
-
+
return this;
},
/**
- Adds a new unbounded lower limit.
+ Adds a new unbounded lower limit.
- @member ejs.GeoDistanceFacet
- @param {Number} from The lower limit of the unbounded range
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoDistanceFacet
+ @param {Number} from The lower limit of the unbounded range
+ @returns {Object} returns this so that calls can be chained.
+ */
addUnboundedFrom: function (from) {
if (from == null) {
return facet[name].geo_distance.ranges;
}
-
+
facet[name].geo_distance.ranges.push({
from: from
});
-
+
return this;
},
/**
- Adds a new unbounded upper limit.
+ Adds a new unbounded upper limit.
- @member ejs.GeoDistanceFacet
- @param {Number} to The upper limit of the unbounded range
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoDistanceFacet
+ @param {Number} to The upper limit of the unbounded range
+ @returns {Object} returns this so that calls can be chained.
+ */
addUnboundedTo: function (to) {
if (to == null) {
return facet[name].geo_distance.ranges;
}
-
+
facet[name].geo_distance.ranges.push({
to: to
});
-
+
return this;
},
/**
- Sets the distance unit. Valid values are "mi" for miles or "km"
- for kilometers. Defaults to "km".
+ Sets the distance unit. Valid values are "mi" for miles or "km"
+ for kilometers. Defaults to "km".
- @member ejs.GeoDistanceFacet
- @param {Number} unit the unit of distance measure.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoDistanceFacet
+ @param {Number} unit the unit of distance measure.
+ @returns {Object} returns this so that calls can be chained.
+ */
unit: function (unit) {
if (unit == null) {
return facet[name].geo_distance.unit;
}
-
+
unit = unit.toLowerCase();
if (unit === 'mi' || unit === 'km') {
facet[name].geo_distance.unit = unit;
}
-
+
return this;
},
-
- /**
- How to compute the distance. Can either be arc (better precision)
- or plane (faster). Defaults to arc.
- @member ejs.GeoDistanceFacet
- @param {String} type The execution type as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ How to compute the distance. Can either be arc (better precision)
+ or plane (faster). Defaults to arc.
+
+ @member ejs.GeoDistanceFacet
+ @param {String} type The execution type as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
distanceType: function (type) {
if (type == null) {
return facet[name].geo_distance.distance_type;
@@ -1050,22 +1160,22 @@
if (type === 'arc' || type === 'plane') {
facet[name].geo_distance.distance_type = type;
}
-
+
return this;
},
/**
- If the lat/long points should be normalized to lie within their
- respective normalized ranges.
-
- Normalized ranges are:
- lon = -180 (exclusive) to 180 (inclusive) range
- lat = -90 to 90 (both inclusive) range
+ If the lat/long points should be normalized to lie within their
+ respective normalized ranges.
- @member ejs.GeoDistanceFacet
- @param {String} trueFalse True if the coordinates should be normalized. False otherwise.
- @returns {Object} returns this so that calls can be chained.
- */
+ Normalized ranges are:
+ lon = -180 (exclusive) to 180 (inclusive) range
+ lat = -90 to 90 (both inclusive) range
+
+ @member ejs.GeoDistanceFacet
+ @param {String} trueFalse True if the coordinates should be normalized. False otherwise.
+ @returns {Object} returns this so that calls can be chained.
+ */
normalize: function (trueFalse) {
if (trueFalse == null) {
return facet[name].geo_distance.normalize;
@@ -1074,208 +1184,208 @@
facet[name].geo_distance.normalize = trueFalse;
return this;
},
-
- /**
- Allows you to specify a different value field to aggrerate over.
- @member ejs.GeoDistanceFacet
- @param {String} fieldName The name of the field to be used.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Allows you to specify a different value field to aggrerate over.
+
+ @member ejs.GeoDistanceFacet
+ @param {String} fieldName The name of the field to be used.
+ @returns {Object} returns this so that calls can be chained.
+ */
valueField: function (fieldName) {
if (fieldName == null) {
return facet[name].geo_distance.value_field;
}
-
+
facet[name].geo_distance.value_field = fieldName;
return this;
},
-
- /**
- Allows you modify the value field using a script. The modified value
- is then used to compute the statistical data.
- @member ejs.GeoDistanceFacet
- @param {String} scriptCode A valid script string to execute.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Allows you modify the value field using a script. The modified value
+ is then used to compute the statistical data.
+
+ @member ejs.GeoDistanceFacet
+ @param {String} scriptCode A valid script string to execute.
+ @returns {Object} returns this so that calls can be chained.
+ */
valueScript: function (scriptCode) {
if (scriptCode == null) {
return facet[name].geo_distance.value_script;
}
-
+
facet[name].geo_distance.value_script = scriptCode;
return this;
},
-
- /**
- The script language being used. Currently supported values are
- javascript, groovy, and mvel.
- @member ejs.GeoDistanceFacet
- @param {String} language The language of the script.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ The script language being used. Currently supported values are
+ javascript, groovy, and mvel.
+
+ @member ejs.GeoDistanceFacet
+ @param {String} language The language of the script.
+ @returns {Object} returns this so that calls can be chained.
+ */
lang: function (language) {
if (language == null) {
return facet[name].geo_distance.lang;
}
-
+
facet[name].geo_distance.lang = language;
return this;
},
-
- /**
- Sets parameters that will be applied to the script. Overwrites
- any existing params.
- @member ejs.GeoDistanceFacet
- @param {Object} p An object where the keys are the parameter name and
- values are the parameter value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets parameters that will be applied to the script. Overwrites
+ any existing params.
+
+ @member ejs.GeoDistanceFacet
+ @param {Object} p An object where the keys are the parameter name and
+ values are the parameter value.
+ @returns {Object} returns this so that calls can be chained.
+ */
params: function (p) {
if (p == null) {
return facet[name].geo_distance.params;
}
-
+
facet[name].geo_distance.params = p;
return this;
},
-
- /**
- Filter object.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Filter object.
+ @returns {Object} returns this so that calls can be chained.
+ */
facetFilter: function (oFilter) {
if (oFilter == null) {
return facet[name].facet_filter;
}
-
+
if (!isFilter(oFilter)) {
throw new TypeError('Argument must be a Filter');
}
-
+
facet[name].facet_filter = oFilter._self();
return this;
},
/**
- this so that calls can be chained.
- */
+ @member ejs.GeoDistanceFacet
+ @param {Boolean} trueFalse Calculate facet counts globally or not.
+ @returns {Object} returns this so that calls can be chained.
+ */
global: function (trueFalse) {
if (trueFalse == null) {
return facet[name].global;
}
-
+
facet[name].global = trueFalse;
return this;
},
-
+
/**
-
-
collectorpost
-
- @member ejs.GeoDistanceFacet
- @param {String} m The mode: collector or post.
- @returns {Object} returns
this so that calls can be chained.
- */
+
+
collectorpost
+
+ @member ejs.GeoDistanceFacet
+ @param {String} m The mode: collector or post.
+ @returns {Object} returns
this so that calls can be chained.
+ */
mode: function (m) {
if (m == null) {
return facet[name].mode;
}
-
+
m = m.toLowerCase();
if (m === 'collector' || m === 'post') {
facet[name].mode = m;
}
-
+
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
scope: function (scope) {
return this;
},
-
- /**
- facetFilterthis so that calls can be chained.
- */
+ /**
+ facetFilterthis so that calls can be chained.
+ */
cacheFilter: function (trueFalse) {
if (trueFalse == null) {
return facet[name].cache_filter;
}
-
+
facet[name].cache_filter = trueFalse;
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
nested: function (path) {
if (path == null) {
return facet[name].nested;
}
-
+
facet[name].nested = path;
return this;
},
-
- /**
- facet object. This is typically used by
- internal API functions so use with caution.facet property.
- */
+ /**
+ facet object. This is typically used by
+ internal API functions so use with caution.facet property.
+ */
_self: function () {
return facet;
}
@@ -1283,43 +1393,43 @@
};
/**
- @class
- GROUP BY statements but perform much
- better. You can also construct several "groups" at once by simply
- specifying multiple facets.GROUP BY statements but perform much
+ better. You can also construct several "groups" at once by simply
+ specifying multiple facets.doc_authors. Setting
- name to Authors would allow you to refer to the
- facet by that name, possibly simplifying some of the display logic.
+ @param {String} name The name which be used to refer to this facet. For instance,
+ the facet itself might utilize a field named doc_authors. Setting
+ name to Authors would allow you to refer to the
+ facet by that name, possibly simplifying some of the display logic.
- */
+ */
ejs.HistogramFacet = function (name) {
/**
- The internal facet object.
- @member ejs.HistogramFacet
- @property {Object} facet
- */
+ The internal facet object.
+ @member ejs.HistogramFacet
+ @property {Object} facet
+ */
var facet = {};
facet[name] = {
@@ -1329,351 +1439,351 @@
return {
/**
- Sets the field to be used to construct the this facet.
+ Sets the field to be used to construct the this facet.
- @member ejs.HistogramFacet
- @param {String} fieldName The field name whose data will be used to construct the facet.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.HistogramFacet
+ @param {String} fieldName The field name whose data will be used to construct the facet.
+ @returns {Object} returns this so that calls can be chained.
+ */
field: function (fieldName) {
if (fieldName == null) {
return facet[name].histogram.field;
}
-
+
facet[name].histogram.field = fieldName;
return this;
},
/**
- Sets the bucket interval used to calculate the distribution.
+ Sets the bucket interval used to calculate the distribution.
- @member ejs.HistogramFacet
- @param {Number} numericInterval The bucket interval in which to group values.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.HistogramFacet
+ @param {Number} numericInterval The bucket interval in which to group values.
+ @returns {Object} returns this so that calls can be chained.
+ */
interval: function (numericInterval) {
if (numericInterval == null) {
return facet[name].histogram.interval;
}
-
+
facet[name].histogram.interval = numericInterval;
return this;
},
/**
- Sets the bucket interval used to calculate the distribution based
- on a time value such as "1d", "1w", etc.
+ Sets the bucket interval used to calculate the distribution based
+ on a time value such as "1d", "1w", etc.
- @member ejs.HistogramFacet
- @param {Number} timeInterval The bucket interval in which to group values.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.HistogramFacet
+ @param {Number} timeInterval The bucket interval in which to group values.
+ @returns {Object} returns this so that calls can be chained.
+ */
timeInterval: function (timeInterval) {
if (timeInterval == null) {
return facet[name].histogram.time_interval;
}
-
+
facet[name].histogram.time_interval = timeInterval;
return this;
},
/**
- Sets the "from", "start", or lower bounds bucket. For example if
- you have a value of 1023, an interval of 100, and a from value of
- 1500, it will be placed into the 1500 bucket vs. the normal bucket
- of 1000.
+ Sets the "from", "start", or lower bounds bucket. For example if
+ you have a value of 1023, an interval of 100, and a from value of
+ 1500, it will be placed into the 1500 bucket vs. the normal bucket
+ of 1000.
- @member ejs.HistogramFacet
- @param {Number} from the lower bounds bucket value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.HistogramFacet
+ @param {Number} from the lower bounds bucket value.
+ @returns {Object} returns this so that calls can be chained.
+ */
from: function (from) {
if (from == null) {
return facet[name].histogram.from;
}
-
+
facet[name].histogram.from = from;
return this;
},
/**
- Sets the "to", "end", or upper bounds bucket. For example if
- you have a value of 1023, an interval of 100, and a to value of
- 900, it will be placed into the 900 bucket vs. the normal bucket
- of 1000.
+ Sets the "to", "end", or upper bounds bucket. For example if
+ you have a value of 1023, an interval of 100, and a to value of
+ 900, it will be placed into the 900 bucket vs. the normal bucket
+ of 1000.
- @member ejs.HistogramFacet
- @param {Number} to the upper bounds bucket value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.HistogramFacet
+ @param {Number} to the upper bounds bucket value.
+ @returns {Object} returns this so that calls can be chained.
+ */
to: function (to) {
if (to == null) {
return facet[name].histogram.to;
}
-
+
facet[name].histogram.to = to;
return this;
},
-
- /**
- Allows you to specify a different value field to aggrerate over.
- @member ejs.HistogramFacet
- @param {String} fieldName The name of the field to be used.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Allows you to specify a different value field to aggrerate over.
+
+ @member ejs.HistogramFacet
+ @param {String} fieldName The name of the field to be used.
+ @returns {Object} returns this so that calls can be chained.
+ */
valueField: function (fieldName) {
if (fieldName == null) {
return facet[name].histogram.value_field;
}
-
+
facet[name].histogram.value_field = fieldName;
return this;
},
/**
- Allows you to specify a different key field to be used to group intervals.
+ Allows you to specify a different key field to be used to group intervals.
- @member ejs.HistogramFacet
- @param {String} fieldName The name of the field to be used.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.HistogramFacet
+ @param {String} fieldName The name of the field to be used.
+ @returns {Object} returns this so that calls can be chained.
+ */
keyField: function (fieldName) {
if (fieldName == null) {
return facet[name].histogram.key_field;
}
-
+
facet[name].histogram.key_field = fieldName;
return this;
},
/**
- Allows you modify the value field using a script. The modified value
- is then used to compute the statistical data.
+ Allows you modify the value field using a script. The modified value
+ is then used to compute the statistical data.
- @member ejs.HistogramFacet
- @param {String} scriptCode A valid script string to execute.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.HistogramFacet
+ @param {String} scriptCode A valid script string to execute.
+ @returns {Object} returns this so that calls can be chained.
+ */
valueScript: function (scriptCode) {
if (scriptCode == null) {
return facet[name].histogram.value_script;
}
-
+
facet[name].histogram.value_script = scriptCode;
return this;
},
/**
- Allows you modify the key field using a script. The modified value
- is then used to generate the interval.
+ Allows you modify the key field using a script. The modified value
+ is then used to generate the interval.
- @member ejs.HistogramFacet
- @param {String} scriptCode A valid script string to execute.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.HistogramFacet
+ @param {String} scriptCode A valid script string to execute.
+ @returns {Object} returns this so that calls can be chained.
+ */
keyScript: function (scriptCode) {
if (scriptCode == null) {
return facet[name].histogram.key_script;
}
-
+
facet[name].histogram.key_script = scriptCode;
return this;
},
/**
- The script language being used. Currently supported values are
- javascript, groovy, and mvel.
+ The script language being used. Currently supported values are
+ javascript, groovy, and mvel.
- @member ejs.HistogramFacet
- @param {String} language The language of the script.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.HistogramFacet
+ @param {String} language The language of the script.
+ @returns {Object} returns this so that calls can be chained.
+ */
lang: function (language) {
if (language == null) {
return facet[name].histogram.lang;
}
-
+
facet[name].histogram.lang = language;
return this;
},
/**
- Sets parameters that will be applied to the script. Overwrites
- any existing params.
+ Sets parameters that will be applied to the script. Overwrites
+ any existing params.
- @member ejs.HistogramFacet
- @param {Object} p An object where the keys are the parameter name and
- values are the parameter value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.HistogramFacet
+ @param {Object} p An object where the keys are the parameter name and
+ values are the parameter value.
+ @returns {Object} returns this so that calls can be chained.
+ */
params: function (p) {
if (p == null) {
return facet[name].histogram.params;
}
-
+
facet[name].histogram.params = p;
return this;
},
-
+
/**
- Sets the type of ordering that will be performed on the date
- buckets. Valid values are:
-
- key - the default, sort by the bucket's key value
- count - sort by the number of items in the bucket
- total - sort by the sum/total of the items in the bucket
-
- @member ejs.HistogramFacet
- @param {String} o The ordering method: key, count, or total.
- @returns {Object} returns this so that calls can be chained.
- */
+ Sets the type of ordering that will be performed on the date
+ buckets. Valid values are:
+
+ key - the default, sort by the bucket's key value
+ count - sort by the number of items in the bucket
+ total - sort by the sum/total of the items in the bucket
+
+ @member ejs.HistogramFacet
+ @param {String} o The ordering method: key, count, or total.
+ @returns {Object} returns this so that calls can be chained.
+ */
order: function (o) {
if (o == null) {
return facet[name].histogram.order;
}
-
+
o = o.toLowerCase();
if (o === 'key' || o === 'count' || o === 'total') {
facet[name].histogram.order = o;
}
-
+
return this;
},
-
- /**
- Filter object.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Filter object.
+ @returns {Object} returns this so that calls can be chained.
+ */
facetFilter: function (oFilter) {
if (oFilter == null) {
return facet[name].facet_filter;
}
-
+
if (!isFilter(oFilter)) {
throw new TypeError('Argument must be a Filter');
}
-
+
facet[name].facet_filter = oFilter._self();
return this;
},
/**
- this so that calls can be chained.
- */
+ @member ejs.HistogramFacet
+ @param {Boolean} trueFalse Calculate facet counts globally or not.
+ @returns {Object} returns this so that calls can be chained.
+ */
global: function (trueFalse) {
if (trueFalse == null) {
return facet[name].global;
}
-
+
facet[name].global = trueFalse;
return this;
},
-
+
/**
-
-
collectorpost
-
- @member ejs.HistogramFacet
- @param {String} m The mode: collector or post.
- @returns {Object} returns
this so that calls can be chained.
- */
+
+
collectorpost
+
+ @member ejs.HistogramFacet
+ @param {String} m The mode: collector or post.
+ @returns {Object} returns
this so that calls can be chained.
+ */
mode: function (m) {
if (m == null) {
return facet[name].mode;
}
-
+
m = m.toLowerCase();
if (m === 'collector' || m === 'post') {
facet[name].mode = m;
}
-
+
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
scope: function (scope) {
return this;
},
-
- /**
- facetFilterthis so that calls can be chained.
- */
+ /**
+ facetFilterthis so that calls can be chained.
+ */
cacheFilter: function (trueFalse) {
if (trueFalse == null) {
return facet[name].cache_filter;
}
-
+
facet[name].cache_filter = trueFalse;
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
nested: function (path) {
if (path == null) {
return facet[name].nested;
}
-
+
facet[name].nested = path;
return this;
},
/**
- facet object. This is typically used by
- internal API functions so use with caution.facet property.
- */
+ /**
+ facet object. This is typically used by
+ internal API functions so use with caution.facet property.
+ */
_self: function () {
return facet;
}
@@ -1681,199 +1791,199 @@
};
/**
- @class
- Query and
- have the number of matching hits returned as the value.Query and
+ have the number of matching hits returned as the value.GROUP BY statements but perform much
- better. You can also construct several "groups" at once by simply
- specifying multiple facets.GROUP BY statements but perform much
+ better. You can also construct several "groups" at once by simply
+ specifying multiple facets.doc_authors. Setting
- name to Authors would allow you to refer to the
- facet by that name, possibly simplifying some of the display logic.
+ @param {String} name The name which be used to refer to this facet. For instance,
+ the facet itself might utilize a field named doc_authors. Setting
+ name to Authors would allow you to refer to the
+ facet by that name, possibly simplifying some of the display logic.
- */
+ */
ejs.QueryFacet = function (name) {
/**
- The internal facet object.
- @member ejs.QueryFacet
- @property {Object} facet
- */
+ The internal facet object.
+ @member ejs.QueryFacet
+ @property {Object} facet
+ */
var facet = {};
facet[name] = {};
return {
/**
- Query object.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.QueryFacet
+ @param {Object} oQuery A valid Query object.
+ @returns {Object} returns this so that calls can be chained.
+ */
query: function (oQuery) {
if (oQuery == null) {
return facet[name].query;
}
-
+
if (!isQuery(oQuery)) {
throw new TypeError('Argument must be a Query');
}
-
+
facet[name].query = oQuery._self();
return this;
},
/**
- Filter object.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.QueryFacet
+ @param {Object} oFilter A valid Filter object.
+ @returns {Object} returns this so that calls can be chained.
+ */
facetFilter: function (oFilter) {
if (oFilter == null) {
return facet[name].facet_filter;
}
-
+
if (!isFilter(oFilter)) {
throw new TypeError('Argumnet must be a Filter');
}
-
+
facet[name].facet_filter = oFilter._self();
return this;
},
/**
- this so that calls can be chained.
- */
+ @member ejs.QueryFacet
+ @param {Boolean} trueFalse Calculate facet counts globally or not.
+ @returns {Object} returns this so that calls can be chained.
+ */
global: function (trueFalse) {
if (trueFalse == null) {
return facet[name].global;
}
-
+
facet[name].global = trueFalse;
return this;
},
-
+
/**
-
-
collectorpost
-
- @member ejs.QueryFacet
- @param {String} m The mode: collector or post.
- @returns {Object} returns
this so that calls can be chained.
- */
+
+
collectorpost
+
+ @member ejs.QueryFacet
+ @param {String} m The mode: collector or post.
+ @returns {Object} returns
this so that calls can be chained.
+ */
mode: function (m) {
if (m == null) {
return facet[name].mode;
}
-
+
m = m.toLowerCase();
if (m === 'collector' || m === 'post') {
facet[name].mode = m;
}
-
+
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
scope: function (scope) {
return this;
},
-
- /**
- facetFilterthis so that calls can be chained.
- */
+ /**
+ facetFilterthis so that calls can be chained.
+ */
cacheFilter: function (trueFalse) {
if (trueFalse == null) {
return facet[name].cache_filter;
}
-
+
facet[name].cache_filter = trueFalse;
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
nested: function (path) {
if (path == null) {
return facet[name].nested;
}
-
+
facet[name].nested = path;
return this;
},
/**
- facet object. This is typically used by
- internal API functions so use with caution.facet property.
- */
+ /**
+ facet object. This is typically used by
+ internal API functions so use with caution.facet property.
+ */
_self: function () {
return facet;
}
@@ -1881,41 +1991,41 @@
};
/**
- @class
- GROUP BY statements but perform much
- better. You can also construct several "groups" at once by simply
- specifying multiple facets.GROUP BY statements but perform much
+ better. You can also construct several "groups" at once by simply
+ specifying multiple facets.doc_authors. Setting
- name to Authors would allow you to refer to the
- facet by that name, possibly simplifying some of the display logic.
+ @param {String} name The name which be used to refer to this facet. For instance,
+ the facet itself might utilize a field named doc_authors. Setting
+ name to Authors would allow you to refer to the
+ facet by that name, possibly simplifying some of the display logic.
- */
+ */
ejs.RangeFacet = function (name) {
/**
- The internal facet object.
- @member ejs.RangeFacet
- @property {Object} facet
- */
+ The internal facet object.
+ @member ejs.RangeFacet
+ @property {Object} facet
+ */
var facet = {};
facet[name] = {
@@ -1927,314 +2037,314 @@
return {
/**
- Sets the document field to be used for the facet.
+ Sets the document field to be used for the facet.
- @member ejs.RangeFacet
- @param {String} fieldName The field name whose data will be used to compute the interval.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RangeFacet
+ @param {String} fieldName The field name whose data will be used to compute the interval.
+ @returns {Object} returns this so that calls can be chained.
+ */
field: function (fieldName) {
if (fieldName == null) {
return facet[name].range.field;
}
-
+
facet[name].range.field = fieldName;
return this;
},
/**
- Allows you to specify an alternate key field to be used to compute the interval.
+ Allows you to specify an alternate key field to be used to compute the interval.
- @member ejs.RangeFacet
- @param {String} fieldName The field name whose data will be used to compute the interval.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RangeFacet
+ @param {String} fieldName The field name whose data will be used to compute the interval.
+ @returns {Object} returns this so that calls can be chained.
+ */
keyField: function (fieldName) {
if (fieldName == null) {
return facet[name].range.key_field;
}
-
+
facet[name].range.key_field = fieldName;
return this;
},
/**
- Allows you to specify an alternate value field to be used to compute statistical information.
+ Allows you to specify an alternate value field to be used to compute statistical information.
- @member ejs.RangeFacet
- @param {String} fieldName The field name whose data will be used to compute statistics.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RangeFacet
+ @param {String} fieldName The field name whose data will be used to compute statistics.
+ @returns {Object} returns this so that calls can be chained.
+ */
valueField: function (fieldName) {
if (fieldName == null) {
return facet[name].range.value_field;
}
-
+
facet[name].range.value_field = fieldName;
return this;
},
/**
- Allows you modify the value field using a script. The modified value
- is then used to compute the statistical data.
+ Allows you modify the value field using a script. The modified value
+ is then used to compute the statistical data.
- @member ejs.RangeFacet
- @param {String} scriptCode A valid script string to execute.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RangeFacet
+ @param {String} scriptCode A valid script string to execute.
+ @returns {Object} returns this so that calls can be chained.
+ */
valueScript: function (scriptCode) {
if (scriptCode == null) {
return facet[name].range.value_script;
}
-
+
facet[name].range.value_script = scriptCode;
return this;
},
/**
- Allows you modify the key field using a script. The modified value
- is then used to generate the interval.
+ Allows you modify the key field using a script. The modified value
+ is then used to generate the interval.
- @member ejs.RangeFacet
- @param {String} scriptCode A valid script string to execute.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RangeFacet
+ @param {String} scriptCode A valid script string to execute.
+ @returns {Object} returns this so that calls can be chained.
+ */
keyScript: function (scriptCode) {
if (scriptCode == null) {
return facet[name].range.key_script;
}
-
+
facet[name].range.key_script = scriptCode;
return this;
},
/**
- The script language being used. Currently supported values are
- javascript, groovy, and mvel.
+ The script language being used. Currently supported values are
+ javascript, groovy, and mvel.
- @member ejs.RangeFacet
- @param {String} language The language of the script.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RangeFacet
+ @param {String} language The language of the script.
+ @returns {Object} returns this so that calls can be chained.
+ */
lang: function (language) {
if (language == null) {
return facet[name].range.lang;
}
-
+
facet[name].range.lang = language;
return this;
},
/**
- Sets parameters that will be applied to the script. Overwrites
- any existing params.
+ Sets parameters that will be applied to the script. Overwrites
+ any existing params.
- @member ejs.RangeFacet
- @param {Object} p An object where the keys are the parameter name and
- values are the parameter value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RangeFacet
+ @param {Object} p An object where the keys are the parameter name and
+ values are the parameter value.
+ @returns {Object} returns this so that calls can be chained.
+ */
params: function (p) {
if (p == null) {
return facet[name].range.params;
}
-
+
facet[name].range.params = p;
return this;
},
-
- /**
- Adds a new bounded range.
- @member ejs.RangeFacet
- @param {Number} from The lower bound of the range (can also be Date).
- @param {Number} to The upper bound of the range (can also be Date).
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Adds a new bounded range.
+
+ @member ejs.RangeFacet
+ @param {Number} from The lower bound of the range (can also be Date).
+ @param {Number} to The upper bound of the range (can also be Date).
+ @returns {Object} returns this so that calls can be chained.
+ */
addRange: function (from, to) {
if (arguments.length === 0) {
return facet[name].range.ranges;
}
-
+
facet[name].range.ranges.push({
from: from,
to: to
});
-
+
return this;
},
/**
- Adds a new unbounded lower limit.
+ Adds a new unbounded lower limit.
- @member ejs.RangeFacet
- @param {Number} from The lower limit of the unbounded range (can also be Date).
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RangeFacet
+ @param {Number} from The lower limit of the unbounded range (can also be Date).
+ @returns {Object} returns this so that calls can be chained.
+ */
addUnboundedFrom: function (from) {
if (from == null) {
return facet[name].range.ranges;
}
-
+
facet[name].range.ranges.push({
from: from
});
-
+
return this;
},
/**
- Adds a new unbounded upper limit.
+ Adds a new unbounded upper limit.
- @member ejs.RangeFacet
- @param {Number} to The upper limit of the unbounded range (can also be Date).
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RangeFacet
+ @param {Number} to The upper limit of the unbounded range (can also be Date).
+ @returns {Object} returns this so that calls can be chained.
+ */
addUnboundedTo: function (to) {
if (to == null) {
return facet[name].range.ranges;
}
-
+
facet[name].range.ranges.push({
to: to
});
-
+
return this;
},
/**
- Filter object.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RangeFacet
+ @param {Object} oFilter A valid Filter object.
+ @returns {Object} returns this so that calls can be chained.
+ */
facetFilter: function (oFilter) {
if (oFilter == null) {
return facet[name].facet_filter;
}
-
+
if (!isFilter(oFilter)) {
throw new TypeError('Argument must be a Filter');
}
-
+
facet[name].facet_filter = oFilter._self();
return this;
},
/**
- this so that calls can be chained.
- */
+ @member ejs.RangeFacet
+ @param {Boolean} trueFalse Calculate facet counts globally or not.
+ @returns {Object} returns this so that calls can be chained.
+ */
global: function (trueFalse) {
if (trueFalse == null) {
return facet[name].global;
}
-
+
facet[name].global = trueFalse;
return this;
},
-
+
/**
-
-
collectorpost
-
- @member ejs.RangeFacet
- @param {String} m The mode: collector or post.
- @returns {Object} returns
this so that calls can be chained.
- */
+
+
collectorpost
+
+ @member ejs.RangeFacet
+ @param {String} m The mode: collector or post.
+ @returns {Object} returns
this so that calls can be chained.
+ */
mode: function (m) {
if (m == null) {
return facet[name].mode;
}
-
+
m = m.toLowerCase();
if (m === 'collector' || m === 'post') {
facet[name].mode = m;
}
-
+
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
scope: function (scope) {
return this;
},
-
- /**
- facetFilterthis so that calls can be chained.
- */
+ /**
+ facetFilterthis so that calls can be chained.
+ */
cacheFilter: function (trueFalse) {
if (trueFalse == null) {
return facet[name].cache_filter;
}
-
+
facet[name].cache_filter = trueFalse;
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
nested: function (path) {
if (path == null) {
return facet[name].nested;
}
-
+
facet[name].nested = path;
return this;
},
-
- /**
- facet object. This is typically used by
- internal API functions so use with caution.facet property.
- */
+ /**
+ facet object. This is typically used by
+ internal API functions so use with caution.facet property.
+ */
_self: function () {
return facet;
}
@@ -2242,41 +2352,41 @@
};
/**
- @class
- GROUP BY statements but perform much
- better. You can also construct several "groups" at once by simply
- specifying multiple facets.GROUP BY statements but perform much
+ better. You can also construct several "groups" at once by simply
+ specifying multiple facets.doc_authors. Setting
- name to Authors would allow you to refer to the
- facet by that name, possibly simplifying some of the display logic.
+ @param {String} name The name which be used to refer to this facet. For instance,
+ the facet itself might utilize a field named doc_authors. Setting
+ name to Authors would allow you to refer to the
+ facet by that name, possibly simplifying some of the display logic.
- */
+ */
ejs.StatisticalFacet = function (name) {
/**
- The internal facet object.
- @member ejs.StatisticalFacet
- @property {Object} facet
- */
+ The internal facet object.
+ @member ejs.StatisticalFacet
+ @property {Object} facet
+ */
var facet = {};
facet[name] = {
@@ -2286,224 +2396,224 @@
return {
/**
- Sets the field to be used to construct the this facet.
+ Sets the field to be used to construct the this facet.
- @member ejs.StatisticalFacet
- @param {String} fieldName The field name whose data will be used to construct the facet.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.StatisticalFacet
+ @param {String} fieldName The field name whose data will be used to construct the facet.
+ @returns {Object} returns this so that calls can be chained.
+ */
field: function (fieldName) {
if (fieldName == null) {
return facet[name].statistical.field;
}
-
+
facet[name].statistical.field = fieldName;
return this;
},
/**
- Aggregate statistical info across a set of fields.
+ Aggregate statistical info across a set of fields.
- @member ejs.StatisticalFacet
- @param {Array} aFieldName An array of field names.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.StatisticalFacet
+ @param {Array} aFieldName An array of field names.
+ @returns {Object} returns this so that calls can be chained.
+ */
fields: function (fields) {
if (fields == null) {
return facet[name].statistical.fields;
}
-
+
if (!isArray(fields)) {
throw new TypeError('Argument must be an array');
}
-
+
facet[name].statistical.fields = fields;
return this;
},
/**
- Define a script to evaluate of which the result will be used to generate
- the statistical information.
+ Define a script to evaluate of which the result will be used to generate
+ the statistical information.
- @member ejs.StatisticalFacet
- @param {String} code The script code to execute.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.StatisticalFacet
+ @param {String} code The script code to execute.
+ @returns {Object} returns this so that calls can be chained.
+ */
script: function (code) {
if (code == null) {
return facet[name].statistical.script;
}
-
+
facet[name].statistical.script = code;
return this;
},
/**
- The script language being used. Currently supported values are
- javascript, groovy, and mvel.
+ The script language being used. Currently supported values are
+ javascript, groovy, and mvel.
- @member ejs.StatisticalFacet
- @param {String} language The language of the script.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.StatisticalFacet
+ @param {String} language The language of the script.
+ @returns {Object} returns this so that calls can be chained.
+ */
lang: function (language) {
if (language == null) {
return facet[name].statistical.lang;
}
-
+
facet[name].statistical.lang = language;
return this;
},
/**
- Allows you to set script parameters to be used during the execution of the script.
+ Allows you to set script parameters to be used during the execution of the script.
- @member ejs.StatisticalFacet
- @param {Object} oParams An object containing key/value pairs representing param name/value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.StatisticalFacet
+ @param {Object} oParams An object containing key/value pairs representing param name/value.
+ @returns {Object} returns this so that calls can be chained.
+ */
params: function (oParams) {
if (oParams == null) {
return facet[name].statistical.params;
}
-
+
facet[name].statistical.params = oParams;
return this;
},
/**
- Filter object.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.StatisticalFacet
+ @param {Object} oFilter A valid Filter object.
+ @returns {Object} returns this so that calls can be chained.
+ */
facetFilter: function (oFilter) {
if (oFilter == null) {
return facet[name].facet_filter;
}
-
+
if (!isFilter(oFilter)) {
throw new TypeError('Argument must be a Filter');
}
-
+
facet[name].facet_filter = oFilter._self();
return this;
},
/**
- this so that calls can be chained.
- */
+ @member ejs.StatisticalFacet
+ @param {Boolean} trueFalse Calculate facet counts globally or not.
+ @returns {Object} returns this so that calls can be chained.
+ */
global: function (trueFalse) {
if (trueFalse == null) {
return facet[name].global;
}
-
+
facet[name].global = trueFalse;
return this;
},
-
+
/**
-
-
collectorpost
-
- @member ejs.StatisticalFacet
- @param {String} m The mode: collector or post.
- @returns {Object} returns
this so that calls can be chained.
- */
+
+
collectorpost
+
+ @member ejs.StatisticalFacet
+ @param {String} m The mode: collector or post.
+ @returns {Object} returns
this so that calls can be chained.
+ */
mode: function (m) {
if (m == null) {
return facet[name].mode;
}
-
+
m = m.toLowerCase();
if (m === 'collector' || m === 'post') {
facet[name].mode = m;
}
-
+
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
scope: function (scope) {
return this;
},
-
- /**
- facetFilterthis so that calls can be chained.
- */
+ /**
+ facetFilterthis so that calls can be chained.
+ */
cacheFilter: function (trueFalse) {
if (trueFalse == null) {
return facet[name].cache_filter;
}
-
+
facet[name].cache_filter = trueFalse;
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
nested: function (path) {
if (path == null) {
return facet[name].nested;
}
-
+
facet[name].nested = path;
return this;
},
/**
- facet object. This is typically used by
- internal API functions so use with caution.facet property.
- */
+ /**
+ facet object. This is typically used by
+ internal API functions so use with caution.facet property.
+ */
_self: function () {
return facet;
}
@@ -2511,41 +2621,41 @@
};
/**
- @class
- GROUP BY statements but perform much
- better. You can also construct several "groups" at once by simply
- specifying multiple facets.GROUP BY statements but perform much
+ better. You can also construct several "groups" at once by simply
+ specifying multiple facets.doc_authors. Setting
- name to Authors would allow you to refer to the
- facet by that name, possibly simplifying some of the display logic.
+ @param {String} name The name which be used to refer to this facet. For instance,
+ the facet itself might utilize a field named doc_authors. Setting
+ name to Authors would allow you to refer to the
+ facet by that name, possibly simplifying some of the display logic.
- */
+ */
ejs.TermStatsFacet = function (name) {
/**
- The internal facet object.
- @member ejs.TermStatsFacet
- @property {Object} facet
- */
+ The internal facet object.
+ @member ejs.TermStatsFacet
+ @property {Object} facet
+ */
var facet = {};
facet[name] = {
@@ -2555,310 +2665,310 @@
return {
/**
- Sets the field for which statistical information will be generated.
+ Sets the field for which statistical information will be generated.
- @member ejs.TermStatsFacet
- @param {String} fieldName The field name whose data will be used to construct the facet.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.TermStatsFacet
+ @param {String} fieldName The field name whose data will be used to construct the facet.
+ @returns {Object} returns this so that calls can be chained.
+ */
valueField: function (fieldName) {
if (fieldName == null) {
return facet[name].terms_stats.value_field;
}
-
+
facet[name].terms_stats.value_field = fieldName;
return this;
},
/**
- Sets the field which will be used to pivot on (group-by).
+ Sets the field which will be used to pivot on (group-by).
- @member ejs.TermStatsFacet
- @param {String} fieldName The field name whose data will be used to construct the facet.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.TermStatsFacet
+ @param {String} fieldName The field name whose data will be used to construct the facet.
+ @returns {Object} returns this so that calls can be chained.
+ */
keyField: function (fieldName) {
if (fieldName == null) {
return facet[name].terms_stats.key_field;
}
-
+
facet[name].terms_stats.key_field = fieldName;
return this;
},
/**
- Sets a script that will provide the terms for a given document.
+ Sets a script that will provide the terms for a given document.
- @member ejs.TermStatsFacet
- @param {String} script The script code.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.TermStatsFacet
+ @param {String} script The script code.
+ @returns {Object} returns this so that calls can be chained.
+ */
scriptField: function (script) {
if (script == null) {
return facet[name].terms_stats.script_field;
}
-
+
facet[name].terms_stats.script_field = script;
return this;
},
-
- /**
- Define a script to evaluate of which the result will be used to generate
- the statistical information.
- @member ejs.TermStatsFacet
- @param {String} code The script code to execute.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Define a script to evaluate of which the result will be used to generate
+ the statistical information.
+
+ @member ejs.TermStatsFacet
+ @param {String} code The script code to execute.
+ @returns {Object} returns this so that calls can be chained.
+ */
valueScript: function (code) {
if (code == null) {
return facet[name].terms_stats.value_script;
}
-
+
facet[name].terms_stats.value_script = code;
return this;
},
/**
- true or false
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.TermStatsFacet
+ @param {String} trueFalse true or false
+ @returns {Object} returns this so that calls can be chained.
+ */
allTerms: function (trueFalse) {
if (trueFalse == null) {
return facet[name].terms_stats.all_terms;
}
-
+
facet[name].terms_stats.all_terms = trueFalse;
return this;
},
-
- /**
- The script language being used. Currently supported values are
- javascript, groovy, and mvel.
- @member ejs.TermStatsFacet
- @param {String} language The language of the script.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ The script language being used. Currently supported values are
+ javascript, groovy, and mvel.
+
+ @member ejs.TermStatsFacet
+ @param {String} language The language of the script.
+ @returns {Object} returns this so that calls can be chained.
+ */
lang: function (language) {
if (language == null) {
return facet[name].terms_stats.lang;
}
-
+
facet[name].terms_stats.lang = language;
return this;
},
/**
- Allows you to set script parameters to be used during the execution of the script.
+ Allows you to set script parameters to be used during the execution of the script.
- @member ejs.TermStatsFacet
- @param {Object} oParams An object containing key/value pairs representing param name/value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.TermStatsFacet
+ @param {Object} oParams An object containing key/value pairs representing param name/value.
+ @returns {Object} returns this so that calls can be chained.
+ */
params: function (oParams) {
if (oParams == null) {
return facet[name].terms_stats.params;
}
-
+
facet[name].terms_stats.params = oParams;
return this;
},
/**
- Sets the number of facet entries that will be returned for this facet. For instance, you
- might ask for only the top 5 aggregate keys although there might be hundreds of
- unique keys. Higher settings could cause memory strain.
+ Sets the number of facet entries that will be returned for this facet. For instance, you
+ might ask for only the top 5 aggregate keys although there might be hundreds of
+ unique keys. Higher settings could cause memory strain.
- @member ejs.TermStatsFacet
- @param {Integer} facetSize The numer of facet entries to be returned.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.TermStatsFacet
+ @param {Integer} facetSize The numer of facet entries to be returned.
+ @returns {Object} returns this so that calls can be chained.
+ */
size: function (facetSize) {
if (facetSize == null) {
return facet[name].terms_stats.size;
}
-
+
facet[name].terms_stats.size = facetSize;
return this;
},
/**
- Sets the type of ordering that will be performed on the date
- buckets. Valid values are:
-
- count - default, sort by the number of items in the bucket
- term - sort by term value.
- reverse_count - reverse sort of the number of items in the bucket
- reverse_term - reverse sort of the term value.
- total - sorts by the total value of the bucket contents
- reverse_total - reverse sort of the total value of bucket contents
- min - the minimum value in the bucket
- reverse_min - the reverse sort of the minimum value
- max - the maximum value in the bucket
- reverse_max - the reverse sort of the maximum value
- mean - the mean value of the bucket contents
- reverse_mean - the reverse sort of the mean value of bucket contents.
-
- @member ejs.TermStatsFacet
- @param {String} o The ordering method
- @returns {Object} returns this so that calls can be chained.
- */
+ Sets the type of ordering that will be performed on the date
+ buckets. Valid values are:
+
+ count - default, sort by the number of items in the bucket
+ term - sort by term value.
+ reverse_count - reverse sort of the number of items in the bucket
+ reverse_term - reverse sort of the term value.
+ total - sorts by the total value of the bucket contents
+ reverse_total - reverse sort of the total value of bucket contents
+ min - the minimum value in the bucket
+ reverse_min - the reverse sort of the minimum value
+ max - the maximum value in the bucket
+ reverse_max - the reverse sort of the maximum value
+ mean - the mean value of the bucket contents
+ reverse_mean - the reverse sort of the mean value of bucket contents.
+
+ @member ejs.TermStatsFacet
+ @param {String} o The ordering method
+ @returns {Object} returns this so that calls can be chained.
+ */
order: function (o) {
if (o == null) {
return facet[name].terms_stats.order;
}
-
+
o = o.toLowerCase();
- if (o === 'count' || o === 'term' || o === 'reverse_count' ||
- o === 'reverse_term' || o === 'total' || o === 'reverse_total' ||
- o === 'min' || o === 'reverse_min' || o === 'max' ||
+ if (o === 'count' || o === 'term' || o === 'reverse_count' ||
+ o === 'reverse_term' || o === 'total' || o === 'reverse_total' ||
+ o === 'min' || o === 'reverse_min' || o === 'max' ||
o === 'reverse_max' || o === 'mean' || o === 'reverse_mean') {
-
+
facet[name].terms_stats.order = o;
}
-
+
return this;
},
/**
- Filter object.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.TermStatsFacet
+ @param {Object} oFilter A valid Filter object.
+ @returns {Object} returns this so that calls can be chained.
+ */
facetFilter: function (oFilter) {
if (oFilter == null) {
return facet[name].facet_filter;
}
-
+
if (!isFilter(oFilter)) {
throw new TypeError('Argument must be a Filter');
}
-
+
facet[name].facet_filter = oFilter._self();
return this;
},
/**
- this so that calls can be chained.
- */
+ @member ejs.TermStatsFacet
+ @param {Boolean} trueFalse Calculate facet counts globally or not.
+ @returns {Object} returns this so that calls can be chained.
+ */
global: function (trueFalse) {
if (trueFalse == null) {
return facet[name].global;
}
-
+
facet[name].global = trueFalse;
return this;
},
-
+
/**
-
-
collectorpost
-
- @member ejs.TermStatsFacet
- @param {String} m The mode: collector or post.
- @returns {Object} returns
this so that calls can be chained.
- */
+
+
collectorpost
+
+ @member ejs.TermStatsFacet
+ @param {String} m The mode: collector or post.
+ @returns {Object} returns
this so that calls can be chained.
+ */
mode: function (m) {
if (m == null) {
return facet[name].mode;
}
-
+
m = m.toLowerCase();
if (m === 'collector' || m === 'post') {
facet[name].mode = m;
}
-
+
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
scope: function (scope) {
return this;
},
-
- /**
- facetFilterthis so that calls can be chained.
- */
+ /**
+ facetFilterthis so that calls can be chained.
+ */
cacheFilter: function (trueFalse) {
if (trueFalse == null) {
return facet[name].cache_filter;
}
-
+
facet[name].cache_filter = trueFalse;
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
nested: function (path) {
if (path == null) {
return facet[name].nested;
}
-
+
facet[name].nested = path;
return this;
},
-
- /**
- facet object. This is typically used by
- internal API functions so use with caution.facet property.
- */
+ /**
+ facet object. This is typically used by
+ internal API functions so use with caution.facet property.
+ */
_self: function () {
return facet;
}
@@ -2866,38 +2976,38 @@
};
/**
- @class
- GROUP BY statements but perform much
- better. You can also construct several "groups" at once by simply
- specifying multiple facets.GROUP BY statements but perform much
+ better. You can also construct several "groups" at once by simply
+ specifying multiple facets.doc_authors. Setting
- name to Authors would allow you to refer to the
- facet by that name, possibly simplifying some of the display logic.
+ @param {String} name The name which be used to refer to this facet. For instance,
+ the facet itself might utilize a field named doc_authors. Setting
+ name to Authors would allow you to refer to the
+ facet by that name, possibly simplifying some of the display logic.
- */
+ */
ejs.TermsFacet = function (name) {
/**
- The internal facet object.
- @member ejs.TermsFacet
- @property {Object} facet
- */
+ The internal facet object.
+ @member ejs.TermsFacet
+ @property {Object} facet
+ */
var facet = {};
facet[name] = {
@@ -2907,142 +3017,142 @@
return {
/**
- Sets the field to be used to construct the this facet. Set to
- _index to return a facet count of hits per _index the search was
- executed on.
+ Sets the field to be used to construct the this facet. Set to
+ _index to return a facet count of hits per _index the search was
+ executed on.
- @member ejs.TermsFacet
- @param {String} fieldName The field name whose data will be used to construct the facet.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.TermsFacet
+ @param {String} fieldName The field name whose data will be used to construct the facet.
+ @returns {Object} returns this so that calls can be chained.
+ */
field: function (fieldName) {
if (fieldName == null) {
return facet[name].terms.field;
}
-
+
facet[name].terms.field = fieldName;
return this;
},
/**
- Aggregate statistical info across a set of fields.
+ Aggregate statistical info across a set of fields.
- @member ejs.TermsFacet
- @param {Array} aFieldName An array of field names.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.TermsFacet
+ @param {Array} aFieldName An array of field names.
+ @returns {Object} returns this so that calls can be chained.
+ */
fields: function (fields) {
if (fields == null) {
return facet[name].terms.fields;
}
-
+
if (!isArray(fields)) {
throw new TypeError('Argument must be an array');
}
-
+
facet[name].terms.fields = fields;
return this;
},
/**
- Sets a script that will provide the terms for a given document.
+ Sets a script that will provide the terms for a given document.
- @member ejs.TermsFacet
- @param {String} script The script code.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.TermsFacet
+ @param {String} script The script code.
+ @returns {Object} returns this so that calls can be chained.
+ */
scriptField: function (script) {
if (script == null) {
return facet[name].terms.script_field;
}
-
+
facet[name].terms.script_field = script;
return this;
},
-
- /**
- Sets the number of facet entries that will be returned for this facet. For instance, you
- might ask for only the top 5 authors although there might be hundreds of
- unique authors.
- @member ejs.TermsFacet
- @param {Integer} facetSize The numer of facet entries to be returned.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the number of facet entries that will be returned for this facet. For instance, you
+ might ask for only the top 5 authors although there might be hundreds of
+ unique authors.
+
+ @member ejs.TermsFacet
+ @param {Integer} facetSize The numer of facet entries to be returned.
+ @returns {Object} returns this so that calls can be chained.
+ */
size: function (facetSize) {
if (facetSize == null) {
return facet[name].terms.size;
}
-
+
facet[name].terms.size = facetSize;
return this;
},
/**
- Sets the type of ordering that will be performed on the date
- buckets. Valid values are:
-
- count - default, sort by the number of items in the bucket
- term - sort by term value.
- reverse_count - reverse sort of the number of items in the bucket
- reverse_term - reverse sort of the term value.
-
- @member ejs.TermsFacet
- @param {String} o The ordering method
- @returns {Object} returns this so that calls can be chained.
- */
+ Sets the type of ordering that will be performed on the date
+ buckets. Valid values are:
+
+ count - default, sort by the number of items in the bucket
+ term - sort by term value.
+ reverse_count - reverse sort of the number of items in the bucket
+ reverse_term - reverse sort of the term value.
+
+ @member ejs.TermsFacet
+ @param {String} o The ordering method
+ @returns {Object} returns this so that calls can be chained.
+ */
order: function (o) {
if (o == null) {
return facet[name].terms.order;
}
-
+
o = o.toLowerCase();
- if (o === 'count' || o === 'term' ||
+ if (o === 'count' || o === 'term' ||
o === 'reverse_count' || o === 'reverse_term') {
-
+
facet[name].terms.order = o;
}
-
+
return this;
},
/**
- true or false
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.TermsFacet
+ @param {String} trueFalse true or false
+ @returns {Object} returns this so that calls can be chained.
+ */
allTerms: function (trueFalse) {
if (trueFalse == null) {
return facet[name].terms.all_terms;
}
-
+
facet[name].terms.all_terms = trueFalse;
return this;
},
/**
- this so that calls can be chained.
- */
+ @member ejs.TermsFacet
+ @param {String || Array} exclude A single term to exclude or an
+ array of terms to exclude.
+ @returns {Object} returns this so that calls can be chained.
+ */
exclude: function (exclude) {
if (facet[name].terms.exclude == null) {
facet[name].terms.exclude = [];
}
-
+
if (exclude == null) {
return facet[name].terms.exclude;
}
-
+
if (isString(exclude)) {
facet[name].terms.exclude.push(exclude);
} else if (isArray(exclude)) {
@@ -3050,245 +3160,245 @@
} else {
throw new TypeError('Argument must be string or array');
}
-
+
return this;
},
/**
- this so that calls can be chained.
- */
+ @member ejs.TermsFacet
+ @param {String} exp A valid regular expression.
+ @returns {Object} returns this so that calls can be chained.
+ */
regex: function (exp) {
if (exp == null) {
return facet[name].terms.regex;
}
-
+
facet[name].terms.regex = exp;
return this;
},
/**
- regexregexthis so that calls can be chained.
- */
+ @member ejs.TermsFacet
+ @param {String} flags A valid regex flag - see Java Pattern API
+ @returns {Object} returns this so that calls can be chained.
+ */
regexFlags: function (flags) {
if (flags == null) {
return facet[name].terms.regex_flags;
}
-
+
facet[name].terms.regex_flags = flags;
return this;
},
/**
- Allows you modify the term using a script. The modified value
- is then used in the facet collection.
+ Allows you modify the term using a script. The modified value
+ is then used in the facet collection.
- @member ejs.TermsFacet
- @param {String} scriptCode A valid script string to execute.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.TermsFacet
+ @param {String} scriptCode A valid script string to execute.
+ @returns {Object} returns this so that calls can be chained.
+ */
script: function (scriptCode) {
if (scriptCode == null) {
return facet[name].terms.script;
}
-
+
facet[name].terms.script = scriptCode;
return this;
},
/**
- The script language being used. Currently supported values are
- javascript, groovy, and mvel.
+ The script language being used. Currently supported values are
+ javascript, groovy, and mvel.
- @member ejs.TermsFacet
- @param {String} language The language of the script.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.TermsFacet
+ @param {String} language The language of the script.
+ @returns {Object} returns this so that calls can be chained.
+ */
lang: function (language) {
if (language == null) {
return facet[name].terms.lang;
}
-
+
facet[name].terms.lang = language;
return this;
},
/**
- Sets parameters that will be applied to the script. Overwrites
- any existing params.
+ Sets parameters that will be applied to the script. Overwrites
+ any existing params.
- @member ejs.TermsFacet
- @param {Object} p An object where the keys are the parameter name and
- values are the parameter value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.TermsFacet
+ @param {Object} p An object where the keys are the parameter name and
+ values are the parameter value.
+ @returns {Object} returns this so that calls can be chained.
+ */
params: function (p) {
if (p == null) {
return facet[name].terms.params;
}
-
+
facet[name].terms.params = p;
return this;
},
-
- /**
- Sets the execution hint determines how the facet is computed.
- Currently only supported value is "map".
- @member ejs.TermsFacet
- @param {Object} h The hint value as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the execution hint determines how the facet is computed.
+ Currently only supported value is "map".
+
+ @member ejs.TermsFacet
+ @param {Object} h The hint value as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
executionHint: function (h) {
if (h == null) {
return facet[name].terms.execution_hint;
}
-
+
facet[name].terms.execution_hint = h;
return this;
},
-
- /**
- Filter object.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Filter object.
+ @returns {Object} returns this so that calls can be chained.
+ */
facetFilter: function (oFilter) {
if (oFilter == null) {
return facet[name].facet_filter;
}
-
+
if (!isFilter(oFilter)) {
throw new TypeError('Argument must be a Filter');
}
-
+
facet[name].facet_filter = oFilter._self();
return this;
},
/**
- this so that calls can be chained.
- */
+ @member ejs.TermsFacet
+ @param {Boolean} trueFalse Calculate facet counts globally or not.
+ @returns {Object} returns this so that calls can be chained.
+ */
global: function (trueFalse) {
if (trueFalse == null) {
return facet[name].global;
}
-
+
facet[name].global = trueFalse;
return this;
},
-
+
/**
-
-
collectorpost
-
- @member ejs.TermsFacet
- @param {String} m The mode: collector or post.
- @returns {Object} returns
this so that calls can be chained.
- */
+
+
collectorpost
+
+ @member ejs.TermsFacet
+ @param {String} m The mode: collector or post.
+ @returns {Object} returns
this so that calls can be chained.
+ */
mode: function (m) {
if (m == null) {
return facet[name].mode;
}
-
+
m = m.toLowerCase();
if (m === 'collector' || m === 'post') {
facet[name].mode = m;
}
-
+
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
scope: function (scope) {
return this;
},
-
- /**
- facetFilterthis so that calls can be chained.
- */
+ /**
+ facetFilterthis so that calls can be chained.
+ */
cacheFilter: function (trueFalse) {
if (trueFalse == null) {
return facet[name].cache_filter;
}
-
+
facet[name].cache_filter = trueFalse;
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
nested: function (path) {
if (path == null) {
return facet[name].nested;
}
-
+
facet[name].nested = path;
return this;
},
-
- /**
- facet property. This is typically used by
- internal API functions so use with caution.facet property.
- */
+ /**
+ facet property. This is typically used by
+ internal API functions so use with caution.facet property.
+ */
_self: function () {
return facet;
}
@@ -3296,25 +3406,25 @@
};
/**
- @class
- A container Filter that allows Boolean AND composition of Filters.
+ @class
+ A container Filter that allows Boolean AND composition of Filters.
- @name ejs.AndFilter
+ @name ejs.AndFilter
- @desc
- A container Filter that allows Boolean AND composition of Filters.
+ @desc
+ A container Filter that allows Boolean AND composition of Filters.
- @param {Filter || Array} f A single Filter object or an array of valid
- Filter objects.
- */
+ @param {Filter || Array} f A single Filter object or an array of valid
+ Filter objects.
+ */
ejs.AndFilter = function (f) {
/**
- The internal filter object. Use _self()
+ The internal filter object. Use _self()
- @member ejs.AndFilter
- @property {Object} filter
- */
+ @member ejs.AndFilter
+ @property {Object} filter
+ */
var i,
len,
filter = {
@@ -3330,7 +3440,7 @@
if (!isFilter(f[i])) {
throw new TypeError('Array must contain only Filter objects');
}
-
+
filter.and.filters.push(f[i]._self());
}
} else {
@@ -3340,22 +3450,22 @@
return {
/**
- Sets the filters for the filter. If fltr is a single
- Filter, it is added to the current filters. If fltr is an array
- of Filters, then they replace all existing filters.
+ Sets the filters for the filter. If fltr is a single
+ Filter, it is added to the current filters. If fltr is an array
+ of Filters, then they replace all existing filters.
- @member ejs.AndFilter
- @param {Filter || Array} fltr A valid filter object or an array of filters.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.AndFilter
+ @param {Filter || Array} fltr A valid filter object or an array of filters.
+ @returns {Object} returns this so that calls can be chained.
+ */
filters: function (fltr) {
var i,
len;
-
+
if (fltr == null) {
return filter.and.filters;
}
-
+
if (isFilter(fltr)) {
filter.and.filters.push(fltr._self());
} else if (isArray(fltr)) {
@@ -3364,23 +3474,23 @@
if (!isFilter(fltr[i])) {
throw new TypeError('Array must contain only Filter objects');
}
-
+
filter.and.filters.push(fltr[i]._self());
}
} else {
throw new TypeError('Argument must be a Filter or an Array of Filters');
}
-
+
return this;
},
/**
- Sets the filter name.
+ Sets the filter name.
- @member ejs.AndFilter
- @param {String} name A name for the filter.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.AndFilter
+ @param {String} name A name for the filter.
+ @returns {Object} returns this so that calls can be chained.
+ */
name: function (name) {
if (name == null) {
return filter.and._name;
@@ -3391,12 +3501,12 @@
},
/**
- Enable or disable caching of the filter
+ Enable or disable caching of the filter
- @member ejs.AndFilter
- @param {Boolean} trueFalse True to cache the filter, false otherwise.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.AndFilter
+ @param {Boolean} trueFalse True to cache the filter, false otherwise.
+ @returns {Object} returns this so that calls can be chained.
+ */
cache: function (trueFalse) {
if (trueFalse == null) {
return filter.and._cache;
@@ -3405,14 +3515,14 @@
filter.and._cache = trueFalse;
return this;
},
-
- /**
- Sets the cache key.
- @member ejs.AndFilter
- @param {String} key the cache key as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the cache key.
+
+ @member ejs.AndFilter
+ @param {String} key the cache key as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
cacheKey: function (key) {
if (key == null) {
return filter.and._cache_key;
@@ -3421,33 +3531,33 @@
filter.and._cache_key = key;
return this;
},
-
- /**
- Returns the filter container as a JSON string
- @member ejs.AndFilter
- @returns {String} JSON representation of the andFilter object
- */
+ /**
+ Returns the filter container as a JSON string
+
+ @member ejs.AndFilter
+ @returns {String} JSON representation of the andFilter object
+ */
toString: function () {
return JSON.stringify(filter);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.AndFilter
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.AndFilter
+ @returns {String} the type of object
+ */
_type: function () {
return 'filter';
},
-
- /**
- Returns the filter object.
- @member ejs.AndFilter
- @returns {Object} filter object
- */
+ /**
+ Returns the filter object.
+
+ @member ejs.AndFilter
+ @returns {Object} filter object
+ */
_self: function () {
return filter;
}
@@ -3455,26 +3565,26 @@
};
/**
- @class
- BoolFilter allows you to build Boolean filter constructs
- from individual filters. Similar in concept to Boolean query, except that
- the clauses are other filters. Can be placed within queries that accept a
- filter.
-
- @name ejs.BoolFilter
+ @class
+ BoolFilter allows you to build Boolean filter constructs
+ from individual filters. Similar in concept to Boolean query, except that
+ the clauses are other filters. Can be placed within queries that accept a
+ filter.
- @desc
- A Filter that matches documents matching boolean combinations of other
- filters.
+ @name ejs.BoolFilter
- */
+ @desc
+ A Filter that matches documents matching boolean combinations of other
+ filters.
+
+ */
ejs.BoolFilter = function () {
/**
- The internal filter object. Use _self()
- @member ejs.BoolFilter
- @property {Object} filter
- */
+ The internal filter object. Use _self()
+ @member ejs.BoolFilter
+ @property {Object} filter
+ */
var filter = {
bool: {}
};
@@ -3482,23 +3592,23 @@
return {
/**
- Adds filter to boolean container. Given filter "must" appear in
- matching documents. If passed a single Filter it is added to the
- list of existing filters. If passed an array of Filters, they
- replace all existing filters.
+ Adds filter to boolean container. Given filter "must" appear in
+ matching documents. If passed a single Filter it is added to the
+ list of existing filters. If passed an array of Filters, they
+ replace all existing filters.
- @member ejs.BoolFilter
- @param {Filter || Array} oFilter A valid Filter or array of
- Filter objects.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.BoolFilter
+ @param {Filter || Array} oFilter A valid Filter or array of
+ Filter objects.
+ @returns {Object} returns this so that calls can be chained.
+ */
must: function (oFilter) {
var i, len;
-
+
if (filter.bool.must == null) {
filter.bool.must = [];
}
-
+
if (oFilter == null) {
return filter.bool.must;
}
@@ -3511,30 +3621,30 @@
if (!isFilter(oFilter[i])) {
throw new TypeError('Argument must be an array of Filters');
}
-
+
filter.bool.must.push(oFilter[i]._self());
}
} else {
throw new TypeError('Argument must be a Filter or array of Filters');
}
-
+
return this;
},
/**
- Adds filter to boolean container. Given filter "must not" appear
- in matching documents. If passed a single Filter it is added to
- the list of existing filters. If passed an array of Filters,
- they replace all existing filters.
+ Adds filter to boolean container. Given filter "must not" appear
+ in matching documents. If passed a single Filter it is added to
+ the list of existing filters. If passed an array of Filters,
+ they replace all existing filters.
- @member ejs.BoolFilter
- @param {Filter || Array} oFilter A valid Filter or array of
- Filter objects.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.BoolFilter
+ @param {Filter || Array} oFilter A valid Filter or array of
+ Filter objects.
+ @returns {Object} returns this so that calls can be chained.
+ */
mustNot: function (oFilter) {
var i, len;
-
+
if (filter.bool.must_not == null) {
filter.bool.must_not = [];
}
@@ -3542,7 +3652,7 @@
if (oFilter == null) {
return filter.bool.must_not;
}
-
+
if (isFilter(oFilter)) {
filter.bool.must_not.push(oFilter._self());
} else if (isArray(oFilter)) {
@@ -3551,30 +3661,30 @@
if (!isFilter(oFilter[i])) {
throw new TypeError('Argument must be an array of Filters');
}
-
+
filter.bool.must_not.push(oFilter[i]._self());
}
} else {
throw new TypeError('Argument must be a Filter or array of Filters');
}
-
+
return this;
},
/**
- Adds filter to boolean container. Given filter "should" appear in
- matching documents. If passed a single Filter it is added to
- the list of existing filters. If passed an array of Filters,
- they replace all existing filters.
+ Adds filter to boolean container. Given filter "should" appear in
+ matching documents. If passed a single Filter it is added to
+ the list of existing filters. If passed an array of Filters,
+ they replace all existing filters.
- @member ejs.BoolFilter
- @param {Filter || Array} oFilter A valid Filter or array of
- Filter objects.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.BoolFilter
+ @param {Filter || Array} oFilter A valid Filter or array of
+ Filter objects.
+ @returns {Object} returns this so that calls can be chained.
+ */
should: function (oFilter) {
var i, len;
-
+
if (filter.bool.should == null) {
filter.bool.should = [];
}
@@ -3582,7 +3692,7 @@
if (oFilter == null) {
return filter.bool.should;
}
-
+
if (isFilter(oFilter)) {
filter.bool.should.push(oFilter._self());
} else if (isArray(oFilter)) {
@@ -3591,23 +3701,23 @@
if (!isFilter(oFilter[i])) {
throw new TypeError('Argument must be an array of Filters');
}
-
+
filter.bool.should.push(oFilter[i]._self());
}
} else {
throw new TypeError('Argument must be a Filter or array of Filters');
}
-
+
return this;
},
/**
- Sets the filter name.
+ Sets the filter name.
- @member ejs.BoolFilter
- @param {String} name A name for the filter.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.BoolFilter
+ @param {String} name A name for the filter.
+ @returns {Object} returns this so that calls can be chained.
+ */
name: function (name) {
if (name == null) {
return filter.bool._name;
@@ -3618,12 +3728,12 @@
},
/**
- Enable or disable caching of the filter
+ Enable or disable caching of the filter
- @member ejs.BoolFilter
- @param {Boolean} trueFalse True to cache the filter, false otherwise.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.BoolFilter
+ @param {Boolean} trueFalse True to cache the filter, false otherwise.
+ @returns {Object} returns this so that calls can be chained.
+ */
cache: function (trueFalse) {
if (trueFalse == null) {
return filter.bool._cache;
@@ -3632,14 +3742,14 @@
filter.bool._cache = trueFalse;
return this;
},
-
- /**
- Sets the cache key.
- @member ejs.BoolFilter
- @param {String} key the cache key as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the cache key.
+
+ @member ejs.BoolFilter
+ @param {String} key the cache key as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
cacheKey: function (key) {
if (key == null) {
return filter.bool._cache_key;
@@ -3648,34 +3758,34 @@
filter.bool._cache_key = key;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.BoolFilter
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.BoolFilter
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(filter);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.BoolFilter
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.BoolFilter
+ @returns {String} the type of object
+ */
_type: function () {
return 'filter';
},
-
- /**
- Retrieves the internal filter object. This is typically used by
- internal API functions so use with caution.
- @member ejs.BoolFilter
- @returns {String} returns this object's internal filter property.
- */
+ /**
+ Retrieves the internal filter object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.BoolFilter
+ @returns {String} returns this object's internal filter property.
+ */
_self: function () {
return filter;
}
@@ -3683,25 +3793,25 @@
};
/**
- @class
- get()
+ The internal filter object. Use get()
- @member ejs.ExistsFilter
- @property {Object} filter
- */
+ @member ejs.ExistsFilter
+ @property {Object} filter
+ */
var filter = {
exists: {
field: fieldName
@@ -3711,12 +3821,12 @@
return {
/**
- Sets the field to check for missing values.
+ Sets the field to check for missing values.
- @member ejs.ExistsFilter
- @param {String} name A name of the field.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.ExistsFilter
+ @param {String} name A name of the field.
+ @returns {Object} returns this so that calls can be chained.
+ */
field: function (name) {
if (name == null) {
return filter.exists.field;
@@ -3725,14 +3835,14 @@
filter.exists.field = name;
return this;
},
-
- /**
- Sets the filter name.
- @member ejs.ExistsFilter
- @param {String} name A name for the filter.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the filter name.
+
+ @member ejs.ExistsFilter
+ @param {String} name A name for the filter.
+ @returns {Object} returns this so that calls can be chained.
+ */
name: function (name) {
if (name == null) {
return filter.exists._name;
@@ -3741,33 +3851,33 @@
filter.exists._name = name;
return this;
},
-
- /**
- Returns the filter container as a JSON string
- @member ejs.ExistsFilter
- @returns {String} JSON representation of the existsFilter object
- */
+ /**
+ Returns the filter container as a JSON string
+
+ @member ejs.ExistsFilter
+ @returns {String} JSON representation of the existsFilter object
+ */
toString: function () {
return JSON.stringify(filter);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.ExistsFilter
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.ExistsFilter
+ @returns {String} the type of object
+ */
_type: function () {
return 'filter';
},
-
- /**
- Returns the filter object.
- @member ejs.ExistsFilter
- @returns {Object} filter object
- */
+ /**
+ Returns the filter object.
+
+ @member ejs.ExistsFilter
+ @returns {Object} filter object
+ */
_self: function () {
return filter;
}
@@ -3775,26 +3885,26 @@
};
/**
- @class
- _self()
+ The internal filter object. Use _self()
- @member ejs.GeoBboxFilter
- @property {Object} filter
- */
+ @member ejs.GeoBboxFilter
+ @property {Object} filter
+ */
var filter = {
geo_bounding_box: {}
};
@@ -3804,15 +3914,15 @@
return {
/**
- Sets the fields to filter against.
+ Sets the fields to filter against.
- @member ejs.GeoBboxFilter
- @param {String} f A valid field name.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoBboxFilter
+ @param {String} f A valid field name.
+ @returns {Object} returns this so that calls can be chained.
+ */
field: function (f) {
var oldValue = filter.geo_bounding_box[fieldName];
-
+
if (f == null) {
return fieldName;
}
@@ -3820,60 +3930,60 @@
delete filter.geo_bounding_box[fieldName];
fieldName = f;
filter.geo_bounding_box[f] = oldValue;
-
+
return this;
},
-
- /**
- Sets the top-left coordinate of the bounding box
- @member ejs.GeoBboxFilter
- @param {GeoPoint} p A valid GeoPoint object
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the top-left coordinate of the bounding box
+
+ @member ejs.GeoBboxFilter
+ @param {GeoPoint} p A valid GeoPoint object
+ @returns {Object} returns this so that calls can be chained.
+ */
topLeft: function (p) {
if (p == null) {
return filter.geo_bounding_box[fieldName].top_left;
}
-
+
if (isGeoPoint(p)) {
filter.geo_bounding_box[fieldName].top_left = p._self();
} else {
throw new TypeError('Argument must be a GeoPoint');
}
-
+
return this;
},
/**
- Sets the bottom-right coordinate of the bounding box
+ Sets the bottom-right coordinate of the bounding box
- @member ejs.GeoBboxFilter
- @param {GeoPoint} p A valid GeoPoint object
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoBboxFilter
+ @param {GeoPoint} p A valid GeoPoint object
+ @returns {Object} returns this so that calls can be chained.
+ */
bottomRight: function (p) {
if (p == null) {
return filter.geo_bounding_box[fieldName].bottom_right;
}
-
+
if (isGeoPoint(p)) {
filter.geo_bounding_box[fieldName].bottom_right = p._self();
} else {
throw new TypeError('Argument must be a GeoPoint');
}
-
+
return this;
},
/**
- Sets the type of the bounding box execution. Valid values are
- "memory" and "indexed". Default is memory.
+ Sets the type of the bounding box execution. Valid values are
+ "memory" and "indexed". Default is memory.
- @member ejs.GeoBboxFilter
- @param {String} type The execution type as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoBboxFilter
+ @param {String} type The execution type as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
type: function (type) {
if (type == null) {
return filter.geo_bounding_box.type;
@@ -3883,22 +3993,22 @@
if (type === 'memory' || type === 'indexed') {
filter.geo_bounding_box.type = type;
}
-
+
return this;
},
-
- /**
- If the lat/long points should be normalized to lie within their
- respective normalized ranges.
-
- Normalized ranges are:
- lon = -180 (exclusive) to 180 (inclusive) range
- lat = -90 to 90 (both inclusive) range
- @member ejs.GeoBboxFilter
- @param {String} trueFalse True if the coordinates should be normalized. False otherwise.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ If the lat/long points should be normalized to lie within their
+ respective normalized ranges.
+
+ Normalized ranges are:
+ lon = -180 (exclusive) to 180 (inclusive) range
+ lat = -90 to 90 (both inclusive) range
+
+ @member ejs.GeoBboxFilter
+ @param {String} trueFalse True if the coordinates should be normalized. False otherwise.
+ @returns {Object} returns this so that calls can be chained.
+ */
normalize: function (trueFalse) {
if (trueFalse == null) {
return filter.geo_bounding_box.normalize;
@@ -3907,14 +4017,14 @@
filter.geo_bounding_box.normalize = trueFalse;
return this;
},
-
- /**
- Sets the filter name.
- @member ejs.GeoBboxFilter
- @param {String} name A name for the filter.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the filter name.
+
+ @member ejs.GeoBboxFilter
+ @param {String} name A name for the filter.
+ @returns {Object} returns this so that calls can be chained.
+ */
name: function (name) {
if (name == null) {
return filter.geo_bounding_box._name;
@@ -3925,12 +4035,12 @@
},
/**
- Enable or disable caching of the filter
+ Enable or disable caching of the filter
- @member ejs.GeoBboxFilter
- @param {Boolean} trueFalse True to cache the filter, false otherwise.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoBboxFilter
+ @param {Boolean} trueFalse True to cache the filter, false otherwise.
+ @returns {Object} returns this so that calls can be chained.
+ */
cache: function (trueFalse) {
if (trueFalse == null) {
return filter.geo_bounding_box._cache;
@@ -3939,14 +4049,14 @@
filter.geo_bounding_box._cache = trueFalse;
return this;
},
-
- /**
- Sets the cache key.
- @member ejs.GeoBboxFilter
- @param {String} key the cache key as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the cache key.
+
+ @member ejs.GeoBboxFilter
+ @param {String} key the cache key as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
cacheKey: function (key) {
if (key == null) {
return filter.geo_bounding_box._cache_key;
@@ -3955,33 +4065,33 @@
filter.geo_bounding_box._cache_key = key;
return this;
},
-
- /**
- Returns the filter container as a JSON string
- @member ejs.GeoBboxFilter
- @returns {String} JSON representation of the notFilter object
- */
+ /**
+ Returns the filter container as a JSON string
+
+ @member ejs.GeoBboxFilter
+ @returns {String} JSON representation of the notFilter object
+ */
toString: function () {
return JSON.stringify(filter);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.GeoBboxFilter
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.GeoBboxFilter
+ @returns {String} the type of object
+ */
_type: function () {
return 'filter';
},
-
- /**
- Returns the filter object.
- @member ejs.GeoBboxFilter
- @returns {Object} filter object
- */
+ /**
+ Returns the filter object.
+
+ @member ejs.GeoBboxFilter
+ @returns {Object} filter object
+ */
_self: function () {
return filter;
}
@@ -3989,45 +4099,45 @@
};
/**
- @class
- _self()
+ The internal filter object. Use _self()
- @member ejs.GeoDistanceFilter
- @property {Object} filter
- */
+ @member ejs.GeoDistanceFilter
+ @property {Object} filter
+ */
var filter = {
geo_distance: {
}
};
filter.geo_distance[fieldName] = [0, 0];
-
+
return {
/**
- Sets the fields to filter against.
+ Sets the fields to filter against.
- @member ejs.GeoDistanceFilter
- @param {String} f A valid field name.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoDistanceFilter
+ @param {String} f A valid field name.
+ @returns {Object} returns this so that calls can be chained.
+ */
field: function (f) {
var oldValue = filter.geo_distance[fieldName];
-
+
if (f == null) {
return fieldName;
}
@@ -4035,83 +4145,83 @@
delete filter.geo_distance[fieldName];
fieldName = f;
filter.geo_distance[f] = oldValue;
-
+
return this;
},
-
- /**
- Sets the numeric distance to be used. The distance can be a
- numeric value, and then the unit (either mi or km can be set)
- controlling the unit. Or a single string with the unit as well.
- @member ejs.GeoDistanceFilter
- @param {Number} numericDistance the numeric distance
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the numeric distance to be used. The distance can be a
+ numeric value, and then the unit (either mi or km can be set)
+ controlling the unit. Or a single string with the unit as well.
+
+ @member ejs.GeoDistanceFilter
+ @param {Number} numericDistance the numeric distance
+ @returns {Object} returns this so that calls can be chained.
+ */
distance: function (numericDistance) {
if (numericDistance == null) {
return filter.geo_distance.distance;
}
-
+
if (!isNumber(numericDistance)) {
throw new TypeError('Argument must be a numeric value');
}
-
+
filter.geo_distance.distance = numericDistance;
return this;
},
/**
- Sets the distance unit. Valid values are "mi" for miles or "km"
- for kilometers. Defaults to "km".
+ Sets the distance unit. Valid values are "mi" for miles or "km"
+ for kilometers. Defaults to "km".
- @member ejs.GeoDistanceFilter
- @param {Number} unit the unit of distance measure.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoDistanceFilter
+ @param {Number} unit the unit of distance measure.
+ @returns {Object} returns this so that calls can be chained.
+ */
unit: function (unit) {
if (unit == null) {
return filter.geo_distance.unit;
}
-
+
unit = unit.toLowerCase();
if (unit === 'mi' || unit === 'km') {
filter.geo_distance.unit = unit;
}
-
+
return this;
},
/**
- Sets the point of origin in which distance will be measured from
+ Sets the point of origin in which distance will be measured from
- @member ejs.GeoDistanceFilter
- @param {GeoPoint} p A valid GeoPoint object.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoDistanceFilter
+ @param {GeoPoint} p A valid GeoPoint object.
+ @returns {Object} returns this so that calls can be chained.
+ */
point: function (p) {
if (p == null) {
return filter.geo_distance[fieldName];
}
-
+
if (isGeoPoint(p)) {
filter.geo_distance[fieldName] = p._self();
} else {
throw new TypeError('Argument must be a GeoPoint');
}
-
+
return this;
},
/**
- How to compute the distance. Can either be arc (better precision)
- or plane (faster). Defaults to arc.
+ How to compute the distance. Can either be arc (better precision)
+ or plane (faster). Defaults to arc.
- @member ejs.GeoDistanceFilter
- @param {String} type The execution type as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoDistanceFilter
+ @param {String} type The execution type as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
distanceType: function (type) {
if (type == null) {
return filter.geo_distance.distance_type;
@@ -4121,22 +4231,22 @@
if (type === 'arc' || type === 'plane') {
filter.geo_distance.distance_type = type;
}
-
+
return this;
},
-
- /**
- If the lat/long points should be normalized to lie within their
- respective normalized ranges.
-
- Normalized ranges are:
- lon = -180 (exclusive) to 180 (inclusive) range
- lat = -90 to 90 (both inclusive) range
- @member ejs.GeoDistanceFilter
- @param {String} trueFalse True if the coordinates should be normalized. False otherwise.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ If the lat/long points should be normalized to lie within their
+ respective normalized ranges.
+
+ Normalized ranges are:
+ lon = -180 (exclusive) to 180 (inclusive) range
+ lat = -90 to 90 (both inclusive) range
+
+ @member ejs.GeoDistanceFilter
+ @param {String} trueFalse True if the coordinates should be normalized. False otherwise.
+ @returns {Object} returns this so that calls can be chained.
+ */
normalize: function (trueFalse) {
if (trueFalse == null) {
return filter.geo_distance.normalize;
@@ -4145,17 +4255,17 @@
filter.geo_distance.normalize = trueFalse;
return this;
},
-
- /**
- Will an optimization of using first a bounding box check will be
- used. Defaults to memory which will do in memory checks. Can also
- have values of indexed to use indexed value check, or none which
- disables bounding box optimization.
- @member ejs.GeoDistanceFilter
- @param {String} t optimization type of memory, indexed, or none.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Will an optimization of using first a bounding box check will be
+ used. Defaults to memory which will do in memory checks. Can also
+ have values of indexed to use indexed value check, or none which
+ disables bounding box optimization.
+
+ @member ejs.GeoDistanceFilter
+ @param {String} t optimization type of memory, indexed, or none.
+ @returns {Object} returns this so that calls can be chained.
+ */
optimizeBbox: function (t) {
if (t == null) {
return filter.geo_distance.optimize_bbox;
@@ -4165,17 +4275,17 @@
if (t === 'memory' || t === 'indexed' || t === 'none') {
filter.geo_distance.optimize_bbox = t;
}
-
+
return this;
},
-
- /**
- Sets the filter name.
- @member ejs.GeoDistanceFilter
- @param {String} name A name for the filter.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the filter name.
+
+ @member ejs.GeoDistanceFilter
+ @param {String} name A name for the filter.
+ @returns {Object} returns this so that calls can be chained.
+ */
name: function (name) {
if (name == null) {
return filter.geo_distance._name;
@@ -4186,12 +4296,12 @@
},
/**
- Enable or disable caching of the filter
+ Enable or disable caching of the filter
- @member ejs.GeoDistanceFilter
- @param {Boolean} trueFalse True to cache the filter, false otherwise.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoDistanceFilter
+ @param {Boolean} trueFalse True to cache the filter, false otherwise.
+ @returns {Object} returns this so that calls can be chained.
+ */
cache: function (trueFalse) {
if (trueFalse == null) {
return filter.geo_distance._cache;
@@ -4200,14 +4310,14 @@
filter.geo_distance._cache = trueFalse;
return this;
},
-
- /**
- Sets the cache key.
- @member ejs.GeoDistanceFilter
- @param {String} key the cache key as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the cache key.
+
+ @member ejs.GeoDistanceFilter
+ @param {String} key the cache key as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
cacheKey: function (key) {
if (key == null) {
return filter.geo_distance._cache_key;
@@ -4216,33 +4326,33 @@
filter.geo_distance._cache_key = key;
return this;
},
-
- /**
- Returns the filter container as a JSON string
- @member ejs.GeoDistanceFilter
- @returns {String} JSON representation of the notFilter object
- */
+ /**
+ Returns the filter container as a JSON string
+
+ @member ejs.GeoDistanceFilter
+ @returns {String} JSON representation of the notFilter object
+ */
toString: function () {
return JSON.stringify(filter);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.GeoDistanceFilter
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.GeoDistanceFilter
+ @returns {String} the type of object
+ */
_type: function () {
return 'filter';
},
-
- /**
- Returns the filter object.
- @member ejs.GeoDistanceFilter
- @returns {Object} filter object
- */
+ /**
+ Returns the filter object.
+
+ @member ejs.GeoDistanceFilter
+ @returns {Object} filter object
+ */
_self: function () {
return filter;
}
@@ -4250,41 +4360,41 @@
};
/**
- @class
- _self()
+ The internal filter object. Use _self()
- @member ejs.GeoDistanceRangeFilter
- @property {Object} filter
- */
+ @member ejs.GeoDistanceRangeFilter
+ @property {Object} filter
+ */
var filter = {
geo_distance_range: {}
};
filter.geo_distance_range[fieldName] = [0, 0];
-
+
return {
- /**
- Sets the fields to filter against.
+ /**
+ Sets the fields to filter against.
- @member ejs.GeoDistanceRangeFilter
- @param {String} f A valid field name.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoDistanceRangeFilter
+ @param {String} f A valid field name.
+ @returns {Object} returns this so that calls can be chained.
+ */
field: function (f) {
var oldValue = filter.geo_distance_range[fieldName];
@@ -4298,34 +4408,34 @@
return this;
},
-
- /**
- * Sets the start point of the distance range
- @member ejs.GeoDistanceRangeFilter
- @param {Number} numericDistance the numeric distance
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ * Sets the start point of the distance range
+
+ @member ejs.GeoDistanceRangeFilter
+ @param {Number} numericDistance the numeric distance
+ @returns {Object} returns this so that calls can be chained.
+ */
from: function (numericDistance) {
if (numericDistance == null) {
return filter.geo_distance_range.from;
}
-
+
if (!isNumber(numericDistance)) {
throw new TypeError('Argument must be a numeric value');
}
-
+
filter.geo_distance_range.from = numericDistance;
return this;
},
/**
- * Sets the end point of the distance range
+ * Sets the end point of the distance range
- @member ejs.GeoDistanceRangeFilter
- @param {Number} numericDistance the numeric distance
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoDistanceRangeFilter
+ @param {Number} numericDistance the numeric distance
+ @returns {Object} returns this so that calls can be chained.
+ */
to: function (numericDistance) {
if (numericDistance == null) {
return filter.geo_distance_range.to;
@@ -4334,19 +4444,19 @@
if (!isNumber(numericDistance)) {
throw new TypeError('Argument must be a numeric value');
}
-
+
filter.geo_distance_range.to = numericDistance;
return this;
},
/**
- Should the first from (if set) be inclusive or not.
- Defaults to true
+ Should the first from (if set) be inclusive or not.
+ Defaults to true
- @member ejs.GeoDistanceRangeFilter
- @param {Boolean} trueFalse true to include, false to exclude
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoDistanceRangeFilter
+ @param {Boolean} trueFalse true to include, false to exclude
+ @returns {Object} returns this so that calls can be chained.
+ */
includeLower: function (trueFalse) {
if (trueFalse == null) {
return filter.geo_distance_range.include_lower;
@@ -4357,12 +4467,12 @@
},
/**
- Should the last to (if set) be inclusive or not. Defaults to true.
+ Should the last to (if set) be inclusive or not. Defaults to true.
- @member ejs.GeoDistanceRangeFilter
- @param {Boolean} trueFalse true to include, false to exclude
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoDistanceRangeFilter
+ @param {Boolean} trueFalse true to include, false to exclude
+ @returns {Object} returns this so that calls can be chained.
+ */
includeUpper: function (trueFalse) {
if (trueFalse == null) {
return filter.geo_distance_range.include_upper;
@@ -4373,13 +4483,13 @@
},
/**
- Greater than value. Same as setting from to the value, and
- include_lower to false,
+ Greater than value. Same as setting from to the value, and
+ include_lower to false,
- @member ejs.GeoDistanceRangeFilter
- @param {Number} val the numeric distance
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoDistanceRangeFilter
+ @param {Number} val the numeric distance
+ @returns {Object} returns this so that calls can be chained.
+ */
gt: function (val) {
if (val == null) {
return filter.geo_distance_range.gt;
@@ -4388,19 +4498,19 @@
if (!isNumber(val)) {
throw new TypeError('Argument must be a numeric value');
}
-
+
filter.geo_distance_range.gt = val;
return this;
},
/**
- Greater than or equal to value. Same as setting from to the value,
- and include_lower to true.
+ Greater than or equal to value. Same as setting from to the value,
+ and include_lower to true.
- @member ejs.GeoDistanceRangeFilter
- @param {Number} val the numeric distance
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoDistanceRangeFilter
+ @param {Number} val the numeric distance
+ @returns {Object} returns this so that calls can be chained.
+ */
gte: function (val) {
if (val == null) {
return filter.geo_distance_range.gte;
@@ -4409,19 +4519,19 @@
if (!isNumber(val)) {
throw new TypeError('Argument must be a numeric value');
}
-
+
filter.geo_distance_range.gte = val;
return this;
},
/**
- Less than value. Same as setting to to the value, and include_upper
- to false.
+ Less than value. Same as setting to to the value, and include_upper
+ to false.
- @member ejs.GeoDistanceRangeFilter
- @param {Number} val the numeric distance
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoDistanceRangeFilter
+ @param {Number} val the numeric distance
+ @returns {Object} returns this so that calls can be chained.
+ */
lt: function (val) {
if (val == null) {
return filter.geo_distance_range.lt;
@@ -4430,19 +4540,19 @@
if (!isNumber(val)) {
throw new TypeError('Argument must be a numeric value');
}
-
+
filter.geo_distance_range.lt = val;
return this;
},
/**
- Less than or equal to value. Same as setting to to the value,
- and include_upper to true.
+ Less than or equal to value. Same as setting to to the value,
+ and include_upper to true.
- @member ejs.GeoDistanceRangeFilter
- @param {Number} val the numeric distance
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoDistanceRangeFilter
+ @param {Number} val the numeric distance
+ @returns {Object} returns this so that calls can be chained.
+ */
lte: function (val) {
if (val == null) {
return filter.geo_distance_range.lte;
@@ -4451,62 +4561,62 @@
if (!isNumber(val)) {
throw new TypeError('Argument must be a numeric value');
}
-
+
filter.geo_distance_range.lte = val;
return this;
},
-
- /**
- Sets the distance unit. Valid values are "mi" for miles or "km"
- for kilometers. Defaults to "km".
- @member ejs.GeoDistanceRangeFilter
- @param {Number} unit the unit of distance measure.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the distance unit. Valid values are "mi" for miles or "km"
+ for kilometers. Defaults to "km".
+
+ @member ejs.GeoDistanceRangeFilter
+ @param {Number} unit the unit of distance measure.
+ @returns {Object} returns this so that calls can be chained.
+ */
unit: function (unit) {
if (unit == null) {
return filter.geo_distance_range.unit;
}
-
+
unit = unit.toLowerCase();
if (unit === 'mi' || unit === 'km') {
filter.geo_distance_range.unit = unit;
}
-
+
return this;
},
/**
- Sets the point of origin in which distance will be measured from
+ Sets the point of origin in which distance will be measured from
- @member ejs.GeoDistanceRangeFilter
- @param {GeoPoint} p A valid GeoPoint object.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoDistanceRangeFilter
+ @param {GeoPoint} p A valid GeoPoint object.
+ @returns {Object} returns this so that calls can be chained.
+ */
point: function (p) {
if (p == null) {
return filter.geo_distance_range[fieldName];
}
-
+
if (isGeoPoint(p)) {
filter.geo_distance_range[fieldName] = p._self();
} else {
throw new TypeError('Argument must be a GeoPoint');
}
-
+
return this;
},
/**
- How to compute the distance. Can either be arc (better precision)
- or plane (faster). Defaults to arc.
+ How to compute the distance. Can either be arc (better precision)
+ or plane (faster). Defaults to arc.
- @member ejs.GeoDistanceRangeFilter
- @param {String} type The execution type as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoDistanceRangeFilter
+ @param {String} type The execution type as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
distanceType: function (type) {
if (type == null) {
return filter.geo_distance_range.distance_type;
@@ -4516,22 +4626,22 @@
if (type === 'arc' || type === 'plane') {
filter.geo_distance_range.distance_type = type;
}
-
+
return this;
},
-
- /**
- If the lat/long points should be normalized to lie within their
- respective normalized ranges.
-
- Normalized ranges are:
- lon = -180 (exclusive) to 180 (inclusive) range
- lat = -90 to 90 (both inclusive) range
- @member ejs.GeoDistanceRangeFilter
- @param {String} trueFalse True if the coordinates should be normalized. False otherwise.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ If the lat/long points should be normalized to lie within their
+ respective normalized ranges.
+
+ Normalized ranges are:
+ lon = -180 (exclusive) to 180 (inclusive) range
+ lat = -90 to 90 (both inclusive) range
+
+ @member ejs.GeoDistanceRangeFilter
+ @param {String} trueFalse True if the coordinates should be normalized. False otherwise.
+ @returns {Object} returns this so that calls can be chained.
+ */
normalize: function (trueFalse) {
if (trueFalse == null) {
return filter.geo_distance_range.normalize;
@@ -4540,17 +4650,17 @@
filter.geo_distance_range.normalize = trueFalse;
return this;
},
-
- /**
- Will an optimization of using first a bounding box check will be
- used. Defaults to memory which will do in memory checks. Can also
- have values of indexed to use indexed value check, or none which
- disables bounding box optimization.
- @member ejs.GeoDistanceRangeFilter
- @param {String} t optimization type of memory, indexed, or none.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Will an optimization of using first a bounding box check will be
+ used. Defaults to memory which will do in memory checks. Can also
+ have values of indexed to use indexed value check, or none which
+ disables bounding box optimization.
+
+ @member ejs.GeoDistanceRangeFilter
+ @param {String} t optimization type of memory, indexed, or none.
+ @returns {Object} returns this so that calls can be chained.
+ */
optimizeBbox: function (t) {
if (t == null) {
return filter.geo_distance_range.optimize_bbox;
@@ -4560,17 +4670,17 @@
if (t === 'memory' || t === 'indexed' || t === 'none') {
filter.geo_distance_range.optimize_bbox = t;
}
-
+
return this;
},
-
- /**
- Sets the filter name.
- @member ejs.GeoDistanceRangeFilter
- @param {String} name A name for the filter.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the filter name.
+
+ @member ejs.GeoDistanceRangeFilter
+ @param {String} name A name for the filter.
+ @returns {Object} returns this so that calls can be chained.
+ */
name: function (name) {
if (name == null) {
return filter.geo_distance_range._name;
@@ -4581,12 +4691,12 @@
},
/**
- Enable or disable caching of the filter
+ Enable or disable caching of the filter
- @member ejs.GeoDistanceRangeFilter
- @param {Boolean} trueFalse True to cache the filter, false otherwise.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoDistanceRangeFilter
+ @param {Boolean} trueFalse True to cache the filter, false otherwise.
+ @returns {Object} returns this so that calls can be chained.
+ */
cache: function (trueFalse) {
if (trueFalse == null) {
return filter.geo_distance_range._cache;
@@ -4595,14 +4705,14 @@
filter.geo_distance_range._cache = trueFalse;
return this;
},
-
- /**
- Sets the cache key.
- @member ejs.GeoDistanceRangeFilter
- @param {String} key the cache key as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the cache key.
+
+ @member ejs.GeoDistanceRangeFilter
+ @param {String} key the cache key as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
cacheKey: function (key) {
if (key == null) {
return filter.geo_distance_range._cache_key;
@@ -4612,31 +4722,31 @@
return this;
},
/**
- Returns the filter container as a JSON string
+ Returns the filter container as a JSON string
- @member ejs.GeoDistanceRangeFilter
- @returns {String} JSON representation of the notFilter object
- */
+ @member ejs.GeoDistanceRangeFilter
+ @returns {String} JSON representation of the notFilter object
+ */
toString: function () {
return JSON.stringify(filter);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.GeoDistanceRangeFilter
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.GeoDistanceRangeFilter
+ @returns {String} the type of object
+ */
_type: function () {
return 'filter';
},
-
- /**
- Returns the filter object.
- @member ejs.GeoDistanceRangeFilter
- @returns {Object} filter object
- */
+ /**
+ Returns the filter object.
+
+ @member ejs.GeoDistanceRangeFilter
+ @returns {Object} filter object
+ */
_self: function () {
return filter;
}
@@ -4644,25 +4754,25 @@
};
/**
- @class
- _self()
+ The internal filter object. Use _self()
- @member ejs.GeoPolygonFilter
- @property {Object} filter
- */
+ @member ejs.GeoPolygonFilter
+ @property {Object} filter
+ */
var filter = {
geo_polygon: {}
};
@@ -4674,12 +4784,12 @@
return {
/**
- Sets the fields to filter against.
+ Sets the fields to filter against.
- @member ejs.GeoPolygonFilter
- @param {String} f A valid field name.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoPolygonFilter
+ @param {String} f A valid field name.
+ @returns {Object} returns this so that calls can be chained.
+ */
field: function (f) {
var oldValue = filter.geo_polygon[fieldName];
@@ -4693,24 +4803,24 @@
return this;
},
-
- /**
- Sets a series of points that represent a polygon. If passed a
- single GeoPoint object, it is added to the current
- list of points. If passed an array of GeoPoint
- objects it replaces all current values.
- @member ejs.GeoPolygonFilter
- @param {Array} pointsArray the array of points that represent the polygon
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets a series of points that represent a polygon. If passed a
+ single GeoPoint object, it is added to the current
+ list of points. If passed an array of GeoPoint
+ objects it replaces all current values.
+
+ @member ejs.GeoPolygonFilter
+ @param {Array} pointsArray the array of points that represent the polygon
+ @returns {Object} returns this so that calls can be chained.
+ */
points: function (p) {
var i, len;
-
+
if (p == null) {
return filter.geo_polygon[fieldName].points;
}
-
+
if (isGeoPoint(p)) {
filter.geo_polygon[fieldName].points.push(p._self());
} else if (isArray(p)) {
@@ -4719,28 +4829,28 @@
if (!isGeoPoint(p[i])) {
throw new TypeError('Argument must be Array of GeoPoints');
}
-
+
filter.geo_polygon[fieldName].points.push(p[i]._self());
}
} else {
throw new TypeError('Argument must be a GeoPoint or Array of GeoPoints');
}
-
+
return this;
},
/**
- If the lat/long points should be normalized to lie within their
- respective normalized ranges.
-
- Normalized ranges are:
- lon = -180 (exclusive) to 180 (inclusive) range
- lat = -90 to 90 (both inclusive) range
+ If the lat/long points should be normalized to lie within their
+ respective normalized ranges.
- @member ejs.GeoPolygonFilter
- @param {String} trueFalse True if the coordinates should be normalized. False otherwise.
- @returns {Object} returns this so that calls can be chained.
- */
+ Normalized ranges are:
+ lon = -180 (exclusive) to 180 (inclusive) range
+ lat = -90 to 90 (both inclusive) range
+
+ @member ejs.GeoPolygonFilter
+ @param {String} trueFalse True if the coordinates should be normalized. False otherwise.
+ @returns {Object} returns this so that calls can be chained.
+ */
normalize: function (trueFalse) {
if (trueFalse == null) {
return filter.geo_polygon.normalize;
@@ -4749,14 +4859,14 @@
filter.geo_polygon.normalize = trueFalse;
return this;
},
-
- /**
- Sets the filter name.
- @member ejs.GeoPolygonFilter
- @param {String} name A name for the filter.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the filter name.
+
+ @member ejs.GeoPolygonFilter
+ @param {String} name A name for the filter.
+ @returns {Object} returns this so that calls can be chained.
+ */
name: function (name) {
if (name == null) {
return filter.geo_polygon._name;
@@ -4767,12 +4877,12 @@
},
/**
- Enable or disable caching of the filter
+ Enable or disable caching of the filter
- @member ejs.GeoPolygonFilter
- @param {Boolean} trueFalse True to cache the filter, false otherwise.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoPolygonFilter
+ @param {Boolean} trueFalse True to cache the filter, false otherwise.
+ @returns {Object} returns this so that calls can be chained.
+ */
cache: function (trueFalse) {
if (trueFalse == null) {
return filter.geo_polygon._cache;
@@ -4781,14 +4891,14 @@
filter.geo_polygon._cache = trueFalse;
return this;
},
-
- /**
- Sets the cache key.
- @member ejs.GeoPolygonFilter
- @param {String} key the cache key as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the cache key.
+
+ @member ejs.GeoPolygonFilter
+ @param {String} key the cache key as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
cacheKey: function (key) {
if (key == null) {
return filter.geo_polygon._cache_key;
@@ -4797,33 +4907,33 @@
filter.geo_polygon._cache_key = key;
return this;
},
-
- /**
- Returns the filter container as a JSON string
- @member ejs.GeoPolygonFilter
- @returns {String} JSON representation of the notFilter object
- */
+ /**
+ Returns the filter container as a JSON string
+
+ @member ejs.GeoPolygonFilter
+ @returns {String} JSON representation of the notFilter object
+ */
toString: function () {
return JSON.stringify(filter);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.GeoPolygonFilter
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.GeoPolygonFilter
+ @returns {String} the type of object
+ */
_type: function () {
return 'filter';
},
-
- /**
- Returns the filter object.
- @member ejs.GeoPolygonFilter
- @returns {Object} filter object
- */
+ /**
+ Returns the filter object.
+
+ @member ejs.GeoPolygonFilter
+ @returns {Object} filter object
+ */
_self: function () {
return filter;
}
@@ -4831,29 +4941,29 @@
};
/**
- @class
- Use _self()
- @member ejs.GeoShapeFilter
- @property {Object} GeoShapeFilter
- */
+ The internal filter object. Use _self()
+ @member ejs.GeoShapeFilter
+ @property {Object} GeoShapeFilter
+ */
var filter = {
geo_shape: {}
};
@@ -4863,15 +4973,15 @@
return {
/**
- Sets the field to filter against.
+ Sets the field to filter against.
- @member ejs.GeoShapeFilter
- @param {String} f A valid field name.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoShapeFilter
+ @param {String} f A valid field name.
+ @returns {Object} returns this so that calls can be chained.
+ */
field: function (f) {
var oldValue = filter.geo_shape[field];
-
+
if (f == null) {
return field;
}
@@ -4879,17 +4989,17 @@
delete filter.geo_shape[field];
field = f;
filter.geo_shape[f] = oldValue;
-
+
return this;
},
/**
- Sets the shape
+ Sets the shape
- @member ejs.GeoShapeFilter
- @param {String} shape A valid Shape object.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoShapeFilter
+ @param {String} shape A valid Shape object.
+ @returns {Object} returns this so that calls can be chained.
+ */
shape: function (shape) {
if (shape == null) {
return filter.geo_shape[field].shape;
@@ -4898,19 +5008,19 @@
if (filter.geo_shape[field].indexed_shape != null) {
delete filter.geo_shape[field].indexed_shape;
}
-
+
filter.geo_shape[field].shape = shape._self();
return this;
},
/**
- Sets the indexed shape. Use this if you already have shape definitions
- already indexed.
+ Sets the indexed shape. Use this if you already have shape definitions
+ already indexed.
- @member ejs.GeoShapeFilter
- @param {String} indexedShape A valid IndexedShape object.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoShapeFilter
+ @param {String} indexedShape A valid IndexedShape object.
+ @returns {Object} returns this so that calls can be chained.
+ */
indexedShape: function (indexedShape) {
if (indexedShape == null) {
return filter.geo_shape[field].indexed_shape;
@@ -4919,21 +5029,21 @@
if (filter.geo_shape[field].shape != null) {
delete filter.geo_shape[field].shape;
}
-
+
filter.geo_shape[field].indexed_shape = indexedShape._self();
return this;
},
/**
- Sets the shape relation type. A relationship between a Query Shape
- and indexed Shapes that will be used to determine if a Document
- should be matched or not. Valid values are: intersects, disjoint,
- and within.
+ Sets the shape relation type. A relationship between a Query Shape
+ and indexed Shapes that will be used to determine if a Document
+ should be matched or not. Valid values are: intersects, disjoint,
+ and within.
- @member ejs.GeoShapeFilter
- @param {String} indexedShape A valid IndexedShape object.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoShapeFilter
+ @param {String} indexedShape A valid IndexedShape object.
+ @returns {Object} returns this so that calls can be chained.
+ */
relation: function (relation) {
if (relation == null) {
return filter.geo_shape[field].relation;
@@ -4943,30 +5053,30 @@
if (relation === 'intersects' || relation === 'disjoint' || relation === 'within') {
filter.geo_shape[field].relation = relation;
}
-
+
return this;
},
/**
-
-
+ recursive - default, recursively traverse nodes in
- the spatial prefix tree. This strategy has support for
- searching non-point shapes.term - uses a large TermsFilter on each node
- in the spatial prefix tree. It only supports the search of
- indexed Point shapes.this so that calls can be chained.
- */
+
+
+
+ recursive - default, recursively traverse nodes in
+ the spatial prefix tree. This strategy has support for
+ searching non-point shapes.term - uses a large TermsFilter on each node
+ in the spatial prefix tree. It only supports the search of
+ indexed Point shapes.this so that calls can be chained.
+ */
strategy: function (strategy) {
if (strategy == null) {
return filter.geo_shape[field].strategy;
@@ -4976,17 +5086,17 @@
if (strategy === 'recursive' || strategy === 'term') {
filter.geo_shape[field].strategy = strategy;
}
-
+
return this;
},
-
- /**
- Sets the filter name.
- @member ejs.GeoShapeFilter
- @param {String} name A name for the filter.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the filter name.
+
+ @member ejs.GeoShapeFilter
+ @param {String} name A name for the filter.
+ @returns {Object} returns this so that calls can be chained.
+ */
name: function (name) {
if (name == null) {
return filter.geo_shape._name;
@@ -4997,12 +5107,12 @@
},
/**
- Enable or disable caching of the filter
+ Enable or disable caching of the filter
- @member ejs.GeoShapeFilter
- @param {Boolean} trueFalse True to cache the filter, false otherwise.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoShapeFilter
+ @param {Boolean} trueFalse True to cache the filter, false otherwise.
+ @returns {Object} returns this so that calls can be chained.
+ */
cache: function (trueFalse) {
if (trueFalse == null) {
return filter.geo_shape._cache;
@@ -5011,14 +5121,14 @@
filter.geo_shape._cache = trueFalse;
return this;
},
-
- /**
- Sets the cache key.
- @member ejs.GeoShapeFilter
- @param {String} key the cache key as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the cache key.
+
+ @member ejs.GeoShapeFilter
+ @param {String} key the cache key as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
cacheKey: function (key) {
if (key == null) {
return filter.geo_shape._cache_key;
@@ -5027,34 +5137,34 @@
filter.geo_shape._cache_key = key;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.GeoShapeFilter
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.GeoShapeFilter
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(filter);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.GeoShapeFilter
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.GeoShapeFilter
+ @returns {String} the type of object
+ */
_type: function () {
return 'filter';
},
-
- /**
- Retrieves the internal filter object. This is typically used by
- internal API functions so use with caution.
- @member ejs.GeoShapeFilter
- @returns {String} returns this object's internal filter property.
- */
+ /**
+ Retrieves the internal filter object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.GeoShapeFilter
+ @returns {String} returns this object's internal filter property.
+ */
_self: function () {
return filter;
}
@@ -5062,29 +5172,29 @@
};
/**
- @class
- Use _self()
- @member ejs.HasChildFilter
- @property {Object} query
- */
+ The internal query object. Use _self()
+ @member ejs.HasChildFilter
+ @property {Object} query
+ */
var filter = {
has_child: {
query: qry._self(),
@@ -5095,82 +5205,82 @@
return {
/**
- Sets the query
+ Sets the query
- @member ejs.HasChildFilter
- @param {Query} q A valid Query object
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.HasChildFilter
+ @param {Query} q A valid Query object
+ @returns {Object} returns this so that calls can be chained.
+ */
query: function (q) {
if (q == null) {
return filter.has_child.query;
}
-
+
if (!isQuery(q)) {
throw new TypeError('Argument must be a Query object');
}
-
+
filter.has_child.query = q._self();
return this;
},
/**
- Sets the filter
+ Sets the filter
- @since elasticsearch 0.90
- @member ejs.HasChildFilter
- @param {Query} f A valid Filter object
- @returns {Object} returns this so that calls can be chained.
- */
+ @since elasticsearch 0.90
+ @member ejs.HasChildFilter
+ @param {Query} f A valid Filter object
+ @returns {Object} returns this so that calls can be chained.
+ */
filter: function (f) {
if (f == null) {
return filter.has_child.filter;
}
-
+
if (!isFilter(f)) {
throw new TypeError('Argument must be a Filter object');
}
-
+
filter.has_child.filter = f._self();
return this;
},
/**
- Sets the child document type to search against
+ Sets the child document type to search against
- @member ejs.HasChildFilter
- @param {String} t A valid type name
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.HasChildFilter
+ @param {String} t A valid type name
+ @returns {Object} returns this so that calls can be chained.
+ */
type: function (t) {
if (t == null) {
return filter.has_child.type;
}
-
+
filter.has_child.type = t;
return this;
},
/**
- Sets the scope of the filter. A scope allows to run facets on the
- same scope name that will work against the child documents.
+ Sets the scope of the filter. A scope allows to run facets on the
+ same scope name that will work against the child documents.
- @deprecated since elasticsearch 0.90
- @member ejs.HasChildFilter
- @param {String} s The scope name as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ @deprecated since elasticsearch 0.90
+ @member ejs.HasChildFilter
+ @param {String} s The scope name as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
scope: function (s) {
return this;
},
/**
- Sets the filter name.
+ Sets the filter name.
- @member ejs.HasChildFilter
- @param {String} name A name for the filter.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.HasChildFilter
+ @param {String} name A name for the filter.
+ @returns {Object} returns this so that calls can be chained.
+ */
name: function (name) {
if (name == null) {
return filter.has_child._name;
@@ -5179,34 +5289,66 @@
filter.has_child._name = name;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.HasChildFilter
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Enable or disable caching of the filter
+
+ @member ejs.HasChildFilter
+ @param {Boolean} trueFalse True to cache the filter, false otherwise.
+ @returns {Object} returns this so that calls can be chained.
+ */
+ cache: function (trueFalse) {
+ if (trueFalse == null) {
+ return filter.has_child._cache;
+ }
+
+ filter.has_child._cache = trueFalse;
+ return this;
+ },
+
+ /**
+ Sets the cache key.
+
+ @member ejs.HasChildFilter
+ @param {String} key the cache key as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
+ cacheKey: function (key) {
+ if (key == null) {
+ return filter.has_child._cache_key;
+ }
+
+ filter.has_child._cache_key = key;
+ return this;
+ },
+
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.HasChildFilter
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(filter);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.HasChildFilter
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.HasChildFilter
+ @returns {String} the type of object
+ */
_type: function () {
return 'filter';
},
-
- /**
- Retrieves the internal filter object. This is typically used by
- internal API functions so use with caution.
- @member ejs.HasChildFilter
- @returns {String} returns this object's internal filter property.
- */
+ /**
+ Retrieves the internal filter object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.HasChildFilter
+ @returns {String} returns this object's internal filter property.
+ */
_self: function () {
return filter;
}
@@ -5214,29 +5356,29 @@
};
/**
- @class
- Use _self()
- @member ejs.HasParentFilter
- @property {Object} query
- */
+ The internal filter object. Use _self()
+ @member ejs.HasParentFilter
+ @property {Object} query
+ */
var filter = {
has_parent: {
query: qry._self(),
@@ -5247,12 +5389,12 @@
return {
/**
- Sets the query
+ Sets the query
- @member ejs.HasParentFilter
- @param {Object} q A valid Query object
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.HasParentFilter
+ @param {Object} q A valid Query object
+ @returns {Object} returns this so that calls can be chained.
+ */
query: function (q) {
if (q == null) {
return filter.has_parent.query;
@@ -5261,19 +5403,19 @@
if (!isQuery(q)) {
throw new TypeError('Argument must be a Query object');
}
-
+
filter.has_parent.query = q._self();
return this;
},
-
- /**
- Sets the filter
- @since elasticsearch 0.90
- @member ejs.HasParentFilter
- @param {Object} f A valid Filter object
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the filter
+
+ @since elasticsearch 0.90
+ @member ejs.HasParentFilter
+ @param {Object} f A valid Filter object
+ @returns {Object} returns this so that calls can be chained.
+ */
filter: function (f) {
if (f == null) {
return filter.has_parent.filter;
@@ -5282,18 +5424,18 @@
if (!isFilter(f)) {
throw new TypeError('Argument must be a Filter object');
}
-
+
filter.has_parent.filter = f._self();
return this;
},
/**
- Sets the child document type to search against
+ Sets the child document type to search against
- @member ejs.HasParentFilter
- @param {String} t A valid type name
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.HasParentFilter
+ @param {String} t A valid type name
+ @returns {Object} returns this so that calls can be chained.
+ */
parentType: function (t) {
if (t == null) {
return filter.has_parent.parent_type;
@@ -5304,25 +5446,25 @@
},
/**
- Sets the scope of the filter. A scope allows to run facets on the
- same scope name that will work against the parent documents.
+ Sets the scope of the filter. A scope allows to run facets on the
+ same scope name that will work against the parent documents.
- @deprecated since elasticsearch 0.90
- @member ejs.HasParentFilter
- @param {String} s The scope name as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ @deprecated since elasticsearch 0.90
+ @member ejs.HasParentFilter
+ @param {String} s The scope name as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
scope: function (s) {
return this;
},
-
- /**
- Sets the filter name.
- @member ejs.HasParentFilter
- @param {String} name A name for the filter.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the filter name.
+
+ @member ejs.HasParentFilter
+ @param {String} name A name for the filter.
+ @returns {Object} returns this so that calls can be chained.
+ */
name: function (name) {
if (name == null) {
return filter.has_parent._name;
@@ -5331,34 +5473,66 @@
filter.has_parent._name = name;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.HasParentFilter
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Enable or disable caching of the filter
+
+ @member ejs.HasParentFilter
+ @param {Boolean} trueFalse True to cache the filter, false otherwise.
+ @returns {Object} returns this so that calls can be chained.
+ */
+ cache: function (trueFalse) {
+ if (trueFalse == null) {
+ return filter.has_parent._cache;
+ }
+
+ filter.has_parent._cache = trueFalse;
+ return this;
+ },
+
+ /**
+ Sets the cache key.
+
+ @member ejs.HasParentFilter
+ @param {String} key the cache key as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
+ cacheKey: function (key) {
+ if (key == null) {
+ return filter.has_parent._cache_key;
+ }
+
+ filter.has_parent._cache_key = key;
+ return this;
+ },
+
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.HasParentFilter
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(filter);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.HasParentFilter
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.HasParentFilter
+ @returns {String} the type of object
+ */
_type: function () {
return 'filter';
},
-
- /**
- Retrieves the internal filter object. This is typically used by
- internal API functions so use with caution.
- @member ejs.HasParentFilter
- @returns {String} returns this object's internal filter property.
- */
+ /**
+ Retrieves the internal filter object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.HasParentFilter
+ @returns {String} returns this object's internal filter property.
+ */
_self: function () {
return filter;
}
@@ -5366,29 +5540,29 @@
};
/**
- @class
- Use get()
- @member ejs.IdsFilter
- @property {Object} filter
- */
+ The internal filter object. Use get()
+ @member ejs.IdsFilter
+ @property {Object} filter
+ */
var filter = {
ids: {}
};
-
+
if (isString(ids)) {
filter.ids.values = [ids];
} else if (isArray(ids)) {
@@ -5400,19 +5574,19 @@
return {
/**
- Sets the values array or adds a new value. if val is a string, it
- is added to the list of existing document ids. If val is an
- array it is set as the document values and replaces any existing values.
+ Sets the values array or adds a new value. if val is a string, it
+ is added to the list of existing document ids. If val is an
+ array it is set as the document values and replaces any existing values.
- @member ejs.IdsFilter
- @param {Array || String} val An single document id or an array of document ids.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.IdsFilter
+ @param {Array || String} val An single document id or an array of document ids.
+ @returns {Object} returns this so that calls can be chained.
+ */
values: function (val) {
if (val == null) {
return filter.ids.values;
}
-
+
if (isString(val)) {
filter.ids.values.push(val);
} else if (isArray(val)) {
@@ -5420,29 +5594,29 @@
} else {
throw new TypeError('Argument must be a string or an array');
}
-
+
return this;
},
/**
- Sets the type as a single type or an array of types. If type is a
- string, it is added to the list of existing types. If type is an
- array, it is set as the types and overwrites an existing types. This
- parameter is optional.
+ Sets the type as a single type or an array of types. If type is a
+ string, it is added to the list of existing types. If type is an
+ array, it is set as the types and overwrites an existing types. This
+ parameter is optional.
- @member ejs.IdsFilter
- @param {Array || String} type A type or a list of types
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.IdsFilter
+ @param {Array || String} type A type or a list of types
+ @returns {Object} returns this so that calls can be chained.
+ */
type: function (type) {
if (filter.ids.type == null) {
filter.ids.type = [];
}
-
+
if (type == null) {
return filter.ids.type;
}
-
+
if (isString(type)) {
filter.ids.type.push(type);
} else if (isArray(type)) {
@@ -5450,17 +5624,17 @@
} else {
throw new TypeError('Argument must be a string or an array');
}
-
+
return this;
},
/**
- Sets the filter name.
+ Sets the filter name.
- @member ejs.IdsFilter
- @param {String} name A name for the filter.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.IdsFilter
+ @param {String} name A name for the filter.
+ @returns {Object} returns this so that calls can be chained.
+ */
name: function (name) {
if (name == null) {
return filter.ids._name;
@@ -5469,34 +5643,34 @@
filter.ids._name = name;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.IdsFilter
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.IdsFilter
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(filter);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.IdsFilter
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.IdsFilter
+ @returns {String} the type of object
+ */
_type: function () {
return 'filter';
},
-
- /**
- Retrieves the internal filter object. This is typically used by
- internal API functions so use with caution.
- @member ejs.IdsFilter
- @returns {String} returns this object's internal filter property.
- */
+ /**
+ Retrieves the internal filter object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.IdsFilter
+ @returns {String} returns this object's internal filter property.
+ */
_self: function () {
return filter;
}
@@ -5504,32 +5678,32 @@
};
/**
- @class
- Use _self()
- @member ejs.IndicesFilter
- @property {Object} filter
- */
+ The internal filter object. Use _self()
+ @member ejs.IndicesFilter
+ @property {Object} filter
+ */
var filter = {
indices: {
filter: fltr._self()
@@ -5547,14 +5721,14 @@
return {
/**
- Sets the indicies the filter should match. When passed a string,
- the index name is added to the current list of indices. When passed
- an array, it overwites all current indices.
+ Sets the indicies the filter should match. When passed a string,
+ the index name is added to the current list of indices. When passed
+ an array, it overwites all current indices.
- @member ejs.IndicesFilter
- @param {String || Array} i A single index name or an array of index names.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.IndicesFilter
+ @param {String || Array} i A single index name or an array of index names.
+ @returns {Object} returns this so that calls can be chained.
+ */
indices: function (i) {
if (i == null) {
return filter.indices.indices;
@@ -5570,15 +5744,15 @@
return this;
},
-
- /**
- Sets the filter to be used when executing on one of the indicies
- specified.
- @member ejs.IndicesFilter
- @param {Object} f A valid Filter object
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the filter to be used when executing on one of the indicies
+ specified.
+
+ @member ejs.IndicesFilter
+ @param {Object} f A valid Filter object
+ @returns {Object} returns this so that calls can be chained.
+ */
filter: function (f) {
if (f == null) {
return filter.indices.filter;
@@ -5587,20 +5761,20 @@
if (!isFilter(f)) {
throw new TypeError('Argument must be a Filter');
}
-
+
filter.indices.filter = f._self();
return this;
},
/**
- Sets the filter to be used on an index that does not match an index
- name in the indices list. Can also be set to "none" to not match any
- documents or "all" to match all documents.
+ Sets the filter to be used on an index that does not match an index
+ name in the indices list. Can also be set to "none" to not match any
+ documents or "all" to match all documents.
- @member ejs.IndicesFilter
- @param {Object || String} f A valid Filter object or "none" or "all"
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.IndicesFilter
+ @param {Object || String} f A valid Filter object or "none" or "all"
+ @returns {Object} returns this so that calls can be chained.
+ */
noMatchFilter: function (f) {
if (f == null) {
return filter.indices.no_match_filter;
@@ -5616,37 +5790,37 @@
} else {
throw new TypeError('Argument must be string or Filter');
}
-
+
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.IndicesFilter
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.IndicesFilter
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(filter);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.IndicesFilter
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.IndicesFilter
+ @returns {String} the type of object
+ */
_type: function () {
return 'filter';
},
-
- /**
- Retrieves the internal filter object. This is typically used by
- internal API functions so use with caution.
- @member ejs.IndicesFilter
- @returns {String} returns this object's internal filter property.
- */
+ /**
+ Retrieves the internal filter object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.IndicesFilter
+ @returns {String} returns this object's internal filter property.
+ */
_self: function () {
return filter;
}
@@ -5654,23 +5828,23 @@
};
/**
- @class
- Use get()
- @member ejs.LimitFilter
- @property {Object} filter
- */
+ The internal filter object. Use get()
+ @member ejs.LimitFilter
+ @property {Object} filter
+ */
var filter = {
limit: {
value: limit
@@ -5680,12 +5854,12 @@
return {
/**
- Sets the limit value.
+ Sets the limit value.
- @member ejs.LimitFilter
- @param {Integer} val An The number of documents to execute on.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.LimitFilter
+ @param {Integer} val An The number of documents to execute on.
+ @returns {Object} returns this so that calls can be chained.
+ */
value: function (val) {
if (val == null) {
return filter.limit.value;
@@ -5694,38 +5868,38 @@
if (!isNumber(val)) {
throw new TypeError('Argument must be a numeric value');
}
-
+
filter.limit.value = val;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.LimitFilter
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.LimitFilter
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(filter);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.LimitFilter
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.LimitFilter
+ @returns {String} the type of object
+ */
_type: function () {
return 'filter';
},
-
- /**
- Retrieves the internal filter object. This is typically used by
- internal API functions so use with caution.
- @member ejs.LimitFilter
- @returns {String} returns this object's internal filter property.
- */
+ /**
+ Retrieves the internal filter object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.LimitFilter
+ @returns {String} returns this object's internal filter property.
+ */
_self: function () {
return filter;
}
@@ -5733,23 +5907,23 @@
};
/**
- @class
- get().
- @member ejs.MatchAllFilter
- @property {Object} filter
- */
+ The internal Query object. Use get().
+ @member ejs.MatchAllFilter
+ @property {Object} filter
+ */
var filter = {
match_all: {}
};
@@ -5757,30 +5931,30 @@
return {
/**
- Serializes the internal filter object as a JSON string.
- @member ejs.MatchAllFilter
- @returns {String} Returns a JSON representation of the object.
- */
+ Serializes the internal filter object as a JSON string.
+ @member ejs.MatchAllFilter
+ @returns {String} Returns a JSON representation of the object.
+ */
toString: function () {
return JSON.stringify(filter);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.MatchAllFilter
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.MatchAllFilter
+ @returns {String} the type of object
+ */
_type: function () {
return 'filter';
},
-
+
/**
- This method is used to retrieve the raw filter object. It's designed
- for internal use when composing and serializing queries.
- @member ejs.MatchAllFilter
- @returns {Object} Returns the object's filter property.
- */
+ This method is used to retrieve the raw filter object. It's designed
+ for internal use when composing and serializing queries.
+ @member ejs.MatchAllFilter
+ @returns {Object} Returns the object's filter property.
+ */
_self: function () {
return filter;
}
@@ -5788,24 +5962,24 @@
};
/**
- @class
- get()
+ The internal filter object. Use get()
- @member ejs.MissingFilter
- @property {Object} filter
- */
+ @member ejs.MissingFilter
+ @property {Object} filter
+ */
var filter = {
missing: {
field: fieldName
@@ -5815,12 +5989,12 @@
return {
/**
- Sets the field to check for missing values.
+ Sets the field to check for missing values.
- @member ejs.MissingFilter
- @param {String} name A name of the field.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MissingFilter
+ @param {String} name A name of the field.
+ @returns {Object} returns this so that calls can be chained.
+ */
field: function (name) {
if (name == null) {
return filter.missing.field;
@@ -5829,14 +6003,14 @@
filter.missing.field = name;
return this;
},
-
- /**
- Checks if the field doesn't exist.
- @member ejs.MissingFilter
- @param {Boolean} trueFalse True to check if the field doesn't exist.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Checks if the field doesn't exist.
+
+ @member ejs.MissingFilter
+ @param {Boolean} trueFalse True to check if the field doesn't exist.
+ @returns {Object} returns this so that calls can be chained.
+ */
existence: function (trueFalse) {
if (trueFalse == null) {
return filter.missing.existence;
@@ -5847,12 +6021,12 @@
},
/**
- Checks if the field has null values.
+ Checks if the field has null values.
- @member ejs.MissingFilter
- @param {Boolean} trueFalse True to check if the field has nulls.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MissingFilter
+ @param {Boolean} trueFalse True to check if the field has nulls.
+ @returns {Object} returns this so that calls can be chained.
+ */
nullValue: function (trueFalse) {
if (trueFalse == null) {
return filter.missing.null_value;
@@ -5861,14 +6035,14 @@
filter.missing.null_value = trueFalse;
return this;
},
-
- /**
- Sets the filter name.
- @member ejs.MissingFilter
- @param {String} name A name for the filter.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the filter name.
+
+ @member ejs.MissingFilter
+ @param {String} name A name for the filter.
+ @returns {Object} returns this so that calls can be chained.
+ */
name: function (name) {
if (name == null) {
return filter.missing._name;
@@ -5877,33 +6051,33 @@
filter.missing._name = name;
return this;
},
-
- /**
- Returns the filter container as a JSON string
- @member ejs.MissingFilter
- @returns {String} JSON representation of the missingFilter object
- */
+ /**
+ Returns the filter container as a JSON string
+
+ @member ejs.MissingFilter
+ @returns {String} JSON representation of the missingFilter object
+ */
toString: function () {
return JSON.stringify(filter);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.MissingFilter
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.MissingFilter
+ @returns {String} the type of object
+ */
_type: function () {
return 'filter';
},
-
- /**
- Returns the filter object.
- @member ejs.MissingFilter
- @returns {Object} filter object
- */
+ /**
+ Returns the filter object.
+
+ @member ejs.MissingFilter
+ @returns {Object} filter object
+ */
_self: function () {
return filter;
}
@@ -5911,32 +6085,32 @@
};
/**
- @class
- XPath
- expressions in XML both conceptually and syntactically.XPath
+ expressions in XML both conceptually and syntactically._self().
- @member ejs.NestedFilter
- @property {Object} filter
- */
+ The internal Filter object. Use _self().
+ @member ejs.NestedFilter
+ @property {Object} filter
+ */
var filter = {
nested: {
path: path
@@ -5944,68 +6118,68 @@
};
return {
-
+
/**
- Sets the root context for the nested filter.
- @member ejs.NestedFilter
- @param {String} p The path defining the root for the nested filter.
- @returns {Object} returns this so that calls can be chained.
- */
+ Sets the root context for the nested filter.
+ @member ejs.NestedFilter
+ @param {String} p The path defining the root for the nested filter.
+ @returns {Object} returns this so that calls can be chained.
+ */
path: function (p) {
if (p == null) {
return filter.nested.path;
}
-
+
filter.nested.path = p;
return this;
},
/**
- Sets the nested query to be executed.
- @member ejs.NestedFilter
- @param {Query} oQuery A valid Query object
- @returns {Object} returns this so that calls can be chained.
- */
+ Sets the nested query to be executed.
+ @member ejs.NestedFilter
+ @param {Query} oQuery A valid Query object
+ @returns {Object} returns this so that calls can be chained.
+ */
query: function (oQuery) {
if (oQuery == null) {
return filter.nested.query;
}
-
+
if (!isQuery(oQuery)) {
throw new TypeError('Argument must be a Query object');
}
-
+
filter.nested.query = oQuery._self();
return this;
},
/**
- Sets the nested filter to be executed.
- @member ejs.NestedFilter
- @param {Object} oFilter A valid Filter object
- @returns {Object} returns this so that calls can be chained.
- */
+ Sets the nested filter to be executed.
+ @member ejs.NestedFilter
+ @param {Object} oFilter A valid Filter object
+ @returns {Object} returns this so that calls can be chained.
+ */
filter: function (oFilter) {
if (oFilter == null) {
return filter.nested.filter;
}
-
+
if (!isFilter(oFilter)) {
throw new TypeError('Argument must be a Filter object');
}
-
+
filter.nested.filter = oFilter._self();
return this;
},
/**
- Sets the boost value of the nested Query.
+ Sets the boost value of the nested Query.
- @member ejs.NestedFilter
- @param {Double} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.NestedFilter
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return filter.nested.boost;
@@ -6014,15 +6188,15 @@
filter.nested.boost = boost;
return this;
},
-
- /**
- If the nested query should be "joined" with the parent document.
- Defaults to false.
- @member ejs.NestedFilter
- @param {Boolean} trueFalse If the query should be joined or not.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ If the nested query should be "joined" with the parent document.
+ Defaults to false.
+
+ @member ejs.NestedFilter
+ @param {Boolean} trueFalse If the query should be joined or not.
+ @returns {Object} returns this so that calls can be chained.
+ */
join: function (trueFalse) {
if (trueFalse == null) {
return filter.nested.join;
@@ -6031,27 +6205,27 @@
filter.nested.join = trueFalse;
return this;
},
-
- /**
- Sets the scope of the filter. A scope allows to run facets on the
- same scope name that will work against the nested documents.
- @deprecated since elasticsearch 0.90
- @member ejs.NestedFilter
- @param {String} s The scope name as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the scope of the filter. A scope allows to run facets on the
+ same scope name that will work against the nested documents.
+
+ @deprecated since elasticsearch 0.90
+ @member ejs.NestedFilter
+ @param {String} s The scope name as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
scope: function (s) {
return this;
},
-
- /**
- Sets the filter name.
- @member ejs.NestedFilter
- @param {String} name A name for the filter.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the filter name.
+
+ @member ejs.NestedFilter
+ @param {String} name A name for the filter.
+ @returns {Object} returns this so that calls can be chained.
+ */
name: function (name) {
if (name == null) {
return filter.nested._name;
@@ -6062,12 +6236,12 @@
},
/**
- Enable or disable caching of the filter
+ Enable or disable caching of the filter
- @member ejs.NestedFilter
- @param {Boolean} trueFalse True to cache the filter, false otherwise.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.NestedFilter
+ @param {Boolean} trueFalse True to cache the filter, false otherwise.
+ @returns {Object} returns this so that calls can be chained.
+ */
cache: function (trueFalse) {
if (trueFalse == null) {
return filter.nested._cache;
@@ -6076,14 +6250,14 @@
filter.nested._cache = trueFalse;
return this;
},
-
- /**
- Sets the cache key.
- @member ejs.NestedFilter
- @param {String} key the cache key as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the cache key.
+
+ @member ejs.NestedFilter
+ @param {String} key the cache key as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
cacheKey: function (key) {
if (key == null) {
return filter.nested._cache_key;
@@ -6092,33 +6266,33 @@
filter.nested._cache_key = key;
return this;
},
-
+
/**
- Serializes the internal filter object as a JSON string.
- @member ejs.NestedFilter
- @returns {String} Returns a JSON representation of the termFilter object.
- */
+ Serializes the internal filter object as a JSON string.
+ @member ejs.NestedFilter
+ @returns {String} Returns a JSON representation of the termFilter object.
+ */
toString: function () {
return JSON.stringify(filter);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.NestedFilter
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.NestedFilter
+ @returns {String} the type of object
+ */
_type: function () {
return 'filter';
},
-
+
/**
- This method is used to retrieve the raw filter object. It's designed
- for internal use when composing and serializing filters.
-
- @member ejs.NestedFilter
- @returns {Object} Returns the object's filter property.
- */
+ This method is used to retrieve the raw filter object. It's designed
+ for internal use when composing and serializing filters.
+
+ @member ejs.NestedFilter
+ @returns {Object} Returns the object's filter property.
+ */
_self: function () {
return filter;
}
@@ -6126,29 +6300,29 @@
};
/**
- @class
- _self()
- @member ejs.NotFilter
- @property {Object} filter
- */
+ /**
+ The internal filter object. Use _self()
+
+ @member ejs.NotFilter
+ @property {Object} filter
+ */
var filter = {
not: oFilter._self()
};
@@ -6156,32 +6330,32 @@
return {
/**
- Sets the filter
+ Sets the filter
- @member ejs.NotFilter
- @param {Object} fltr A valid filter object such as a termFilter, etc.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.NotFilter
+ @param {Object} fltr A valid filter object such as a termFilter, etc.
+ @returns {Object} returns this so that calls can be chained.
+ */
filter: function (fltr) {
if (fltr == null) {
return filter.not;
}
-
+
if (!isFilter(fltr)) {
throw new TypeError('Argument must be a Filter');
}
-
+
filter.not = fltr._self();
return this;
},
/**
- Sets the filter name.
+ Sets the filter name.
- @member ejs.NotFilter
- @param {String} name A name for the filter.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.NotFilter
+ @param {String} name A name for the filter.
+ @returns {Object} returns this so that calls can be chained.
+ */
name: function (name) {
if (name == null) {
return filter.not._name;
@@ -6192,12 +6366,12 @@
},
/**
- Enable or disable caching of the filter
+ Enable or disable caching of the filter
- @member ejs.NotFilter
- @param {Boolean} trueFalse True to cache the filter, false otherwise.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.NotFilter
+ @param {Boolean} trueFalse True to cache the filter, false otherwise.
+ @returns {Object} returns this so that calls can be chained.
+ */
cache: function (trueFalse) {
if (trueFalse == null) {
return filter.not._cache;
@@ -6206,14 +6380,14 @@
filter.not._cache = trueFalse;
return this;
},
-
- /**
- Sets the cache key.
- @member ejs.NotFilter
- @param {String} key the cache key as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the cache key.
+
+ @member ejs.NotFilter
+ @param {String} key the cache key as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
cacheKey: function (key) {
if (key == null) {
return filter.not._cache_key;
@@ -6222,33 +6396,33 @@
filter.not._cache_key = key;
return this;
},
-
- /**
- Returns the filter container as a JSON string
- @member ejs.NotFilter
- @returns {String} JSON representation of the notFilter object
- */
+ /**
+ Returns the filter container as a JSON string
+
+ @member ejs.NotFilter
+ @returns {String} JSON representation of the notFilter object
+ */
toString: function () {
return JSON.stringify(filter);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.NotFilter
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.NotFilter
+ @returns {String} the type of object
+ */
_type: function () {
return 'filter';
},
-
- /**
- Returns the filter object.
- @member ejs.NotFilter
- @returns {Object} filter object
- */
+ /**
+ Returns the filter object.
+
+ @member ejs.NotFilter
+ @returns {Object} filter object
+ */
_self: function () {
return filter;
}
@@ -6256,35 +6430,35 @@
};
/**
- @class
- get()
+ The internal filter object. Use get()
- @member ejs.NumericRangeFilter
- @property {Object} filter
- */
+ @member ejs.NumericRangeFilter
+ @property {Object} filter
+ */
var filter = {
numeric_range: {}
};
@@ -6294,54 +6468,54 @@
return {
/**
- Returns the field name used to create this object.
+ Returns the field name used to create this object.
- @member ejs.NumericRangeFilter
- @param {String} field the field name
- @returns {Object} returns this so that calls can be
- chained. Returns {String}, field name when field is not specified.
- */
+ @member ejs.NumericRangeFilter
+ @param {String} field the field name
+ @returns {Object} returns this so that calls can be
+ chained. Returns {String}, field name when field is not specified.
+ */
field: function (field) {
var oldValue = filter.numeric_range[fieldName];
-
+
if (field == null) {
return fieldName;
}
-
+
delete filter.numeric_range[fieldName];
fieldName = field;
filter.numeric_range[fieldName] = oldValue;
-
+
return this;
},
-
- /**
- Sets the endpoint for the current range.
- @member ejs.NumericRangeFilter
- @param {Number} startPoint A numeric value representing the start of the range
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the endpoint for the current range.
+
+ @member ejs.NumericRangeFilter
+ @param {Number} startPoint A numeric value representing the start of the range
+ @returns {Object} returns this so that calls can be chained.
+ */
from: function (from) {
if (from == null) {
return filter.numeric_range[fieldName].from;
}
-
+
if (!isNumber(from)) {
throw new TypeError('Argument must be a numeric value');
}
-
+
filter.numeric_range[fieldName].from = from;
return this;
},
/**
- Sets the endpoint for the current range.
+ Sets the endpoint for the current range.
- @member ejs.NumericRangeFilter
- @param {Number} endPoint A numeric value representing the end of the range
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.NumericRangeFilter
+ @param {Number} endPoint A numeric value representing the end of the range
+ @returns {Object} returns this so that calls can be chained.
+ */
to: function (to) {
if (to == null) {
return filter.numeric_range[fieldName].to;
@@ -6350,19 +6524,19 @@
if (!isNumber(to)) {
throw new TypeError('Argument must be a numeric value');
}
-
+
filter.numeric_range[fieldName].to = to;
return this;
},
/**
- Should the first from (if set) be inclusive or not.
- Defaults to true
+ Should the first from (if set) be inclusive or not.
+ Defaults to true
- @member ejs.NumericRangeFilter
- @param {Boolean} trueFalse true to include, false to exclude
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.NumericRangeFilter
+ @param {Boolean} trueFalse true to include, false to exclude
+ @returns {Object} returns this so that calls can be chained.
+ */
includeLower: function (trueFalse) {
if (trueFalse == null) {
return filter.numeric_range[fieldName].include_lower;
@@ -6373,12 +6547,12 @@
},
/**
- Should the last to (if set) be inclusive or not. Defaults to true.
+ Should the last to (if set) be inclusive or not. Defaults to true.
- @member ejs.NumericRangeFilter
- @param {Boolean} trueFalse true to include, false to exclude
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.NumericRangeFilter
+ @param {Boolean} trueFalse true to include, false to exclude
+ @returns {Object} returns this so that calls can be chained.
+ */
includeUpper: function (trueFalse) {
if (trueFalse == null) {
return filter.numeric_range[fieldName].include_upper;
@@ -6389,13 +6563,13 @@
},
/**
- Greater than value. Same as setting from to the value, and
- include_lower to false,
+ Greater than value. Same as setting from to the value, and
+ include_lower to false,
- @member ejs.NumericRangeFilter
- @param {Variable Type} val the value, type depends on field type
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.NumericRangeFilter
+ @param {Variable Type} val the value, type depends on field type
+ @returns {Object} returns this so that calls can be chained.
+ */
gt: function (val) {
if (val == null) {
return filter.numeric_range[fieldName].gt;
@@ -6404,19 +6578,19 @@
if (!isNumber(val)) {
throw new TypeError('Argument must be a numeric value');
}
-
+
filter.numeric_range[fieldName].gt = val;
return this;
},
/**
- Greater than or equal to value. Same as setting from to the value,
- and include_lower to true.
+ Greater than or equal to value. Same as setting from to the value,
+ and include_lower to true.
- @member ejs.NumericRangeFilter
- @param {Variable Type} val the value, type depends on field type
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.NumericRangeFilter
+ @param {Variable Type} val the value, type depends on field type
+ @returns {Object} returns this so that calls can be chained.
+ */
gte: function (val) {
if (val == null) {
return filter.numeric_range[fieldName].gte;
@@ -6425,19 +6599,19 @@
if (!isNumber(val)) {
throw new TypeError('Argument must be a numeric value');
}
-
+
filter.numeric_range[fieldName].gte = val;
return this;
},
/**
- Less than value. Same as setting to to the value, and include_upper
- to false.
+ Less than value. Same as setting to to the value, and include_upper
+ to false.
- @member ejs.NumericRangeFilter
- @param {Variable Type} val the value, type depends on field type
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.NumericRangeFilter
+ @param {Variable Type} val the value, type depends on field type
+ @returns {Object} returns this so that calls can be chained.
+ */
lt: function (val) {
if (val == null) {
return filter.numeric_range[fieldName].lt;
@@ -6446,19 +6620,19 @@
if (!isNumber(val)) {
throw new TypeError('Argument must be a numeric value');
}
-
+
filter.numeric_range[fieldName].lt = val;
return this;
},
/**
- Less than or equal to value. Same as setting to to the value,
- and include_upper to true.
+ Less than or equal to value. Same as setting to to the value,
+ and include_upper to true.
- @member ejs.NumericRangeFilter
- @param {Variable Type} val the value, type depends on field type
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.NumericRangeFilter
+ @param {Variable Type} val the value, type depends on field type
+ @returns {Object} returns this so that calls can be chained.
+ */
lte: function (val) {
if (val == null) {
return filter.numeric_range[fieldName].lte;
@@ -6467,18 +6641,18 @@
if (!isNumber(val)) {
throw new TypeError('Argument must be a numeric value');
}
-
+
filter.numeric_range[fieldName].lte = val;
return this;
},
-
- /**
- Sets the filter name.
- @member ejs.NumericRangeFilter
- @param {String} name A name for the filter.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the filter name.
+
+ @member ejs.NumericRangeFilter
+ @param {String} name A name for the filter.
+ @returns {Object} returns this so that calls can be chained.
+ */
name: function (name) {
if (name == null) {
return filter.numeric_range._name;
@@ -6489,12 +6663,12 @@
},
/**
- Enable or disable caching of the filter
+ Enable or disable caching of the filter
- @member ejs.NumericRangeFilter
- @param {Boolean} trueFalse True to cache the filter, false otherwise.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.NumericRangeFilter
+ @param {Boolean} trueFalse True to cache the filter, false otherwise.
+ @returns {Object} returns this so that calls can be chained.
+ */
cache: function (trueFalse) {
if (trueFalse == null) {
return filter.numeric_range._cache;
@@ -6505,12 +6679,12 @@
},
/**
- Sets the cache key.
+ Sets the cache key.
- @member ejs.NumericRangeFilter
- @param {String} key the cache key as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.NumericRangeFilter
+ @param {String} key the cache key as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
cacheKey: function (key) {
if (key == null) {
return filter.numeric_range._cache_key;
@@ -6519,33 +6693,33 @@
filter.numeric_range._cache_key = key;
return this;
},
-
- /**
- Returns the filter container as a JSON string.
- @member ejs.NumericRangeFilter
- @returns {String} JSON representation of the numericRangeFilter object
- */
+ /**
+ Returns the filter container as a JSON string.
+
+ @member ejs.NumericRangeFilter
+ @returns {String} JSON representation of the numericRangeFilter object
+ */
toString: function () {
return JSON.stringify(filter);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.NumericRangeFilter
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.NumericRangeFilter
+ @returns {String} the type of object
+ */
_type: function () {
return 'filter';
},
-
- /**
- Returns the filter object.
- @member ejs.NumericRangeFilter
- @returns {Object} filter object
- */
+ /**
+ Returns the filter object.
+
+ @member ejs.NumericRangeFilter
+ @returns {Object} filter object
+ */
_self: function () {
return filter;
}
@@ -6553,24 +6727,24 @@
};
/**
- @class
- A container filter that allows Boolean OR composition of filters.
+ @class
+ A container filter that allows Boolean OR composition of filters.
- @name ejs.OrFilter
+ @name ejs.OrFilter
- @desc
- A container Filter that allows Boolean OR composition of filters.
+ @desc
+ A container Filter that allows Boolean OR composition of filters.
- @param {Filter || Array} filters A valid Filter or array of Filters.
- */
+ @param {Filter || Array} filters A valid Filter or array of Filters.
+ */
ejs.OrFilter = function (filters) {
/**
- The internal filter object. Use _self()
+ The internal filter object. Use _self()
- @member ejs.OrFilter
- @property {Object} filter
- */
+ @member ejs.OrFilter
+ @property {Object} filter
+ */
var filter, i, len;
filter = {
@@ -6586,7 +6760,7 @@
if (!isFilter(filters[i])) {
throw new TypeError('Argument must be array of Filters');
}
-
+
filter.or.filters.push(filters[i]._self());
}
} else {
@@ -6596,21 +6770,21 @@
return {
/**
- Updates the filters. If passed a single Filter it is added to
- the existing filters. If passed an array of Filters, they
- replace all existing Filters.
+ Updates the filters. If passed a single Filter it is added to
+ the existing filters. If passed an array of Filters, they
+ replace all existing Filters.
- @member ejs.OrFilter
- @param {Filter || Array} fltr A Filter or array of Filters
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.OrFilter
+ @param {Filter || Array} fltr A Filter or array of Filters
+ @returns {Object} returns this so that calls can be chained.
+ */
filters: function (fltr) {
var i, len;
-
+
if (fltr == null) {
return filter.or.filters;
}
-
+
if (isFilter(fltr)) {
filter.or.filters.push(fltr._self());
} else if (isArray(fltr)) {
@@ -6619,23 +6793,23 @@
if (!isFilter(fltr[i])) {
throw new TypeError('Argument must be an array of Filters');
}
-
+
filter.or.filters.push(fltr[i]._self());
}
} else {
throw new TypeError('Argument must be a Filter or array of Filters');
}
-
+
return this;
},
/**
- Sets the filter name.
+ Sets the filter name.
- @member ejs.OrFilter
- @param {String} name A name for the filter.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.OrFilter
+ @param {String} name A name for the filter.
+ @returns {Object} returns this so that calls can be chained.
+ */
name: function (name) {
if (name == null) {
return filter.or._name;
@@ -6646,12 +6820,12 @@
},
/**
- Enable or disable caching of the filter
+ Enable or disable caching of the filter
- @member ejs.OrFilter
- @param {Boolean} trueFalse True to cache the filter, false otherwise.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.OrFilter
+ @param {Boolean} trueFalse True to cache the filter, false otherwise.
+ @returns {Object} returns this so that calls can be chained.
+ */
cache: function (trueFalse) {
if (trueFalse == null) {
return filter.or._cache;
@@ -6662,12 +6836,12 @@
},
/**
- Sets the cache key.
+ Sets the cache key.
- @member ejs.OrFilter
- @param {String} key the cache key as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.OrFilter
+ @param {String} key the cache key as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
cacheKey: function (key) {
if (key == null) {
return filter.or._cache_key;
@@ -6676,33 +6850,33 @@
filter.or._cache_key = key;
return this;
},
-
- /**
- Returns the filter container as a JSON string
- @member ejs.OrFilter
- @returns {String} JSON representation of the orFilter object
- */
+ /**
+ Returns the filter container as a JSON string
+
+ @member ejs.OrFilter
+ @returns {String} JSON representation of the orFilter object
+ */
toString: function () {
return JSON.stringify(filter);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.OrFilter
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.OrFilter
+ @returns {String} the type of object
+ */
_type: function () {
return 'filter';
},
-
- /**
- Returns the filter object.
- @member ejs.OrFilter
- @returns {Object} filter object
- */
+ /**
+ Returns the filter object.
+
+ @member ejs.OrFilter
+ @returns {Object} filter object
+ */
_self: function () {
return filter;
}
@@ -6710,79 +6884,79 @@
};
/**
- @class
- get()
+ The internal filter object. Use get()
- @member ejs.PrefixFilter
- @property {Object} filter
- */
+ @member ejs.PrefixFilter
+ @property {Object} filter
+ */
var filter = {
prefix: {}
};
filter.prefix[fieldName] = prefix;
-
+
return {
/**
- Returns the field name used to create this object.
+ Returns the field name used to create this object.
- @member ejs.PrefixFilter
- @param {String} field the field name
- @returns {Object} returns this so that calls can be
- chained. Returns {String}, field name when field is not specified.
- */
+ @member ejs.PrefixFilter
+ @param {String} field the field name
+ @returns {Object} returns this so that calls can be
+ chained. Returns {String}, field name when field is not specified.
+ */
field: function (field) {
var oldValue = filter.prefix[fieldName];
-
+
if (field == null) {
return fieldName;
}
-
+
delete filter.prefix[fieldName];
fieldName = field;
filter.prefix[fieldName] = oldValue;
-
+
return this;
},
-
- /**
- Sets the prefix to search for.
- @member ejs.PrefixFilter
- @param {String} value the prefix value to match
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the prefix to search for.
+
+ @member ejs.PrefixFilter
+ @param {String} value the prefix value to match
+ @returns {Object} returns this so that calls can be chained.
+ */
prefix: function (value) {
if (value == null) {
return filter.prefix[fieldName];
}
-
+
filter.prefix[fieldName] = value;
return this;
},
/**
- Sets the filter name.
+ Sets the filter name.
- @member ejs.PrefixFilter
- @param {String} name A name for the filter.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.PrefixFilter
+ @param {String} name A name for the filter.
+ @returns {Object} returns this so that calls can be chained.
+ */
name: function (name) {
if (name == null) {
return filter.prefix._name;
@@ -6793,12 +6967,12 @@
},
/**
- Enable or disable caching of the filter
+ Enable or disable caching of the filter
- @member ejs.PrefixFilter
- @param {Boolean} trueFalse True to cache the filter, false otherwise.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.PrefixFilter
+ @param {Boolean} trueFalse True to cache the filter, false otherwise.
+ @returns {Object} returns this so that calls can be chained.
+ */
cache: function (trueFalse) {
if (trueFalse == null) {
return filter.prefix._cache;
@@ -6809,12 +6983,12 @@
},
/**
- Sets the cache key.
+ Sets the cache key.
- @member ejs.PrefixFilter
- @param {String} key the cache key as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.PrefixFilter
+ @param {String} key the cache key as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
cacheKey: function (key) {
if (key == null) {
return filter.prefix._cache_key;
@@ -6823,33 +6997,33 @@
filter.prefix._cache_key = key;
return this;
},
-
- /**
- Returns the filter container as a JSON string
- @member ejs.PrefixFilter
- @returns {String} JSON representation of the prefixFilter object
- */
+ /**
+ Returns the filter container as a JSON string
+
+ @member ejs.PrefixFilter
+ @returns {String} JSON representation of the prefixFilter object
+ */
toString: function () {
return JSON.stringify(filter);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.PrefixFilter
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.PrefixFilter
+ @returns {String} the type of object
+ */
_type: function () {
return 'filter';
},
-
- /**
- Returns the filter object.
- @member ejs.PrefixFilter
- @returns {Object} filter object
- */
+ /**
+ Returns the filter object.
+
+ @member ejs.PrefixFilter
+ @returns {Object} filter object
+ */
_self: function () {
return filter;
}
@@ -6857,35 +7031,35 @@
};
/**
- @class
- Use _self()
- @member ejs.QueryFilter
- @property {Object} query
- */
+ The internal query object. Use _self()
+ @member ejs.QueryFilter
+ @property {Object} query
+ */
var filter = {
fquery: {
query: qry._self()
@@ -6895,12 +7069,12 @@
return {
/**
- Sets the query
+ Sets the query
- @member ejs.QueryFilter
- @param {Object} q A valid Query object
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.QueryFilter
+ @param {Object} q A valid Query object
+ @returns {Object} returns this so that calls can be chained.
+ */
query: function (q) {
if (q == null) {
return filter.fquery.query;
@@ -6909,18 +7083,18 @@
if (!isQuery(q)) {
throw new TypeError('Argument must be a Query');
}
-
+
filter.fquery.query = q._self();
return this;
},
/**
- Sets the filter name.
+ Sets the filter name.
- @member ejs.QueryFilter
- @param {String} name A name for the filter.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.QueryFilter
+ @param {String} name A name for the filter.
+ @returns {Object} returns this so that calls can be chained.
+ */
name: function (name) {
if (name == null) {
return filter.fquery._name;
@@ -6931,12 +7105,12 @@
},
/**
- Enable or disable caching of the filter
+ Enable or disable caching of the filter
- @member ejs.QueryFilter
- @param {Boolean} trueFalse True to cache the filter, false otherwise.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.QueryFilter
+ @param {Boolean} trueFalse True to cache the filter, false otherwise.
+ @returns {Object} returns this so that calls can be chained.
+ */
cache: function (trueFalse) {
if (trueFalse == null) {
return filter.fquery._cache;
@@ -6945,14 +7119,14 @@
filter.fquery._cache = trueFalse;
return this;
},
-
- /**
- Sets the cache key.
- @member ejs.QueryFilter
- @param {String} key the cache key as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the cache key.
+
+ @member ejs.QueryFilter
+ @param {String} key the cache key as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
cacheKey: function (key) {
if (key == null) {
return filter.fquery._cache_key;
@@ -6961,34 +7135,34 @@
filter.fquery._cache_key = key;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.QueryFilter
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.QueryFilter
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(filter);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.QueryFilter
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.QueryFilter
+ @returns {String} the type of object
+ */
_type: function () {
return 'filter';
},
-
- /**
- Retrieves the internal filter object. This is typically used by
- internal API functions so use with caution.
- @member ejs.QueryFilter
- @returns {String} returns this object's internal filter property.
- */
+ /**
+ Retrieves the internal filter object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.QueryFilter
+ @returns {String} returns this object's internal filter property.
+ */
_self: function () {
return filter;
}
@@ -6996,23 +7170,23 @@
};
/**
- @class
- Use get()
- @member ejs.RangeFilter
- @property {Object} filter
- */
+ The internal filter object. Use get()
+ @member ejs.RangeFilter
+ @property {Object} filter
+ */
var filter = {
range: {}
};
@@ -7022,12 +7196,12 @@
return {
/**
- The field to run the filter against.
+ The field to run the filter against.
- @member ejs.RangeFilter
- @param {String} f A single field name.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RangeFilter
+ @param {String} f A single field name.
+ @returns {Object} returns this so that calls can be chained.
+ */
field: function (f) {
var oldValue = filter.range[field];
@@ -7043,12 +7217,12 @@
},
/**
- The lower bound. Defaults to start from the first.
+ The lower bound. Defaults to start from the first.
- @member ejs.RangeFilter
- @param {Variable Type} f the lower bound value, type depends on field type
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RangeFilter
+ @param {Variable Type} f the lower bound value, type depends on field type
+ @returns {Object} returns this so that calls can be chained.
+ */
from: function (f) {
if (f == null) {
return filter.range[field].from;
@@ -7059,12 +7233,12 @@
},
/**
- The upper bound. Defaults to unbounded.
+ The upper bound. Defaults to unbounded.
- @member ejs.RangeFilter
- @param {Variable Type} t the upper bound value, type depends on field type
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RangeFilter
+ @param {Variable Type} t the upper bound value, type depends on field type
+ @returns {Object} returns this so that calls can be chained.
+ */
to: function (t) {
if (t == null) {
return filter.range[field].to;
@@ -7075,13 +7249,13 @@
},
/**
- Should the first from (if set) be inclusive or not.
- Defaults to true
+ Should the first from (if set) be inclusive or not.
+ Defaults to true
- @member ejs.RangeFilter
- @param {Boolean} trueFalse true to include, false to exclude
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RangeFilter
+ @param {Boolean} trueFalse true to include, false to exclude
+ @returns {Object} returns this so that calls can be chained.
+ */
includeLower: function (trueFalse) {
if (trueFalse == null) {
return filter.range[field].include_lower;
@@ -7092,12 +7266,12 @@
},
/**
- Should the last to (if set) be inclusive or not. Defaults to true.
+ Should the last to (if set) be inclusive or not. Defaults to true.
- @member ejs.RangeFilter
- @param {Boolean} trueFalse true to include, false to exclude
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RangeFilter
+ @param {Boolean} trueFalse true to include, false to exclude
+ @returns {Object} returns this so that calls can be chained.
+ */
includeUpper: function (trueFalse) {
if (trueFalse == null) {
return filter.range[field].include_upper;
@@ -7108,13 +7282,13 @@
},
/**
- Greater than value. Same as setting from to the value, and
- include_lower to false,
+ Greater than value. Same as setting from to the value, and
+ include_lower to false,
- @member ejs.RangeFilter
- @param {Variable Type} val the value, type depends on field type
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RangeFilter
+ @param {Variable Type} val the value, type depends on field type
+ @returns {Object} returns this so that calls can be chained.
+ */
gt: function (val) {
if (val == null) {
return filter.range[field].gt;
@@ -7125,13 +7299,13 @@
},
/**
- Greater than or equal to value. Same as setting from to the value,
- and include_lower to true.
+ Greater than or equal to value. Same as setting from to the value,
+ and include_lower to true.
- @member ejs.RangeFilter
- @param {Variable Type} val the value, type depends on field type
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RangeFilter
+ @param {Variable Type} val the value, type depends on field type
+ @returns {Object} returns this so that calls can be chained.
+ */
gte: function (val) {
if (val == null) {
return filter.range[field].gte;
@@ -7142,13 +7316,13 @@
},
/**
- Less than value. Same as setting to to the value, and include_upper
- to false.
+ Less than value. Same as setting to to the value, and include_upper
+ to false.
- @member ejs.RangeFilter
- @param {Variable Type} val the value, type depends on field type
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RangeFilter
+ @param {Variable Type} val the value, type depends on field type
+ @returns {Object} returns this so that calls can be chained.
+ */
lt: function (val) {
if (val == null) {
return filter.range[field].lt;
@@ -7159,13 +7333,13 @@
},
/**
- Less than or equal to value. Same as setting to to the value,
- and include_upper to true.
+ Less than or equal to value. Same as setting to to the value,
+ and include_upper to true.
- @member ejs.RangeFilter
- @param {Variable Type} val the value, type depends on field type
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RangeFilter
+ @param {Variable Type} val the value, type depends on field type
+ @returns {Object} returns this so that calls can be chained.
+ */
lte: function (val) {
if (val == null) {
return filter.range[field].lte;
@@ -7174,14 +7348,14 @@
filter.range[field].lte = val;
return this;
},
-
- /**
- Sets the filter name.
- @member ejs.RangeFilter
- @param {String} name A name for the filter.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the filter name.
+
+ @member ejs.RangeFilter
+ @param {String} name A name for the filter.
+ @returns {Object} returns this so that calls can be chained.
+ */
name: function (name) {
if (name == null) {
return filter.range._name;
@@ -7192,12 +7366,12 @@
},
/**
- Enable or disable caching of the filter
+ Enable or disable caching of the filter
- @member ejs.RangeFilter
- @param {Boolean} trueFalse True to cache the filter, false otherwise.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RangeFilter
+ @param {Boolean} trueFalse True to cache the filter, false otherwise.
+ @returns {Object} returns this so that calls can be chained.
+ */
cache: function (trueFalse) {
if (trueFalse == null) {
return filter.range._cache;
@@ -7208,12 +7382,12 @@
},
/**
- Sets the cache key.
+ Sets the cache key.
- @member ejs.RangeFilter
- @param {String} key the cache key as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RangeFilter
+ @param {String} key the cache key as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
cacheKey: function (key) {
if (key == null) {
return filter.range._cache_key;
@@ -7222,34 +7396,34 @@
filter.range._cache_key = key;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.RangeFilter
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.RangeFilter
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(filter);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.RangeFilter
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.RangeFilter
+ @returns {String} the type of object
+ */
_type: function () {
return 'filter';
},
-
- /**
- Retrieves the internal filter object. This is typically used by
- internal API functions so use with caution.
- @member ejs.RangeFilter
- @returns {String} returns this object's internal filter property.
- */
+ /**
+ Retrieves the internal filter object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.RangeFilter
+ @returns {String} returns this object's internal filter property.
+ */
_self: function () {
return filter;
}
@@ -7257,26 +7431,26 @@
};
/**
- @class
- Use get()
- @member ejs.RegexpFilter
- @property {Object} filter
- */
+ The internal filter object. Use get()
+ @member ejs.RegexpFilter
+ @property {Object} filter
+ */
var filter = {
regexp: {}
};
@@ -7288,12 +7462,12 @@
return {
/**
- The field to run the filter against.
+ The field to run the filter against.
- @member ejs.RegexpFilter
- @param {String} f A single field name.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RegexpFilter
+ @param {String} f A single field name.
+ @returns {Object} returns this so that calls can be chained.
+ */
field: function (f) {
var oldValue = filter.regexp[field];
@@ -7309,12 +7483,12 @@
},
/**
- The regexp value.
+ The regexp value.
- @member ejs.RegexpFilter
- @param {String} p A string regexp
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RegexpFilter
+ @param {String} p A string regexp
+ @returns {Object} returns this so that calls can be chained.
+ */
value: function (p) {
if (p == null) {
return filter.regexp[field].value;
@@ -7325,24 +7499,24 @@
},
/**
- The regex flags to use. Valid flags are:
-
- INTERSECTION - Support for intersection notation
- COMPLEMENT - Support for complement notation
- EMPTY - Support for the empty language symbol: #
- ANYSTRING - Support for the any string symbol: @
- INTERVAL - Support for numerical interval notation: this so that calls can be chained.
- */
+ INTERSECTION - Support for intersection notation
+ COMPLEMENT - Support for complement notation
+ EMPTY - Support for the empty language symbol: #
+ ANYSTRING - Support for the any string symbol: @
+ INTERVAL - Support for numerical interval notation: this so that calls can be chained.
+ */
flags: function (f) {
if (f == null) {
return filter.regexp[field].flags;
@@ -7351,15 +7525,15 @@
filter.regexp[field].flags = f;
return this;
},
-
+
/**
- The regex flags to use as a numeric value. Advanced use only,
- it is probably better to stick with the flags option.
-
- @member ejs.RegexpFilter
- @param {String} v The flags as a numeric value.
- @returns {Object} returns this so that calls can be chained.
- */
+ The regex flags to use as a numeric value. Advanced use only,
+ it is probably better to stick with the flags option.
+
+ @member ejs.RegexpFilter
+ @param {String} v The flags as a numeric value.
+ @returns {Object} returns this so that calls can be chained.
+ */
flagsValue: function (v) {
if (v == null) {
return filter.regexp[field].flags_value;
@@ -7370,12 +7544,12 @@
},
/**
- Sets the filter name.
+ Sets the filter name.
- @member ejs.RegexpFilter
- @param {String} name A name for the filter.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RegexpFilter
+ @param {String} name A name for the filter.
+ @returns {Object} returns this so that calls can be chained.
+ */
name: function (name) {
if (name == null) {
return filter.regexp._name;
@@ -7386,12 +7560,12 @@
},
/**
- Enable or disable caching of the filter
+ Enable or disable caching of the filter
- @member ejs.RegexpFilter
- @param {Boolean} trueFalse True to cache the filter, false otherwise.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RegexpFilter
+ @param {Boolean} trueFalse True to cache the filter, false otherwise.
+ @returns {Object} returns this so that calls can be chained.
+ */
cache: function (trueFalse) {
if (trueFalse == null) {
return filter.regexp._cache;
@@ -7402,12 +7576,12 @@
},
/**
- Sets the cache key.
+ Sets the cache key.
- @member ejs.RegexpFilter
- @param {String} key the cache key as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RegexpFilter
+ @param {String} key the cache key as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
cacheKey: function (key) {
if (key == null) {
return filter.regexp._cache_key;
@@ -7416,34 +7590,34 @@
filter.regexp._cache_key = key;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.RegexpFilter
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.RegexpFilter
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(filter);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.RegexpFilter
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.RegexpFilter
+ @returns {String} the type of object
+ */
_type: function () {
return 'filter';
},
-
- /**
- Retrieves the internal filter object. This is typically used by
- internal API functions so use with caution.
- @member ejs.RegexpFilter
- @returns {String} returns this object's internal filter property.
- */
+ /**
+ Retrieves the internal filter object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.RegexpFilter
+ @returns {String} returns this object's internal filter property.
+ */
_self: function () {
return filter;
}
@@ -7451,23 +7625,23 @@
};
/**
- @class
- Use get()
- @member ejs.ScriptFilter
- @property {Object} filter
- */
+ The internal filter object. Use get()
+ @member ejs.ScriptFilter
+ @property {Object} filter
+ */
var filter = {
script: {
script: script
@@ -7477,62 +7651,62 @@
return {
/**
- Sets the script.
+ Sets the script.
- @member ejs.ScriptFilter
- @param {String} s The script as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.ScriptFilter
+ @param {String} s The script as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
script: function (s) {
if (s == null) {
return filter.script.script;
}
-
+
filter.script.script = s;
return this;
},
/**
- Sets parameters that will be applied to the script. Overwrites
- any existing params.
+ Sets parameters that will be applied to the script. Overwrites
+ any existing params.
- @member ejs.ScriptFilter
- @param {Object} p An object where the keys are the parameter name and
- values are the parameter value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.ScriptFilter
+ @param {Object} p An object where the keys are the parameter name and
+ values are the parameter value.
+ @returns {Object} returns this so that calls can be chained.
+ */
params: function (p) {
if (p == null) {
return filter.script.params;
}
-
+
filter.script.params = p;
return this;
},
-
- /**
- Sets the script language.
- @member ejs.ScriptFilter
- @param {String} lang The script language, default mvel.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the script language.
+
+ @member ejs.ScriptFilter
+ @param {String} lang The script language, default mvel.
+ @returns {Object} returns this so that calls can be chained.
+ */
lang: function (lang) {
if (lang == null) {
return filter.script.lang;
}
-
+
filter.script.lang = lang;
return this;
},
-
- /**
- Sets the filter name.
- @member ejs.ScriptFilter
- @param {String} name A name for the filter.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the filter name.
+
+ @member ejs.ScriptFilter
+ @param {String} name A name for the filter.
+ @returns {Object} returns this so that calls can be chained.
+ */
name: function (name) {
if (name == null) {
return filter.script._name;
@@ -7543,12 +7717,12 @@
},
/**
- Enable or disable caching of the filter
+ Enable or disable caching of the filter
- @member ejs.ScriptFilter
- @param {Boolean} trueFalse True to cache the filter, false otherwise.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.ScriptFilter
+ @param {Boolean} trueFalse True to cache the filter, false otherwise.
+ @returns {Object} returns this so that calls can be chained.
+ */
cache: function (trueFalse) {
if (trueFalse == null) {
return filter.script._cache;
@@ -7559,12 +7733,12 @@
},
/**
- Sets the cache key.
+ Sets the cache key.
- @member ejs.ScriptFilter
- @param {String} key the cache key as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.ScriptFilter
+ @param {String} key the cache key as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
cacheKey: function (key) {
if (key == null) {
return filter.script._cache_key;
@@ -7573,34 +7747,34 @@
filter.script._cache_key = key;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.ScriptFilter
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.ScriptFilter
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(filter);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.ScriptFilter
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.ScriptFilter
+ @returns {String} the type of object
+ */
_type: function () {
return 'filter';
},
-
- /**
- Retrieves the internal filter object. This is typically used by
- internal API functions so use with caution.
- @member ejs.ScriptFilter
- @returns {String} returns this object's internal filter property.
- */
+ /**
+ Retrieves the internal filter object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.ScriptFilter
+ @returns {String} returns this object's internal filter property.
+ */
_self: function () {
return filter;
}
@@ -7608,26 +7782,26 @@
};
/**
- @class
- this so that calls can be chained.
- When k is not specified, Returns {String}, the filter fieldName used to construct
- the termFilter object.
- */
+ Provides access to the filter fieldName used to construct the
+ termFilter object.
+
+ @member ejs.TermFilter
+ @param {String} f the fieldName term
+ @returns {Object} returns this so that calls can be chained.
+ When k is not specified, Returns {String}, the filter fieldName used to construct
+ the termFilter object.
+ */
field: function (f) {
var oldValue = filter.term[fieldName];
-
+
if (f == null) {
return fieldName;
}
-
+
delete filter.term[fieldName];
fieldName = f;
filter.term[fieldName] = oldValue;
-
+
return this;
},
/**
- Provides access to the filter term used to construct the
- termFilter object.
-
- @member ejs.TermFilter
- @returns {Object} returns this so that calls can be chained.
- When k is not specified, Returns {String}, the filter term used
- to construct the termFilter object.
- */
+ Provides access to the filter term used to construct the
+ termFilter object.
+
+ @member ejs.TermFilter
+ @returns {Object} returns this so that calls can be chained.
+ When k is not specified, Returns {String}, the filter term used
+ to construct the termFilter object.
+ */
term: function (v) {
if (v == null) {
return filter.term[fieldName];
}
-
+
filter.term[fieldName] = v;
return this;
},
/**
- Sets the filter name.
+ Sets the filter name.
- @member ejs.TermFilter
- @param {String} name A name for the filter.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.TermFilter
+ @param {String} name A name for the filter.
+ @returns {Object} returns this so that calls can be chained.
+ */
name: function (name) {
if (name == null) {
return filter.term._name;
@@ -7695,12 +7869,12 @@
},
/**
- Enable or disable caching of the filter
+ Enable or disable caching of the filter
- @member ejs.TermFilter
- @param {Boolean} trueFalse True to cache the filter, false otherwise.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.TermFilter
+ @param {Boolean} trueFalse True to cache the filter, false otherwise.
+ @returns {Object} returns this so that calls can be chained.
+ */
cache: function (trueFalse) {
if (trueFalse == null) {
return filter.term._cache;
@@ -7711,12 +7885,12 @@
},
/**
- Sets the cache key.
+ Sets the cache key.
- @member ejs.TermFilter
- @param {String} key the cache key as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.TermFilter
+ @param {String} key the cache key as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
cacheKey: function (key) {
if (key == null) {
return filter.term._cache_key;
@@ -7725,33 +7899,33 @@
filter.term._cache_key = key;
return this;
},
-
+
/**
- Serializes the internal filter object as a JSON string.
-
- @member ejs.TermFilter
- @returns {String} Returns a JSON representation of the termFilter object.
- */
+ Serializes the internal filter object as a JSON string.
+
+ @member ejs.TermFilter
+ @returns {String} Returns a JSON representation of the termFilter object.
+ */
toString: function () {
return JSON.stringify(filter);
},
-
+
/**
- The type of ejs object. For internal use only.
-
- @member ejs.TermFilter
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.TermFilter
+ @returns {String} the type of object
+ */
_type: function () {
return 'filter';
},
-
+
/**
- Returns the filter object. For internal use only.
-
- @member ejs.TermFilter
- @returns {Object} Returns the object's filter property.
- */
+ Returns the filter object. For internal use only.
+
+ @member ejs.TermFilter
+ @returns {Object} Returns the object's filter property.
+ */
_self: function () {
return filter;
}
@@ -7759,43 +7933,43 @@
};
/**
- @class
- Use get()
- @member ejs.TermsFilter
- @property {Object} filter
- */
+ The internal filter object. Use get()
+ @member ejs.TermsFilter
+ @property {Object} filter
+ */
var filter = {
- terms: {}
- },
-
+ terms: {}
+ },
+
// make sure we are setup for a list of terms
- setupTerms = function () {
- if (!isArray(filter.terms[field])) {
- filter.terms[field] = [];
- }
- },
-
+ setupTerms = function () {
+ if (!isArray(filter.terms[field])) {
+ filter.terms[field] = [];
+ }
+ },
+
// make sure we are setup for a terms lookup
- setupLookup = function () {
- if (isArray(filter.terms[field])) {
- filter.terms[field] = {};
- }
- };
-
+ setupLookup = function () {
+ if (isArray(filter.terms[field])) {
+ filter.terms[field] = {};
+ }
+ };
+
if (isArray(terms)) {
filter.terms[field] = terms;
} else {
@@ -7805,15 +7979,15 @@
return {
/**
- Sets the fields to filter against.
+ Sets the fields to filter against.
- @member ejs.TermsFilter
- @param {String} f A valid field name.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.TermsFilter
+ @param {String} f A valid field name.
+ @returns {Object} returns this so that calls can be chained.
+ */
field: function (f) {
var oldValue = filter.terms[field];
-
+
if (f == null) {
return field;
}
@@ -7821,143 +7995,143 @@
delete filter.terms[field];
field = f;
filter.terms[f] = oldValue;
-
+
return this;
},
-
- /**
- Sets the terms. If t is a String, it is added to the existing
- list of terms. If t is an array, the list of terms replaces the
- existing terms.
- @member ejs.TermsFilter
- @param {String || Array} t A single term or an array or terms.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the terms. If t is a String, it is added to the existing
+ list of terms. If t is an array, the list of terms replaces the
+ existing terms.
+
+ @member ejs.TermsFilter
+ @param {String || Array} t A single term or an array or terms.
+ @returns {Object} returns this so that calls can be chained.
+ */
terms: function (t) {
setupTerms();
if (t == null) {
return filter.terms[field];
}
-
+
if (isArray(t)) {
filter.terms[field] = t;
} else {
filter.terms[field].push(t);
}
-
+
return this;
},
/**
- Sets the index the document containing the terms is in when
- performing a terms lookup. Defaults to the index currently
- being searched.
+ Sets the index the document containing the terms is in when
+ performing a terms lookup. Defaults to the index currently
+ being searched.
- @since elasticsearch 0.90
- @member ejs.TermsFilter
- @param {String} idx A valid index name.
- @returns {Object} returns this so that calls can be chained.
- */
+ @since elasticsearch 0.90
+ @member ejs.TermsFilter
+ @param {String} idx A valid index name.
+ @returns {Object} returns this so that calls can be chained.
+ */
index: function (idx) {
setupLookup();
if (idx == null) {
return filter.terms[field].index;
}
-
+
filter.terms[field].index = idx;
return this;
},
/**
- Sets the type the document containing the terms when performing a
- terms lookup.
+ Sets the type the document containing the terms when performing a
+ terms lookup.
- @since elasticsearch 0.90
- @member ejs.TermsFilter
- @param {String} type A valid type name.
- @returns {Object} returns this so that calls can be chained.
- */
+ @since elasticsearch 0.90
+ @member ejs.TermsFilter
+ @param {String} type A valid type name.
+ @returns {Object} returns this so that calls can be chained.
+ */
type: function (type) {
setupLookup();
if (type == null) {
return filter.terms[field].type;
}
-
+
filter.terms[field].type = type;
return this;
},
/**
- Sets the document id of the document containing the terms to use
- when performing a terms lookup.
+ Sets the document id of the document containing the terms to use
+ when performing a terms lookup.
- @since elasticsearch 0.90
- @member ejs.TermsFilter
- @param {String} id A valid index name.
- @returns {Object} returns this so that calls can be chained.
- */
+ @since elasticsearch 0.90
+ @member ejs.TermsFilter
+ @param {String} id A valid index name.
+ @returns {Object} returns this so that calls can be chained.
+ */
id: function (id) {
setupLookup();
if (id == null) {
return filter.terms[field].id;
}
-
+
filter.terms[field].id = id;
return this;
},
-
- /**
- Sets the path/field name where the terms in the source document
- are located when performing a terms lookup.
- @since elasticsearch 0.90
- @member ejs.TermsFilter
- @param {String} path A valid index name.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the path/field name where the terms in the source document
+ are located when performing a terms lookup.
+
+ @since elasticsearch 0.90
+ @member ejs.TermsFilter
+ @param {String} path A valid index name.
+ @returns {Object} returns this so that calls can be chained.
+ */
path: function (path) {
setupLookup();
if (path == null) {
return filter.terms[field].path;
}
-
+
filter.terms[field].path = path;
return this;
},
-
- /**
- Sets the way terms filter executes is by iterating over the terms
- provided and finding matches docs (loading into a bitset) and
- caching it. Valid values are: plain, bool, bool_nocache, and,
- and_nocache, or, or_nocache. Defaults to plain.
- @member ejs.TermsFilter
- @param {String} e A valid execution method.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the way terms filter executes is by iterating over the terms
+ provided and finding matches docs (loading into a bitset) and
+ caching it. Valid values are: plain, bool, bool_nocache, and,
+ and_nocache, or, or_nocache. Defaults to plain.
+
+ @member ejs.TermsFilter
+ @param {String} e A valid execution method.
+ @returns {Object} returns this so that calls can be chained.
+ */
execution: function (e) {
if (e == null) {
return filter.terms.execution;
}
-
+
e = e.toLowerCase();
- if (e === 'plain' || e === 'bool' || e === 'bool_nocache' ||
+ if (e === 'plain' || e === 'bool' || e === 'bool_nocache' ||
e === 'and' || e === 'and_nocache' || e === 'or' || e === 'or_nocache') {
filter.terms.execution = e;
}
-
+
return this;
},
-
- /**
- Sets the filter name.
- @member ejs.TermsFilter
- @param {String} name A name for the filter.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the filter name.
+
+ @member ejs.TermsFilter
+ @param {String} name A name for the filter.
+ @returns {Object} returns this so that calls can be chained.
+ */
name: function (name) {
if (name == null) {
return filter.terms._name;
@@ -7968,12 +8142,12 @@
},
/**
- Enable or disable caching of the filter
+ Enable or disable caching of the filter
- @member ejs.TermsFilter
- @param {Boolean} trueFalse True to cache the filter, false otherwise.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.TermsFilter
+ @param {Boolean} trueFalse True to cache the filter, false otherwise.
+ @returns {Object} returns this so that calls can be chained.
+ */
cache: function (trueFalse) {
if (trueFalse == null) {
return filter.terms._cache;
@@ -7982,14 +8156,14 @@
filter.terms._cache = trueFalse;
return this;
},
-
- /**
- Sets the cache key.
- @member ejs.TermsFilter
- @param {String} key the cache key as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the cache key.
+
+ @member ejs.TermsFilter
+ @param {String} key the cache key as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
cacheKey: function (key) {
if (key == null) {
return filter.terms._cache_key;
@@ -7998,34 +8172,34 @@
filter.terms._cache_key = key;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.TermsFilter
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.TermsFilter
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(filter);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.TermsFilter
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.TermsFilter
+ @returns {String} the type of object
+ */
_type: function () {
return 'filter';
},
-
- /**
- Retrieves the internal filter object. This is typically used by
- internal API functions so use with caution.
- @member ejs.TermsFilter
- @returns {String} returns this object's internal filter property.
- */
+ /**
+ Retrieves the internal filter object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.TermsFilter
+ @returns {String} returns this object's internal filter property.
+ */
_self: function () {
return filter;
}
@@ -8033,24 +8207,24 @@
};
/**
- @class
- get()
+ The internal filter object. Use get()
- @member ejs.TypeFilter
- @property {Object} filter
- */
+ @member ejs.TypeFilter
+ @property {Object} filter
+ */
var filter = {
"type": {
"value": type
@@ -8060,47 +8234,47 @@
return {
/**
- * Sets the type
+ * Sets the type
- @member ejs.TypeFilter
- @param {String} type the index type to filter on
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.TypeFilter
+ @param {String} type the index type to filter on
+ @returns {Object} returns this so that calls can be chained.
+ */
type: function (type) {
if (type == null) {
return filter.type.value;
}
-
+
filter.type.value = type;
return this;
},
/**
- Returns the filter container as a JSON string
+ Returns the filter container as a JSON string
- @member ejs.TypeFilter
- @returns {String} JSON representation of the notFilter object
- */
+ @member ejs.TypeFilter
+ @returns {String} JSON representation of the notFilter object
+ */
toString: function () {
return JSON.stringify(filter);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.TypeFilter
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.TypeFilter
+ @returns {String} the type of object
+ */
_type: function () {
return 'filter';
},
-
- /**
- Returns the filter object.
- @member ejs.TypeFilter
- @returns {Object} filter object
- */
+ /**
+ Returns the filter object.
+
+ @member ejs.TypeFilter
+ @returns {Object} filter object
+ */
_self: function () {
return filter;
}
@@ -8108,516 +8282,473 @@
};
/**
- @class
- Document object provides an interface for working with
- Documents. Some example operations avaiable are storing documents,
- retreiving documents, updating documents, and deleting documents from an
- index.Document object provides an interface for working with
+ Documents. Some example operations avaiable are storing documents,
+ retreiving documents, updating documents, and deleting documents from an
+ index.this so that calls can be chained.
- */
+ @member ejs.Document
+ @param {String} idx The index name
+ @returns {Object} returns this so that calls can be chained.
+ */
index: function (idx) {
if (idx == null) {
return index;
}
-
+
index = idx;
return this;
},
-
- /**
- Sets the type of the document.
- @member ejs.Document
- @param {String} t The type name
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the type of the document.
+
+ @member ejs.Document
+ @param {String} t The type name
+ @returns {Object} returns this so that calls can be chained.
+ */
type: function (t) {
if (t == null) {
return type;
}
-
+
type = t;
return this;
},
-
- /**
- Sets the id of the document.
- @member ejs.Document
- @param {String} i The document id
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the id of the document.
+
+ @member ejs.Document
+ @param {String} i The document id
+ @returns {Object} returns this so that calls can be chained.
+ */
id: function (i) {
if (i == null) {
return id;
}
-
+
id = i;
return this;
},
-
+
/**
- index, delete, get, and updatethis so that calls can be chained.
- */
+ index, delete, get, and updatethis so that calls can be chained.
+ */
routing: function (route) {
if (route == null) {
return params.routing;
}
-
+
params.routing = route;
return this;
},
-
+
/**
- index, delete, get, and update.this so that calls can be chained.
- */
+ index, delete, get, and update.this so that calls can be chained.
+ */
parent: function (parent) {
if (parent == null) {
return params.parent;
}
-
+
params.parent = parent;
return this;
},
-
+
/**
- index and updatethis so that calls can be chained.
- */
+ index and updatethis so that calls can be chained.
+ */
timestamp: function (ts) {
if (ts == null) {
return params.timestamp;
}
-
+
params.timestamp = ts;
return this;
},
-
+
/**
-
The provided ttl must be strictly positive and can be a number (in milliseconds)
- or any valid time value such as "1d", "2h", "5m", etc.
This option is valid during the following operations:
- index and update
The provided ttl must be strictly positive and can be a number (in milliseconds)
+ or any valid time value such as "1d", "2h", "5m", etc.
this so that calls can be chained.
- */
+ This option is valid during the following operations:
+ index and update
this so that calls can be chained.
+ */
ttl: function (length) {
if (length == null) {
return params.ttl;
}
-
+
params.ttl = length;
return this;
},
-
+
/**
- Set's a timeout for the given operation.
+Set's a timeout for the given operation.
- If the primary shard has not completed the operation before this value, an error will - occur. The default timeout is 1 minute. The provided timeout must be strictly positive - and can be a number (in milliseconds) or any valid time value such as -"1d", "2h", "5m", etc.
-
- This option is valid during the following operations:
- index, delete, and update
"1d", "2h", "5m", etc.
- @member ejs.Document
- @param {String} length The amount of time after which the operation
- will timeout.
- @returns {Object} returns this so that calls can be chained.
- */
+ This option is valid during the following operations:
+ index, delete, and update
this so that calls can be chained.
+ */
timeout: function (length) {
if (length == null) {
return params.timeout;
}
-
+
params.timeout = length;
return this;
},
-
- /**
- Enables the index to be refreshed immediately after the operation - occurs. This is an advanced setting and can lead to performance - issues.
- -This option is valid during the following operations:
- index, delete, get, and update
this so that calls can be chained.
- */
+ /**
+ Enables the index to be refreshed immediately after the operation + occurs. This is an advanced setting and can lead to performance + issues.
+ +This option is valid during the following operations:
+ index, delete, get, and update
this so that calls can be chained.
+ */
refresh: function (trueFalse) {
if (trueFalse == null) {
return params.refresh;
}
-
+
params.refresh = trueFalse;
return this;
},
-
+
/**
- Sets the document version.
+Sets the document version.
- Used for optimistic concurrency control when set. If the version of the currently - indexed document is less-than or equal to the version specified, an error is produced, - otherwise the operation is permitted. + Used for optimistic concurrency control when set. If the version of the currently + indexed document is less-than or equal to the version specified, an error is produced, + otherwise the operation is permitted. -By default, internal versioning is used that starts at 1 and
- increments with each update.
This option is valid during the following operations:
- index, delete, and update
By default, internal versioning is used that starts at 1 and
+ increments with each update.
this so that calls can be chained.
- */
+ This option is valid during the following operations:
+ index, delete, and update
this so that calls can be chained.
+ */
version: function (version) {
if (version == null) {
return params.version;
}
-
+
params.version = version;
return this;
},
-
+
/**
- Sets the version type.
+Sets the version type.
- Possible values are: - -internal - the defaultexternal - to use your own version (ie. version number from a database)This option is valid during the following operations:
- index, delete, and update
this so that calls can be chained.
- */
+ internal - the defaultexternal - to use your own version (ie. version number from a database)This option is valid during the following operations:
+ index, delete, and update
this so that calls can be chained.
+ */
versionType: function (vt) {
// internal or external
if (vt == null) {
return params.version_type;
}
-
+
vt = vt.toLowerCase();
if (vt === 'internal' || vt === 'external') {
params.version_type = vt;
}
-
+
return this;
},
-
+
/**
- Perform percolation at index time.
+Perform percolation at index time.
-Set to * to run document against all registered queries. It is also possible
- to set this value to a string in query string format, ie. "color:green".
This option is valid during the following operations:
- index and update
Set to * to run document against all registered queries. It is also possible
+ to set this value to a string in query string format, ie. "color:green".
this so that calls can be chained.
- */
+ This option is valid during the following operations:
+ index and update
this so that calls can be chained.
+ */
percolate: function (qry) {
if (qry == null) {
return params.percolate;
}
-
+
params.percolate = qry;
return this;
},
-
+
/**
- Sets the indexing operation type.
+Sets the indexing operation type.
-Valid values are:
- -index - the default, create or replacecreate - create onlyThis option is valid during the following operations:
- index
Valid values are:
- @member ejs.Document - @param {String} op The operation type (index or create) - @returns {Object} returnsthis so that calls can be chained.
- */
+ index - the default, create or replacecreate - create onlyThis option is valid during the following operations:
+ index
this so that calls can be chained.
+ */
opType: function (op) {
if (op == null) {
return params.op_type;
}
-
+
op = op.toLowerCase();
if (op === 'index' || op === 'create') {
params.op_type = op;
}
-
+
return this;
},
-
+
/**
- Sets the replication mode.
+Sets the replication mode.
-Valid values are:
- -async - asynchronous replication to slavessync - synchronous replication to the slavesdefault - the currently configured system default.This option is valid during the following operations:
- index, delete, and update
Valid values are:
- @member ejs.Document - @param {String} r The replication mode (async, sync, or default) - @returns {Object} returnsthis so that calls can be chained.
- */
+ async - asynchronous replication to slavessync - synchronous replication to the slavesdefault - the currently configured system default.This option is valid during the following operations:
+ index, delete, and update
this so that calls can be chained.
+ */
replication: function (r) {
if (r == null) {
return params.replication;
}
-
+
r = r.toLowerCase();
if (r === 'async' || r === 'sync' || r === 'default') {
params.replication = r;
}
-
+
return this;
},
-
+
/**
- Sets the write consistency.
+Sets the write consistency.
-Valid values are:
- -one - only requires write to one shardquorum - requires writes to quorum (N/2 + 1)all - requires write to succeed on all shardsdefault - the currently configured system defaultThis option is valid during the following operations:
- index, delete, and update
Valid values are:
- @member ejs.Document - @param {String} c The write consistency (one, quorum, all, or default) - @returns {Object} returnsthis so that calls can be chained.
- */
+ one - only requires write to one shardquorum - requires writes to quorum (N/2 + 1)all - requires write to succeed on all shardsdefault - the currently configured system defaultThis option is valid during the following operations:
+ index, delete, and update
this so that calls can be chained.
+ */
consistency: function (c) {
if (c == null) {
return params.consistency;
}
-
+
c = c.toLowerCase();
if (c === 'default' || c === 'one' || c === 'quorum' || c === 'all') {
params.consistency = c;
}
-
+
return this;
},
-
+
/**
- Sets the preference of which shard replicas to execute the get - request on.
+Sets the preference of which shard replicas to execute the get + request on.
-By default, the operation is randomized between the shard replicas. - This value can be:
- -_primary - execute only on the primary shard_local - the local shard if possibleany string value - to guarentee the same shards will always be usedThis option is valid during the following operations:
- get
By default, the operation is randomized between the shard replicas. + This value can be:
- @member ejs.Document - @param {String} p The preference value as a string - @returns {Object} returnsthis so that calls can be chained.
- */
+ _primary - execute only on the primary shard_local - the local shard if possibleany string value - to guarentee the same shards will always be usedThis option is valid during the following operations:
+ get
this so that calls can be chained.
+ */
preference: function (p) {
if (p == null) {
return params.preference;
}
-
+
params.preference = p;
return this;
},
-
- /**
- Sets if the get request is performed in realtime or waits for - the indexing operations to complete. By default it is realtime.
- -This option is valid during the following operations:
- get
this so that calls can be chained.
- */
+ /**
+ Sets if the get request is performed in realtime or waits for + the indexing operations to complete. By default it is realtime.
+ +This option is valid during the following operations:
+ get
this so that calls can be chained.
+ */
realtime: function (trueFalse) {
if (trueFalse == null) {
return params.realtime;
}
-
+
params.realtime = trueFalse;
return this;
},
-
+
/**
- Sets the fields of the document to return.
+Sets the fields of the document to return.
-By default the _source field is returned. Pass a single value
- to append to the current list of fields, pass an array to overwrite the current
- list of fields. The returned fields will either be loaded if they are stored,
- or fetched from the _source
This option is valid during the following operations:
- get and update
By default the _source field is returned. Pass a single value
+ to append to the current list of fields, pass an array to overwrite the current
+ list of fields. The returned fields will either be loaded if they are stored,
+ or fetched from the _source
this so that calls can be chained.
- */
+ This option is valid during the following operations:
+ get and update
this so that calls can be chained.
+ */
fields: function (fields) {
if (params.fields == null) {
params.fields = [];
}
-
+
if (fields == null) {
return params.fields;
}
-
+
if (isString(fields)) {
params.fields.push(fields);
} else if (isArray(fields)) {
@@ -8625,241 +8756,242 @@
} else {
throw new TypeError('Argument must be string or array');
}
-
+
return this;
},
-
- /**
- Sets the update script.
- -This option is valid during the following operations:
- update
this so that calls can be chained.
- */
+ /**
+ Sets the update script.
+ +This option is valid during the following operations:
+ update
this so that calls can be chained.
+ */
script: function (script) {
if (script == null) {
return params.script;
}
-
+
params.script = script;
return this;
},
-
- /**
- Sets the update script lanauge. Defaults to mvel
This option is valid during the following operations:
- update
this so that calls can be chained.
- */
+ /**
+ Sets the update script lanauge. Defaults to mvel
This option is valid during the following operations:
+ update
this so that calls can be chained.
+ */
lang: function (lang) {
if (lang == null) {
return params.lang;
}
-
+
params.lang = lang;
return this;
},
-
+
/**
- Sets the parameters sent to the update script.
+Sets the parameters sent to the update script.
-The params must be an object where the key is the parameter name and - the value is the parameter value to use in the script.
- -This option is valid during the following operations:
- update
The params must be an object where the key is the parameter name and + the value is the parameter value to use in the script.
- @member ejs.Document - @param {Object} p a object with script parameters. - @returns {Object} returnsthis so that calls can be chained.
- */
+ This option is valid during the following operations:
+ update
this so that calls can be chained.
+ */
params: function (p) {
// accept object, prefix keys as sp_{key}
if (p == null) {
return params.params;
}
-
+
if (!isObject(p)) {
throw new TypeError('Argument must be an object');
}
-
+
params.params = p;
return this;
},
-
- /**
- Sets how many times to retry if there is a version conflict - between getting the document and indexing / deleting it.
-Defaults to 0.
+ /** +
Sets how many times to retry if there is a version conflict + between getting the document and indexing / deleting it.
-This option is valid during the following operations:
- update
Defaults to 0.
- @member ejs.Document
- @param {Integer} num the number of times to retry operation.
- @returns {Object} returns this so that calls can be chained.
- */
+
This option is valid during the following operations:
+ update
this so that calls can be chained.
+ */
retryOnConflict: function (num) {
if (num == null) {
return params.retry_on_conflict;
}
-
+
params.retry_on_conflict = num;
return this;
},
-
+
/**
- Sets the upsert document.
- -The upsert document is used during updates when the specified document - you are attempting to update does not exist.
+Sets the upsert document.
-This option is valid during the following operations:
- update
The upsert document is used during updates when the specified document + you are attempting to update does not exist.
- @member ejs.Document - @param {Object} doc the upset document. - @returns {Object} returnsthis so that calls can be chained.
- */
+ This option is valid during the following operations:
+ update
this so that calls can be chained.
+ */
upsert: function (doc) {
if (doc == null) {
return params.upsert;
}
-
+
if (!isObject(doc)) {
throw new TypeError('Argument must be an object');
}
-
+
params.upsert = doc;
return this;
},
-
+
/**
- Sets the source document.
+Sets the source document.
-When set during an update operation, it is used as the partial update document.
+When set during an update operation, it is used as the partial update document.
-This option is valid during the following operations:
- index and update
This option is valid during the following operations:
+ index and update
this so that calls can be chained.
- */
+ @member ejs.Document
+ @param {Object} doc the source document.
+ @returns {Object} returns this so that calls can be chained.
+ */
source: function (doc) {
if (doc == null) {
return params.source;
}
-
+
if (!isObject(doc)) {
throw new TypeError('Argument must be an object');
}
-
+
params.source = doc;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.Document - @returns {String} returns this object as a serialized JSON string. - */ + /** +Allows you to serialize this object into a JSON encoded string.
+ + @member ejs.Document + @returns {String} returns this object as a serialized JSON string. + */ toString: function () { return JSON.stringify(params); }, - + /** -The type of ejs object. For internal use only.
- - @member ejs.Document - @returns {String} the type of object - */ +The type of ejs object. For internal use only.
+ + @member ejs.Document + @returns {String} the type of object + */ _type: function () { return 'document'; }, - - /** -Retrieves the internal document object. This is
- typically used by internal API functions so use with caution.
Retrieves the internal document object. This is
+ typically used by internal API functions so use with caution.
Retrieves a document from the given index and type.
- @member ejs.Document - @param {Function} successcb A callback function that handles the response. - @param {Function} errorcb A callback function that handles errors. - @returns {Object} The return value is dependent on client implementation. - */ + /** +Retrieves a document from the given index and type.
+ + @member ejs.Document + @param {Function} successcb A callback function that handles the response. + @param {Function} errorcb A callback function that handles errors. + @returns {Object} The return value is dependent on client implementation. + */ doGet: function (successcb, errorcb) { // make sure the user has set a client if (ejs.client == null) { throw new Error("No Client Set"); } - + if (index == null || type == null || id == null) { throw new Error('Index, Type, and ID must be set'); } - + // we don't need to convert the client params to a string // on get requests, just create the url and pass the client // params as the data var url = '/' + index + '/' + type + '/' + id; - - return ejs.client.get(url, genClientParams(), successcb, errorcb); + + return ejs.client.get(url, genClientParams(params, paramExcludes), + successcb, errorcb); }, /** -Stores a document in the given index and type. If no id - is set, one is created during indexing.
+Stores a document in the given index and type. If no id + is set, one is created during indexing.
- @member ejs.Document - @param {Function} successcb A callback function that handles the response. - @param {Function} errorcb A callback function that handles errors. - @returns {Object} The return value is dependent on client implementation. - */ + @member ejs.Document + @param {Function} successcb A callback function that handles the response. + @param {Function} errorcb A callback function that handles errors. + @returns {Object} The return value is dependent on client implementation. + */ doIndex: function (successcb, errorcb) { // make sure the user has set a client if (ejs.client == null) { throw new Error("No Client Set"); } - + if (index == null || type == null) { throw new Error('Index and Type must be set'); } - + if (params.source == null) { throw new Error('No source document found'); } - + var url = '/' + index + '/' + type, data = JSON.stringify(params.source), - paramStr = genParamStr(), + paramStr = genParamStr(params, paramExcludes), response; - + if (id != null) { url = url + '/' + id; } - + if (paramStr !== '') { url = url + '?' + paramStr; } - + // do post if id not set so one is created if (id == null) { response = ejs.client.post(url, data, successcb, errorcb); @@ -8867,96 +8999,96 @@ // put when id is specified response = ejs.client.put(url, data, successcb, errorcb); } - + return response; }, /** -Updates a document in the given index and type.
+Updates a document in the given index and type.
-If the document is not found in the index, the "upsert" value is used - if set. The document is updated via an update script or partial document.
+If the document is not found in the index, the "upsert" value is used + if set. The document is updated via an update script or partial document.
-To use a script, set the script option, to use a - partial document, set the source with the partial document.
+To use a script, set the script option, to use a + partial document, set the source with the partial document.
- @member ejs.Document - @param {Function} successcb A callback function that handles the response. - @param {Function} errorcb A callback function that handles errors. - @returns {Object} The return value is dependent on client implementation. - */ + @member ejs.Document + @param {Function} successcb A callback function that handles the response. + @param {Function} errorcb A callback function that handles errors. + @returns {Object} The return value is dependent on client implementation. + */ doUpdate: function (successcb, errorcb) { // make sure the user has set a client if (ejs.client == null) { throw new Error("No Client Set"); } - + if (index == null || type == null || id == null) { throw new Error('Index, Type, and ID must be set'); } - + if (params.script == null && params.source == null) { throw new Error('Update script or document required'); } - + var url = '/' + index + '/' + type + '/' + id + '/_update', data = {}, - paramStr = genParamStr(); - + paramStr = genParamStr(params, paramExcludes); + if (paramStr !== '') { url = url + '?' + paramStr; } - + if (params.script != null) { data.script = params.script; } - + if (params.lang != null) { data.lang = params.lang; } - + if (params.params != null) { data.params = params.params; } - + if (params.upsert != null) { data.upsert = params.upsert; } - + if (params.source != null) { data.doc = params.source; } - + return ejs.client.post(url, JSON.stringify(data), successcb, errorcb); }, /** -Deletes the document from the given index and type using the - speciifed id.
+Deletes the document from the given index and type using the + speciifed id.
- @member ejs.Document - @param {Function} successcb A callback function that handles the response. - @param {Function} errorcb A callback function that handles errors. - @returns {void} Returns the value of the callback when executing on the server. - */ + @member ejs.Document + @param {Function} successcb A callback function that handles the response. + @param {Function} errorcb A callback function that handles errors. + @returns {void} Returns the value of the callback when executing on the server. + */ doDelete: function (successcb, errorcb) { // make sure the user has set a client if (ejs.client == null) { throw new Error("No Client Set"); } - + if (index == null || type == null || id == null) { throw new Error('Index, Type, and ID must be set'); } - + var url = '/' + index + '/' + type + '/' + id, data = '', - paramStr = genParamStr(); - + paramStr = genParamStr(params, paramExcludes); + if (paramStr !== '') { url = url + '?' + paramStr; } - + return ejs.client.del(url, data, successcb, errorcb); } @@ -8965,25 +9097,25 @@ /** - @class -A boolQuery allows you to build Boolean query constructs
- from individual term or phrase queries. For example you might want to search
- for documents containing the terms javascript and python.
A boolQuery allows you to build Boolean query constructs
+ from individual term or phrase queries. For example you might want to search
+ for documents containing the terms javascript and python.
termQuerys, phraseQuerys or other boolQuerys.
+ @desc
+ A Query that matches documents matching boolean combinations of other
+ queries, e.g. termQuerys, phraseQuerys or other boolQuerys.
- */
+ */
ejs.BoolQuery = function () {
/**
- The internal query object. Use _self()
- @member ejs.BoolQuery
- @property {Object} query
- */
+ The internal query object. Use _self()
+ @member ejs.BoolQuery
+ @property {Object} query
+ */
var query = {
bool: {}
};
@@ -8991,19 +9123,19 @@
return {
/**
- Adds query to boolean container. Given query "must" appear in matching documents.
+ Adds query to boolean container. Given query "must" appear in matching documents.
- @member ejs.BoolQuery
- @param {Object} oQuery A valid Query object
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.BoolQuery
+ @param {Object} oQuery A valid Query object
+ @returns {Object} returns this so that calls can be chained.
+ */
must: function (oQuery) {
var i, len;
-
+
if (query.bool.must == null) {
query.bool.must = [];
}
-
+
if (oQuery == null) {
return query.bool.must;
}
@@ -9016,26 +9148,26 @@
if (!isQuery(oQuery[i])) {
throw new TypeError('Argument must be an array of Queries');
}
-
+
query.bool.must.push(oQuery[i]._self());
}
} else {
throw new TypeError('Argument must be a Query or array of Queries');
}
-
+
return this;
},
/**
- Adds query to boolean container. Given query "must not" appear in matching documents.
+ Adds query to boolean container. Given query "must not" appear in matching documents.
- @member ejs.BoolQuery
- @param {Object} oQuery A valid query object
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.BoolQuery
+ @param {Object} oQuery A valid query object
+ @returns {Object} returns this so that calls can be chained.
+ */
mustNot: function (oQuery) {
var i, len;
-
+
if (query.bool.must_not == null) {
query.bool.must_not = [];
}
@@ -9043,7 +9175,7 @@
if (oQuery == null) {
return query.bool.must_not;
}
-
+
if (isQuery(oQuery)) {
query.bool.must_not.push(oQuery._self());
} else if (isArray(oQuery)) {
@@ -9052,26 +9184,26 @@
if (!isQuery(oQuery[i])) {
throw new TypeError('Argument must be an array of Queries');
}
-
+
query.bool.must_not.push(oQuery[i]._self());
}
} else {
throw new TypeError('Argument must be a Query or array of Queries');
}
-
+
return this;
},
/**
- Adds query to boolean container. Given query "should" appear in matching documents.
+ Adds query to boolean container. Given query "should" appear in matching documents.
- @member ejs.BoolQuery
- @param {Object} oQuery A valid query object
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.BoolQuery
+ @param {Object} oQuery A valid query object
+ @returns {Object} returns this so that calls can be chained.
+ */
should: function (oQuery) {
var i, len;
-
+
if (query.bool.should == null) {
query.bool.should = [];
}
@@ -9079,7 +9211,7 @@
if (oQuery == null) {
return query.bool.should;
}
-
+
if (isQuery(oQuery)) {
query.bool.should.push(oQuery._self());
} else if (isArray(oQuery)) {
@@ -9088,23 +9220,23 @@
if (!isQuery(oQuery[i])) {
throw new TypeError('Argument must be an array of Queries');
}
-
+
query.bool.should.push(oQuery[i]._self());
}
} else {
throw new TypeError('Argument must be a Query or array of Queries');
}
-
+
return this;
},
/**
- Sets the boost value for documents matching the Query.
+ Sets the boost value for documents matching the Query.
- @member ejs.BoolQuery
- @param {Double} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.BoolQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.bool.boost;
@@ -9115,13 +9247,13 @@
},
/**
- Enables or disables similarity coordinate scoring of documents
- matching the Query. Default: false.
+ Enables or disables similarity coordinate scoring of documents
+ matching the Query. Default: false.
- @member ejs.BoolQuery
- @param {String} trueFalse A true/falsethis so that calls can be chained.
- */
+ @member ejs.BoolQuery
+ @param {String} trueFalse A true/falsethis so that calls can be chained.
+ */
disableCoord: function (trueFalse) {
if (trueFalse == null) {
return query.bool.disable_coord;
@@ -9132,20 +9264,20 @@
},
/**
- Sets the number of optional clauses that must match.
- -By default no optional clauses are necessary for a match - (unless there are no required clauses). If this method is used, - then the specified number of clauses is required.
+Sets the number of optional clauses that must match.
-Use of this method is totally independent of specifying that - any specific clauses are required (or prohibited). This number will - only be compared against the number of matching optional clauses.
- - @member ejs.BoolQuery - @param {Integer} minMatch A positiveinteger value.
- @returns {Object} returns this so that calls can be chained.
- */
+ By default no optional clauses are necessary for a match + (unless there are no required clauses). If this method is used, + then the specified number of clauses is required.
+ +Use of this method is totally independent of specifying that + any specific clauses are required (or prohibited). This number will + only be compared against the number of matching optional clauses.
+ + @member ejs.BoolQuery + @param {Integer} minMatch A positiveinteger value.
+ @returns {Object} returns this so that calls can be chained.
+ */
minimumNumberShouldMatch: function (minMatch) {
if (minMatch == null) {
return query.bool.minimum_number_should_match;
@@ -9156,32 +9288,32 @@
},
/**
- Allows you to serialize this object into a JSON encoded string.
+ Allows you to serialize this object into a JSON encoded string.
- @member ejs.BoolQuery
- @returns {String} returns this object as a serialized JSON string.
- */
+ @member ejs.BoolQuery
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.BoolQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.BoolQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
- /**
- Retrieves the internal query object. This is typically used by
- internal API functions so use with caution.
- @member ejs.BoolQuery
- @returns {String} returns this object's internal query property.
- */
+ /**
+ Retrieves the internal query object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.BoolQuery
+ @returns {String} returns this object's internal query property.
+ */
_self: function () {
return query;
}
@@ -9189,33 +9321,33 @@
};
/**
- @class
- The boosting query can be used to effectively demote results that match - a given query. Unlike the “NOT” clause in bool query, this still selects - documents that contain undesirable terms, but reduces their overall - score.
+ @class +The boosting query can be used to effectively demote results that match + a given query. Unlike the “NOT” clause in bool query, this still selects + documents that contain undesirable terms, but reduces their overall + score.
- @name ejs.BoostingQuery + @name ejs.BoostingQuery - @desc -Constructs a query that can demote search results. A negative boost.
+ @desc +Constructs a query that can demote search results. A negative boost.
- @param {Object} positiveQry Valid query object used to select all matching docs. - @param {Object} negativeQry Valid query object to match the undesirable docs - returned within the positiveQry result set. - @param {Double} negativeBoost A double value where 0 < n < 1. - */ + @param {Object} positiveQry Valid query object used to select all matching docs. + @param {Object} negativeQry Valid query object to match the undesirable docs + returned within the positiveQry result set. + @param {Double} negativeBoost A double value where 0 < n < 1. + */ ejs.BoostingQuery = function (positiveQry, negativeQry, negativeBoost) { if (!isQuery(positiveQry) || !isQuery(negativeQry)) { throw new TypeError('Arguments must be Queries'); } - + /** - The internal Query object. Use_self().
- @member ejs.BoostingQuery
- @property {Object} BoostingQuery
- */
+ The internal Query object. Use _self().
+ @member ejs.BoostingQuery
+ @property {Object} BoostingQuery
+ */
var query = {
boosting: {
positive: positiveQry._self(),
@@ -9225,59 +9357,59 @@
};
return {
-
- /**
- Sets the "master" query that determines which results are returned.
- @member ejs.BoostingQuery
- @param {Object} oQuery A valid Query object
- @returns {Object} returns this so that calls can be
- chained. Returns {Object} current positive query if oQuery is
- not specified.
- */
+ /**
+ Sets the "master" query that determines which results are returned.
+
+ @member ejs.BoostingQuery
+ @param {Object} oQuery A valid Query object
+ @returns {Object} returns this so that calls can be
+ chained. Returns {Object} current positive query if oQuery is
+ not specified.
+ */
positive: function (oQuery) {
if (oQuery == null) {
return query.boosting.positive;
}
-
+
if (!isQuery(oQuery)) {
throw new TypeError('Argument must be a Query');
}
-
+
query.boosting.positive = oQuery._self();
return this;
},
/**
- Sets the query used to match documents in the positive
- query that will be negatively boosted.
+ Sets the query used to match documents in the positive
+ query that will be negatively boosted.
- @member ejs.BoostingQuery
- @param {Object} oQuery A valid Query object
- @returns {Object} returns this so that calls can be
- chained. Returns {Object} current negative query if oQuery is
- not specified.
- */
+ @member ejs.BoostingQuery
+ @param {Object} oQuery A valid Query object
+ @returns {Object} returns this so that calls can be
+ chained. Returns {Object} current negative query if oQuery is
+ not specified.
+ */
negative: function (oQuery) {
if (oQuery == null) {
return query.boosting.negative;
}
-
+
if (!isQuery(oQuery)) {
throw new TypeError('Argument must be a Query');
}
-
+
query.boosting.negative = oQuery._self();
return this;
},
-
- /**
- Sets the negative boost value.
- @member ejs.BoostingQuery
- @param {Double} boost A positive double value where 0 < n < 1.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the negative boost value.
+
+ @member ejs.BoostingQuery
+ @param {Double} boost A positive double value where 0 < n < 1.
+ @returns {Object} returns this so that calls can be chained.
+ */
negativeBoost: function (negBoost) {
if (negBoost == null) {
return query.boosting.negative_boost;
@@ -9286,14 +9418,14 @@
query.boosting.negative_boost = negBoost;
return this;
},
-
- /**
- Sets the boost value of the Query.
- @member ejs.BoostingQuery
- @param {Double} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the boost value of the Query.
+
+ @member ejs.BoostingQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.boosting.boost;
@@ -9304,31 +9436,31 @@
},
/**
- Serializes the internal query object as a JSON string.
- @member ejs.BoostingQuery
- @returns {String} Returns a JSON representation of the Query object.
- */
+ Serializes the internal query object as a JSON string.
+ @member ejs.BoostingQuery
+ @returns {String} Returns a JSON representation of the Query object.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.BoostingQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.BoostingQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
+
/**
- This method is used to retrieve the raw query object. It's designed
- for internal use when composing and serializing queries.
-
- @member ejs.BoostingQuery
- @returns {Object} Returns the object's query property.
- */
+ This method is used to retrieve the raw query object. It's designed
+ for internal use when composing and serializing queries.
+
+ @member ejs.BoostingQuery
+ @returns {Object} Returns the object's query property.
+ */
_self: function () {
return query;
}
@@ -9336,65 +9468,65 @@
};
/**
- @class
- A query that executes high-frequency terms in a optional sub-query to - prevent slow queries due to "common" terms like stopwords.
- -This query basically builds two queries out of the terms in the query - string where low-frequency terms are added to a required boolean clause and - high-frequency terms are added to an optional boolean clause. The optional - clause is only executed if the required "low-frequency' clause matches.
- -CommonTermsQuery has several advantages over stopword
- filtering at index or query time since a term can be "classified" based on
- the actual document frequency in the index and can prevent slow queries even
- across domains without specialized stopword files.
A query that executes high-frequency terms in a optional sub-query to + prevent slow queries due to "common" terms like stopwords.
- @param {String} field the document field/key to query against - @param {String} qstr the query string - */ +This query basically builds two queries out of the terms in the query + string where low-frequency terms are added to a required boolean clause and + high-frequency terms are added to an optional boolean clause. The optional + clause is only executed if the required "low-frequency' clause matches.
+ +CommonTermsQuery has several advantages over stopword
+ filtering at index or query time since a term can be "classified" based on
+ the actual document frequency in the index and can prevent slow queries even
+ across domains without specialized stopword files.
Use get()
- @member ejs.CommonTermsQuery
- @property {Object} query
- */
+ The internal query object. Use get()
+ @member ejs.CommonTermsQuery
+ @property {Object} query
+ */
var query = {
common: {}
};
-
+
// support for full Builder functionality where no constructor is used
// use dummy field until one is set
if (field == null) {
field = 'no_field_set';
}
-
+
query.common[field] = {};
-
+
// only set the query is one is passed in
if (qstr != null) {
query.common[field].query = qstr;
}
-
+
return {
/**
- Sets the field to query against.
+ Sets the field to query against.
- @member ejs.CommonTermsQuery
- @param {String} f A valid field name.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.CommonTermsQuery
+ @param {String} f A valid field name.
+ @returns {Object} returns this so that calls can be chained.
+ */
field: function (f) {
var oldValue = query.common[field];
-
+
if (f == null) {
return field;
}
@@ -9402,17 +9534,17 @@
delete query.common[field];
field = f;
query.common[f] = oldValue;
-
+
return this;
},
-
- /**
- Sets the query string.
- @member ejs.CommonTermsQuery
- @param {String} qstr The query string.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the query string.
+
+ @member ejs.CommonTermsQuery
+ @param {String} qstr The query string.
+ @returns {Object} returns this so that calls can be chained.
+ */
query: function (qstr) {
if (qstr == null) {
return query.common[field].query;
@@ -9423,12 +9555,12 @@
},
/**
- Sets the analyzer name used to analyze the Query object.
+ Sets the analyzer name used to analyze the Query object.
- @member ejs.CommonTermsQuery
- @param {String} analyzer A valid analyzer name.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.CommonTermsQuery
+ @param {String} analyzer A valid analyzer name.
+ @returns {Object} returns this so that calls can be chained.
+ */
analyzer: function (analyzer) {
if (analyzer == null) {
return query.common[field].analyzer;
@@ -9437,15 +9569,15 @@
query.common[field].analyzer = analyzer;
return this;
},
-
- /**
- Enables or disables similarity coordinate scoring of documents
- commoning the Query. Default: false.
- @member ejs.CommonTermsQuery
- @param {String} trueFalse A true/falsethis so that calls can be chained.
- */
+ /**
+ Enables or disables similarity coordinate scoring of documents
+ commoning the Query. Default: false.
+
+ @member ejs.CommonTermsQuery
+ @param {String} trueFalse A true/falsethis so that calls can be chained.
+ */
disableCoords: function (trueFalse) {
if (trueFalse == null) {
return query.common[field].disable_coords;
@@ -9454,15 +9586,15 @@
query.common[field].disable_coords = trueFalse;
return this;
},
-
- /**
- Sets the maximum threshold/frequency to be considered a low
- frequency term. Set to a value between 0 and 1.
- @member ejs.CommonTermsQuery
- @param {Number} freq A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the maximum threshold/frequency to be considered a low
+ frequency term. Set to a value between 0 and 1.
+
+ @member ejs.CommonTermsQuery
+ @param {Number} freq A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
cutoffFrequency: function (freq) {
if (freq == null) {
return query.common[field].cutoff_frequency;
@@ -9473,13 +9605,13 @@
},
/**
- Sets the boolean operator to be used for high frequency terms.
- Default: AND
+ Sets the boolean operator to be used for high frequency terms.
+ Default: AND
- @member ejs.CommonTermsQuery
- @param {String} op Any of "and" or "or", no quote characters.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.CommonTermsQuery
+ @param {String} op Any of "and" or "or", no quote characters.
+ @returns {Object} returns this so that calls can be chained.
+ */
highFreqOperator: function (op) {
if (op == null) {
return query.common[field].high_freq_operator;
@@ -9492,15 +9624,15 @@
return this;
},
-
+
/**
- Sets the boolean operator to be used for low frequency terms.
- Default: AND
-
- @member ejs.CommonTermsQuery
- @param {String} op Any of "and" or "or", no quote characters.
- @returns {Object} returns this so that calls can be chained.
- */
+ Sets the boolean operator to be used for low frequency terms.
+ Default: AND
+
+ @member ejs.CommonTermsQuery
+ @param {String} op Any of "and" or "or", no quote characters.
+ @returns {Object} returns this so that calls can be chained.
+ */
lowFreqOperator: function (op) {
if (op == null) {
return query.common[field].low_freq_operator;
@@ -9513,31 +9645,31 @@
return this;
},
-
- /**
- Sets the minimum number of common that need to common in a document
- before that document is returned in the results.
- @member ejs.CommonTermsQuery
- @param {Integer} min A positive integer.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the minimum number of common that need to common in a document
+ before that document is returned in the results.
+
+ @member ejs.CommonTermsQuery
+ @param {Integer} min A positive integer.
+ @returns {Object} returns this so that calls can be chained.
+ */
minimumShouldMatch: function (min) {
if (min == null) {
return query.common[field].minimum_should_match;
}
-
+
query.common[field].minimum_should_match = min;
return this;
},
/**
- Sets the boost value for documents commoning the Query.
+ Sets the boost value for documents commoning the Query.
- @member ejs.CommonTermsQuery
- @param {Number} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.CommonTermsQuery
+ @param {Number} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.common[field].boost;
@@ -9546,34 +9678,34 @@
query.common[field].boost = boost;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.CommonTermsQuery
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.CommonTermsQuery
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.CommonTermsQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.CommonTermsQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
- /**
- Retrieves the internal query object. This is typically used by
- internal API functions so use with caution.
- @member ejs.CommonTermsQuery
- @returns {String} returns this object's internal query property.
- */
+ /**
+ Retrieves the internal query object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.CommonTermsQuery
+ @returns {String} returns this object's internal query property.
+ */
_self: function () {
return query;
}
@@ -9581,84 +9713,84 @@
};
/**
- @class
- A constant score query wraps another Query or
- Filter and returns a constant score for each
- result that is equal to the query boost.
A constant score query wraps another Query or
+ Filter and returns a constant score for each
+ result that is equal to the query boost.
Note that lucene's query normalization (queryNorm) attempts - to make scores between different queries comparable. It does not - change the relevance of your query, but it might confuse you when - you look at the score of your documents and they are not equal to - the query boost value as expected. The scores were normalized by - queryNorm, but maintain the same relevance.
+Note that lucene's query normalization (queryNorm) attempts + to make scores between different queries comparable. It does not + change the relevance of your query, but it might confuse you when + you look at the score of your documents and they are not equal to + the query boost value as expected. The scores were normalized by + queryNorm, but maintain the same relevance.
- @name ejs.ConstantScoreQuery + @name ejs.ConstantScoreQuery - @desc -Constructs a query where each documents returned by the internal - query or filter have a constant score equal to the boost factor.
+ @desc +Constructs a query where each documents returned by the internal + query or filter have a constant score equal to the boost factor.
- */ + */ ejs.ConstantScoreQuery = function () { /** - The internal Query object. Use_self().
- @member ejs.ConstantScoreQuery
- @property {Object} query
- */
+ The internal Query object. Use _self().
+ @member ejs.ConstantScoreQuery
+ @property {Object} query
+ */
var query = {
constant_score: {}
};
return {
/**
- Adds the query to apply a constant score to.
+ Adds the query to apply a constant score to.
- @member ejs.ConstantScoreQuery
- @param {Object} oQuery A valid Query object
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.ConstantScoreQuery
+ @param {Object} oQuery A valid Query object
+ @returns {Object} returns this so that calls can be chained.
+ */
query: function (oQuery) {
if (oQuery == null) {
return query.constant_score.query;
}
-
+
if (!isQuery(oQuery)) {
throw new TypeError('Argument must be a Query');
}
-
+
query.constant_score.query = oQuery._self();
return this;
},
/**
- Adds the filter to apply a constant score to.
+ Adds the filter to apply a constant score to.
- @member ejs.ConstantScoreQuery
- @param {Object} oFilter A valid Filter object
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.ConstantScoreQuery
+ @param {Object} oFilter A valid Filter object
+ @returns {Object} returns this so that calls can be chained.
+ */
filter: function (oFilter) {
if (oFilter == null) {
return query.constant_score.filter;
}
-
+
if (!isFilter(oFilter)) {
throw new TypeError('Argument must be a Filter');
}
-
+
query.constant_score.filter = oFilter._self();
return this;
},
/**
- Enables caching of the filter.
+ Enables caching of the filter.
- @member ejs.ConstantScoreQuery
- @param {Boolean} trueFalse A boolean value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.ConstantScoreQuery
+ @param {Boolean} trueFalse A boolean value.
+ @returns {Object} returns this so that calls can be chained.
+ */
cache: function (trueFalse) {
if (trueFalse == null) {
return query.constant_score._cache;
@@ -9667,14 +9799,14 @@
query.constant_score._cache = trueFalse;
return this;
},
-
- /**
- Set the cache key.
- @member ejs.ConstantScoreQuery
- @param {String} k A string cache key.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Set the cache key.
+
+ @member ejs.ConstantScoreQuery
+ @param {String} k A string cache key.
+ @returns {Object} returns this so that calls can be chained.
+ */
cacheKey: function (k) {
if (k == null) {
return query.constant_score._cache_key;
@@ -9683,14 +9815,14 @@
query.constant_score._cache_key = k;
return this;
},
-
- /**
- Sets the boost value of the Query.
- @member ejs.ConstantScoreQuery
- @param {Double} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the boost value of the Query.
+
+ @member ejs.ConstantScoreQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.constant_score.boost;
@@ -9701,31 +9833,31 @@
},
/**
- Serializes the internal query object as a JSON string.
- @member ejs.ConstantScoreQuery
- @returns {String} Returns a JSON representation of the Query object.
- */
+ Serializes the internal query object as a JSON string.
+ @member ejs.ConstantScoreQuery
+ @returns {String} Returns a JSON representation of the Query object.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.ConstantScoreQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.ConstantScoreQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
+
/**
- This method is used to retrieve the raw query object. It's designed
- for internal use when composing and serializing queries.
-
- @member ejs.ConstantScoreQuery
- @returns {Object} Returns the object's query property.
- */
+ This method is used to retrieve the raw query object. It's designed
+ for internal use when composing and serializing queries.
+
+ @member ejs.ConstantScoreQuery
+ @returns {Object} Returns the object's query property.
+ */
_self: function () {
return query;
}
@@ -9733,29 +9865,29 @@
};
/**
- @class
- A query allows to wrap another query and multiply its score by the - provided boost_factor. This can sometimes be desired since boost value set - on specific queries gets normalized, while this query boost factor does not.
+ @class +A query allows to wrap another query and multiply its score by the + provided boost_factor. This can sometimes be desired since boost value set + on specific queries gets normalized, while this query boost factor does not.
- @name ejs.CustomBoostFactorQuery + @name ejs.CustomBoostFactorQuery - @desc - Boosts a queries score without that boost being normalized. + @desc + Boosts a queries score without that boost being normalized. - @param {Object} qry A valid query object. - */ + @param {Object} qry A valid query object. + */ ejs.CustomBoostFactorQuery = function (qry) { if (!isQuery(qry)) { throw new TypeError('Argument must be a Query'); } - + /** - The internal query object.Use _self()
- @member ejs.CustomBoostFactorQuery
- @property {Object} query
- */
+ The internal query object. Use _self()
+ @member ejs.CustomBoostFactorQuery
+ @property {Object} query
+ */
var query = {
custom_boost_factor: {
query: qry._self()
@@ -9765,32 +9897,32 @@
return {
/**
- Sets the query to be apply the custom boost to.
+ Sets the query to be apply the custom boost to.
- @member ejs.CustomBoostFactorQuery
- @param {Object} q A valid Query object
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.CustomBoostFactorQuery
+ @param {Object} q A valid Query object
+ @returns {Object} returns this so that calls can be chained.
+ */
query: function (q) {
if (q == null) {
return query.custom_boost_factor.query;
}
-
+
if (!isQuery(q)) {
throw new TypeError('Argument must be a Query');
}
-
+
query.custom_boost_factor.query = q._self();
return this;
},
-
- /**
- Sets the language used in the script.
- @member ejs.CustomBoostFactorQuery
- @param {Double} boost The boost value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the language used in the script.
+
+ @member ejs.CustomBoostFactorQuery
+ @param {Double} boost The boost value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boostFactor: function (boost) {
if (boost == null) {
return query.custom_boost_factor.boost_factor;
@@ -9799,14 +9931,14 @@
query.custom_boost_factor.boost_factor = boost;
return this;
},
-
- /**
- Sets the boost value of the Query.
- @member ejs.CustomBoostFactorQuery
- @param {Double} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the boost value of the Query.
+
+ @member ejs.CustomBoostFactorQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.custom_boost_factor.boost;
@@ -9815,34 +9947,34 @@
query.custom_boost_factor.boost = boost;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.CustomBoostFactorQuery
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.CustomBoostFactorQuery
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.CustomBoostFactorQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.CustomBoostFactorQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
- /**
- Retrieves the internal query object. This is typically used by
- internal API functions so use with caution.
- @member ejs.CustomBoostFactorQuery
- @returns {String} returns this object's internal query property.
- */
+ /**
+ Retrieves the internal query object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.CustomBoostFactorQuery
+ @returns {String} returns this object's internal query property.
+ */
_self: function () {
return query;
}
@@ -9850,66 +9982,66 @@
};
/**
- @class
- A custom_filters_score query allows to execute a query, and if the hit - matches a provided filter (ordered), use either a boost or a script - associated with it to compute the score.
+ @class +A custom_filters_score query allows to execute a query, and if the hit + matches a provided filter (ordered), use either a boost or a script + associated with it to compute the score.
-This can considerably simplify and increase performance for parameterized - based scoring since filters are easily cached for faster performance, and - boosting / script is considerably simpler.
- - @name ejs.CustomFiltersScoreQuery +This can considerably simplify and increase performance for parameterized + based scoring since filters are easily cached for faster performance, and + boosting / script is considerably simpler.
- @desc - Returned documents matched by the query and scored based on if the document - matched in a filter. + @name ejs.CustomFiltersScoreQuery - @param {Object} qry A valid query object. - @param {Object || Array} filters A single object or array of objects. Each - object must have a 'filter' property and either a 'boost' or 'script' - property. - */ + @desc + Returned documents matched by the query and scored based on if the document + matched in a filter. + + @param {Object} qry A valid query object. + @param {Object || Array} filters A single object or array of objects. Each + object must have a 'filter' property and either a 'boost' or 'script' + property. + */ ejs.CustomFiltersScoreQuery = function (qry, filters) { if (!isQuery(qry)) { throw new TypeError('Argument must be a Query'); } - + /** - The internal query object.Use _self()
- @member ejs.CustomFiltersScoreQuery
- @property {Object} query
- */
+ The internal query object. Use _self()
+ @member ejs.CustomFiltersScoreQuery
+ @property {Object} query
+ */
var query = {
- custom_filters_score: {
- query: qry._self(),
- filters: []
- }
- },
-
+ custom_filters_score: {
+ query: qry._self(),
+ filters: []
+ }
+ },
+
// generate a valid filter object that can be inserted into the filters
// array. Returns null when an invalid filter is passed in.
- genFilterObject = function (filter) {
- var obj = null;
-
- if (filter.filter && isFilter(filter.filter)) {
- obj = {
- filter: filter.filter._self()
- };
-
- if (filter.boost) {
- obj.boost = filter.boost;
- } else if (filter.script) {
- obj.script = filter.script;
- } else {
- // invalid filter, must boost or script must be specified
- obj = null;
+ genFilterObject = function (filter) {
+ var obj = null;
+
+ if (filter.filter && isFilter(filter.filter)) {
+ obj = {
+ filter: filter.filter._self()
+ };
+
+ if (filter.boost) {
+ obj.boost = filter.boost;
+ } else if (filter.script) {
+ obj.script = filter.script;
+ } else {
+ // invalid filter, must boost or script must be specified
+ obj = null;
+ }
}
- }
-
- return obj;
- };
+
+ return obj;
+ };
each((isArray(filters) ? filters : [filters]), function (filter) {
var fObj = genFilterObject(filter);
@@ -9917,78 +10049,78 @@
query.custom_filters_score.filters.push(fObj);
}
});
-
+
return {
/**
- Sets the query to be apply the custom boost to.
+ Sets the query to be apply the custom boost to.
- @member ejs.CustomFiltersScoreQuery
- @param {Object} q A valid Query object
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.CustomFiltersScoreQuery
+ @param {Object} q A valid Query object
+ @returns {Object} returns this so that calls can be chained.
+ */
query: function (q) {
if (q == null) {
return query.custom_filters_score.query;
}
-
+
if (!isQuery(q)) {
throw new TypeError('Argument must be a Query');
}
-
+
query.custom_filters_score.query = q._self();
return this;
},
/**
- Sets the filters and their related boost or script scoring method.
+Sets the filters and their related boost or script scoring method.
-Takes an array of objects where each object has a 'filter' property - and either a 'boost' or 'script' property. Pass a single object to - add to the current list of filters or pass a list of objects to - overwrite all existing filters.
- -
- {filter: someFilter, boost: 2.1}
-
+ Takes an array of objects where each object has a 'filter' property + and either a 'boost' or 'script' property. Pass a single object to + add to the current list of filters or pass a list of objects to + overwrite all existing filters.
- @member ejs.CustomFiltersScoreQuery - @param {Object || Array} fltrs An object or array of objects - contining a filter and either a boost or script property. - @returns {Object} returnsthis so that calls can be chained.
- */
+
+ {filter: someFilter, boost: 2.1}
+
+
+ @member ejs.CustomFiltersScoreQuery
+ @param {Object || Array} fltrs An object or array of objects
+ contining a filter and either a boost or script property.
+ @returns {Object} returns this so that calls can be chained.
+ */
filters: function (fltrs) {
if (fltrs == null) {
return query.custom_filters_score.filters;
}
-
+
if (isArray(fltrs)) {
query.custom_filters_score.filters = [];
}
-
+
each((isArray(fltrs) ? fltrs : [fltrs]), function (f) {
var fObj = genFilterObject(f);
if (fObj !== null) {
query.custom_filters_score.filters.push(fObj);
}
});
-
+
return this;
},
-
+
/**
- A score_mode can be defined to control how multiple matching - filters control the score.
+
A score_mode can be defined to control how multiple matching + filters control the score.
-
By default, it is set to first which means the first matching filter
- will control the score of the result. It can also be set to
- min/max/total/avg/multiply which will aggregate the result from all
- matching filters based on the aggregation type.
+
By default, it is set to first which means the first matching filter
+ will control the score of the result. It can also be set to
+ min/max/total/avg/multiply which will aggregate the result from all
+ matching filters based on the aggregation type.
- @member ejs.CustomFiltersScoreQuery
- @param {String} s The scoring type as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.CustomFiltersScoreQuery
+ @param {String} s The scoring type as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
scoreMode: function (s) {
if (s == null) {
return query.custom_filters_score.score_mode;
@@ -9998,35 +10130,35 @@
if (s === 'first' || s === 'min' || s === 'max' || s === 'total' || s === 'avg' || s === 'multiply') {
query.custom_filters_score.score_mode = s;
}
-
+
return this;
},
-
- /**
- Sets parameters that will be applied to the script. Overwrites
- any existing params.
- @member ejs.CustomFiltersScoreQuery
- @param {Object} q An object where the keys are the parameter name and
- values are the parameter value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets parameters that will be applied to the script. Overwrites
+ any existing params.
+
+ @member ejs.CustomFiltersScoreQuery
+ @param {Object} q An object where the keys are the parameter name and
+ values are the parameter value.
+ @returns {Object} returns this so that calls can be chained.
+ */
params: function (p) {
if (p == null) {
return query.custom_filters_score.params;
}
-
+
query.custom_filters_score.params = p;
return this;
},
-
- /**
- Sets the language used in the script.
- @member ejs.CustomFiltersScoreQuery
- @param {String} l The script language, defatuls to mvel.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the language used in the script.
+
+ @member ejs.CustomFiltersScoreQuery
+ @param {String} l The script language, defatuls to mvel.
+ @returns {Object} returns this so that calls can be chained.
+ */
lang: function (l) {
if (l == null) {
return query.custom_filters_score.lang;
@@ -10037,12 +10169,12 @@
},
/**
- Sets the maximum value a computed boost can reach.
+ Sets the maximum value a computed boost can reach.
- @member ejs.CustomFiltersScoreQuery
- @param {Double} max A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.CustomFiltersScoreQuery
+ @param {Double} max A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
maxBoost: function (max) {
if (max == null) {
return query.custom_filters_score.max_boost;
@@ -10051,14 +10183,14 @@
query.custom_filters_score.max_boost = max;
return this;
},
-
- /**
- Sets the boost value of the Query.
- @member ejs.CustomFiltersScoreQuery
- @param {Double} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the boost value of the Query.
+
+ @member ejs.CustomFiltersScoreQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.custom_filters_score.boost;
@@ -10067,34 +10199,34 @@
query.custom_filters_score.boost = boost;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.CustomFiltersScoreQuery
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.CustomFiltersScoreQuery
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.CustomFiltersScoreQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.CustomFiltersScoreQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
- /**
- Retrieves the internal query object. This is typically used by
- internal API functions so use with caution.
- @member ejs.CustomFiltersScoreQuery
- @returns {String} returns this object's internal query property.
- */
+ /**
+ Retrieves the internal query object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.CustomFiltersScoreQuery
+ @returns {String} returns this object's internal query property.
+ */
_self: function () {
return query;
}
@@ -10102,30 +10234,30 @@
};
/**
- @class
-
A query that wraps another query and customize the scoring of it - optionally with a computation derived from other field values in the - doc (numeric ones) using script expression.
+ @class +A query that wraps another query and customize the scoring of it + optionally with a computation derived from other field values in the + doc (numeric ones) using script expression.
- @name ejs.CustomScoreQuery + @name ejs.CustomScoreQuery - @desc - Scores a query based on a script. + @desc + Scores a query based on a script. - @param {Object} qry A valid query object. - @param {String} script A valid script expression. - */ + @param {Object} qry A valid query object. + @param {String} script A valid script expression. + */ ejs.CustomScoreQuery = function (qry, script) { if (!isQuery(qry)) { throw new TypeError('Argument must be a Query'); } - + /** - The internal query object.Use _self()
- @member ejs.CustomScoreQuery
- @property {Object} query
- */
+ The internal query object. Use _self()
+ @member ejs.CustomScoreQuery
+ @property {Object} query
+ */
var query = {
custom_score: {
query: qry._self(),
@@ -10136,66 +10268,66 @@
return {
/**
- Sets the query to be apply the custom score to.
+ Sets the query to be apply the custom score to.
- @member ejs.CustomScoreQuery
- @param {Object} q A valid Query object
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.CustomScoreQuery
+ @param {Object} q A valid Query object
+ @returns {Object} returns this so that calls can be chained.
+ */
query: function (q) {
if (q == null) {
return query.custom_score.query;
}
-
+
if (!isQuery(q)) {
throw new TypeError('Argument must be a Query');
}
-
+
query.custom_score.query = q._self();
return this;
},
/**
- Sets the script that calculates the custom score
+ Sets the script that calculates the custom score
- @member ejs.CustomScoreQuery
- @param {String} s A valid script expression
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.CustomScoreQuery
+ @param {String} s A valid script expression
+ @returns {Object} returns this so that calls can be chained.
+ */
script: function (s) {
if (s == null) {
return query.custom_score.script;
}
-
+
query.custom_score.script = s;
return this;
},
/**
- Sets parameters that will be applied to the script. Overwrites
- any existing params.
+ Sets parameters that will be applied to the script. Overwrites
+ any existing params.
- @member ejs.CustomScoreQuery
- @param {Object} p An object where the keys are the parameter name and
- values are the parameter value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.CustomScoreQuery
+ @param {Object} p An object where the keys are the parameter name and
+ values are the parameter value.
+ @returns {Object} returns this so that calls can be chained.
+ */
params: function (p) {
if (p == null) {
return query.custom_score.params;
}
-
+
query.custom_score.params = p;
return this;
},
-
- /**
- Sets the language used in the script.
- @member ejs.CustomScoreQuery
- @param {String} l The script language, defatuls to mvel.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the language used in the script.
+
+ @member ejs.CustomScoreQuery
+ @param {String} l The script language, defatuls to mvel.
+ @returns {Object} returns this so that calls can be chained.
+ */
lang: function (l) {
if (l == null) {
return query.custom_score.lang;
@@ -10204,14 +10336,14 @@
query.custom_score.lang = l;
return this;
},
-
- /**
- Sets the boost value of the Query.
- @member ejs.CustomScoreQuery
- @param {Double} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the boost value of the Query.
+
+ @member ejs.CustomScoreQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.custom_score.boost;
@@ -10220,34 +10352,34 @@
query.custom_score.boost = boost;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.CustomScoreQuery
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.CustomScoreQuery
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.CustomScoreQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.CustomScoreQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
- /**
- Retrieves the internal query object. This is typically used by
- internal API functions so use with caution.
- @member ejs.CustomScoreQuery
- @returns {String} returns this object's internal query property.
- */
+ /**
+ Retrieves the internal query object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.CustomScoreQuery
+ @returns {String} returns this object's internal query property.
+ */
_self: function () {
return query;
}
@@ -10255,26 +10387,26 @@
};
/**
- @class
- A query that generates the union of documents produced by its subqueries, and
- that scores each document with the maximum score for that document as produced
- by any subquery, plus a tie breaking increment for any additional matching
- subqueries.
+ @class
+ A query that generates the union of documents produced by its subqueries, and
+ that scores each document with the maximum score for that document as produced
+ by any subquery, plus a tie breaking increment for any additional matching
+ subqueries.
- @name ejs.DisMaxQuery
+ @name ejs.DisMaxQuery
- @desc
- A query that generates the union of documents produced by its subqueries such
- as termQuerys, phraseQuerys, boolQuerys, etc.
+ @desc
+ A query that generates the union of documents produced by its subqueries such
+ as termQuerys, phraseQuerys, boolQuerys, etc.
- */
+ */
ejs.DisMaxQuery = function () {
/**
- The internal query object. Use _self()
- @member ejs.DisMaxQuery
- @property {Object} query
- */
+ The internal query object. Use _self()
+ @member ejs.DisMaxQuery
+ @property {Object} query
+ */
var query = {
dis_max: {}
};
@@ -10282,25 +10414,25 @@
return {
/**
- Updates the queries. If passed a single Query, it is added to the
- list of existing queries. If passed an array of Queries, it
- replaces all existing values.
+ Updates the queries. If passed a single Query, it is added to the
+ list of existing queries. If passed an array of Queries, it
+ replaces all existing values.
- @member ejs.DisMaxQuery
- @param {Query || Array} qs A single Query or an array of Queries
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.DisMaxQuery
+ @param {Query || Array} qs A single Query or an array of Queries
+ @returns {Object} returns this so that calls can be chained.
+ */
queries: function (qs) {
var i, len;
-
+
if (qs == null) {
return query.dis_max.queries;
}
-
+
if (query.dis_max.queries == null) {
query.dis_max.queries = [];
}
-
+
if (isQuery(qs)) {
query.dis_max.queries.push(qs._self());
} else if (isArray(qs)) {
@@ -10309,7 +10441,7 @@
if (!isQuery(qs[i])) {
throw new TypeError('Argument must be array of Queries');
}
-
+
query.dis_max.queries.push(qs[i]._self());
}
} else {
@@ -10320,12 +10452,12 @@
},
/**
- Sets the boost value of the Query. Default: 1.0.
+ Sets the boost value of the Query. Default: 1.0.
- @member ejs.DisMaxQuery
- @param {Double} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.DisMaxQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.dis_max.boost;
@@ -10337,19 +10469,19 @@
/**
- The tie breaker value.
+The tie breaker value.
-The tie breaker capability allows results that include the same term in multiple - fields to be judged better than results that include this term in only the best of those - multiple fields, without confusing this with the better case of two different terms in - the multiple fields.
+The tie breaker capability allows results that include the same term in multiple + fields to be judged better than results that include this term in only the best of those + multiple fields, without confusing this with the better case of two different terms in + the multiple fields.
-Default: 0.0.
+Default: 0.0.
- @member ejs.DisMaxQuery - @param {Double} tieBreaker A positivedouble value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.DisMaxQuery
+ @param {Double} tieBreaker A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
tieBreaker: function (tieBreaker) {
if (tieBreaker == null) {
return query.dis_max.tie_breaker;
@@ -10360,67 +10492,67 @@
},
/**
- Allows you to serialize this object into a JSON encoded string.
+ Allows you to serialize this object into a JSON encoded string.
- @member ejs.DisMaxQuery
- @returns {String} returns this object as a serialized JSON string.
- */
+ @member ejs.DisMaxQuery
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.DisMaxQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.DisMaxQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
- /**
- Retrieves the internal query object. This is typically used by
- internal API functions so use with caution.
- @member ejs.DisMaxQuery
- @returns {String} returns this object's internal query property.
- */
+ /**
+ Retrieves the internal query object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.DisMaxQuery
+ @returns {String} returns this object's internal query property.
+ */
_self: function () {
return query;
}
};
};
-
+
/**
- @class
- Wrapper to allow SpanQuery objects participate in composite single-field - SpanQueries by 'lying' about their search field. That is, the masked - SpanQuery will function as normal, but when asked for the field it - queries against, it will return the value specified as the masked field vs. - the real field used in the wrapped span query.
+ @class +Wrapper to allow SpanQuery objects participate in composite single-field + SpanQueries by 'lying' about their search field. That is, the masked + SpanQuery will function as normal, but when asked for the field it + queries against, it will return the value specified as the masked field vs. + the real field used in the wrapped span query.
- @name ejs.FieldMaskingSpanQuery + @name ejs.FieldMaskingSpanQuery - @desc - Wraps a SpanQuery and hides the real field being searched across. + @desc + Wraps a SpanQuery and hides the real field being searched across. - @param {Query} spanQry A valid SpanQuery - @param {Integer} field the maximum field position in a match. - - */ + @param {Query} spanQry A valid SpanQuery + @param {Integer} field the maximum field position in a match. + + */ ejs.FieldMaskingSpanQuery = function (spanQry, field) { if (!isQuery(spanQry)) { throw new TypeError('Argument must be a SpanQuery'); } - + /** - The internal query object.Use _self()
- @member ejs.FieldMaskingSpanQuery
- @property {Object} query
- */
+ The internal query object. Use _self()
+ @member ejs.FieldMaskingSpanQuery
+ @property {Object} query
+ */
var query = {
field_masking_span: {
query: spanQry._self(),
@@ -10431,48 +10563,48 @@
return {
/**
- Sets the span query to wrap.
+ Sets the span query to wrap.
- @member ejs.FieldMaskingSpanQuery
- @param {Query} spanQuery Any valid span type query.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.FieldMaskingSpanQuery
+ @param {Query} spanQuery Any valid span type query.
+ @returns {Object} returns this so that calls can be chained.
+ */
query: function (spanQuery) {
if (spanQuery == null) {
return query.field_masking_span.query;
}
-
+
if (!isQuery(spanQuery)) {
throw new TypeError('Argument must be a SpanQuery');
}
-
+
query.field_masking_span.query = spanQuery._self();
return this;
},
/**
- Sets the value of the "masked" field.
+ Sets the value of the "masked" field.
- @member ejs.FieldMaskingSpanQuery
- @param {String} f A field name the wrapped span query should use
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.FieldMaskingSpanQuery
+ @param {String} f A field name the wrapped span query should use
+ @returns {Object} returns this so that calls can be chained.
+ */
field: function (f) {
if (f == null) {
return query.field_masking_span.field;
}
-
+
query.field_masking_span.field = f;
return this;
},
/**
- Sets the boost value of the Query.
+ Sets the boost value of the Query.
- @member ejs.FieldMaskingSpanQuery
- @param {Double} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.FieldMaskingSpanQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.field_masking_span.boost;
@@ -10481,34 +10613,34 @@
query.field_masking_span.boost = boost;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.FieldMaskingSpanQuery
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.FieldMaskingSpanQuery
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.FieldMaskingSpanQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.FieldMaskingSpanQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
- /**
- Retrieves the internal query object. This is typically used by
- internal API functions so use with caution.
- @member ejs.FieldMaskingSpanQuery
- @returns {String} returns this object's internal query property.
- */
+ /**
+ Retrieves the internal query object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.FieldMaskingSpanQuery
+ @returns {String} returns this object's internal query property.
+ */
_self: function () {
return query;
}
@@ -10516,29 +10648,29 @@
};
/**
- @class
- A query that executes against a given field or document property. It is a simplified version
- of the queryString object.
+ @class
+ A query that executes against a given field or document property. It is a simplified version
+ of the queryString object.
- @name ejs.FieldQuery
+ @name ejs.FieldQuery
- @desc
- A query that executes against a given field or document property.
+ @desc
+ A query that executes against a given field or document property.
- @param {String} field The field or document property to search against.
- @param {String} qstr The value to match.
- */
+ @param {String} field The field or document property to search against.
+ @param {String} qstr The value to match.
+ */
ejs.FieldQuery = function (field, qstr) {
/**
- The internal query object. Use get()
- @member ejs.FieldQuery
- @property {Object} query
- */
+ The internal query object. Use get()
+ @member ejs.FieldQuery
+ @property {Object} query
+ */
var query = {
field: {}
};
-
+
query.field[field] = {
query: qstr
};
@@ -10546,12 +10678,12 @@
return {
/**
- The field to run the query against.
+ The field to run the query against.
- @member ejs.FieldQuery
- @param {String} f A single field name.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.FieldQuery
+ @param {String} f A single field name.
+ @returns {Object} returns this so that calls can be chained.
+ */
field: function (f) {
var oldValue = query.field[field];
@@ -10565,14 +10697,14 @@
return this;
},
-
- /**
- Sets the query string.
- @member ejs.FieldQuery - @param {String} q The lucene query string. - @returns {Object} returnsthis so that calls can be chained.
- */
+ /**
+ Sets the query string.
+ + @member ejs.FieldQuery + @param {String} q The lucene query string. + @returns {Object} returnsthis so that calls can be chained.
+ */
query: function (q) {
if (q == null) {
return query.field[field].query;
@@ -10581,38 +10713,38 @@
query.field[field].query = q;
return this;
},
-
+
/**
- Set the default Boolean operator.
Set the default Boolean operator.
This operator is used to join individual query terms when no operator is
- explicity used in the query string (i.e., this AND that).
- Defaults to OR (same as Google).
This operator is used to join individual query terms when no operator is
+ explicity used in the query string (i.e., this AND that).
+ Defaults to OR (same as Google).
this so that calls can be chained.
- */
+ @member ejs.FieldQuery
+ @param {String} op The operator, AND or OR.
+ @returns {Object} returns this so that calls can be chained.
+ */
defaultOperator: function (op) {
if (op == null) {
return query.field[field].default_operator;
}
-
+
op = op.toUpperCase();
if (op === 'AND' || op === 'OR') {
query.field[field].default_operator = op;
}
-
+
return this;
},
/**
- Sets the analyzer name used to analyze the Query object.
Sets the analyzer name used to analyze the Query object.
this so that calls can be chained.
- */
+ @member ejs.FieldQuery
+ @param {String} analyzer A valid analyzer name.
+ @returns {Object} returns this so that calls can be chained.
+ */
analyzer: function (analyzer) {
if (analyzer == null) {
return query.field[field].analyzer;
@@ -10623,13 +10755,13 @@
},
/**
- Sets the quote analyzer name used to analyze the query
- when in quoted text.
Sets the quote analyzer name used to analyze the query
+ when in quoted text.
this so that calls can be chained.
- */
+ @member ejs.FieldQuery
+ @param {String} analyzer A valid analyzer name.
+ @returns {Object} returns this so that calls can be chained.
+ */
quoteAnalyzer: function (analyzer) {
if (analyzer == null) {
return query.field[field].quote_analyzer;
@@ -10638,15 +10770,15 @@
query.field[field].quote_analyzer = analyzer;
return this;
},
-
- /**
- Sets whether or not we should auto generate phrase queries *if* the - analyzer returns more than one term. Default: false.
- @member ejs.FieldQuery - @param {Boolean} trueFalse Atrue/false value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets whether or not we should auto generate phrase queries *if* the + analyzer returns more than one term. Default: false.
+ + @member ejs.FieldQuery + @param {Boolean} trueFalse Atrue/false value.
+ @returns {Object} returns this so that calls can be chained.
+ */
autoGeneratePhraseQueries: function (trueFalse) {
if (trueFalse == null) {
return query.field[field].auto_generate_phrase_queries;
@@ -10657,15 +10789,15 @@
},
/**
- Sets whether or not wildcard characters (* and ?) are allowed as the
- first character of the Query.
Sets whether or not wildcard characters (* and ?) are allowed as the
+ first character of the Query.
Default: true.
Default: true.
true/false value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.FieldQuery
+ @param {Boolean} trueFalse A true/false value.
+ @returns {Object} returns this so that calls can be chained.
+ */
allowLeadingWildcard: function (trueFalse) {
if (trueFalse == null) {
return query.field[field].allow_leading_wildcard;
@@ -10676,16 +10808,16 @@
},
/**
- Sets whether or not terms from wildcard, prefix, fuzzy, and
- range queries should automatically be lowercased in the Query
- since they are not analyzed.
Sets whether or not terms from wildcard, prefix, fuzzy, and
+ range queries should automatically be lowercased in the Query
+ since they are not analyzed.
Default: true.
Default: true.
true/false value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.FieldQuery
+ @param {Boolean} trueFalse A true/false value.
+ @returns {Object} returns this so that calls can be chained.
+ */
lowercaseExpandedTerms: function (trueFalse) {
if (trueFalse == null) {
return query.field[field].lowercase_expanded_terms;
@@ -10696,15 +10828,15 @@
},
/**
- Sets whether or not position increments will be used in the
- Query.
Sets whether or not position increments will be used in the
+ Query.
Default: true.
Default: true.
true/false value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.FieldQuery
+ @param {Boolean} trueFalse A true/false value.
+ @returns {Object} returns this so that calls can be chained.
+ */
enablePositionIncrements: function (trueFalse) {
if (trueFalse == null) {
return query.field[field].enable_position_increments;
@@ -10715,14 +10847,14 @@
},
/**
- Set the minimum similarity for fuzzy queries.
+Set the minimum similarity for fuzzy queries.
-Default: 0.5.
Default: 0.5.
double value between 0 and 1.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.FieldQuery
+ @param {Double} minSim A double value between 0 and 1.
+ @returns {Object} returns this so that calls can be chained.
+ */
fuzzyMinSim: function (minSim) {
if (minSim == null) {
return query.field[field].fuzzy_min_sim;
@@ -10733,14 +10865,14 @@
},
/**
- Sets the boost value of the Query.
Sets the boost value of the Query.
Default: 1.0.
Default: 1.0.
double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.FieldQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.field[field].boost;
@@ -10751,14 +10883,14 @@
},
/**
- Sets the prefix length for fuzzy queries.
- -Default: 0.
Sets the prefix length for fuzzy queries.
- @member ejs.FieldQuery - @param {Integer} fuzzLen A positiveinteger value.
- @returns {Object} returns this so that calls can be chained.
- */
+ Default: 0.
integer value.
+ @returns {Object} returns this so that calls can be chained.
+ */
fuzzyPrefixLength: function (fuzzLen) {
if (fuzzLen == null) {
return query.field[field].fuzzy_prefix_length;
@@ -10769,12 +10901,12 @@
},
/**
- Sets the max number of term expansions for fuzzy queries.
+Sets the max number of term expansions for fuzzy queries.
- @member ejs.FieldQuery - @param {Integer} max A positiveinteger value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.FieldQuery
+ @param {Integer} max A positive integer value.
+ @returns {Object} returns this so that calls can be chained.
+ */
fuzzyMaxExpansions: function (max) {
if (max == null) {
return query.field[field].fuzzy_max_expansions;
@@ -10785,40 +10917,40 @@
},
/**
- Sets fuzzy rewrite method.
+
Sets fuzzy rewrite method.
-
Valid values are:
- -constant_score_auto - tries to pick the best constant-score rewrite
- method based on term and document counts from the queryscoring_boolean - translates each term into boolean should and
- keeps the scores as computed by the queryconstant_score_boolean - same as scoring_boolean, expect no scores
- are computed.constant_score_filter - first creates a private Filter, by visiting
- each term in sequence and marking all docs for that termtop_terms_boost_N - first translates each term into boolean should
- and scores are only computed as the boost using the top N
- scoring terms. Replace N with an integer value.top_terms_N - first translates each term into boolean should
- and keeps the scores as computed by the query. Only the top N
- scoring terms are used. Replace N with an integer value.Default is constant_score_auto.
Valid values are:
-This is an advanced option, use with care.
- - @member ejs.FieldQuery - @param {String} m The rewrite method as a string. - @returns {Object} returnsthis so that calls can be chained.
- */
+ constant_score_auto - tries to pick the best constant-score rewrite
+ method based on term and document counts from the queryscoring_boolean - translates each term into boolean should and
+ keeps the scores as computed by the queryconstant_score_boolean - same as scoring_boolean, expect no scores
+ are computed.constant_score_filter - first creates a private Filter, by visiting
+ each term in sequence and marking all docs for that termtop_terms_boost_N - first translates each term into boolean should
+ and scores are only computed as the boost using the top N
+ scoring terms. Replace N with an integer value.top_terms_N - first translates each term into boolean should
+ and keeps the scores as computed by the query. Only the top N
+ scoring terms are used. Replace N with an integer value.Default is constant_score_auto.
This is an advanced option, use with care.
+ + @member ejs.FieldQuery + @param {String} m The rewrite method as a string. + @returns {Object} returnsthis so that calls can be chained.
+ */
fuzzyRewrite: function (m) {
if (m == null) {
return query.field[field].fuzzy_rewrite;
@@ -10827,75 +10959,75 @@
m = m.toLowerCase();
if (m === 'constant_score_auto' || m === 'scoring_boolean' ||
m === 'constant_score_boolean' || m === 'constant_score_filter' ||
- m.indexOf('top_terms_boost_') === 0 ||
+ m.indexOf('top_terms_boost_') === 0 ||
m.indexOf('top_terms_') === 0) {
-
+
query.field[field].fuzzy_rewrite = m;
}
-
+
return this;
},
/**
- Sets rewrite method.
+Sets rewrite method.
-Valid values are:
- -constant_score_auto - tries to pick the best constant-score rewrite
- method based on term and document counts from the queryscoring_boolean - translates each term into boolean should and
- keeps the scores as computed by the queryconstant_score_boolean - same as scoring_boolean, expect no scores
- are computed.
-
- constant_score_filter - first creates a private Filter, by visiting
- each term in sequence and marking all docs for that termtop_terms_boost_N - first translates each term into boolean should
- and scores are only computed as the boost using the top N
- scoring terms. Replace N with an integer value.top_terms_N - first translates each term into boolean should
- and keeps the scores as computed by the query. Only the top N
- scoring terms are used. Replace N with an integer value.Default is constant_score_auto.
Valid values are:
- This is an advanced option, use with care. +constant_score_auto - tries to pick the best constant-score rewrite
+ method based on term and document counts from the querythis so that calls can be chained.
- */
+ scoring_boolean - translates each term into boolean should and
+ keeps the scores as computed by the queryconstant_score_boolean - same as scoring_boolean, expect no scores
+ are computed.
+
+ constant_score_filter - first creates a private Filter, by visiting
+ each term in sequence and marking all docs for that termtop_terms_boost_N - first translates each term into boolean should
+ and scores are only computed as the boost using the top N
+ scoring terms. Replace N with an integer value.top_terms_N - first translates each term into boolean should
+ and keeps the scores as computed by the query. Only the top N
+ scoring terms are used. Replace N with an integer value.Default is constant_score_auto.
this so that calls can be chained.
+ */
rewrite: function (m) {
if (m == null) {
return query.field[field].rewrite;
}
-
+
m = m.toLowerCase();
if (m === 'constant_score_auto' || m === 'scoring_boolean' ||
m === 'constant_score_boolean' || m === 'constant_score_filter' ||
- m.indexOf('top_terms_boost_') === 0 ||
+ m.indexOf('top_terms_boost_') === 0 ||
m.indexOf('top_terms_') === 0) {
-
+
query.field[field].rewrite = m;
}
-
+
return this;
},
/**
- Sets the suffix to automatically add to the field name when - performing a quoted search.
+Sets the suffix to automatically add to the field name when + performing a quoted search.
- @member ejs.FieldQuery - @param {String} s The suffix as a string. - @returns {Object} returnsthis so that calls can be chained.
- */
+ @member ejs.FieldQuery
+ @param {String} s The suffix as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
quoteFieldSuffix: function (s) {
if (s == null) {
return query.field[field].quote_field_suffix;
@@ -10904,17 +11036,17 @@
query.field[field].quote_field_suffix = s;
return this;
},
-
+
/**
- Sets the default slop for phrases. If zero, then exact phrase matches - are required.
+Sets the default slop for phrases. If zero, then exact phrase matches + are required.
-Default: 0.
Default: 0.
integer value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.FieldQuery
+ @param {Integer} slop A positive integer value.
+ @returns {Object} returns this so that calls can be chained.
+ */
phraseSlop: function (slop) {
if (slop == null) {
return query.field[field].phrase_slop;
@@ -10925,17 +11057,17 @@
},
/**
- Sets whether or not we should attempt to analyzed wilcard terms in the
- Query.
Sets whether or not we should attempt to analyzed wilcard terms in the
+ Query.
By default, wildcard terms are not analyzed. Analysis of wildcard characters is not perfect.
+By default, wildcard terms are not analyzed. Analysis of wildcard characters is not perfect.
-Default: false.
Default: false.
true/false value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.FieldQuery
+ @param {Boolean} trueFalse A true/false value.
+ @returns {Object} returns this so that calls can be chained.
+ */
analyzeWildcard: function (trueFalse) {
if (trueFalse == null) {
return query.field[field].analyze_wildcard;
@@ -10946,12 +11078,12 @@
},
/**
- If the query string should be escaped or not.
+If the query string should be escaped or not.
- @member ejs.FieldQuery - @param {Boolean} trueFalse Atrue/false value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.FieldQuery
+ @param {Boolean} trueFalse A true/false value.
+ @returns {Object} returns this so that calls can be chained.
+ */
escape: function (trueFalse) {
if (trueFalse == null) {
return query.field[field].escape;
@@ -10960,15 +11092,15 @@
query.field[field].escape = trueFalse;
return this;
},
-
- /**
- Sets a percent value controlling how many should clauses in the
- resulting Query should match.
integer between 0 and 100.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets a percent value controlling how many should clauses in the
+ resulting Query should match.
integer between 0 and 100.
+ @returns {Object} returns this so that calls can be chained.
+ */
minimumShouldMatch: function (minMatch) {
if (minMatch == null) {
return query.field[field].minimum_should_match;
@@ -10979,32 +11111,32 @@
},
/**
- Allows you to serialize this object into a JSON encoded string.
+Allows you to serialize this object into a JSON encoded string.
- @member ejs.FieldQuery - @returns {String} returns this object as a serialized JSON string. - */ + @member ejs.FieldQuery + @returns {String} returns this object as a serialized JSON string. + */ toString: function () { return JSON.stringify(query); }, /** -The type of ejs object. For internal use only.
- - @member ejs.FieldQuery - @returns {String} the type of object - */ +The type of ejs object. For internal use only.
+ + @member ejs.FieldQuery + @returns {String} the type of object + */ _type: function () { return 'query'; }, - - /** -Retrieves the internal query object. This is typically used by
- internal API functions so use with caution.
query property.
- */
+ /**
+ Retrieves the internal query object. This is typically used by
+ internal API functions so use with caution.
query property.
+ */
_self: function () {
return query;
}
@@ -11012,38 +11144,38 @@
};
/**
- @class
- Filter queries allow you to restrict the results returned by a query. There are
- several different types of filters that can be applied
- (see filter module). A filterQuery
- takes a Query and a Filter object as arguments and constructs
- a new Query that is then used for the search.
Filter queries allow you to restrict the results returned by a query. There are
+ several different types of filters that can be applied
+ (see filter module). A filterQuery
+ takes a Query and a Filter object as arguments and constructs
+ a new Query that is then used for the search.
A query that applies a filter to the results of another query.
+ @desc +A query that applies a filter to the results of another query.
- @param {Object} someQuery a validQuery object
- @param {Object} someFilter a valid Filter object. This parameter
- is optional.
+ @param {Object} someQuery a valid Query object
+ @param {Object} someFilter a valid Filter object. This parameter
+ is optional.
- */
+ */
ejs.FilteredQuery = function (someQuery, someFilter) {
if (!isQuery(someQuery)) {
throw new TypeError('Argument must be a Query');
}
-
+
if (someFilter != null && !isFilter(someFilter)) {
throw new TypeError('Argument must be a Filter');
}
-
+
/**
- The internal query object. Use _self()
- @member ejs.FilteredQuery
- @property {Object} query
- */
+ The internal query object. Use _self()
+ @member ejs.FilteredQuery
+ @property {Object} query
+ */
var query = {
filtered: {
query: someQuery._self()
@@ -11053,70 +11185,70 @@
if (someFilter != null) {
query.filtered.filter = someFilter._self();
}
-
+
return {
/**
- Adds the query to apply a constant score to.
+Adds the query to apply a constant score to.
- @member ejs.FilteredQuery - @param {Object} oQuery A validQuery object
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.FilteredQuery
+ @param {Object} oQuery A valid Query object
+ @returns {Object} returns this so that calls can be chained.
+ */
query: function (oQuery) {
if (oQuery == null) {
return query.filtered.query;
}
-
+
if (!isQuery(oQuery)) {
throw new TypeError('Argument must be a Query');
}
-
+
query.filtered.query = oQuery._self();
return this;
},
/**
- Adds the filter to apply a constant score to.
+Adds the filter to apply a constant score to.
- @member ejs.FilteredQuery - @param {Object} oFilter A validFilter object
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.FilteredQuery
+ @param {Object} oFilter A valid Filter object
+ @returns {Object} returns this so that calls can be chained.
+ */
filter: function (oFilter) {
if (oFilter == null) {
return query.filtered.filter;
}
-
+
if (!isFilter(oFilter)) {
throw new TypeError('Argument must be a Filter');
}
-
+
query.filtered.filter = oFilter._self();
return this;
},
/**
- Sets the filter strategy.
+Sets the filter strategy.
-The strategy defines how the filter is applied during document collection. - Valid values are:
- -query_first - advance query scorer first then filterrandom_access_random - random access filterleap_frog - query scorer and filter "leap-frog", query goes firstleap_frog_filter_first - same as leap_frog, but filter goes firstrandom_access_N - replace N with integer, same as random access
- except you can specify a custom thresholdThe strategy defines how the filter is applied during document collection. + Valid values are:
-This is an advanced setting, use with care.
- - @member ejs.FilteredQuery - @param {String} strategy The strategy as a string. - @returns {Object} returnsthis so that calls can be chained.
- */
+ query_first - advance query scorer first then filterrandom_access_random - random access filterleap_frog - query scorer and filter "leap-frog", query goes firstleap_frog_filter_first - same as leap_frog, but filter goes firstrandom_access_N - replace N with integer, same as random access
+ except you can specify a custom thresholdThis is an advanced setting, use with care.
+ + @member ejs.FilteredQuery + @param {String} strategy The strategy as a string. + @returns {Object} returnsthis so that calls can be chained.
+ */
strategy: function (strategy) {
if (strategy == null) {
return query.filtered.strategy;
@@ -11126,20 +11258,20 @@
if (strategy === 'query_first' || strategy === 'random_access_always' ||
strategy === 'leap_frog' || strategy === 'leap_frog_filter_first' ||
strategy.indexOf('random_access_') === 0) {
-
+
query.filtered.strategy = strategy;
}
-
+
return this;
},
-
- /**
- Enables caching of the filter.
- @member ejs.FilteredQuery - @param {Boolean} trueFalse A boolean value. - @returns {Object} returnsthis so that calls can be chained.
- */
+ /**
+ Enables caching of the filter.
+ + @member ejs.FilteredQuery + @param {Boolean} trueFalse A boolean value. + @returns {Object} returnsthis so that calls can be chained.
+ */
cache: function (trueFalse) {
if (trueFalse == null) {
return query.filtered._cache;
@@ -11148,14 +11280,14 @@
query.filtered._cache = trueFalse;
return this;
},
-
- /**
- Set the cache key.
- @member ejs.FilteredQuery - @param {String} k A string cache key. - @returns {Object} returnsthis so that calls can be chained.
- */
+ /**
+ Set the cache key.
+ + @member ejs.FilteredQuery + @param {String} k A string cache key. + @returns {Object} returnsthis so that calls can be chained.
+ */
cacheKey: function (k) {
if (k == null) {
return query.filtered._cache_key;
@@ -11164,14 +11296,14 @@
query.filtered._cache_key = k;
return this;
},
-
- /**
- Sets the boost value of the Query.
double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the boost value of the Query.
double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.filtered.boost;
@@ -11180,33 +11312,33 @@
query.filtered.boost = boost;
return this;
},
-
- /**
- Converts this object to a json string
- @member ejs.FilteredQuery - @returns {Object} string - */ + /** +Converts this object to a json string
+ + @member ejs.FilteredQuery + @returns {Object} string + */ toString: function () { return JSON.stringify(query); }, /** -The type of ejs object. For internal use only.
- - @member ejs.FilteredQuery - @returns {String} the type of object - */ +The type of ejs object. For internal use only.
+ + @member ejs.FilteredQuery + @returns {String} the type of object + */ _type: function () { return 'query'; }, - - /** -returns the query object.
- @member ejs.FilteredQuery - @returns {Object} query object - */ + /** +returns the query object.
+ + @member ejs.FilteredQuery + @returns {Object} query object + */ _self: function () { return query; } @@ -11214,44 +11346,44 @@ }; /** - @class -The fuzzy_like_this_field query is the same as the fuzzy_like_this - query, except that it runs against a single field. It provides nicer query - DSL over the generic fuzzy_like_this query, and support typed fields - query (automatically wraps typed fields with type filter to match only on - the specific type).
+ @class +The fuzzy_like_this_field query is the same as the fuzzy_like_this + query, except that it runs against a single field. It provides nicer query + DSL over the generic fuzzy_like_this query, and support typed fields + query (automatically wraps typed fields with type filter to match only on + the specific type).
-Fuzzifies ALL terms provided as strings and then picks the best n - differentiating terms. In effect this mixes the behaviour of FuzzyQuery and - MoreLikeThis but with special consideration of fuzzy scoring factors. This - generally produces good results for queries where users may provide details - in a number of fields and have no knowledge of boolean query syntax and - also want a degree of fuzzy matching and a fast query.
+Fuzzifies ALL terms provided as strings and then picks the best n + differentiating terms. In effect this mixes the behaviour of FuzzyQuery and + MoreLikeThis but with special consideration of fuzzy scoring factors. This + generally produces good results for queries where users may provide details + in a number of fields and have no knowledge of boolean query syntax and + also want a degree of fuzzy matching and a fast query.
-For each source term the fuzzy variants are held in a BooleanQuery with - no coord factor (because we are not looking for matches on multiple variants - in any one doc). Additionally, a specialized TermQuery is used for variants - and does not use that variant term’s IDF because this would favour rarer - terms eg misspellings. Instead, all variants use the same IDF - ranking (the one for the source query term) and this is factored into the - variant’s boost. If the source query term does not exist in the index the - average IDF of the variants is used.
+For each source term the fuzzy variants are held in a BooleanQuery with + no coord factor (because we are not looking for matches on multiple variants + in any one doc). Additionally, a specialized TermQuery is used for variants + and does not use that variant term’s IDF because this would favour rarer + terms eg misspellings. Instead, all variants use the same IDF + ranking (the one for the source query term) and this is factored into the + variant’s boost. If the source query term does not exist in the index the + average IDF of the variants is used.
- @name ejs.FuzzyLikeThisFieldQuery + @name ejs.FuzzyLikeThisFieldQuery - @desc -Constructs a query where each documents returned are “like” provided text
+ @desc +Constructs a query where each documents returned are “like” provided text
- @param {String} field The field to run the query against. - @param {String} likeText The text to find documents like it. - */ + @param {String} field The field to run the query against. + @param {String} likeText The text to find documents like it. + */ ejs.FuzzyLikeThisFieldQuery = function (field, likeText) { /** - The internal Query object. Useget().
- @member ejs.FuzzyLikeThisFieldQuery
- @property {Object} query
- */
+ The internal Query object. Use get().
+ @member ejs.FuzzyLikeThisFieldQuery
+ @property {Object} query
+ */
var query = {
flt_field: {}
};
@@ -11259,135 +11391,135 @@
query.flt_field[field] = {
like_text: likeText
};
-
- return {
-
- /**
- The field to run the query against.
- @member ejs.FuzzyLikeThisFieldQuery
- @param {String} f A single field name.
- @returns {Object} returns this so that calls can be chained.
- */
+ return {
+
+ /**
+ The field to run the query against.
+
+ @member ejs.FuzzyLikeThisFieldQuery
+ @param {String} f A single field name.
+ @returns {Object} returns this so that calls can be chained.
+ */
field: function (f) {
var oldValue = query.flt_field[field];
-
+
if (f == null) {
return field;
}
-
+
delete query.flt_field[field];
field = f;
query.flt_field[f] = oldValue;
-
+
return this;
},
-
- /**
- The text to find documents like
- @member ejs.FuzzyLikeThisFieldQuery
- @param {String} s A text string.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ The text to find documents like
+
+ @member ejs.FuzzyLikeThisFieldQuery
+ @param {String} s A text string.
+ @returns {Object} returns this so that calls can be chained.
+ */
likeText: function (txt) {
if (txt == null) {
return query.flt_field[field].like_text;
}
-
+
query.flt_field[field].like_text = txt;
return this;
},
/**
- Should term frequency be ignored. Defaults to false.
+ Should term frequency be ignored. Defaults to false.
- @member ejs.FuzzyLikeThisFieldQuery
- @param {Boolean} trueFalse A boolean value
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.FuzzyLikeThisFieldQuery
+ @param {Boolean} trueFalse A boolean value
+ @returns {Object} returns this so that calls can be chained.
+ */
ignoreTf: function (trueFalse) {
if (trueFalse == null) {
return query.flt_field[field].ignore_tf;
}
-
+
query.flt_field[field].ignore_tf = trueFalse;
return this;
},
/**
- The maximum number of query terms that will be included in any
- generated query. Defaults to 25.
+ The maximum number of query terms that will be included in any
+ generated query. Defaults to 25.
- @member ejs.FuzzyLikeThisFieldQuery
- @param {Integer} max A positive integer value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.FuzzyLikeThisFieldQuery
+ @param {Integer} max A positive integer value.
+ @returns {Object} returns this so that calls can be chained.
+ */
maxQueryTerms: function (max) {
if (max == null) {
return query.flt_field[field].max_query_terms;
}
-
+
query.flt_field[field].max_query_terms = max;
return this;
},
/**
- The minimum similarity of the term variants. Defaults to 0.5.
+ The minimum similarity of the term variants. Defaults to 0.5.
- @member ejs.FuzzyLikeThisFieldQuery
- @param {Double} min A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.FuzzyLikeThisFieldQuery
+ @param {Double} min A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
minSimilarity: function (min) {
if (min == null) {
return query.flt_field[field].min_similarity;
}
-
+
query.flt_field[field].min_similarity = min;
return this;
},
/**
- Length of required common prefix on variant terms. Defaults to 0..
+ Length of required common prefix on variant terms. Defaults to 0..
- @member ejs.FuzzyLikeThisFieldQuery
- @param {Integer} len A positive integer value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.FuzzyLikeThisFieldQuery
+ @param {Integer} len A positive integer value.
+ @returns {Object} returns this so that calls can be chained.
+ */
prefixLength: function (len) {
if (len == null) {
return query.flt_field[field].prefix_length;
}
-
+
query.flt_field[field].prefix_length = len;
return this;
},
/**
- The analyzer that will be used to analyze the text. Defaults to the
- analyzer associated with the field.
+ The analyzer that will be used to analyze the text. Defaults to the
+ analyzer associated with the field.
- @member ejs.FuzzyLikeThisFieldQuery
- @param {String} analyzerName The name of the analyzer.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.FuzzyLikeThisFieldQuery
+ @param {String} analyzerName The name of the analyzer.
+ @returns {Object} returns this so that calls can be chained.
+ */
analyzer: function (analyzerName) {
if (analyzerName == null) {
return query.flt_field[field].analyzer;
}
-
+
query.flt_field[field].analyzer = analyzerName;
return this;
},
-
- /**
- Sets the boost value of the Query.
- @member ejs.FuzzyLikeThisFieldQuery
- @param {Double} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the boost value of the Query.
+
+ @member ejs.FuzzyLikeThisFieldQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.flt_field[field].boost;
@@ -11398,30 +11530,30 @@
},
/**
- Serializes the internal query object as a JSON string.
- @member ejs.FuzzyLikeThisFieldQuery
- @returns {String} Returns a JSON representation of the Query object.
- */
+ Serializes the internal query object as a JSON string.
+ @member ejs.FuzzyLikeThisFieldQuery
+ @returns {String} Returns a JSON representation of the Query object.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.FuzzyLikeThisFieldQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.FuzzyLikeThisFieldQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
+
/**
- This method is used to retrieve the raw query object. It's designed
- for internal use when composing and serializing queries.
- @member ejs.FuzzyLikeThisFieldQuery
- @returns {Object} Returns the object's query property.
- */
+ This method is used to retrieve the raw query object. It's designed
+ for internal use when composing and serializing queries.
+ @member ejs.FuzzyLikeThisFieldQuery
+ @returns {Object} Returns the object's query property.
+ */
_self: function () {
return query;
}
@@ -11429,40 +11561,40 @@
};
/**
- @class
- Fuzzy like this query find documents that are “like” provided text by - running it against one or more fields.
+ @class +Fuzzy like this query find documents that are “like” provided text by + running it against one or more fields.
-Fuzzifies ALL terms provided as strings and then picks the best n - differentiating terms. In effect this mixes the behaviour of FuzzyQuery and - MoreLikeThis but with special consideration of fuzzy scoring factors. This - generally produces good results for queries where users may provide details - in a number of fields and have no knowledge of boolean query syntax and - also want a degree of fuzzy matching and a fast query.
- -For each source term the fuzzy variants are held in a BooleanQuery with - no coord factor (because we are not looking for matches on multiple variants - in any one doc). Additionally, a specialized TermQuery is used for variants - and does not use that variant term’s IDF because this would favour rarer - terms eg misspellings. Instead, all variants use the same IDF - ranking (the one for the source query term) and this is factored into the - variant’s boost. If the source query term does not exist in the index the - average IDF of the variants is used.
+Fuzzifies ALL terms provided as strings and then picks the best n + differentiating terms. In effect this mixes the behaviour of FuzzyQuery and + MoreLikeThis but with special consideration of fuzzy scoring factors. This + generally produces good results for queries where users may provide details + in a number of fields and have no knowledge of boolean query syntax and + also want a degree of fuzzy matching and a fast query.
- @name ejs.FuzzyLikeThisQuery +For each source term the fuzzy variants are held in a BooleanQuery with + no coord factor (because we are not looking for matches on multiple variants + in any one doc). Additionally, a specialized TermQuery is used for variants + and does not use that variant term’s IDF because this would favour rarer + terms eg misspellings. Instead, all variants use the same IDF + ranking (the one for the source query term) and this is factored into the + variant’s boost. If the source query term does not exist in the index the + average IDF of the variants is used.
- @desc -Constructs a query where each documents returned are “like” provided text
+ @name ejs.FuzzyLikeThisQuery - @param {String} likeText The text to find documents like it. - */ + @desc +Constructs a query where each documents returned are “like” provided text
+ + @param {String} likeText The text to find documents like it. + */ ejs.FuzzyLikeThisQuery = function (likeText) { /** - The internal Query object. Useget().
- @member ejs.FuzzyLikeThisQuery
- @property {Object} query
- */
+ The internal Query object. Use get().
+ @member ejs.FuzzyLikeThisQuery
+ @property {Object} query
+ */
var query = {
flt: {
like_text: likeText
@@ -11470,25 +11602,25 @@
};
return {
-
- /**
- The fields to run the query against. If you call with a single field,
- it is added to the existing list of fields. If called with an array
- of field names, it replaces any existing values with the new array.
- @member ejs.FuzzyLikeThisQuery
- @param {String || Array} f A single field name or a list of field names.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ The fields to run the query against. If you call with a single field,
+ it is added to the existing list of fields. If called with an array
+ of field names, it replaces any existing values with the new array.
+
+ @member ejs.FuzzyLikeThisQuery
+ @param {String || Array} f A single field name or a list of field names.
+ @returns {Object} returns this so that calls can be chained.
+ */
fields: function (f) {
if (query.flt.fields == null) {
query.flt.fields = [];
}
-
+
if (f == null) {
return query.flt.fields;
}
-
+
if (isString(f)) {
query.flt.fields.push(f);
} else if (isArray(f)) {
@@ -11496,115 +11628,115 @@
} else {
throw new TypeError('Argument must be a string or array');
}
-
+
return this;
},
-
- /**
- The text to find documents like
- @member ejs.FuzzyLikeThisQuery
- @param {String} s A text string.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ The text to find documents like
+
+ @member ejs.FuzzyLikeThisQuery
+ @param {String} s A text string.
+ @returns {Object} returns this so that calls can be chained.
+ */
likeText: function (txt) {
if (txt == null) {
return query.flt.like_text;
}
-
+
query.flt.like_text = txt;
return this;
},
/**
- Should term frequency be ignored. Defaults to false.
+ Should term frequency be ignored. Defaults to false.
- @member ejs.FuzzyLikeThisQuery
- @param {Boolean} trueFalse A boolean value
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.FuzzyLikeThisQuery
+ @param {Boolean} trueFalse A boolean value
+ @returns {Object} returns this so that calls can be chained.
+ */
ignoreTf: function (trueFalse) {
if (trueFalse == null) {
return query.flt.ignore_tf;
}
-
+
query.flt.ignore_tf = trueFalse;
return this;
},
/**
- The maximum number of query terms that will be included in any
- generated query. Defaults to 25.
+ The maximum number of query terms that will be included in any
+ generated query. Defaults to 25.
- @member ejs.FuzzyLikeThisQuery
- @param {Integer} max A positive integer value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.FuzzyLikeThisQuery
+ @param {Integer} max A positive integer value.
+ @returns {Object} returns this so that calls can be chained.
+ */
maxQueryTerms: function (max) {
if (max == null) {
return query.flt.max_query_terms;
}
-
+
query.flt.max_query_terms = max;
return this;
},
/**
- The minimum similarity of the term variants. Defaults to 0.5.
+ The minimum similarity of the term variants. Defaults to 0.5.
- @member ejs.FuzzyLikeThisQuery
- @param {Double} min A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.FuzzyLikeThisQuery
+ @param {Double} min A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
minSimilarity: function (min) {
if (min == null) {
return query.flt.min_similarity;
}
-
+
query.flt.min_similarity = min;
return this;
},
/**
- Length of required common prefix on variant terms. Defaults to 0..
+ Length of required common prefix on variant terms. Defaults to 0..
- @member ejs.FuzzyLikeThisQuery
- @param {Integer} len A positive integer value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.FuzzyLikeThisQuery
+ @param {Integer} len A positive integer value.
+ @returns {Object} returns this so that calls can be chained.
+ */
prefixLength: function (len) {
if (len == null) {
return query.flt.prefix_length;
}
-
+
query.flt.prefix_length = len;
return this;
},
/**
- The analyzer that will be used to analyze the text. Defaults to the
- analyzer associated with the field.
+ The analyzer that will be used to analyze the text. Defaults to the
+ analyzer associated with the field.
- @member ejs.FuzzyLikeThisQuery
- @param {String} analyzerName The name of the analyzer.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.FuzzyLikeThisQuery
+ @param {String} analyzerName The name of the analyzer.
+ @returns {Object} returns this so that calls can be chained.
+ */
analyzer: function (analyzerName) {
if (analyzerName == null) {
return query.flt.analyzer;
}
-
+
query.flt.analyzer = analyzerName;
return this;
},
-
- /**
- Sets the boost value of the Query.
- @member ejs.FuzzyLikeThisQuery
- @param {Double} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the boost value of the Query.
+
+ @member ejs.FuzzyLikeThisQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.flt.boost;
@@ -11615,30 +11747,30 @@
},
/**
- Serializes the internal query object as a JSON string.
- @member ejs.FuzzyLikeThisQuery
- @returns {String} Returns a JSON representation of the Query object.
- */
+ Serializes the internal query object as a JSON string.
+ @member ejs.FuzzyLikeThisQuery
+ @returns {String} Returns a JSON representation of the Query object.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.FuzzyLikeThisQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.FuzzyLikeThisQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
+
/**
- This method is used to retrieve the raw query object. It's designed
- for internal use when composing and serializing queries.
- @member ejs.FuzzyLikeThisQuery
- @returns {Object} Returns the object's query property.
- */
+ This method is used to retrieve the raw query object. It's designed
+ for internal use when composing and serializing queries.
+ @member ejs.FuzzyLikeThisQuery
+ @returns {Object} Returns the object's query property.
+ */
_self: function () {
return query;
}
@@ -11646,32 +11778,32 @@
};
/**
- @class
- A fuzzy search query based on the Damerau-Levenshtein (optimal string - alignment) algorithm, though you can explicitly choose classic Levenshtein - by passing false to the transpositions parameter./p> - -
fuzzy query on a numeric field will result in a range query “around” - the value using the min_similarity value. As an example, if you perform a - fuzzy query against a field value of "12" with a min similarity setting - of "2", the query will search for values between "10" and "14".
+ @class +A fuzzy search query based on the Damerau-Levenshtein (optimal string + alignment) algorithm, though you can explicitly choose classic Levenshtein + by passing false to the transpositions parameter./p> - @name ejs.FuzzyQuery +
fuzzy query on a numeric field will result in a range query “around” + the value using the min_similarity value. As an example, if you perform a + fuzzy query against a field value of "12" with a min similarity setting + of "2", the query will search for values between "10" and "14".
- @desc -Constructs a query where each documents returned are “like” provided text
- - @param {String} field The field to run the fuzzy query against. - @param {String} value The value to fuzzify. - - */ + @name ejs.FuzzyQuery + + @desc +Constructs a query where each documents returned are “like” provided text
+ + @param {String} field The field to run the fuzzy query against. + @param {String} value The value to fuzzify. + + */ ejs.FuzzyQuery = function (field, value) { /** - The internal Query object. Useget().
- @member ejs.FuzzyQuery
- @property {Object} query
- */
+ The internal Query object. Use get().
+ @member ejs.FuzzyQuery
+ @property {Object} query
+ */
var query = {
fuzzy: {}
};
@@ -11683,33 +11815,33 @@
return {
/**
- The field to run the query against.
+The field to run the query against.
- @member ejs.FuzzyQuery - @param {String} f A single field name. - @returns {Object} returnsthis so that calls can be chained.
- */
+ @member ejs.FuzzyQuery
+ @param {String} f A single field name.
+ @returns {Object} returns this so that calls can be chained.
+ */
field: function (f) {
var oldValue = query.fuzzy[field];
-
+
if (f == null) {
return field;
}
-
+
delete query.fuzzy[field];
field = f;
query.fuzzy[f] = oldValue;
-
+
return this;
},
/**
- The query text to fuzzify.
+The query text to fuzzify.
- @member ejs.FuzzyQuery - @param {String} s A text string. - @returns {Object} returnsthis so that calls can be chained.
- */
+ @member ejs.FuzzyQuery
+ @param {String} s A text string.
+ @returns {Object} returns this so that calls can be chained.
+ */
value: function (txt) {
if (txt == null) {
return query.fuzzy[field].value;
@@ -11720,12 +11852,12 @@
},
/**
- Set to false to use classic Levenshtein edit distance.
+Set to false to use classic Levenshtein edit distance.
- @member ejs.FuzzyQuery - @param {Boolean} trueFalse A boolean value - @returns {Object} returnsthis so that calls can be chained.
- */
+ @member ejs.FuzzyQuery
+ @param {Boolean} trueFalse A boolean value
+ @returns {Object} returns this so that calls can be chained.
+ */
transpositions: function (trueFalse) {
if (trueFalse == null) {
return query.fuzzy[field].transpositions;
@@ -11736,13 +11868,13 @@
},
/**
- The maximum number of query terms that will be included in any
- generated query. Defaults to 50.
+
The maximum number of query terms that will be included in any
+ generated query. Defaults to 50.
- @member ejs.FuzzyQuery
- @param {Integer} max A positive integer value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.FuzzyQuery
+ @param {Integer} max A positive integer value.
+ @returns {Object} returns this so that calls can be chained.
+ */
maxExpansions: function (max) {
if (max == null) {
return query.fuzzy[field].max_expansions;
@@ -11753,12 +11885,12 @@
},
/**
-
The minimum similarity of the term variants. Defaults to 0.5.
The minimum similarity of the term variants. Defaults to 0.5.
this so that calls can be chained.
- */
+ @member ejs.FuzzyQuery
+ @param {Double} min A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
minSimilarity: function (min) {
if (min == null) {
return query.fuzzy[field].min_similarity;
@@ -11769,12 +11901,12 @@
},
/**
- Length of required common prefix on variant terms. Defaults to 0.
Length of required common prefix on variant terms. Defaults to 0.
this so that calls can be chained.
- */
+ @member ejs.FuzzyQuery
+ @param {Integer} len A positive integer value.
+ @returns {Object} returns this so that calls can be chained.
+ */
prefixLength: function (len) {
if (len == null) {
return query.fuzzy[field].prefix_length;
@@ -11783,65 +11915,65 @@
query.fuzzy[field].prefix_length = len;
return this;
},
-
+
/**
- Sets rewrite method. Valid values are:
- -constant_score_auto - tries to pick the best constant-score rewrite
- method based on term and document counts from the queryscoring_boolean - translates each term into boolean should and
- keeps the scores as computed by the queryconstant_score_boolean - same as scoring_boolean, expect no scores
- are computed.constant_score_filter - first creates a private Filter, by visiting
- each term in sequence and marking all docs for that termtop_terms_boost_N - first translates each term into boolean should
- and scores are only computed as the boost using the top N
- scoring terms. Replace N with an integer value.top_terms_N - first translates each term into boolean should
- and keeps the scores as computed by the query. Only the top N
- scoring terms are used. Replace N with an integer value.Default is constant_score_auto.
Sets rewrite method. Valid values are:
-This is an advanced option, use with care.
+constant_score_auto - tries to pick the best constant-score rewrite
+ method based on term and document counts from the querythis so that calls can be chained.
- */
+ scoring_boolean - translates each term into boolean should and
+ keeps the scores as computed by the queryconstant_score_boolean - same as scoring_boolean, expect no scores
+ are computed.constant_score_filter - first creates a private Filter, by visiting
+ each term in sequence and marking all docs for that termtop_terms_boost_N - first translates each term into boolean should
+ and scores are only computed as the boost using the top N
+ scoring terms. Replace N with an integer value.top_terms_N - first translates each term into boolean should
+ and keeps the scores as computed by the query. Only the top N
+ scoring terms are used. Replace N with an integer value.Default is constant_score_auto.
This is an advanced option, use with care.
+ + @member ejs.FuzzyQuery + @param {String} m The rewrite method as a string. + @returns {Object} returnsthis so that calls can be chained.
+ */
rewrite: function (m) {
if (m == null) {
return query.fuzzy[field].rewrite;
}
-
+
m = m.toLowerCase();
if (m === 'constant_score_auto' || m === 'scoring_boolean' ||
m === 'constant_score_boolean' || m === 'constant_score_filter' ||
- m.indexOf('top_terms_boost_') === 0 ||
+ m.indexOf('top_terms_boost_') === 0 ||
m.indexOf('top_terms_') === 0) {
-
+
query.fuzzy[field].rewrite = m;
}
-
+
return this;
},
-
-
- /**
- Sets the boost value of the Query.
double value.
- @returns {Object} returns this so that calls can be chained.
- */
+
+ /**
+ Sets the boost value of the Query.
double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.fuzzy[field].boost;
@@ -11852,32 +11984,32 @@
},
/**
- Serializes the internal query object as a JSON string.
Serializes the internal query object as a JSON string.
The type of ejs object. For internal use only.
- - @member ejs.FuzzyQuery - @returns {String} the type of object - */ +The type of ejs object. For internal use only.
+ + @member ejs.FuzzyQuery + @returns {String} the type of object + */ _type: function () { return 'query'; }, - - /** -This method is used to retrieve the raw query object. It's designed - for internal use when composing and serializing queries.
- @member ejs.FuzzyQuery - @returns {Object} Returns the object's query property. - */ + /** +This method is used to retrieve the raw query object. It's designed + for internal use when composing and serializing queries.
+ + @member ejs.FuzzyQuery + @returns {Object} Returns the object's query property. + */ _self: function () { return query; } @@ -11885,29 +12017,29 @@ }; /** - @class -Efficient querying of documents containing shapes indexed using the - geo_shape type.
+ @class +Efficient querying of documents containing shapes indexed using the + geo_shape type.
-Much like the geo_shape type, the geo_shape query uses a grid square - representation of the query shape to find those documents which have shapes - that relate to the query shape in a specified way. In order to do this, the - field being queried must be of geo_shape type. The query will use the same - PrefixTree configuration as defined for the field.
- - @name ejs.GeoShapeQuery +Much like the geo_shape type, the geo_shape query uses a grid square + representation of the query shape to find those documents which have shapes + that relate to the query shape in a specified way. In order to do this, the + field being queried must be of geo_shape type. The query will use the same + PrefixTree configuration as defined for the field.
- @desc - A Query to find documents with a geo_shapes matching a specific shape. + @name ejs.GeoShapeQuery - */ + @desc + A Query to find documents with a geo_shapes matching a specific shape. + + */ ejs.GeoShapeQuery = function (field) { /** - The internal query object.Use _self()
- @member ejs.GeoShapeQuery
- @property {Object} GeoShapeQuery
- */
+ The internal query object. Use _self()
+ @member ejs.GeoShapeQuery
+ @property {Object} GeoShapeQuery
+ */
var query = {
geo_shape: {}
};
@@ -11917,15 +12049,15 @@
return {
/**
- Sets the field to query against.
+ Sets the field to query against.
- @member ejs.GeoShapeQuery
- @param {String} f A valid field name.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoShapeQuery
+ @param {String} f A valid field name.
+ @returns {Object} returns this so that calls can be chained.
+ */
field: function (f) {
var oldValue = query.geo_shape[field];
-
+
if (f == null) {
return field;
}
@@ -11933,17 +12065,17 @@
delete query.geo_shape[field];
field = f;
query.geo_shape[f] = oldValue;
-
+
return this;
},
/**
- Sets the shape
+ Sets the shape
- @member ejs.GeoShapeQuery
- @param {String} shape A valid Shape object.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoShapeQuery
+ @param {String} shape A valid Shape object.
+ @returns {Object} returns this so that calls can be chained.
+ */
shape: function (shape) {
if (shape == null) {
return query.geo_shape[field].shape;
@@ -11952,19 +12084,19 @@
if (query.geo_shape[field].indexed_shape != null) {
delete query.geo_shape[field].indexed_shape;
}
-
+
query.geo_shape[field].shape = shape._self();
return this;
},
/**
- Sets the indexed shape. Use this if you already have shape definitions
- already indexed.
+ Sets the indexed shape. Use this if you already have shape definitions
+ already indexed.
- @member ejs.GeoShapeQuery
- @param {String} indexedShape A valid IndexedShape object.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoShapeQuery
+ @param {String} indexedShape A valid IndexedShape object.
+ @returns {Object} returns this so that calls can be chained.
+ */
indexedShape: function (indexedShape) {
if (indexedShape == null) {
return query.geo_shape[field].indexed_shape;
@@ -11973,21 +12105,21 @@
if (query.geo_shape[field].shape != null) {
delete query.geo_shape[field].shape;
}
-
+
query.geo_shape[field].indexed_shape = indexedShape._self();
return this;
},
/**
- Sets the shape relation type. A relationship between a Query Shape
- and indexed Shapes that will be used to determine if a Document
- should be matched or not. Valid values are: intersects, disjoint,
- and within.
+ Sets the shape relation type. A relationship between a Query Shape
+ and indexed Shapes that will be used to determine if a Document
+ should be matched or not. Valid values are: intersects, disjoint,
+ and within.
- @member ejs.GeoShapeQuery
- @param {String} indexedShape A valid IndexedShape object.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.GeoShapeQuery
+ @param {String} indexedShape A valid IndexedShape object.
+ @returns {Object} returns this so that calls can be chained.
+ */
relation: function (relation) {
if (relation == null) {
return query.geo_shape[field].relation;
@@ -11997,30 +12129,30 @@
if (relation === 'intersects' || relation === 'disjoint' || relation === 'within') {
query.geo_shape[field].relation = relation;
}
-
+
return this;
},
/**
- Sets the spatial strategy.
-Valid values are:
- -recursive - default, recursively traverse nodes in
- the spatial prefix tree. This strategy has support for
- searching non-point shapes.term - uses a large TermsFilter on each node
- in the spatial prefix tree. It only supports the search of
- indexed Point shapes.Sets the spatial strategy.
+Valid values are:
-This is an advanced setting, use with care.
- - @since elasticsearch 0.90 - @member ejs.GeoShapeQuery - @param {String} strategy The strategy as a string. - @returns {Object} returnsthis so that calls can be chained.
- */
+ recursive - default, recursively traverse nodes in
+ the spatial prefix tree. This strategy has support for
+ searching non-point shapes.term - uses a large TermsFilter on each node
+ in the spatial prefix tree. It only supports the search of
+ indexed Point shapes.This is an advanced setting, use with care.
+ + @since elasticsearch 0.90 + @member ejs.GeoShapeQuery + @param {String} strategy The strategy as a string. + @returns {Object} returnsthis so that calls can be chained.
+ */
strategy: function (strategy) {
if (strategy == null) {
return query.geo_shape[field].strategy;
@@ -12030,17 +12162,17 @@
if (strategy === 'recursive' || strategy === 'term') {
query.geo_shape[field].strategy = strategy;
}
-
+
return this;
},
-
- /**
- Sets the boost value for documents matching the Query.
- @member ejs.GeoShapeQuery
- @param {Number} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the boost value for documents matching the Query.
+
+ @member ejs.GeoShapeQuery
+ @param {Number} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.geo_shape[field].boost;
@@ -12051,32 +12183,32 @@
},
/**
- Allows you to serialize this object into a JSON encoded string.
+ Allows you to serialize this object into a JSON encoded string.
- @member ejs.GeoShapeQuery
- @returns {String} returns this object as a serialized JSON string.
- */
+ @member ejs.GeoShapeQuery
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.GeoShapeQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.GeoShapeQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
- /**
- Retrieves the internal query object. This is typically used by
- internal API functions so use with caution.
- @member ejs.GeoShapeQuery
- @returns {String} returns this object's internal query property.
- */
+ /**
+ Retrieves the internal query object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.GeoShapeQuery
+ @returns {String} returns this object's internal query property.
+ */
_self: function () {
return query;
}
@@ -12084,30 +12216,30 @@
};
/**
- @class
- The has_child query works the same as the has_child filter, - by automatically wrapping the filter with a constant_score. Results in - parent documents that have child docs matching the query being returned.
- - @name ejs.HasChildQuery + @class +The has_child query works the same as the has_child filter, + by automatically wrapping the filter with a constant_score. Results in + parent documents that have child docs matching the query being returned.
- @desc - Returns results that have child documents matching the query. + @name ejs.HasChildQuery - @param {Object} qry A valid query object. - @param {String} type The child type - */ + @desc + Returns results that have child documents matching the query. + + @param {Object} qry A valid query object. + @param {String} type The child type + */ ejs.HasChildQuery = function (qry, type) { if (!isQuery(qry)) { throw new TypeError('Argument must be a valid Query'); } - + /** - The internal query object.Use _self()
- @member ejs.HasChildQuery
- @property {Object} query
- */
+ The internal query object. Use _self()
+ @member ejs.HasChildQuery
+ @property {Object} query
+ */
var query = {
has_child: {
query: qry._self(),
@@ -12118,86 +12250,113 @@
return {
/**
- Sets the query
+ Sets the query
- @member ejs.HasChildQuery
- @param {Object} q A valid Query object
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.HasChildQuery
+ @param {Object} q A valid Query object
+ @returns {Object} returns this so that calls can be chained.
+ */
query: function (q) {
if (q == null) {
return query.has_child.query;
}
-
+
if (!isQuery(q)) {
throw new TypeError('Argument must be a valid Query');
}
-
+
query.has_child.query = q._self();
return this;
},
/**
- Sets the child document type to search against
+ Sets the child document type to search against
- @member ejs.HasChildQuery
- @param {String} t A valid type name
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.HasChildQuery
+ @param {String} t A valid type name
+ @returns {Object} returns this so that calls can be chained.
+ */
type: function (t) {
if (t == null) {
return query.has_child.type;
}
-
+
query.has_child.type = t;
return this;
},
/**
- Sets the scope of the query. A scope allows to run facets on the
- same scope name that will work against the child documents.
+ Sets the scope of the query. A scope allows to run facets on the
+ same scope name that will work against the child documents.
- @deprecated since elasticsearch 0.90
- @member ejs.HasChildQuery
- @param {String} s The scope name as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ @deprecated since elasticsearch 0.90
+ @member ejs.HasChildQuery
+ @param {String} s The scope name as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
scope: function (s) {
return this;
},
/**
- Sets the scoring method. Valid values are:
-
- none - the default, no scoring
- max - the highest score of all matched child documents is used
- sum - the sum the all the matched child documents is used
- avg - the average of all matched child documents is used
+ Sets the scoring method. Valid values are:
- @member ejs.HasChildQuery
- @param {String} s The score type as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ none - the default, no scoring
+ max - the highest score of all matched child documents is used
+ sum - the sum the all the matched child documents is used
+ avg - the average of all matched child documents is used
+
+ @deprecated since elasticsearch 0.90.1, use scoreMode
+
+ @member ejs.HasChildQuery
+ @param {String} s The score type as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
scoreType: function (s) {
if (s == null) {
return query.has_child.score_type;
}
-
+
s = s.toLowerCase();
if (s === 'none' || s === 'max' || s === 'sum' || s === 'avg') {
query.has_child.score_type = s;
}
-
+
return this;
},
-
- /**
- Sets the boost value of the Query.
- @member ejs.HasChildQuery
- @param {Double} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the scoring method. Valid values are:
+
+ none - the default, no scoring
+ max - the highest score of all matched child documents is used
+ sum - the sum the all the matched child documents is used
+ avg - the average of all matched child documents is used
+
+ @member ejs.HasChildQuery
+ @param {String} s The score type as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
+ scoreMode: function (s) {
+ if (s == null) {
+ return query.has_child.score_mode;
+ }
+
+ s = s.toLowerCase();
+ if (s === 'none' || s === 'max' || s === 'sum' || s === 'avg') {
+ query.has_child.score_mode = s;
+ }
+
+ return this;
+ },
+
+ /**
+ Sets the boost value of the Query.
+
+ @member ejs.HasChildQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.has_child.boost;
@@ -12206,34 +12365,34 @@
query.has_child.boost = boost;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.HasChildQuery
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.HasChildQuery
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.HasChildQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.HasChildQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
- /**
- Retrieves the internal query object. This is typically used by
- internal API functions so use with caution.
- @member ejs.HasChildQuery
- @returns {String} returns this object's internal query property.
- */
+ /**
+ Retrieves the internal query object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.HasChildQuery
+ @returns {String} returns this object's internal query property.
+ */
_self: function () {
return query;
}
@@ -12241,30 +12400,30 @@
};
/**
- @class
- The has_parent query works the same as the has_parent filter, by - automatically wrapping the filter with a constant_score. Results in - child documents that have parent docs matching the query being returned.
+ @class +The has_parent query works the same as the has_parent filter, by + automatically wrapping the filter with a constant_score. Results in + child documents that have parent docs matching the query being returned.
- @name ejs.HasParentQuery + @name ejs.HasParentQuery - @desc - Returns results that have parent documents matching the query. + @desc + Returns results that have parent documents matching the query. - @param {Object} qry A valid query object. - @param {String} parentType The child type - */ + @param {Object} qry A valid query object. + @param {String} parentType The child type + */ ejs.HasParentQuery = function (qry, parentType) { if (!isQuery(qry)) { throw new TypeError('Argument must be a Query'); } - + /** - The internal query object.Use _self()
- @member ejs.HasParentQuery
- @property {Object} query
- */
+ The internal query object. Use _self()
+ @member ejs.HasParentQuery
+ @property {Object} query
+ */
var query = {
has_parent: {
query: qry._self(),
@@ -12275,84 +12434,109 @@
return {
/**
- Sets the query
+ Sets the query
- @member ejs.HasParentQuery
- @param {Object} q A valid Query object
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.HasParentQuery
+ @param {Object} q A valid Query object
+ @returns {Object} returns this so that calls can be chained.
+ */
query: function (q) {
if (q == null) {
return query.has_parent.query;
}
-
+
if (!isQuery(q)) {
throw new TypeError('Argument must be a Query');
}
-
+
query.has_parent.query = q._self();
return this;
},
/**
- Sets the child document type to search against
+ Sets the child document type to search against
- @member ejs.HasParentQuery
- @param {String} t A valid type name
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.HasParentQuery
+ @param {String} t A valid type name
+ @returns {Object} returns this so that calls can be chained.
+ */
parentType: function (t) {
if (t == null) {
return query.has_parent.parent_type;
}
-
+
query.has_parent.parent_type = t;
return this;
},
/**
- Sets the scope of the query. A scope allows to run facets on the
- same scope name that will work against the parent documents.
+ Sets the scope of the query. A scope allows to run facets on the
+ same scope name that will work against the parent documents.
- @deprecated since elasticsearch 0.90
- @member ejs.HasParentQuery
- @param {String} s The scope name as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ @deprecated since elasticsearch 0.90
+ @member ejs.HasParentQuery
+ @param {String} s The scope name as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
scope: function (s) {
return this;
},
/**
- Sets the scoring method. Valid values are:
-
- none - the default, no scoring
- score - the score of the parent is used in all child documents.
+ Sets the scoring method. Valid values are:
- @member ejs.HasParentQuery
- @param {String} s The score type as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ none - the default, no scoring
+ score - the score of the parent is used in all child documents.
+
+ @deprecated since elasticsearch 0.90.1 use scoreMode
+
+ @member ejs.HasParentQuery
+ @param {String} s The score type as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
scoreType: function (s) {
if (s == null) {
return query.has_parent.score_type;
}
-
+
s = s.toLowerCase();
if (s === 'none' || s === 'score') {
query.has_parent.score_type = s;
}
-
+
return this;
},
-
- /**
- Sets the boost value of the Query.
- @member ejs.HasParentQuery
- @param {Double} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the scoring method. Valid values are:
+
+ none - the default, no scoring
+ score - the score of the parent is used in all child documents.
+
+ @member ejs.HasParentQuery
+ @param {String} s The score type as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
+ scoreMode: function (s) {
+ if (s == null) {
+ return query.has_parent.score_mode;
+ }
+
+ s = s.toLowerCase();
+ if (s === 'none' || s === 'score') {
+ query.has_parent.score_mode = s;
+ }
+
+ return this;
+ },
+
+ /**
+ Sets the boost value of the Query.
+
+ @member ejs.HasParentQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.has_parent.boost;
@@ -12361,34 +12545,34 @@
query.has_parent.boost = boost;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.HasParentQuery
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.HasParentQuery
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.HasParentQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.HasParentQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
- /**
- Retrieves the internal query object. This is typically used by
- internal API functions so use with caution.
- @member ejs.HasParentQuery
- @returns {String} returns this object's internal query property.
- */
+ /**
+ Retrieves the internal query object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.HasParentQuery
+ @returns {String} returns this object's internal query property.
+ */
_self: function () {
return query;
}
@@ -12396,29 +12580,29 @@
};
/**
- @class
- Filters documents that only have the provided ids. Note, this filter - does not require the _id field to be indexed since it works using the - _uid field.
+ @class +Filters documents that only have the provided ids. Note, this filter + does not require the _id field to be indexed since it works using the + _uid field.
- @name ejs.IdsQuery + @name ejs.IdsQuery - @desc - Matches documents with the specified id(s). + @desc + Matches documents with the specified id(s). - @param {Array || String} ids A single document id or a list of document ids. - */ + @param {Array || String} ids A single document id or a list of document ids. + */ ejs.IdsQuery = function (ids) { /** - The internal query object.Use get()
- @member ejs.IdsQuery
- @property {Object} query
- */
+ The internal query object. Use get()
+ @member ejs.IdsQuery
+ @property {Object} query
+ */
var query = {
ids: {}
};
-
+
if (isString(ids)) {
query.ids.values = [ids];
} else if (isArray(ids)) {
@@ -12430,19 +12614,19 @@
return {
/**
- Sets the values array or adds a new value. if val is a string, it
- is added to the list of existing document ids. If val is an
- array it is set as the document values and replaces any existing values.
+ Sets the values array or adds a new value. if val is a string, it
+ is added to the list of existing document ids. If val is an
+ array it is set as the document values and replaces any existing values.
- @member ejs.IdsQuery
- @param {Array || String} val An single document id or an array of document ids.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.IdsQuery
+ @param {Array || String} val An single document id or an array of document ids.
+ @returns {Object} returns this so that calls can be chained.
+ */
values: function (val) {
if (val == null) {
return query.ids.values;
}
-
+
if (isString(val)) {
query.ids.values.push(val);
} else if (isArray(val)) {
@@ -12450,29 +12634,29 @@
} else {
throw new TypeError('Argument must be string or array');
}
-
+
return this;
},
/**
- Sets the type as a single type or an array of types. If type is a
- string, it is added to the list of existing types. If type is an
- array, it is set as the types and overwrites an existing types. This
- parameter is optional.
+ Sets the type as a single type or an array of types. If type is a
+ string, it is added to the list of existing types. If type is an
+ array, it is set as the types and overwrites an existing types. This
+ parameter is optional.
- @member ejs.IdsQuery
- @param {Array || String} type A type or a list of types
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.IdsQuery
+ @param {Array || String} type A type or a list of types
+ @returns {Object} returns this so that calls can be chained.
+ */
type: function (type) {
if (query.ids.type == null) {
query.ids.type = [];
}
-
+
if (type == null) {
return query.ids.type;
}
-
+
if (isString(type)) {
query.ids.type.push(type);
} else if (isArray(type)) {
@@ -12480,17 +12664,17 @@
} else {
throw new TypeError('Argument must be string or array');
}
-
+
return this;
},
/**
- Sets the boost value of the Query.
+ Sets the boost value of the Query.
- @member ejs.IdsQuery
- @param {Double} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.IdsQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.ids.boost;
@@ -12499,34 +12683,34 @@
query.ids.boost = boost;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.IdsQuery
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.IdsQuery
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.IdsQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.IdsQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
- /**
- Retrieves the internal query object. This is typically used by
- internal API functions so use with caution.
- @member ejs.IdsQuery
- @returns {String} returns this object's internal query property.
- */
+ /**
+ Retrieves the internal query object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.IdsQuery
+ @returns {String} returns this object's internal query property.
+ */
_self: function () {
return query;
}
@@ -12534,32 +12718,32 @@
};
/**
- @class
- The indices query can be used when executed across multiple indices, - allowing to have a query that executes only when executed on an index that - matches a specific list of indices, and another query that executes when it - is executed on an index that does not match the listed indices.
+ @class +The indices query can be used when executed across multiple indices, + allowing to have a query that executes only when executed on an index that + matches a specific list of indices, and another query that executes when it + is executed on an index that does not match the listed indices.
- @name ejs.IndicesQuery + @name ejs.IndicesQuery - @desc - A configurable query that is dependent on the index name. + @desc + A configurable query that is dependent on the index name. - @param {Object} qry A valid query object. - @param {String || Array} indices a single index name or an array of index - names. - */ + @param {Object} qry A valid query object. + @param {String || Array} indices a single index name or an array of index + names. + */ ejs.IndicesQuery = function (qry, indices) { if (!isQuery(qry)) { throw new TypeError('Argument must be a Query'); } - + /** - The internal query object.Use _self()
- @member ejs.IndicesQuery
- @property {Object} query
- */
+ The internal query object. Use _self()
+ @member ejs.IndicesQuery
+ @property {Object} query
+ */
var query = {
indices: {
query: qry._self()
@@ -12573,23 +12757,23 @@
} else {
throw new TypeError('Argument must be a string or array');
}
-
+
return {
/**
- Sets the indicies the query should match. When passed a string,
- the index name is added to the current list of indices. When passed
- an array, it overwites all current indices.
+ Sets the indicies the query should match. When passed a string,
+ the index name is added to the current list of indices. When passed
+ an array, it overwites all current indices.
- @member ejs.IndicesQuery
- @param {String || Array} i A single index name or an array of index names.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.IndicesQuery
+ @param {String || Array} i A single index name or an array of index names.
+ @returns {Object} returns this so that calls can be chained.
+ */
indices: function (i) {
if (i == null) {
return query.indices.indices;
}
-
+
if (isString(i)) {
query.indices.indices.push(i);
} else if (isArray(i)) {
@@ -12600,41 +12784,41 @@
return this;
},
-
- /**
- Sets the query to be executed against the indices specified.
- @member ejs.IndicesQuery
- @param {Object} q A valid Query object
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the query to be executed against the indices specified.
+
+ @member ejs.IndicesQuery
+ @param {Object} q A valid Query object
+ @returns {Object} returns this so that calls can be chained.
+ */
query: function (q) {
if (q == null) {
return query.indices.query;
}
-
+
if (!isQuery(q)) {
throw new TypeError('Argument must be a Query');
}
-
+
query.indices.query = q._self();
return this;
},
/**
- Sets the query to be used on an index that does not match an index
- name in the indices list. Can also be set to "none" to not match any
- documents or "all" to match all documents.
+ Sets the query to be used on an index that does not match an index
+ name in the indices list. Can also be set to "none" to not match any
+ documents or "all" to match all documents.
- @member ejs.IndicesQuery
- @param {Object || String} q A valid Query object or "none" or "all"
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.IndicesQuery
+ @param {Object || String} q A valid Query object or "none" or "all"
+ @returns {Object} returns this so that calls can be chained.
+ */
noMatchQuery: function (q) {
if (q == null) {
return query.indices.no_match_query;
}
-
+
if (isString(q)) {
q = q.toLowerCase();
if (q === 'none' || q === 'all') {
@@ -12645,17 +12829,17 @@
} else {
throw new TypeError('Argument must be string or Query');
}
-
+
return this;
},
-
- /**
- Sets the boost value of the Query.
- @member ejs.IndicesQuery
- @param {Double} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the boost value of the Query.
+
+ @member ejs.IndicesQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.indices.boost;
@@ -12664,34 +12848,34 @@
query.indices.boost = boost;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.IndicesQuery
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.IndicesQuery
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.IndicesQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.IndicesQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
- /**
- Retrieves the internal query object. This is typically used by
- internal API functions so use with caution.
- @member ejs.IndicesQuery
- @returns {String} returns this object's internal query property.
- */
+ /**
+ Retrieves the internal query object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.IndicesQuery
+ @returns {String} returns this object's internal query property.
+ */
_self: function () {
return query;
}
@@ -12699,23 +12883,23 @@
};
/**
- @class
- This query can be used to match all the documents - in a given set of collections and/or types.
+ @class +This query can be used to match all the documents + in a given set of collections and/or types.
- @name ejs.MatchAllQuery + @name ejs.MatchAllQuery - @desc -A query that returns all documents.
+ @desc +A query that returns all documents.
- */ + */ ejs.MatchAllQuery = function () { /** - The internal Query object. Useget().
- @member ejs.MatchAllQuery
- @property {Object} query
- */
+ The internal Query object. Use get().
+ @member ejs.MatchAllQuery
+ @property {Object} query
+ */
var query = {
match_all: {}
};
@@ -12723,12 +12907,12 @@
return {
/**
- Sets the boost value of the Query.
+ Sets the boost value of the Query.
- @member ejs.MatchAllQuery
- @param {Double} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MatchAllQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.match_all.boost;
@@ -12737,33 +12921,33 @@
query.match_all.boost = boost;
return this;
},
-
+
/**
- Serializes the internal query object as a JSON string.
- @member ejs.MatchAllQuery
- @returns {String} Returns a JSON representation of the Query object.
- */
+ Serializes the internal query object as a JSON string.
+ @member ejs.MatchAllQuery
+ @returns {String} Returns a JSON representation of the Query object.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.MatchAllQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.MatchAllQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
+
/**
- This method is used to retrieve the raw query object. It's designed
- for internal use when composing and serializing queries.
-
- @member ejs.MatchAllQuery
- @returns {Object} Returns the object's query property.
- */
+ This method is used to retrieve the raw query object. It's designed
+ for internal use when composing and serializing queries.
+
+ @member ejs.MatchAllQuery
+ @returns {Object} Returns the object's query property.
+ */
_self: function () {
return query;
}
@@ -12771,31 +12955,31 @@
};
/**
- @class
- A MatchQuery is a type of Query that accepts
- text/numerics/dates, analyzes it, generates a query based on the
- MatchQuery type.
-
- @name ejs.MatchQuery
+ @class
+ A MatchQuery is a type of Query that accepts
+ text/numerics/dates, analyzes it, generates a query based on the
+ MatchQuery type.
- @desc
- A Query that appects text, analyzes it, generates internal query based
- on the MatchQuery type.
+ @name ejs.MatchQuery
- @param {String} field the document field/field to query against
- @param {String} qstr the query string
- */
+ @desc
+ A Query that appects text, analyzes it, generates internal query based
+ on the MatchQuery type.
+
+ @param {String} field the document field/field to query against
+ @param {String} qstr the query string
+ */
ejs.MatchQuery = function (field, qstr) {
/**
- The internal query object. Use get()
- @member ejs.MatchQuery
- @property {Object} query
- */
+ The internal query object. Use get()
+ @member ejs.MatchQuery
+ @property {Object} query
+ */
var query = {
match: {}
};
-
+
query.match[field] = {
query: qstr
};
@@ -12803,12 +12987,12 @@
return {
/**
- Sets the boost value for documents matching the Query.
+ Sets the boost value for documents matching the Query.
- @member ejs.MatchQuery
- @param {Number} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MatchQuery
+ @param {Number} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.match[field].boost;
@@ -12819,12 +13003,12 @@
},
/**
- Sets the query string for the Query.
+ Sets the query string for the Query.
- @member ejs.MatchQuery
- @param {String} qstr The query string to search for.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MatchQuery
+ @param {String} qstr The query string to search for.
+ @returns {Object} returns this so that calls can be chained.
+ */
query: function (qstr) {
if (qstr == null) {
return query.match[field].query;
@@ -12835,13 +13019,13 @@
},
/**
- Sets the type of the MatchQuery. Valid values are
- boolean, phrase, and phrase_prefix.
+ Sets the type of the MatchQuery. Valid values are
+ boolean, phrase, and phrase_prefix.
- @member ejs.MatchQuery
- @param {String} type Any of boolean, phrase, phrase_prefix.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MatchQuery
+ @param {String} type Any of boolean, phrase, phrase_prefix.
+ @returns {Object} returns this so that calls can be chained.
+ */
type: function (type) {
if (type == null) {
return query.match[field].type;
@@ -12856,12 +13040,12 @@
},
/**
- Sets the fuzziness value for the Query.
+ Sets the fuzziness value for the Query.
- @member ejs.MatchQuery
- @param {Double} fuzz A double value between 0.0 and 1.0.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MatchQuery
+ @param {Double} fuzz A double value between 0.0 and 1.0.
+ @returns {Object} returns this so that calls can be chained.
+ */
fuzziness: function (fuzz) {
if (fuzz == null) {
return query.match[field].fuzziness;
@@ -12872,14 +13056,14 @@
},
/**
- Sets the maximum threshold/frequency to be considered a low
- frequency term in a CommonTermsQuery.
- Set to a value between 0 and 1.
+ Sets the maximum threshold/frequency to be considered a low
+ frequency term in a CommonTermsQuery.
+ Set to a value between 0 and 1.
- @member ejs.MatchQuery
- @param {Number} freq A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MatchQuery
+ @param {Number} freq A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
cutoffFrequency: function (freq) {
if (freq == null) {
return query.match[field].cutoff_frequency;
@@ -12888,14 +13072,14 @@
query.match[field].cutoff_frequency = freq;
return this;
},
-
- /**
- Sets the prefix length for a fuzzy prefix MatchQuery.
- @member ejs.MatchQuery
- @param {Integer} l A positive integer length value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the prefix length for a fuzzy prefix MatchQuery.
+
+ @member ejs.MatchQuery
+ @param {Integer} l A positive integer length value.
+ @returns {Object} returns this so that calls can be chained.
+ */
prefixLength: function (l) {
if (l == null) {
return query.match[field].prefix_length;
@@ -12906,12 +13090,12 @@
},
/**
- Sets the max expansions of a fuzzy MatchQuery.
+ Sets the max expansions of a fuzzy MatchQuery.
- @member ejs.MatchQuery
- @param {Integer} e A positive integer value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MatchQuery
+ @param {Integer} e A positive integer value.
+ @returns {Object} returns this so that calls can be chained.
+ */
maxExpansions: function (e) {
if (e == null) {
return query.match[field].max_expansions;
@@ -12922,12 +13106,12 @@
},
/**
- Sets default operator of the Query. Default: or.
+ Sets default operator of the Query. Default: or.
- @member ejs.MatchQuery
- @param {String} op Any of "and" or "or", no quote characters.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MatchQuery
+ @param {String} op Any of "and" or "or", no quote characters.
+ @returns {Object} returns this so that calls can be chained.
+ */
operator: function (op) {
if (op == null) {
return query.match[field].operator;
@@ -12942,13 +13126,13 @@
},
/**
- Sets the default slop for phrases. If zero, then exact phrase matches
- are required. Default: 0.
+ Sets the default slop for phrases. If zero, then exact phrase matches
+ are required. Default: 0.
- @member ejs.MatchQuery
- @param {Integer} slop A positive integer value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MatchQuery
+ @param {Integer} slop A positive integer value.
+ @returns {Object} returns this so that calls can be chained.
+ */
slop: function (slop) {
if (slop == null) {
return query.match[field].slop;
@@ -12959,12 +13143,12 @@
},
/**
- Sets the analyzer name used to analyze the Query object.
+ Sets the analyzer name used to analyze the Query object.
- @member ejs.MatchQuery
- @param {String} analyzer A valid analyzer name.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MatchQuery
+ @param {String} analyzer A valid analyzer name.
+ @returns {Object} returns this so that calls can be chained.
+ */
analyzer: function (analyzer) {
if (analyzer == null) {
return query.match[field].analyzer;
@@ -12975,13 +13159,13 @@
},
/**
- Sets a percent value controlling how many "should" clauses in the
- resulting Query should match.
+ Sets a percent value controlling how many "should" clauses in the
+ resulting Query should match.
- @member ejs.MatchQuery
- @param {Integer} minMatch An integer between 0 and 100.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MatchQuery
+ @param {Integer} minMatch An integer between 0 and 100.
+ @returns {Object} returns this so that calls can be chained.
+ */
minimumShouldMatch: function (minMatch) {
if (minMatch == null) {
return query.match[field].minimum_should_match;
@@ -12990,86 +13174,86 @@
query.match[field].minimum_should_match = minMatch;
return this;
},
-
+
/**
- Sets rewrite method. Valid values are:
-
- constant_score_auto - tries to pick the best constant-score rewrite
- method based on term and document counts from the query
-
- scoring_boolean - translates each term into boolean should and
- keeps the scores as computed by the query
-
- constant_score_boolean - same as scoring_boolean, expect no scores
- are computed.
-
- constant_score_filter - first creates a private Filter, by visiting
- each term in sequence and marking all docs for that term
-
- top_terms_boost_N - first translates each term into boolean should
- and scores are only computed as the boost using the top N
- scoring terms. Replace N with an integer value.
-
- top_terms_N - first translates each term into boolean should
- and keeps the scores as computed by the query. Only the top N
- scoring terms are used. Replace N with an integer value.
-
- Default is constant_score_auto.
+ Sets rewrite method. Valid values are:
- This is an advanced option, use with care.
+ constant_score_auto - tries to pick the best constant-score rewrite
+ method based on term and document counts from the query
- @member ejs.MatchQuery
- @param {String} m The rewrite method as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ scoring_boolean - translates each term into boolean should and
+ keeps the scores as computed by the query
+
+ constant_score_boolean - same as scoring_boolean, expect no scores
+ are computed.
+
+ constant_score_filter - first creates a private Filter, by visiting
+ each term in sequence and marking all docs for that term
+
+ top_terms_boost_N - first translates each term into boolean should
+ and scores are only computed as the boost using the top N
+ scoring terms. Replace N with an integer value.
+
+ top_terms_N - first translates each term into boolean should
+ and keeps the scores as computed by the query. Only the top N
+ scoring terms are used. Replace N with an integer value.
+
+ Default is constant_score_auto.
+
+ This is an advanced option, use with care.
+
+ @member ejs.MatchQuery
+ @param {String} m The rewrite method as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
rewrite: function (m) {
if (m == null) {
return query.match[field].rewrite;
}
-
+
m = m.toLowerCase();
if (m === 'constant_score_auto' || m === 'scoring_boolean' ||
m === 'constant_score_boolean' || m === 'constant_score_filter' ||
- m.indexOf('top_terms_boost_') === 0 ||
+ m.indexOf('top_terms_boost_') === 0 ||
m.indexOf('top_terms_') === 0) {
-
+
query.match[field].rewrite = m;
}
-
+
return this;
},
-
- /**
- Sets fuzzy rewrite method. Valid values are:
-
- constant_score_auto - tries to pick the best constant-score rewrite
- method based on term and document counts from the query
-
- scoring_boolean - translates each term into boolean should and
- keeps the scores as computed by the query
-
- constant_score_boolean - same as scoring_boolean, expect no scores
- are computed.
-
- constant_score_filter - first creates a private Filter, by visiting
- each term in sequence and marking all docs for that term
-
- top_terms_boost_N - first translates each term into boolean should
- and scores are only computed as the boost using the top N
- scoring terms. Replace N with an integer value.
-
- top_terms_N - first translates each term into boolean should
- and keeps the scores as computed by the query. Only the top N
- scoring terms are used. Replace N with an integer value.
-
- Default is constant_score_auto.
- This is an advanced option, use with care.
-
- @member ejs.MatchQuery
- @param {String} m The rewrite method as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets fuzzy rewrite method. Valid values are:
+
+ constant_score_auto - tries to pick the best constant-score rewrite
+ method based on term and document counts from the query
+
+ scoring_boolean - translates each term into boolean should and
+ keeps the scores as computed by the query
+
+ constant_score_boolean - same as scoring_boolean, expect no scores
+ are computed.
+
+ constant_score_filter - first creates a private Filter, by visiting
+ each term in sequence and marking all docs for that term
+
+ top_terms_boost_N - first translates each term into boolean should
+ and scores are only computed as the boost using the top N
+ scoring terms. Replace N with an integer value.
+
+ top_terms_N - first translates each term into boolean should
+ and keeps the scores as computed by the query. Only the top N
+ scoring terms are used. Replace N with an integer value.
+
+ Default is constant_score_auto.
+
+ This is an advanced option, use with care.
+
+ @member ejs.MatchQuery
+ @param {String} m The rewrite method as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
fuzzyRewrite: function (m) {
if (m == null) {
return query.match[field].fuzzy_rewrite;
@@ -13078,23 +13262,23 @@
m = m.toLowerCase();
if (m === 'constant_score_auto' || m === 'scoring_boolean' ||
m === 'constant_score_boolean' || m === 'constant_score_filter' ||
- m.indexOf('top_terms_boost_') === 0 ||
+ m.indexOf('top_terms_boost_') === 0 ||
m.indexOf('top_terms_') === 0) {
-
+
query.match[field].fuzzy_rewrite = m;
}
-
+
return this;
},
-
- /**
- Set to false to use classic Levenshtein edit distance in the
- fuzzy query.
- @member ejs.MatchQuery
- @param {Boolean} trueFalse A boolean value
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Set to false to use classic Levenshtein edit distance in the
+ fuzzy query.
+
+ @member ejs.MatchQuery
+ @param {Boolean} trueFalse A boolean value
+ @returns {Object} returns this so that calls can be chained.
+ */
fuzzyTranspositions: function (trueFalse) {
if (trueFalse == null) {
return query.match[field].fuzzy_transpositions;
@@ -13105,12 +13289,12 @@
},
/**
- Enables lenient parsing of the query string.
+ Enables lenient parsing of the query string.
- @member ejs.MatchQuery
- @param {Boolean} trueFalse A boolean value
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MatchQuery
+ @param {Boolean} trueFalse A boolean value
+ @returns {Object} returns this so that calls can be chained.
+ */
lenient: function (trueFalse) {
if (trueFalse == null) {
return query.match[field].lenient;
@@ -13119,15 +13303,15 @@
query.match[field].lenient = trueFalse;
return this;
},
-
- /**
- Sets what happens when no terms match. Valid values are
- "all" or "none".
- @member ejs.MatchQuery
- @param {String} q A no match action, "all" or "none".
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets what happens when no terms match. Valid values are
+ "all" or "none".
+
+ @member ejs.MatchQuery
+ @param {String} q A no match action, "all" or "none".
+ @returns {Object} returns this so that calls can be chained.
+ */
zeroTermsQuery: function (q) {
if (q == null) {
return query.match[field].zero_terms_query;
@@ -13137,37 +13321,37 @@
if (q === 'all' || q === 'none') {
query.match[field].zero_terms_query = q;
}
-
+
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.MatchQuery
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.MatchQuery
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.MatchQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.MatchQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
- /**
- Retrieves the internal query object. This is typically used by
- internal API functions so use with caution.
- @member ejs.MatchQuery
- @returns {String} returns this object's internal query property.
- */
+ /**
+ Retrieves the internal query object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.MatchQuery
+ @returns {String} returns this object's internal query property.
+ */
_self: function () {
return query;
}
@@ -13175,26 +13359,26 @@
};
/**
- @class
- The more_like_this_field query is the same as the more_like_this query, - except it runs against a single field.
+ @class +The more_like_this_field query is the same as the more_like_this query, + except it runs against a single field.
- @name ejs.MoreLikeThisFieldQuery + @name ejs.MoreLikeThisFieldQuery - @desc -Constructs a query where each documents returned are “like” provided text
+ @desc +Constructs a query where each documents returned are “like” provided text
- @param {String} field The field to run the query against. - @param {String} likeText The text to find documents like it. + @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) { /** - The internal Query object. Useget().
- @member ejs.MoreLikeThisFieldQuery
- @property {Object} query
- */
+ The internal Query object. Use get().
+ @member ejs.MoreLikeThisFieldQuery
+ @property {Object} query
+ */
var query = {
mlt_field: {}
};
@@ -13202,37 +13386,37 @@
query.mlt_field[field] = {
like_text: likeText
};
-
+
return {
/**
- The field to run the query against.
+ The field to run the query against.
- @member ejs.MoreLikeThisFieldQuery
- @param {String} f A single field name.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MoreLikeThisFieldQuery
+ @param {String} f A single field name.
+ @returns {Object} returns this 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
+ The text to find documents like
- @member ejs.MoreLikeThisFieldQuery
- @param {String} s A text string.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MoreLikeThisFieldQuery
+ @param {String} s A text string.
+ @returns {Object} returns this so that calls can be chained.
+ */
likeText: function (txt) {
if (txt == null) {
return query.mlt_field[field].like_text;
@@ -13243,13 +13427,13 @@
},
/**
- The percentage of terms to match on (float value).
- Defaults to 0.3 (30 percent).
+ 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 this so that calls can be chained.
- */
+ @member ejs.MoreLikeThisFieldQuery
+ @param {Double} percent A double value between 0 and 1.
+ @returns {Object} returns this so that calls can be chained.
+ */
percentTermsToMatch: function (percent) {
if (percent == null) {
return query.mlt_field[field].percent_terms_to_match;
@@ -13260,13 +13444,13 @@
},
/**
- The frequency below which terms will be ignored in the source doc.
- The default frequency is 2.
+ 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 this so that calls can be chained.
- */
+ @member ejs.MoreLikeThisFieldQuery
+ @param {Integer} freq A positive integer value.
+ @returns {Object} returns this so that calls can be chained.
+ */
minTermFreq: function (freq) {
if (freq == null) {
return query.mlt_field[field].min_term_freq;
@@ -13275,15 +13459,15 @@
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 this so that calls can be chained.
- */
+ /**
+ 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 this so that calls can be chained.
+ */
maxQueryTerms: function (max) {
if (max == null) {
return query.mlt_field[field].max_query_terms;
@@ -13294,16 +13478,16 @@
},
/**
- 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 this so that calls can be chained.
- */
+ 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 this so that calls can be chained.
+ */
stopWords: function (stopWords) {
if (stopWords == null) {
return query.mlt_field[field].stop_words;
@@ -13314,13 +13498,13 @@
},
/**
- The frequency at which words will be ignored which do not occur in
- at least this many docs. Defaults to 5.
+ 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 this so that calls can be chained.
- */
+ @member ejs.MoreLikeThisFieldQuery
+ @param {Integer} min A positive integer value.
+ @returns {Object} returns this so that calls can be chained.
+ */
minDocFreq: function (min) {
if (min == null) {
return query.mlt_field[field].min_doc_freq;
@@ -13331,14 +13515,14 @@
},
/**
- The maximum frequency in which words may still appear. Words that
- appear in more than this many docs will be ignored.
- Defaults to unbounded.
+ 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 this so that calls can be chained.
- */
+ @member ejs.MoreLikeThisFieldQuery
+ @param {Integer} max A positive integer value.
+ @returns {Object} returns this so that calls can be chained.
+ */
maxDocFreq: function (max) {
if (max == null) {
return query.mlt_field[field].max_doc_freq;
@@ -13349,13 +13533,13 @@
},
/**
- 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 this so that calls can be chained.
- */
+ 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 this so that calls can be chained.
+ */
minWordLen: function (len) {
if (len == null) {
return query.mlt_field[field].min_word_len;
@@ -13366,13 +13550,13 @@
},
/**
- 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 this so that calls can be chained.
- */
+ 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 this so that calls can be chained.
+ */
maxWordLen: function (len) {
if (len == null) {
return query.mlt_field[field].max_word_len;
@@ -13381,15 +13565,15 @@
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 this so that calls can be chained.
- */
+ /**
+ 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 this so that calls can be chained.
+ */
analyzer: function (analyzerName) {
if (analyzerName == null) {
return query.mlt_field[field].analyzer;
@@ -13398,15 +13582,15 @@
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 double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the boost factor to use when boosting terms.
+ Defaults to 1.
+
+ @member ejs.MoreLikeThisFieldQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boostTerms: function (boost) {
if (boost == null) {
return query.mlt_field[field].boost_terms;
@@ -13415,14 +13599,14 @@
query.mlt_field[field].boost_terms = boost;
return this;
},
-
- /**
- Sets the boost value of the Query.
- @member ejs.MoreLikeThisFieldQuery
- @param {Double} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the boost value of the Query.
+
+ @member ejs.MoreLikeThisFieldQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.mlt_field[field].boost;
@@ -13433,30 +13617,30 @@
},
/**
- Serializes the internal query object as a JSON string.
- @member ejs.MoreLikeThisFieldQuery
- @returns {String} Returns a JSON representation of the Query object.
- */
+ Serializes the internal query object as a JSON string.
+ @member ejs.MoreLikeThisFieldQuery
+ @returns {String} Returns a JSON representation of the Query object.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.MoreLikeThisFieldQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.MoreLikeThisFieldQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
+
/**
- This method is used to retrieve the raw query object. It's designed
- for internal use when composing and serializing queries.
- @member ejs.MoreLikeThisFieldQuery
- @returns {Object} Returns the object's query property.
- */
+ This method is used to retrieve the raw query object. It's designed
+ for internal use when composing and serializing queries.
+ @member ejs.MoreLikeThisFieldQuery
+ @returns {Object} Returns the object's query property.
+ */
_self: function () {
return query;
}
@@ -13464,26 +13648,26 @@
};
/**
- @class
- More like this query find documents that are “like” provided text by - running it against one or more fields.
+ @class +More like this query find documents that are “like” provided text by + running it against one or more fields.
- @name ejs.MoreLikeThisQuery + @name ejs.MoreLikeThisQuery - @desc -Constructs a query where each documents returned are “like” provided text
+ @desc +Constructs a query where each documents returned are “like” provided text
- @param {String || Array} fields A single field or array of fields to run against. - @param {String} likeText The text to find documents like it. - - */ + @param {String || Array} fields A single field or array of fields to run against. + @param {String} likeText The text to find documents like it. + + */ ejs.MoreLikeThisQuery = function (fields, likeText) { /** - The internal Query object. Useget().
- @member ejs.MoreLikeThisQuery
- @property {Object} query
- */
+ The internal Query object. Use get().
+ @member ejs.MoreLikeThisQuery
+ @property {Object} query
+ */
var query = {
mlt: {
like_text: likeText,
@@ -13498,23 +13682,23 @@
} else {
throw new TypeError('Argument must be string or array');
}
-
- return {
-
- /**
- The fields to run the query against. If you call with a single field,
- it is added to the existing list of fields. If called with an array
- of field names, it replaces any existing values with the new array.
- @member ejs.MoreLikeThisQuery
- @param {String || Array} f A single field name or a list of field names.
- @returns {Object} returns this so that calls can be chained.
- */
+ return {
+
+ /**
+ The fields to run the query against. If you call with a single field,
+ it is added to the existing list of fields. If called with an array
+ of field names, it replaces any existing values with the new array.
+
+ @member ejs.MoreLikeThisQuery
+ @param {String || Array} f A single field name or a list of field names.
+ @returns {Object} returns this so that calls can be chained.
+ */
fields: function (f) {
if (f == null) {
return query.mlt.fields;
}
-
+
if (isString(f)) {
query.mlt.fields.push(f);
} else if (isArray(f)) {
@@ -13522,191 +13706,191 @@
} else {
throw new TypeError('Argument must be a string or array');
}
-
+
return this;
},
-
- /**
- The text to find documents like
- @member ejs.MoreLikeThisQuery
- @param {String} s A text string.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ The text to find documents like
+
+ @member ejs.MoreLikeThisQuery
+ @param {String} s A text string.
+ @returns {Object} returns this so that calls can be chained.
+ */
likeText: function (txt) {
if (txt == null) {
return query.mlt.like_text;
}
-
+
query.mlt.like_text = txt;
return this;
},
/**
- The percentage of terms to match on (float value).
- Defaults to 0.3 (30 percent).
+ The percentage of terms to match on (float value).
+ Defaults to 0.3 (30 percent).
- @member ejs.MoreLikeThisQuery
- @param {Double} percent A double value between 0 and 1.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MoreLikeThisQuery
+ @param {Double} percent A double value between 0 and 1.
+ @returns {Object} returns this so that calls can be chained.
+ */
percentTermsToMatch: function (percent) {
if (percent == null) {
return query.mlt.percent_terms_to_match;
}
-
+
query.mlt.percent_terms_to_match = percent;
return this;
},
/**
- The frequency below which terms will be ignored in the source doc.
- The default frequency is 2.
+ The frequency below which terms will be ignored in the source doc.
+ The default frequency is 2.
- @member ejs.MoreLikeThisQuery
- @param {Integer} freq A positive integer value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MoreLikeThisQuery
+ @param {Integer} freq A positive integer value.
+ @returns {Object} returns this so that calls can be chained.
+ */
minTermFreq: function (freq) {
if (freq == null) {
return query.mlt.min_term_freq;
}
-
+
query.mlt.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.MoreLikeThisQuery
- @param {Integer} max A positive integer value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ The maximum number of query terms that will be included in any
+ generated query. Defaults to 25.
+
+ @member ejs.MoreLikeThisQuery
+ @param {Integer} max A positive integer value.
+ @returns {Object} returns this so that calls can be chained.
+ */
maxQueryTerms: function (max) {
if (max == null) {
return query.mlt.max_query_terms;
}
-
+
query.mlt.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.MoreLikeThisQuery
- @param {Array} stopWords An array of string stopwords
- @returns {Object} returns this so that calls can be chained.
- */
+ 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.MoreLikeThisQuery
+ @param {Array} stopWords An array of string stopwords
+ @returns {Object} returns this so that calls can be chained.
+ */
stopWords: function (stopWords) {
if (stopWords == null) {
return query.mlt.stop_words;
}
-
+
query.mlt.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.
+ The frequency at which words will be ignored which do not occur in
+ at least this many docs. Defaults to 5.
- @member ejs.MoreLikeThisQuery
- @param {Integer} min A positive integer value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MoreLikeThisQuery
+ @param {Integer} min A positive integer value.
+ @returns {Object} returns this so that calls can be chained.
+ */
minDocFreq: function (min) {
if (min == null) {
return query.mlt.min_doc_freq;
}
-
+
query.mlt.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.
+ 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.MoreLikeThisQuery
- @param {Integer} max A positive integer value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MoreLikeThisQuery
+ @param {Integer} max A positive integer value.
+ @returns {Object} returns this so that calls can be chained.
+ */
maxDocFreq: function (max) {
if (max == null) {
return query.mlt.max_doc_freq;
}
-
+
query.mlt.max_doc_freq = max;
return this;
},
/**
- The minimum word length below which words will be ignored.
- Defaults to 0.
-
- @member ejs.MoreLikeThisQuery
- @param {Integer} len A positive integer value.
- @returns {Object} returns this so that calls can be chained.
- */
+ The minimum word length below which words will be ignored.
+ Defaults to 0.
+
+ @member ejs.MoreLikeThisQuery
+ @param {Integer} len A positive integer value.
+ @returns {Object} returns this so that calls can be chained.
+ */
minWordLen: function (len) {
if (len == null) {
return query.mlt.min_word_len;
}
-
+
query.mlt.min_word_len = len;
return this;
},
/**
- The maximum word length above which words will be ignored.
- Defaults to unbounded (0).
-
- @member ejs.MoreLikeThisQuery
- @param {Integer} len A positive integer value.
- @returns {Object} returns this so that calls can be chained.
- */
+ The maximum word length above which words will be ignored.
+ Defaults to unbounded (0).
+
+ @member ejs.MoreLikeThisQuery
+ @param {Integer} len A positive integer value.
+ @returns {Object} returns this so that calls can be chained.
+ */
maxWordLen: function (len) {
if (len == null) {
return query.mlt.max_word_len;
}
-
+
query.mlt.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.MoreLikeThisQuery
- @param {String} analyzerName The name of the analyzer.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ The analyzer that will be used to analyze the text. Defaults to the
+ analyzer associated with the field.
+
+ @member ejs.MoreLikeThisQuery
+ @param {String} analyzerName The name of the analyzer.
+ @returns {Object} returns this so that calls can be chained.
+ */
analyzer: function (analyzerName) {
if (analyzerName == null) {
return query.mlt.analyzer;
}
-
+
query.mlt.analyzer = analyzerName;
return this;
},
-
- /**
- Sets the boost factor to use when boosting terms.
- Defaults to 1.
- @member ejs.MoreLikeThisQuery
- @param {Double} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the boost factor to use when boosting terms.
+ Defaults to 1.
+
+ @member ejs.MoreLikeThisQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boostTerms: function (boost) {
if (boost == null) {
return query.mlt.boost_terms;
@@ -13715,14 +13899,14 @@
query.mlt.boost_terms = boost;
return this;
},
-
- /**
- Sets the boost value of the Query.
- @member ejs.MoreLikeThisQuery
- @param {Double} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the boost value of the Query.
+
+ @member ejs.MoreLikeThisQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.mlt.boost;
@@ -13733,30 +13917,30 @@
},
/**
- Serializes the internal query object as a JSON string.
- @member ejs.MoreLikeThisQuery
- @returns {String} Returns a JSON representation of the Query object.
- */
+ Serializes the internal query object as a JSON string.
+ @member ejs.MoreLikeThisQuery
+ @returns {String} Returns a JSON representation of the Query object.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.MoreLikeThisQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.MoreLikeThisQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
+
/**
- This method is used to retrieve the raw query object. It's designed
- for internal use when composing and serializing queries.
- @member ejs.MoreLikeThisQuery
- @returns {Object} Returns the object's query property.
- */
+ This method is used to retrieve the raw query object. It's designed
+ for internal use when composing and serializing queries.
+ @member ejs.MoreLikeThisQuery
+ @returns {Object} Returns the object's query property.
+ */
_self: function () {
return query;
}
@@ -13764,29 +13948,29 @@
};
/**
- @class
- A MultiMatchQuery query builds further on top of the
- MatchQuery by allowing multiple fields to be specified.
- The idea here is to allow to more easily build a concise match type query
- over multiple fields instead of using a relatively more expressive query
- by using multiple match queries within a bool query.
-
- @name ejs.MultiMatchQuery
+ @class
+ A MultiMatchQuery query builds further on top of the
+ MatchQuery by allowing multiple fields to be specified.
+ The idea here is to allow to more easily build a concise match type query
+ over multiple fields instead of using a relatively more expressive query
+ by using multiple match queries within a bool query.
- @desc
- A Query that allow to more easily build a MatchQuery
- over multiple fields
+ @name ejs.MultiMatchQuery
- @param {String || Array} fields the single field or array of fields to search across
- @param {String} qstr the query string
- */
+ @desc
+ A Query that allow to more easily build a MatchQuery
+ over multiple fields
+
+ @param {String || Array} fields the single field or array of fields to search across
+ @param {String} qstr the query string
+ */
ejs.MultiMatchQuery = function (fields, qstr) {
/**
- The internal query object. Use get()
- @member ejs.MultiMatchQuery
- @property {Object} query
- */
+ The internal query object. Use get()
+ @member ejs.MultiMatchQuery
+ @property {Object} query
+ */
var query = {
multi_match: {
query: qstr,
@@ -13801,20 +13985,20 @@
} else {
throw new TypeError('Argument must be string or array');
}
-
+
return {
/**
- Sets the fields to search across. If passed a single value it is
- added to the existing list of fields. If passed an array of
- values, they overwite all existing values.
+ Sets the fields to search across. If passed a single value it is
+ added to the existing list of fields. If passed an array of
+ values, they overwite all existing values.
- @member ejs.MultiMatchQuery
- @param {String || Array} f A single field or list of fields names to
- search across.
- @returns {Object} returns this so that calls can be
- chained. Returns {Array} current value if `f` not specified.
- */
+ @member ejs.MultiMatchQuery
+ @param {String || Array} f A single field or list of fields names to
+ search across.
+ @returns {Object} returns this so that calls can be
+ chained. Returns {Array} current value if `f` not specified.
+ */
fields: function (f) {
if (f == null) {
return query.multi_match.fields;
@@ -13827,39 +14011,39 @@
} else {
throw new TypeError('Argument must be string or array');
}
-
+
return this;
},
/**
- Sets whether or not queries against multiple fields should be combined using Lucene's
-
- DisjunctionMaxQuery
+ Sets whether or not queries against multiple fields should be combined using Lucene's
+
+ DisjunctionMaxQuery
- @member ejs.MultiMatchQuery
- @param {String} trueFalse A true/false value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MultiMatchQuery
+ @param {String} trueFalse A true/false value.
+ @returns {Object} returns this so that calls can be chained.
+ */
useDisMax: function (trueFalse) {
if (trueFalse == null) {
return query.multi_match.use_dis_max;
}
-
+
query.multi_match.use_dis_max = trueFalse;
return this;
},
/**
- The tie breaker value. The tie breaker capability allows results
- that include the same term in multiple fields to be judged better than
- results that include this term in only the best of those multiple
- fields, without confusing this with the better case of two different
- terms in the multiple fields. Default: 0.0.
+ The tie breaker value. The tie breaker capability allows results
+ that include the same term in multiple fields to be judged better than
+ results that include this term in only the best of those multiple
+ fields, without confusing this with the better case of two different
+ terms in the multiple fields. Default: 0.0.
- @member ejs.MultiMatchQuery
- @param {Double} tieBreaker A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MultiMatchQuery
+ @param {Double} tieBreaker A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
tieBreaker: function (tieBreaker) {
if (tieBreaker == null) {
return query.multi_match.tie_breaker;
@@ -13870,14 +14054,14 @@
},
/**
- Sets the maximum threshold/frequency to be considered a low
- frequency term in a CommonTermsQuery.
- Set to a value between 0 and 1.
+ Sets the maximum threshold/frequency to be considered a low
+ frequency term in a CommonTermsQuery.
+ Set to a value between 0 and 1.
- @member ejs.MultiMatchQuery
- @param {Number} freq A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MultiMatchQuery
+ @param {Number} freq A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
cutoffFrequency: function (freq) {
if (freq == null) {
return query.multi_match.cutoff_frequency;
@@ -13886,15 +14070,15 @@
query.multi_match.cutoff_frequency = freq;
return this;
},
-
- /**
- Sets a percent value controlling how many "should" clauses in the
- resulting Query should match.
- @member ejs.MultiMatchQuery
- @param {Integer} minMatch An integer between 0 and 100.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets a percent value controlling how many "should" clauses in the
+ resulting Query should match.
+
+ @member ejs.MultiMatchQuery
+ @param {Integer} minMatch An integer between 0 and 100.
+ @returns {Object} returns this so that calls can be chained.
+ */
minimumShouldMatch: function (minMatch) {
if (minMatch == null) {
return query.multi_match.minimum_should_match;
@@ -13903,86 +14087,86 @@
query.multi_match.minimum_should_match = minMatch;
return this;
},
-
+
/**
- Sets rewrite method. Valid values are:
-
- constant_score_auto - tries to pick the best constant-score rewrite
- method based on term and document counts from the query
-
- scoring_boolean - translates each term into boolean should and
- keeps the scores as computed by the query
-
- constant_score_boolean - same as scoring_boolean, expect no scores
- are computed.
-
- constant_score_filter - first creates a private Filter, by visiting
- each term in sequence and marking all docs for that term
-
- top_terms_boost_N - first translates each term into boolean should
- and scores are only computed as the boost using the top N
- scoring terms. Replace N with an integer value.
-
- top_terms_N - first translates each term into boolean should
- and keeps the scores as computed by the query. Only the top N
- scoring terms are used. Replace N with an integer value.
-
- Default is constant_score_auto.
+ Sets rewrite method. Valid values are:
- This is an advanced option, use with care.
+ constant_score_auto - tries to pick the best constant-score rewrite
+ method based on term and document counts from the query
- @member ejs.MultiMatchQuery
- @param {String} m The rewrite method as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ scoring_boolean - translates each term into boolean should and
+ keeps the scores as computed by the query
+
+ constant_score_boolean - same as scoring_boolean, expect no scores
+ are computed.
+
+ constant_score_filter - first creates a private Filter, by visiting
+ each term in sequence and marking all docs for that term
+
+ top_terms_boost_N - first translates each term into boolean should
+ and scores are only computed as the boost using the top N
+ scoring terms. Replace N with an integer value.
+
+ top_terms_N - first translates each term into boolean should
+ and keeps the scores as computed by the query. Only the top N
+ scoring terms are used. Replace N with an integer value.
+
+ Default is constant_score_auto.
+
+ This is an advanced option, use with care.
+
+ @member ejs.MultiMatchQuery
+ @param {String} m The rewrite method as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
rewrite: function (m) {
if (m == null) {
return query.multi_match.rewrite;
}
-
+
m = m.toLowerCase();
if (m === 'constant_score_auto' || m === 'scoring_boolean' ||
m === 'constant_score_boolean' || m === 'constant_score_filter' ||
- m.indexOf('top_terms_boost_') === 0 ||
+ m.indexOf('top_terms_boost_') === 0 ||
m.indexOf('top_terms_') === 0) {
-
+
query.multi_match.rewrite = m;
}
-
+
return this;
},
-
- /**
- Sets fuzzy rewrite method. Valid values are:
-
- constant_score_auto - tries to pick the best constant-score rewrite
- method based on term and document counts from the query
-
- scoring_boolean - translates each term into boolean should and
- keeps the scores as computed by the query
-
- constant_score_boolean - same as scoring_boolean, expect no scores
- are computed.
-
- constant_score_filter - first creates a private Filter, by visiting
- each term in sequence and marking all docs for that term
-
- top_terms_boost_N - first translates each term into boolean should
- and scores are only computed as the boost using the top N
- scoring terms. Replace N with an integer value.
-
- top_terms_N - first translates each term into boolean should
- and keeps the scores as computed by the query. Only the top N
- scoring terms are used. Replace N with an integer value.
-
- Default is constant_score_auto.
- This is an advanced option, use with care.
-
- @member ejs.MultiMatchQuery
- @param {String} m The rewrite method as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets fuzzy rewrite method. Valid values are:
+
+ constant_score_auto - tries to pick the best constant-score rewrite
+ method based on term and document counts from the query
+
+ scoring_boolean - translates each term into boolean should and
+ keeps the scores as computed by the query
+
+ constant_score_boolean - same as scoring_boolean, expect no scores
+ are computed.
+
+ constant_score_filter - first creates a private Filter, by visiting
+ each term in sequence and marking all docs for that term
+
+ top_terms_boost_N - first translates each term into boolean should
+ and scores are only computed as the boost using the top N
+ scoring terms. Replace N with an integer value.
+
+ top_terms_N - first translates each term into boolean should
+ and keeps the scores as computed by the query. Only the top N
+ scoring terms are used. Replace N with an integer value.
+
+ Default is constant_score_auto.
+
+ This is an advanced option, use with care.
+
+ @member ejs.MultiMatchQuery
+ @param {String} m The rewrite method as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
fuzzyRewrite: function (m) {
if (m == null) {
return query.multi_match.fuzzy_rewrite;
@@ -13991,22 +14175,22 @@
m = m.toLowerCase();
if (m === 'constant_score_auto' || m === 'scoring_boolean' ||
m === 'constant_score_boolean' || m === 'constant_score_filter' ||
- m.indexOf('top_terms_boost_') === 0 ||
+ m.indexOf('top_terms_boost_') === 0 ||
m.indexOf('top_terms_') === 0) {
-
+
query.multi_match.fuzzy_rewrite = m;
}
-
+
return this;
},
/**
- Enables lenient parsing of the query string.
+ Enables lenient parsing of the query string.
- @member ejs.MultiMatchQuery
- @param {Boolean} trueFalse A boolean value
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MultiMatchQuery
+ @param {Boolean} trueFalse A boolean value
+ @returns {Object} returns this so that calls can be chained.
+ */
lenient: function (trueFalse) {
if (trueFalse == null) {
return query.multi_match.lenient;
@@ -14015,14 +14199,14 @@
query.multi_match.lenient = trueFalse;
return this;
},
-
- /**
- Sets the boost value for documents matching the Query.
- @member ejs.MultiMatchQuery
- @param {Number} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the boost value for documents matching the Query.
+
+ @member ejs.MultiMatchQuery
+ @param {Number} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.multi_match.boost;
@@ -14033,12 +14217,12 @@
},
/**
- Sets the query string for the Query.
+ Sets the query string for the Query.
- @member ejs.MultiMatchQuery
- @param {String} qstr The query string to search for.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MultiMatchQuery
+ @param {String} qstr The query string to search for.
+ @returns {Object} returns this so that calls can be chained.
+ */
query: function (qstr) {
if (qstr == null) {
return query.multi_match.query;
@@ -14049,13 +14233,13 @@
},
/**
- Sets the type of the MultiMatchQuery. Valid values are
- boolean, phrase, and phrase_prefix or phrasePrefix.
+ Sets the type of the MultiMatchQuery. Valid values are
+ boolean, phrase, and phrase_prefix or phrasePrefix.
- @member ejs.MultiMatchQuery
- @param {String} type Any of boolean, phrase, phrase_prefix or phrasePrefix.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MultiMatchQuery
+ @param {String} type Any of boolean, phrase, phrase_prefix or phrasePrefix.
+ @returns {Object} returns this so that calls can be chained.
+ */
type: function (type) {
if (type == null) {
return query.multi_match.type;
@@ -14070,12 +14254,12 @@
},
/**
- Sets the fuzziness value for the Query.
+ Sets the fuzziness value for the Query.
- @member ejs.MultiMatchQuery
- @param {Double} fuzz A double value between 0.0 and 1.0.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MultiMatchQuery
+ @param {Double} fuzz A double value between 0.0 and 1.0.
+ @returns {Object} returns this so that calls can be chained.
+ */
fuzziness: function (fuzz) {
if (fuzz == null) {
return query.multi_match.fuzziness;
@@ -14086,12 +14270,12 @@
},
/**
- Sets the prefix length for a fuzzy prefix Query.
+ Sets the prefix length for a fuzzy prefix Query.
- @member ejs.MultiMatchQuery
- @param {Integer} l A positive integer length value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MultiMatchQuery
+ @param {Integer} l A positive integer length value.
+ @returns {Object} returns this so that calls can be chained.
+ */
prefixLength: function (l) {
if (l == null) {
return query.multi_match.prefix_length;
@@ -14102,12 +14286,12 @@
},
/**
- Sets the max expansions of a fuzzy Query.
+ Sets the max expansions of a fuzzy Query.
- @member ejs.MultiMatchQuery
- @param {Integer} e A positive integer value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MultiMatchQuery
+ @param {Integer} e A positive integer value.
+ @returns {Object} returns this so that calls can be chained.
+ */
maxExpansions: function (e) {
if (e == null) {
return query.multi_match.max_expansions;
@@ -14118,12 +14302,12 @@
},
/**
- Sets default operator of the Query. Default: or.
+ Sets default operator of the Query. Default: or.
- @member ejs.MultiMatchQuery
- @param {String} op Any of "and" or "or", no quote characters.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MultiMatchQuery
+ @param {String} op Any of "and" or "or", no quote characters.
+ @returns {Object} returns this so that calls can be chained.
+ */
operator: function (op) {
if (op == null) {
return query.multi_match.operator;
@@ -14138,13 +14322,13 @@
},
/**
- Sets the default slop for phrases. If zero, then exact phrase matches
- are required. Default: 0.
+ Sets the default slop for phrases. If zero, then exact phrase matches
+ are required. Default: 0.
- @member ejs.MultiMatchQuery
- @param {Integer} slop A positive integer value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MultiMatchQuery
+ @param {Integer} slop A positive integer value.
+ @returns {Object} returns this so that calls can be chained.
+ */
slop: function (slop) {
if (slop == null) {
return query.multi_match.slop;
@@ -14155,12 +14339,12 @@
},
/**
- Sets the analyzer name used to analyze the Query object.
+ Sets the analyzer name used to analyze the Query object.
- @member ejs.MultiMatchQuery
- @param {String} analyzer A valid analyzer name.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MultiMatchQuery
+ @param {String} analyzer A valid analyzer name.
+ @returns {Object} returns this so that calls can be chained.
+ */
analyzer: function (analyzer) {
if (analyzer == null) {
return query.multi_match.analyzer;
@@ -14171,13 +14355,13 @@
},
/**
- Sets what happens when no terms match. Valid values are
- "all" or "none".
+ Sets what happens when no terms match. Valid values are
+ "all" or "none".
- @member ejs.MultiMatchQuery
- @param {String} q A no match action, "all" or "none".
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.MultiMatchQuery
+ @param {String} q A no match action, "all" or "none".
+ @returns {Object} returns this so that calls can be chained.
+ */
zeroTermsQuery: function (q) {
if (q == null) {
return query.multi_match.zero_terms_query;
@@ -14187,37 +14371,37 @@
if (q === 'all' || q === 'none') {
query.multi_match.zero_terms_query = q;
}
-
+
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.MultiMatchQuery
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.MultiMatchQuery
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.MultiMatchQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.MultiMatchQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
- /**
- Retrieves the internal Query object. This is typically used by
- internal API functions so use with caution.
- @member ejs.MultiMatchQuery
- @returns {String} returns this object's internal query property.
- */
+ /**
+ Retrieves the internal Query object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.MultiMatchQuery
+ @returns {String} returns this object's internal query property.
+ */
_self: function () {
return query;
}
@@ -14225,32 +14409,32 @@
};
/**
- @class
- Nested queries allow you to search against content within objects that are
- embedded inside of other objects. It is similar to XPath expressions
- in XML both conceptually and syntactically.
Nested queries allow you to search against content within objects that are
+ embedded inside of other objects. It is similar to XPath expressions
+ in XML both conceptually and syntactically.
The query is executed against the nested objects / docs as if they were - indexed as separate docs and resulting in the rootparent doc (or parent - nested mapping).
- - @name ejs.NestedQuery +The query is executed against the nested objects / docs as if they were + indexed as separate docs and resulting in the rootparent doc (or parent + nested mapping).
- @desc -Constructs a query that is capable of executing a search against objects - nested within a document.
+ @name ejs.NestedQuery - @param {String} path The nested object path. + @desc +Constructs a query that is capable of executing a search against objects + nested within a document.
- */ + @param {String} path The nested object path. + + */ ejs.NestedQuery = function (path) { /** - The internal Query object. Use_self().
-
- @member ejs.NestedQuery
- @property {Object} query
- */
+ The internal Query object. Use _self().
+
+ @member ejs.NestedQuery
+ @property {Object} query
+ */
var query = {
nested: {
path: path
@@ -14258,107 +14442,107 @@
};
return {
-
+
/**
- Sets the root context for the nested query.
-
- @member ejs.NestedQuery
- @param {String} path The path defining the root context for the nested query.
- @returns {Object} returns this so that calls can be chained.
- */
+ Sets the root context for the nested query.
+
+ @member ejs.NestedQuery
+ @param {String} path The path defining the root context for the nested query.
+ @returns {Object} returns this so that calls can be chained.
+ */
path: function (path) {
if (path == null) {
return query.nested.path;
}
-
+
query.nested.path = path;
return this;
},
/**
- Sets the nested query to be executed.
-
- @member ejs.NestedQuery
- @param {Object} oQuery A valid Query object
- @returns {Object} returns this so that calls can be chained.
- */
+ Sets the nested query to be executed.
+
+ @member ejs.NestedQuery
+ @param {Object} oQuery A valid Query object
+ @returns {Object} returns this so that calls can be chained.
+ */
query: function (oQuery) {
if (oQuery == null) {
return query.nested.query;
}
-
+
if (!isQuery(oQuery)) {
throw new TypeError('Argument must be a Query');
}
-
+
query.nested.query = oQuery._self();
return this;
},
/**
- Sets the nested filter to be executed.
-
- @member ejs.NestedQuery
- @param {Object} oFilter A valid Filter object
- @returns {Object} returns this so that calls can be chained.
- */
+ Sets the nested filter to be executed.
+
+ @member ejs.NestedQuery
+ @param {Object} oFilter A valid Filter object
+ @returns {Object} returns this so that calls can be chained.
+ */
filter: function (oFilter) {
if (oFilter == null) {
return query.nested.filter;
}
-
+
if (!isFilter(oFilter)) {
throw new TypeError('Argument must be a Filter');
}
-
+
query.nested.filter = oFilter._self();
return this;
},
/**
- Sets how the inner (nested) matches affect scoring on the parent document.
-
- @member ejs.NestedQuery
- @param {String} mode The mode of scoring to be used for nested matches.
- Options are avg, total, max, none - defaults to avg
- @returns {Object} returns this so that calls can be chained.
- */
+ Sets how the inner (nested) matches affect scoring on the parent document.
+
+ @member ejs.NestedQuery
+ @param {String} mode The mode of scoring to be used for nested matches.
+ Options are avg, total, max, none - defaults to avg
+ @returns {Object} returns this so that calls can be chained.
+ */
scoreMode: function (mode) {
if (mode == null) {
return query.nested.score_mode;
}
-
+
mode = mode.toLowerCase();
- if (mode === 'avg' || mode === 'total' || mode === 'max' ||
- mode === 'none') {
-
+ if (mode === 'avg' || mode === 'total' || mode === 'max' ||
+ mode === 'none' || mode === 'sum') {
+
query.nested.score_mode = mode;
}
-
+
return this;
},
/**
- Sets the scope of the query. A scope allows to run facets on the
- same scope name that will work against the nested documents.
+ Sets the scope of the query. A scope allows to run facets on the
+ same scope name that will work against the nested documents.
- @deprecated since elasticsearch 0.90
- @member ejs.NestedQuery
- @param {String} s The scope name as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ @deprecated since elasticsearch 0.90
+ @member ejs.NestedQuery
+ @param {String} s The scope name as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
scope: function (s) {
return this;
},
-
- /**
- Sets the boost value of the nested Query.
- @member ejs.NestedQuery
- @param {Double} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the boost value of the nested Query.
+
+ @member ejs.NestedQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.nested.boost;
@@ -14367,34 +14551,34 @@
query.nested.boost = boost;
return this;
},
-
+
/**
- Serializes the internal query object as a JSON string.
-
- @member ejs.NestedQuery
- @returns {String} Returns a JSON representation of the termFilter object.
- */
+ Serializes the internal query object as a JSON string.
+
+ @member ejs.NestedQuery
+ @returns {String} Returns a JSON representation of the termFilter object.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.NestedQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.NestedQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
+
/**
- This method is used to retrieve the raw query object. It's designed
- for internal use when composing and serializing queries.
-
- @member ejs.NestedQuery
- @returns {Object} Returns the object's query property.
- */
+ This method is used to retrieve the raw query object. It's designed
+ for internal use when composing and serializing queries.
+
+ @member ejs.NestedQuery
+ @returns {Object} Returns the object's query property.
+ */
_self: function () {
return query;
}
@@ -14402,25 +14586,25 @@
};
/**
- @class
- Matches documents that have fields containing terms with a specified - prefix (not analyzed). The prefix query maps to Lucene PrefixQuery.
+ @class +Matches documents that have fields containing terms with a specified + prefix (not analyzed). The prefix query maps to Lucene PrefixQuery.
- @name ejs.PrefixQuery + @name ejs.PrefixQuery - @desc - Matches documents containing the specified un-analyzed prefix. + @desc + Matches documents containing the specified un-analyzed prefix. - @param {String} field A valid field name. - @param {String} value A string prefix. - */ + @param {String} field A valid field name. + @param {String} value A string prefix. + */ ejs.PrefixQuery = function (field, value) { /** - The internal query object.Use get()
- @member ejs.PrefixQuery
- @property {Object} query
- */
+ The internal query object. Use get()
+ @member ejs.PrefixQuery
+ @property {Object} query
+ */
var query = {
prefix: {}
};
@@ -14428,19 +14612,19 @@
query.prefix[field] = {
value: value
};
-
+
return {
/**
- The field to run the query against.
+ The field to run the query against.
- @member ejs.PrefixQuery
- @param {String} f A single field name.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.PrefixQuery
+ @param {String} f A single field name.
+ @returns {Object} returns this so that calls can be chained.
+ */
field: function (f) {
var oldValue = query.prefix[field];
-
+
if (f == null) {
return field;
}
@@ -14453,12 +14637,12 @@
},
/**
- The prefix value.
+ The prefix value.
- @member ejs.PrefixQuery
- @param {String} p A string prefix
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.PrefixQuery
+ @param {String} p A string prefix
+ @returns {Object} returns this so that calls can be chained.
+ */
value: function (p) {
if (p == null) {
return query.prefix[field].value;
@@ -14469,60 +14653,60 @@
},
/**
- Sets rewrite method. Valid values are:
-
- constant_score_auto - tries to pick the best constant-score rewrite
- method based on term and document counts from the query
-
- scoring_boolean - translates each term into boolean should and
- keeps the scores as computed by the query
-
- constant_score_boolean - same as scoring_boolean, expect no scores
- are computed.
-
- constant_score_filter - first creates a private Filter, by visiting
- each term in sequence and marking all docs for that term
-
- top_terms_boost_N - first translates each term into boolean should
- and scores are only computed as the boost using the top N
- scoring terms. Replace N with an integer value.
-
- top_terms_N - first translates each term into boolean should
- and keeps the scores as computed by the query. Only the top N
- scoring terms are used. Replace N with an integer value.
-
- Default is constant_score_auto.
+ Sets rewrite method. Valid values are:
- This is an advanced option, use with care.
+ constant_score_auto - tries to pick the best constant-score rewrite
+ method based on term and document counts from the query
- @member ejs.PrefixQuery
- @param {String} m The rewrite method as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ scoring_boolean - translates each term into boolean should and
+ keeps the scores as computed by the query
+
+ constant_score_boolean - same as scoring_boolean, expect no scores
+ are computed.
+
+ constant_score_filter - first creates a private Filter, by visiting
+ each term in sequence and marking all docs for that term
+
+ top_terms_boost_N - first translates each term into boolean should
+ and scores are only computed as the boost using the top N
+ scoring terms. Replace N with an integer value.
+
+ top_terms_N - first translates each term into boolean should
+ and keeps the scores as computed by the query. Only the top N
+ scoring terms are used. Replace N with an integer value.
+
+ Default is constant_score_auto.
+
+ This is an advanced option, use with care.
+
+ @member ejs.PrefixQuery
+ @param {String} m The rewrite method as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
rewrite: function (m) {
if (m == null) {
return query.prefix[field].rewrite;
}
-
+
m = m.toLowerCase();
if (m === 'constant_score_auto' || m === 'scoring_boolean' ||
m === 'constant_score_boolean' || m === 'constant_score_filter' ||
- m.indexOf('top_terms_boost_') === 0 ||
+ m.indexOf('top_terms_boost_') === 0 ||
m.indexOf('top_terms_') === 0) {
-
+
query.prefix[field].rewrite = m;
}
-
+
return this;
},
-
- /**
- Sets the boost value of the Query.
- @member ejs.PrefixQuery
- @param {Double} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the boost value of the Query.
+
+ @member ejs.PrefixQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.prefix[field].boost;
@@ -14531,34 +14715,34 @@
query.prefix[field].boost = boost;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.PrefixQuery
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.PrefixQuery
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.PrefixQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.PrefixQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
- /**
- Retrieves the internal query object. This is typically used by
- internal API functions so use with caution.
- @member ejs.PrefixQuery
- @returns {String} returns this object's internal query property.
- */
+ /**
+ Retrieves the internal query object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.PrefixQuery
+ @returns {String} returns this object's internal query property.
+ */
_self: function () {
return query;
}
@@ -14566,28 +14750,28 @@
};
/**
- @class
- A query that is parsed using Lucene's default query parser. Although Lucene provides the - ability to create your own queries through its API, it also provides a rich query language - through the Query Parser, a lexer which interprets a string into a Lucene Query.
+ @class +A query that is parsed using Lucene's default query parser. Although Lucene provides the + ability to create your own queries through its API, it also provides a rich query language + through the Query Parser, a lexer which interprets a string into a Lucene Query.
- See the Lucene Query Parser Syntax - for more information. + See the Lucene Query Parser Syntax + for more information. - @name ejs.QueryStringQuery + @name ejs.QueryStringQuery - @desc - A query that is parsed using Lucene's default query parser. + @desc + A query that is parsed using Lucene's default query parser. - @param {String} qstr A valid Lucene query string. - */ + @param {String} qstr A valid Lucene query string. + */ ejs.QueryStringQuery = function (qstr) { /** - The internal Query object. Useget().
- @member ejs.QueryStringQuery
- @property {Object} query
- */
+ The internal Query object. Use get().
+ @member ejs.QueryStringQuery
+ @property {Object} query
+ */
var query = {
query_string: {}
};
@@ -14597,12 +14781,12 @@
return {
/**
- Sets the query string on this Query object.
+ Sets the query string on this Query object.
- @member ejs.QueryStringQuery
- @param {String} qstr A valid Lucene query string.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.QueryStringQuery
+ @param {String} qstr A valid Lucene query string.
+ @returns {Object} returns this so that calls can be chained.
+ */
query: function (qstr) {
if (qstr == null) {
return query.query_string.query;
@@ -14613,42 +14797,42 @@
},
/**
- Sets the default field/property this query should execute against.
+ Sets the default field/property this query should execute against.
- @member ejs.QueryStringQuery
- @param {String} fieldName The name of document field/property.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.QueryStringQuery
+ @param {String} fieldName The name of document field/property.
+ @returns {Object} returns this so that calls can be chained.
+ */
defaultField: function (fieldName) {
if (fieldName == null) {
return query.query_string.default_field;
}
-
+
query.query_string.default_field = fieldName;
return this;
},
/**
- A set of fields/properties this query should execute against.
- Pass a single value to add to the existing list of fields and
- pass an array to overwrite all existing fields. For each field,
- you can apply a field specific boost by appending a ^boost to the
- field name. For example, title^10, to give the title field a
- boost of 10.
+ A set of fields/properties this query should execute against.
+ Pass a single value to add to the existing list of fields and
+ pass an array to overwrite all existing fields. For each field,
+ you can apply a field specific boost by appending a ^boost to the
+ field name. For example, title^10, to give the title field a
+ boost of 10.
- @member ejs.QueryStringQuery
- @param {Array} fieldNames A list of document fields/properties.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.QueryStringQuery
+ @param {Array} fieldNames A list of document fields/properties.
+ @returns {Object} returns this so that calls can be chained.
+ */
fields: function (fieldNames) {
if (query.query_string.fields == null) {
query.query_string.fields = [];
}
-
+
if (fieldNames == null) {
return query.query_string.fields;
}
-
+
if (isString(fieldNames)) {
query.query_string.fields.push(fieldNames);
} else if (isArray(fieldNames)) {
@@ -14656,57 +14840,57 @@
} else {
throw new TypeError('Argument must be a string or array');
}
-
+
return this;
},
/**
- Sets whether or not queries against multiple fields should be combined using Lucene's
-
- DisjunctionMaxQuery
+ Sets whether or not queries against multiple fields should be combined using Lucene's
+
+ DisjunctionMaxQuery
- @member ejs.QueryStringQuery
- @param {String} trueFalse A true/false value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.QueryStringQuery
+ @param {String} trueFalse A true/false value.
+ @returns {Object} returns this so that calls can be chained.
+ */
useDisMax: function (trueFalse) {
if (trueFalse == null) {
return query.query_string.use_dis_max;
}
-
+
query.query_string.use_dis_max = trueFalse;
return this;
},
/**
- Set the default Boolean operator. This operator is used to join individual query
- terms when no operator is explicity used in the query string (i.e., this AND that).
- Defaults to OR (same as Google).
+ Set the default Boolean operator. This operator is used to join individual query
+ terms when no operator is explicity used in the query string (i.e., this AND that).
+ Defaults to OR (same as Google).
- @member ejs.QueryStringQuery
- @param {String} op The operator to use, AND or OR.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.QueryStringQuery
+ @param {String} op The operator to use, AND or OR.
+ @returns {Object} returns this so that calls can be chained.
+ */
defaultOperator: function (op) {
if (op == null) {
return query.query_string.default_operator;
}
-
+
op = op.toUpperCase();
if (op === 'AND' || op === 'OR') {
query.query_string.default_operator = op;
}
-
+
return this;
},
/**
- Sets the analyzer name used to analyze the Query object.
+ Sets the analyzer name used to analyze the Query object.
- @member ejs.QueryStringQuery
- @param {String} analyzer A valid analyzer name.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.QueryStringQuery
+ @param {String} analyzer A valid analyzer name.
+ @returns {Object} returns this so that calls can be chained.
+ */
analyzer: function (analyzer) {
if (analyzer == null) {
return query.query_string.analyzer;
@@ -14717,13 +14901,13 @@
},
/**
- Sets the quote analyzer name used to analyze the query
- when in quoted text.
+ Sets the quote analyzer name used to analyze the query
+ when in quoted text.
- @member ejs.QueryStringQuery
- @param {String} analyzer A valid analyzer name.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.QueryStringQuery
+ @param {String} analyzer A valid analyzer name.
+ @returns {Object} returns this so that calls can be chained.
+ */
quoteAnalyzer: function (analyzer) {
if (analyzer == null) {
return query.query_string.quote_analyzer;
@@ -14732,15 +14916,15 @@
query.query_string.quote_analyzer = analyzer;
return this;
},
-
- /**
- Sets whether or not wildcard characters (* and ?) are allowed as the
- first character of the Query. Default: true.
- @member ejs.QueryStringQuery
- @param {Boolean} trueFalse A true/false value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets whether or not wildcard characters (* and ?) are allowed as the
+ first character of the Query. Default: true.
+
+ @member ejs.QueryStringQuery
+ @param {Boolean} trueFalse A true/false value.
+ @returns {Object} returns this so that calls can be chained.
+ */
allowLeadingWildcard: function (trueFalse) {
if (trueFalse == null) {
return query.query_string.allow_leading_wildcard;
@@ -14751,14 +14935,14 @@
},
/**
- Sets whether or not terms from wildcard, prefix, fuzzy, and
- range queries should automatically be lowercased in the Query
- since they are not analyzed. Default: true.
+ Sets whether or not terms from wildcard, prefix, fuzzy, and
+ range queries should automatically be lowercased in the Query
+ since they are not analyzed. Default: true.
- @member ejs.QueryStringQuery
- @param {Boolean} trueFalse A true/false value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.QueryStringQuery
+ @param {Boolean} trueFalse A true/false value.
+ @returns {Object} returns this so that calls can be chained.
+ */
lowercaseExpandedTerms: function (trueFalse) {
if (trueFalse == null) {
return query.query_string.lowercase_expanded_terms;
@@ -14769,13 +14953,13 @@
},
/**
- Sets whether or not position increments will be used in the
- Query. Default: true.
+ Sets whether or not position increments will be used in the
+ Query. Default: true.
- @member ejs.QueryStringQuery
- @param {Boolean} trueFalse A true/false value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.QueryStringQuery
+ @param {Boolean} trueFalse A true/false value.
+ @returns {Object} returns this so that calls can be chained.
+ */
enablePositionIncrements: function (trueFalse) {
if (trueFalse == null) {
return query.query_string.enable_position_increments;
@@ -14787,12 +14971,12 @@
/**
- Sets the prefix length for fuzzy queries. Default: 0.
+ Sets the prefix length for fuzzy queries. Default: 0.
- @member ejs.QueryStringQuery
- @param {Integer} fuzzLen A positive integer value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.QueryStringQuery
+ @param {Integer} fuzzLen A positive integer value.
+ @returns {Object} returns this so that calls can be chained.
+ */
fuzzyPrefixLength: function (fuzzLen) {
if (fuzzLen == null) {
return query.query_string.fuzzy_prefix_length;
@@ -14803,12 +14987,12 @@
},
/**
- Set the minimum similarity for fuzzy queries. Default: 0.5.
+ Set the minimum similarity for fuzzy queries. Default: 0.5.
- @member ejs.QueryStringQuery
- @param {Double} minSim A double value between 0 and 1.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.QueryStringQuery
+ @param {Double} minSim A double value between 0 and 1.
+ @returns {Object} returns this so that calls can be chained.
+ */
fuzzyMinSim: function (minSim) {
if (minSim == null) {
return query.query_string.fuzzy_min_sim;
@@ -14819,13 +15003,13 @@
},
/**
- Sets the default slop for phrases. If zero, then exact phrase matches
- are required. Default: 0.
+ Sets the default slop for phrases. If zero, then exact phrase matches
+ are required. Default: 0.
- @member ejs.QueryStringQuery
- @param {Integer} slop A positive integer value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.QueryStringQuery
+ @param {Integer} slop A positive integer value.
+ @returns {Object} returns this so that calls can be chained.
+ */
phraseSlop: function (slop) {
if (slop == null) {
return query.query_string.phrase_slop;
@@ -14836,12 +15020,12 @@
},
/**
- Sets the boost value of the Query. Default: 1.0.
+ Sets the boost value of the Query. Default: 1.0.
- @member ejs.QueryStringQuery
- @param {Double} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.QueryStringQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.query_string.boost;
@@ -14852,14 +15036,14 @@
},
/**
- Sets whether or not we should attempt to analyzed wilcard terms in the
- Query. By default, wildcard terms are not analyzed.
- Analysis of wildcard characters is not perfect. Default: false.
+ Sets whether or not we should attempt to analyzed wilcard terms in the
+ Query. By default, wildcard terms are not analyzed.
+ Analysis of wildcard characters is not perfect. Default: false.
- @member ejs.QueryStringQuery
- @param {Boolean} trueFalse A true/false value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.QueryStringQuery
+ @param {Boolean} trueFalse A true/false value.
+ @returns {Object} returns this so that calls can be chained.
+ */
analyzeWildcard: function (trueFalse) {
if (trueFalse == null) {
return query.query_string.analyze_wildcard;
@@ -14870,13 +15054,13 @@
},
/**
- Sets whether or not we should auto generate phrase queries *if* the
- analyzer returns more than one term. Default: false.
+ Sets whether or not we should auto generate phrase queries *if* the
+ analyzer returns more than one term. Default: false.
- @member ejs.QueryStringQuery
- @param {Boolean} trueFalse A true/false value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.QueryStringQuery
+ @param {Boolean} trueFalse A true/false value.
+ @returns {Object} returns this so that calls can be chained.
+ */
autoGeneratePhraseQueries: function (trueFalse) {
if (trueFalse == null) {
return query.query_string.auto_generate_phrase_queries;
@@ -14887,13 +15071,13 @@
},
/**
- Sets a percent value controlling how many "should" clauses in the
- resulting Query should match.
+ Sets a percent value controlling how many "should" clauses in the
+ resulting Query should match.
- @member ejs.QueryStringQuery
- @param {Integer} minMatch An integer between 0 and 100.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.QueryStringQuery
+ @param {Integer} minMatch An integer between 0 and 100.
+ @returns {Object} returns this so that calls can be chained.
+ */
minimumShouldMatch: function (minMatch) {
if (minMatch == null) {
return query.query_string.minimum_should_match;
@@ -14904,17 +15088,17 @@
},
/**
- Sets the tie breaker value for a Query using
- DisMax. The tie breaker capability allows results
- that include the same term in multiple fields to be judged better than
- results that include this term in only the best of those multiple
- fields, without confusing this with the better case of two different
- terms in the multiple fields. Default: 0.0.
+ Sets the tie breaker value for a Query using
+ DisMax. The tie breaker capability allows results
+ that include the same term in multiple fields to be judged better than
+ results that include this term in only the best of those multiple
+ fields, without confusing this with the better case of two different
+ terms in the multiple fields. Default: 0.0.
- @member ejs.QueryStringQuery
- @param {Double} tieBreaker A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.QueryStringQuery
+ @param {Double} tieBreaker A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
tieBreaker: function (tieBreaker) {
if (tieBreaker == null) {
return query.query_string.tie_breaker;
@@ -14925,12 +15109,12 @@
},
/**
- If they query string should be escaped or not.
+ If they query string should be escaped or not.
- @member ejs.QueryStringQuery
- @param {Boolean} trueFalse A true/false value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.QueryStringQuery
+ @param {Boolean} trueFalse A true/false value.
+ @returns {Object} returns this so that calls can be chained.
+ */
escape: function (trueFalse) {
if (trueFalse == null) {
return query.query_string.escape;
@@ -14941,12 +15125,12 @@
},
/**
- Sets the max number of term expansions for fuzzy queries.
+ Sets the max number of term expansions for fuzzy queries.
- @member ejs.QueryStringQuery
- @param {Integer} max A positive integer value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.QueryStringQuery
+ @param {Integer} max A positive integer value.
+ @returns {Object} returns this so that calls can be chained.
+ */
fuzzyMaxExpansions: function (max) {
if (max == null) {
return query.query_string.fuzzy_max_expansions;
@@ -14957,36 +15141,36 @@
},
/**
- Sets fuzzy rewrite method. Valid values are:
-
- constant_score_auto - tries to pick the best constant-score rewrite
- method based on term and document counts from the query
-
- scoring_boolean - translates each term into boolean should and
- keeps the scores as computed by the query
-
- constant_score_boolean - same as scoring_boolean, expect no scores
- are computed.
-
- constant_score_filter - first creates a private Filter, by visiting
- each term in sequence and marking all docs for that term
-
- top_terms_boost_N - first translates each term into boolean should
- and scores are only computed as the boost using the top N
- scoring terms. Replace N with an integer value.
-
- top_terms_N - first translates each term into boolean should
- and keeps the scores as computed by the query. Only the top N
- scoring terms are used. Replace N with an integer value.
-
- Default is constant_score_auto.
+ Sets fuzzy rewrite method. Valid values are:
- This is an advanced option, use with care.
-
- @member ejs.QueryStringQuery
- @param {String} m The rewrite method as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ constant_score_auto - tries to pick the best constant-score rewrite
+ method based on term and document counts from the query
+
+ scoring_boolean - translates each term into boolean should and
+ keeps the scores as computed by the query
+
+ constant_score_boolean - same as scoring_boolean, expect no scores
+ are computed.
+
+ constant_score_filter - first creates a private Filter, by visiting
+ each term in sequence and marking all docs for that term
+
+ top_terms_boost_N - first translates each term into boolean should
+ and scores are only computed as the boost using the top N
+ scoring terms. Replace N with an integer value.
+
+ top_terms_N - first translates each term into boolean should
+ and keeps the scores as computed by the query. Only the top N
+ scoring terms are used. Replace N with an integer value.
+
+ Default is constant_score_auto.
+
+ This is an advanced option, use with care.
+
+ @member ejs.QueryStringQuery
+ @param {String} m The rewrite method as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
fuzzyRewrite: function (m) {
if (m == null) {
return query.query_string.fuzzy_rewrite;
@@ -14995,71 +15179,71 @@
m = m.toLowerCase();
if (m === 'constant_score_auto' || m === 'scoring_boolean' ||
m === 'constant_score_boolean' || m === 'constant_score_filter' ||
- m.indexOf('top_terms_boost_') === 0 ||
+ m.indexOf('top_terms_boost_') === 0 ||
m.indexOf('top_terms_') === 0) {
-
+
query.query_string.fuzzy_rewrite = m;
}
-
+
return this;
},
/**
- Sets rewrite method. Valid values are:
-
- constant_score_auto - tries to pick the best constant-score rewrite
- method based on term and document counts from the query
-
- scoring_boolean - translates each term into boolean should and
- keeps the scores as computed by the query
-
- constant_score_boolean - same as scoring_boolean, expect no scores
- are computed.
-
- constant_score_filter - first creates a private Filter, by visiting
- each term in sequence and marking all docs for that term
-
- top_terms_boost_N - first translates each term into boolean should
- and scores are only computed as the boost using the top N
- scoring terms. Replace N with an integer value.
-
- top_terms_N - first translates each term into boolean should
- and keeps the scores as computed by the query. Only the top N
- scoring terms are used. Replace N with an integer value.
-
- Default is constant_score_auto.
+ Sets rewrite method. Valid values are:
- This is an advanced option, use with care.
+ constant_score_auto - tries to pick the best constant-score rewrite
+ method based on term and document counts from the query
- @member ejs.QueryStringQuery
- @param {String} m The rewrite method as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ scoring_boolean - translates each term into boolean should and
+ keeps the scores as computed by the query
+
+ constant_score_boolean - same as scoring_boolean, expect no scores
+ are computed.
+
+ constant_score_filter - first creates a private Filter, by visiting
+ each term in sequence and marking all docs for that term
+
+ top_terms_boost_N - first translates each term into boolean should
+ and scores are only computed as the boost using the top N
+ scoring terms. Replace N with an integer value.
+
+ top_terms_N - first translates each term into boolean should
+ and keeps the scores as computed by the query. Only the top N
+ scoring terms are used. Replace N with an integer value.
+
+ Default is constant_score_auto.
+
+ This is an advanced option, use with care.
+
+ @member ejs.QueryStringQuery
+ @param {String} m The rewrite method as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
rewrite: function (m) {
if (m == null) {
return query.query_string.rewrite;
}
-
+
m = m.toLowerCase();
if (m === 'constant_score_auto' || m === 'scoring_boolean' ||
m === 'constant_score_boolean' || m === 'constant_score_filter' ||
- m.indexOf('top_terms_boost_') === 0 ||
+ m.indexOf('top_terms_boost_') === 0 ||
m.indexOf('top_terms_') === 0) {
-
+
query.query_string.rewrite = m;
}
-
+
return this;
},
/**
- Sets the suffix to automatically add to the field name when
- performing a quoted search.
+ Sets the suffix to automatically add to the field name when
+ performing a quoted search.
- @member ejs.QueryStringQuery
- @param {String} s The suffix as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.QueryStringQuery
+ @param {String} s The suffix as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
quoteFieldSuffix: function (s) {
if (s == null) {
return query.query_string.quote_field_suffix;
@@ -15068,14 +15252,14 @@
query.query_string.quote_field_suffix = s;
return this;
},
-
- /**
- Enables lenient parsing of the query string.
- @member ejs.QueryStringQuery
- @param {Boolean} trueFalse A boolean value
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Enables lenient parsing of the query string.
+
+ @member ejs.QueryStringQuery
+ @param {Boolean} trueFalse A boolean value
+ @returns {Object} returns this so that calls can be chained.
+ */
lenient: function (trueFalse) {
if (trueFalse == null) {
return query.query_string.lenient;
@@ -15084,34 +15268,34 @@
query.query_string.lenient = trueFalse;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.QueryStringQuery
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.QueryStringQuery
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.QueryStringQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.QueryStringQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
- /**
- Retrieves the internal query object. This is typically used by
- internal API functions so use with caution.
- @member ejs.QueryStringQuery
- @returns {String} returns this object's internal query property.
- */
+ /**
+ Retrieves the internal query object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.QueryStringQuery
+ @returns {String} returns this object's internal query property.
+ */
_self: function () {
return query;
}
@@ -15119,26 +15303,26 @@
};
/**
- @class
- Matches documents with fields that have terms within a certain range. - The type of the Lucene query depends on the field type, for string fields, - the TermRangeQuery, while for number/date fields, the query is a - NumericRangeQuery.
+ @class +Matches documents with fields that have terms within a certain range. + The type of the Lucene query depends on the field type, for string fields, + the TermRangeQuery, while for number/date fields, the query is a + NumericRangeQuery.
- @name ejs.RangeQuery + @name ejs.RangeQuery - @desc - Matches documents with fields that have terms within a certain range. + @desc + Matches documents with fields that have terms within a certain range. - @param {String} field A valid field name. - */ + @param {String} field A valid field name. + */ ejs.RangeQuery = function (field) { /** - The internal query object.Use get()
- @member ejs.RangeQuery
- @property {Object} query
- */
+ The internal query object. Use get()
+ @member ejs.RangeQuery
+ @property {Object} query
+ */
var query = {
range: {}
};
@@ -15148,12 +15332,12 @@
return {
/**
- The field to run the query against.
+ The field to run the query against.
- @member ejs.RangeQuery
- @param {String} f A single field name.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RangeQuery
+ @param {String} f A single field name.
+ @returns {Object} returns this so that calls can be chained.
+ */
field: function (f) {
var oldValue = query.range[field];
@@ -15169,12 +15353,12 @@
},
/**
- The lower bound. Defaults to start from the first.
+ The lower bound. Defaults to start from the first.
- @member ejs.RangeQuery
- @param {Variable Type} f the lower bound value, type depends on field type
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RangeQuery
+ @param {Variable Type} f the lower bound value, type depends on field type
+ @returns {Object} returns this so that calls can be chained.
+ */
from: function (f) {
if (f == null) {
return query.range[field].from;
@@ -15185,12 +15369,12 @@
},
/**
- The upper bound. Defaults to unbounded.
+ The upper bound. Defaults to unbounded.
- @member ejs.RangeQuery
- @param {Variable Type} t the upper bound value, type depends on field type
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RangeQuery
+ @param {Variable Type} t the upper bound value, type depends on field type
+ @returns {Object} returns this so that calls can be chained.
+ */
to: function (t) {
if (t == null) {
return query.range[field].to;
@@ -15201,13 +15385,13 @@
},
/**
- Should the first from (if set) be inclusive or not.
- Defaults to true
+ Should the first from (if set) be inclusive or not.
+ Defaults to true
- @member ejs.RangeQuery
- @param {Boolean} trueFalse true to include, false to exclude
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RangeQuery
+ @param {Boolean} trueFalse true to include, false to exclude
+ @returns {Object} returns this so that calls can be chained.
+ */
includeLower: function (trueFalse) {
if (trueFalse == null) {
return query.range[field].include_lower;
@@ -15218,12 +15402,12 @@
},
/**
- Should the last to (if set) be inclusive or not. Defaults to true.
+ Should the last to (if set) be inclusive or not. Defaults to true.
- @member ejs.RangeQuery
- @param {Boolean} trueFalse true to include, false to exclude
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RangeQuery
+ @param {Boolean} trueFalse true to include, false to exclude
+ @returns {Object} returns this so that calls can be chained.
+ */
includeUpper: function (trueFalse) {
if (trueFalse == null) {
return query.range[field].include_upper;
@@ -15234,13 +15418,13 @@
},
/**
- Greater than value. Same as setting from to the value, and
- include_lower to false,
+ Greater than value. Same as setting from to the value, and
+ include_lower to false,
- @member ejs.RangeQuery
- @param {Variable Type} val the value, type depends on field type
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RangeQuery
+ @param {Variable Type} val the value, type depends on field type
+ @returns {Object} returns this so that calls can be chained.
+ */
gt: function (val) {
if (val == null) {
return query.range[field].gt;
@@ -15251,13 +15435,13 @@
},
/**
- Greater than or equal to value. Same as setting from to the value,
- and include_lower to true.
+ Greater than or equal to value. Same as setting from to the value,
+ and include_lower to true.
- @member ejs.RangeQuery
- @param {Variable Type} val the value, type depends on field type
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RangeQuery
+ @param {Variable Type} val the value, type depends on field type
+ @returns {Object} returns this so that calls can be chained.
+ */
gte: function (val) {
if (val == null) {
return query.range[field].gte;
@@ -15268,13 +15452,13 @@
},
/**
- Less than value. Same as setting to to the value, and include_upper
- to false.
+ Less than value. Same as setting to to the value, and include_upper
+ to false.
- @member ejs.RangeQuery
- @param {Variable Type} val the value, type depends on field type
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RangeQuery
+ @param {Variable Type} val the value, type depends on field type
+ @returns {Object} returns this so that calls can be chained.
+ */
lt: function (val) {
if (val == null) {
return query.range[field].lt;
@@ -15285,13 +15469,13 @@
},
/**
- Less than or equal to value. Same as setting to to the value,
- and include_upper to true.
+ Less than or equal to value. Same as setting to to the value,
+ and include_upper to true.
- @member ejs.RangeQuery
- @param {Variable Type} val the value, type depends on field type
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RangeQuery
+ @param {Variable Type} val the value, type depends on field type
+ @returns {Object} returns this so that calls can be chained.
+ */
lte: function (val) {
if (val == null) {
return query.range[field].lte;
@@ -15300,14 +15484,14 @@
query.range[field].lte = val;
return this;
},
-
- /**
- Sets the boost value of the Query.
- @member ejs.RangeQuery
- @param {Double} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the boost value of the Query.
+
+ @member ejs.RangeQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.range[field].boost;
@@ -15316,34 +15500,34 @@
query.range[field].boost = boost;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.RangeQuery
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.RangeQuery
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.RangeQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.RangeQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
- /**
- Retrieves the internal query object. This is typically used by
- internal API functions so use with caution.
- @member ejs.RangeQuery
- @returns {String} returns this object's internal query property.
- */
+ /**
+ Retrieves the internal query object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.RangeQuery
+ @returns {String} returns this object's internal query property.
+ */
_self: function () {
return query;
}
@@ -15351,26 +15535,26 @@
};
/**
- @class
- Matches documents that have fields matching a regular expression. Based - on Lucene 4.0 RegexpQuery which uses automaton to efficiently iterate over - index terms.
+ @class +Matches documents that have fields matching a regular expression. Based + on Lucene 4.0 RegexpQuery which uses automaton to efficiently iterate over + index terms.
- @name ejs.RegexpQuery + @name ejs.RegexpQuery - @desc - Matches documents that have fields matching a regular expression. + @desc + Matches documents that have fields matching a regular expression. - @param {String} field A valid field name. - @param {String} value A regex pattern. - */ + @param {String} field A valid field name. + @param {String} value A regex pattern. + */ ejs.RegexpQuery = function (field, value) { /** - The internal query object.Use get()
- @member ejs.RegexpQuery
- @property {Object} query
- */
+ The internal query object. Use get()
+ @member ejs.RegexpQuery
+ @property {Object} query
+ */
var query = {
regexp: {}
};
@@ -15382,12 +15566,12 @@
return {
/**
- The field to run the query against.
+ The field to run the query against.
- @member ejs.RegexpQuery
- @param {String} f A single field name.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RegexpQuery
+ @param {String} f A single field name.
+ @returns {Object} returns this so that calls can be chained.
+ */
field: function (f) {
var oldValue = query.regexp[field];
@@ -15403,12 +15587,12 @@
},
/**
- The regexp value.
+ The regexp value.
- @member ejs.RegexpQuery
- @param {String} p A string regexp
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.RegexpQuery
+ @param {String} p A string regexp
+ @returns {Object} returns this so that calls can be chained.
+ */
value: function (p) {
if (p == null) {
return query.regexp[field].value;
@@ -15419,24 +15603,24 @@
},
/**
- The regex flags to use. Valid flags are:
-
- INTERSECTION - Support for intersection notation
- COMPLEMENT - Support for complement notation
- EMPTY - Support for the empty language symbol: #
- ANYSTRING - Support for the any string symbol: @
- INTERVAL - Support for numerical interval notation: this so that calls can be chained.
- */
+ INTERSECTION - Support for intersection notation
+ COMPLEMENT - Support for complement notation
+ EMPTY - Support for the empty language symbol: #
+ ANYSTRING - Support for the any string symbol: @
+ INTERVAL - Support for numerical interval notation: this so that calls can be chained.
+ */
flags: function (f) {
if (f == null) {
return query.regexp[field].flags;
@@ -15445,15 +15629,15 @@
query.regexp[field].flags = f;
return this;
},
-
+
/**
- The regex flags to use as a numeric value. Advanced use only,
- it is probably better to stick with the flags option.
-
- @member ejs.RegexpQuery
- @param {String} v The flags as a numeric value.
- @returns {Object} returns this so that calls can be chained.
- */
+ The regex flags to use as a numeric value. Advanced use only,
+ it is probably better to stick with the flags option.
+
+ @member ejs.RegexpQuery
+ @param {String} v The flags as a numeric value.
+ @returns {Object} returns this so that calls can be chained.
+ */
flagsValue: function (v) {
if (v == null) {
return query.regexp[field].flags_value;
@@ -15462,62 +15646,62 @@
query.regexp[field].flags_value = v;
return this;
},
-
+
/**
- Sets rewrite method. Valid values are:
-
- constant_score_auto - tries to pick the best constant-score rewrite
- method based on term and document counts from the query
-
- scoring_boolean - translates each term into boolean should and
- keeps the scores as computed by the query
-
- constant_score_boolean - same as scoring_boolean, expect no scores
- are computed.
-
- constant_score_filter - first creates a private Filter, by visiting
- each term in sequence and marking all docs for that term
-
- top_terms_boost_N - first translates each term into boolean should
- and scores are only computed as the boost using the top N
- scoring terms. Replace N with an integer value.
-
- top_terms_N - first translates each term into boolean should
- and keeps the scores as computed by the query. Only the top N
- scoring terms are used. Replace N with an integer value.
-
- Default is constant_score_auto.
+ Sets rewrite method. Valid values are:
- This is an advanced option, use with care.
+ constant_score_auto - tries to pick the best constant-score rewrite
+ method based on term and document counts from the query
- @member ejs.RegexpQuery
- @param {String} m The rewrite method as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ scoring_boolean - translates each term into boolean should and
+ keeps the scores as computed by the query
+
+ constant_score_boolean - same as scoring_boolean, expect no scores
+ are computed.
+
+ constant_score_filter - first creates a private Filter, by visiting
+ each term in sequence and marking all docs for that term
+
+ top_terms_boost_N - first translates each term into boolean should
+ and scores are only computed as the boost using the top N
+ scoring terms. Replace N with an integer value.
+
+ top_terms_N - first translates each term into boolean should
+ and keeps the scores as computed by the query. Only the top N
+ scoring terms are used. Replace N with an integer value.
+
+ Default is constant_score_auto.
+
+ This is an advanced option, use with care.
+
+ @member ejs.RegexpQuery
+ @param {String} m The rewrite method as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
rewrite: function (m) {
if (m == null) {
return query.regexp[field].rewrite;
}
-
+
m = m.toLowerCase();
if (m === 'constant_score_auto' || m === 'scoring_boolean' ||
m === 'constant_score_boolean' || m === 'constant_score_filter' ||
- m.indexOf('top_terms_boost_') === 0 ||
+ m.indexOf('top_terms_boost_') === 0 ||
m.indexOf('top_terms_') === 0) {
-
+
query.regexp[field].rewrite = m;
}
-
+
return this;
},
-
- /**
- Sets the boost value of the Query.
- @member ejs.RegexpQuery
- @param {Double} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the boost value of the Query.
+
+ @member ejs.RegexpQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.regexp[field].boost;
@@ -15526,34 +15710,34 @@
query.regexp[field].boost = boost;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.RegexpQuery
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.RegexpQuery
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.RegexpQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.RegexpQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
- /**
- Retrieves the internal query object. This is typically used by
- internal API functions so use with caution.
- @member ejs.RegexpQuery
- @returns {String} returns this object's internal query property.
- */
+ /**
+ Retrieves the internal query object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.RegexpQuery
+ @returns {String} returns this object's internal query property.
+ */
_self: function () {
return query;
}
@@ -15561,31 +15745,31 @@
};
/**
- @class
- Matches spans near the beginning of a field. The spanFirstQuery allows you to search
- for Spans that start and end within the first n positions of the document.
- The span first query maps to Lucene SpanFirstQuery.
Matches spans near the beginning of a field. The spanFirstQuery allows you to search
+ for Spans that start and end within the first n positions of the document.
+ The span first query maps to Lucene SpanFirstQuery.
Use _self()
- @member ejs.SpanFirstQuery
- @property {Object} query
- */
+ The internal query object. Use _self()
+ @member ejs.SpanFirstQuery
+ @property {Object} query
+ */
var query = {
span_first: {
match: spanQry._self(),
@@ -15596,48 +15780,48 @@
return {
/**
- Sets the span query to match on.
+ Sets the span query to match on.
- @member ejs.SpanFirstQuery
- @param {Object} spanQuery Any valid span type query.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.SpanFirstQuery
+ @param {Object} spanQuery Any valid span type query.
+ @returns {Object} returns this so that calls can be chained.
+ */
match: function (spanQuery) {
if (spanQuery == null) {
return query.span_first.match;
}
-
+
if (!isQuery(spanQuery)) {
throw new TypeError('Argument must be a SpanQuery');
}
-
+
query.span_first.match = spanQuery._self();
return this;
},
/**
- Sets the maximum end position permitted in a match.
+ Sets the maximum end position permitted in a match.
- @member ejs.SpanFirstQuery
- @param {Number} position The maximum position length to consider.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.SpanFirstQuery
+ @param {Number} position The maximum position length to consider.
+ @returns {Object} returns this so that calls can be chained.
+ */
end: function (position) {
if (position == null) {
return query.span_first.end;
}
-
+
query.span_first.end = position;
return this;
},
/**
- Sets the boost value of the Query.
+ Sets the boost value of the Query.
- @member ejs.SpanFirstQuery
- @param {Double} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.SpanFirstQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.span_first.boost;
@@ -15646,34 +15830,34 @@
query.span_first.boost = boost;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.SpanFirstQuery
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.SpanFirstQuery
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.SpanFirstQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.SpanFirstQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
- /**
- Retrieves the internal query object. This is typically used by
- internal API functions so use with caution.
- @member ejs.SpanFirstQuery
- @returns {String} returns this object's internal query property.
- */
+ /**
+ Retrieves the internal query object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.SpanFirstQuery
+ @returns {String} returns this object's internal query property.
+ */
_self: function () {
return query;
}
@@ -15681,26 +15865,116 @@
};
/**
- @class
- A spanNearQuery will look to find a number of spanQuerys within a given - distance from each other.
+ @class +Wraps lucene MultiTermQueries as a SpanQuery so it can be used in the
+ various Span* queries. Examples of valid MultiTermQueries are
+ Fuzzy, NumericRange, Prefix, Regex, Range, and Wildcard.
Use _self()
+ @member ejs.SpanMultiTermQuery
+ @property {Object} query
+ */
+ var query = {
+ span_multi: {
+ match: {}
+ }
+ };
+
+ if (qry != null) {
+ query.span_multi.match = qry._self();
+ }
+
+ return {
+
+ /**
+ Sets the span query to match on.
+
+ @member ejs.SpanMultiTermQuery
+ @param {Object} mtQuery Any valid multi-term query.
+ @returns {Object} returns this so that calls can be chained.
+ */
+ match: function (mtQuery) {
+ if (mtQuery == null) {
+ return query.span_multi.match;
+ }
+
+ if (!isQuery(mtQuery)) {
+ throw new TypeError('Argument must be a MultiTermQuery');
+ }
+
+ query.span_multi.match = mtQuery._self();
+ return this;
+ },
+
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.SpanMultiTermQuery
+ @returns {String} returns this object as a serialized JSON string.
+ */
+ toString: function () {
+ return JSON.stringify(query);
+ },
+
+ /**
+ The type of ejs object. For internal use only.
+
+ @member ejs.SpanMultiTermQuery
+ @returns {String} the type of object
+ */
+ _type: function () {
+ return 'query';
+ },
+
+ /**
+ Retrieves the internal query object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.SpanMultiTermQuery
+ @returns {String} returns this object's internal query property.
+ */
+ _self: function () {
+ return query;
+ }
+ };
+ };
+
+ /**
+ @class
+ A spanNearQuery will look to find a number of spanQuerys within a given + distance from each other.
+ + @name ejs.SpanNearQuery + + @desc + Matches spans which are near one another. + + @param {Query || Array} clauses A single SpanQuery or array of SpanQueries + @param {Integer} slop The number of intervening unmatched positions + + */ ejs.SpanNearQuery = function (clauses, slop) { /** - The internal query object.Use _self()
- @member ejs.SpanNearQuery
- @property {Object} query
- */
+ The internal query object. Use _self()
+ @member ejs.SpanNearQuery
+ @property {Object} query
+ */
var i, len,
query = {
span_near: {
@@ -15708,7 +15982,7 @@
slop: slop
}
};
-
+
if (isQuery(clauses)) {
query.span_near.clauses.push(clauses._self());
} else if (isArray(clauses)) {
@@ -15716,7 +15990,7 @@
if (!isQuery(clauses[i])) {
throw new TypeError('Argument must be array of SpanQueries');
}
-
+
query.span_near.clauses.push(clauses[i]._self());
}
} else {
@@ -15726,21 +16000,21 @@
return {
/**
- Sets the clauses used. If passed a single SpanQuery, it is added
- to the existing list of clauses. If passed an array of
- SpanQueries, they replace any existing clauses.
+ Sets the clauses used. If passed a single SpanQuery, it is added
+ to the existing list of clauses. If passed an array of
+ SpanQueries, they replace any existing clauses.
- @member ejs.SpanNearQuery
- @param {Query || Array} clauses A SpanQuery or array of SpanQueries.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.SpanNearQuery
+ @param {Query || Array} clauses A SpanQuery or array of SpanQueries.
+ @returns {Object} returns this so that calls can be chained.
+ */
clauses: function (clauses) {
var i, len;
-
+
if (clauses == null) {
return query.span_near.clauses;
}
-
+
if (isQuery(clauses)) {
query.span_near.clauses.push(clauses._self());
} else if (isArray(clauses)) {
@@ -15755,66 +16029,66 @@
} else {
throw new TypeError('Argument must be SpanQuery or array of SpanQueries');
}
-
+
return this;
},
/**
- Sets the maximum number of intervening unmatched positions.
+ Sets the maximum number of intervening unmatched positions.
- @member ejs.SpanNearQuery
- @param {Number} distance The number of intervening unmatched positions.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.SpanNearQuery
+ @param {Number} distance The number of intervening unmatched positions.
+ @returns {Object} returns this so that calls can be chained.
+ */
slop: function (distance) {
if (distance == null) {
return query.span_near.slop;
}
-
+
query.span_near.slop = distance;
return this;
},
/**
- Sets whether or not matches are required to be in-order.
+ Sets whether or not matches are required to be in-order.
- @member ejs.SpanNearQuery
- @param {Boolean} trueFalse Determines if matches must be in-order.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.SpanNearQuery
+ @param {Boolean} trueFalse Determines if matches must be in-order.
+ @returns {Object} returns this so that calls can be chained.
+ */
inOrder: function (trueFalse) {
if (trueFalse == null) {
return query.span_near.in_order;
}
-
+
query.span_near.in_order = trueFalse;
return this;
},
/**
- Sets whether or not payloads are being used. A payload is an arbitrary
- byte array stored at a specific position (i.e. token/term).
+ Sets whether or not payloads are being used. A payload is an arbitrary
+ byte array stored at a specific position (i.e. token/term).
- @member ejs.SpanNearQuery
- @param {Boolean} trueFalse Whether or not to return payloads.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.SpanNearQuery
+ @param {Boolean} trueFalse Whether or not to return payloads.
+ @returns {Object} returns this so that calls can be chained.
+ */
collectPayloads: function (trueFalse) {
if (trueFalse == null) {
return query.span_near.collect_payloads;
}
-
+
query.span_near.collect_payloads = trueFalse;
return this;
},
/**
- Sets the boost value of the Query.
+ Sets the boost value of the Query.
- @member ejs.SpanNearQuery
- @param {Double} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.SpanNearQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.span_near.boost;
@@ -15823,34 +16097,34 @@
query.span_near.boost = boost;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.SpanNearQuery
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.SpanNearQuery
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.SpanNearQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.SpanNearQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
- /**
- Retrieves the internal query object. This is typically used by
- internal API functions so use with caution.
- @member ejs.SpanNearQuery
- @returns {String} returns this object's internal query property.
- */
+ /**
+ Retrieves the internal query object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.SpanNearQuery
+ @returns {String} returns this object's internal query property.
+ */
_self: function () {
return query;
}
@@ -15858,30 +16132,30 @@
};
/**
- @class
- Removes matches which overlap with another span query. - The span not query maps to Lucene SpanNotQuery.
+ @class +Removes matches which overlap with another span query. + The span not query maps to Lucene SpanNotQuery.
- @name ejs.SpanNotQuery + @name ejs.SpanNotQuery - @desc - Removes matches which overlap with another span query. + @desc + Removes matches which overlap with another span query. - @param {Query} includeQry a valid SpanQuery whose matching docs will be returned. - @param {Query} excludeQry a valid SpanQuery whose matching docs will not be returned - - */ + @param {Query} includeQry a valid SpanQuery whose matching docs will be returned. + @param {Query} excludeQry a valid SpanQuery whose matching docs will not be returned + + */ ejs.SpanNotQuery = function (includeQry, excludeQry) { if (!isQuery(includeQry) || !isQuery(excludeQry)) { throw new TypeError('Argument must be a SpanQuery'); } - + /** - The internal query object.Use _self()
- @member ejs.SpanNotQuery
- @property {Object} query
- */
+ The internal query object. Use _self()
+ @member ejs.SpanNotQuery
+ @property {Object} query
+ */
var query = {
span_not: {
include: includeQry._self(),
@@ -15892,52 +16166,52 @@
return {
/**
- Set the span query whose matches are filtered.
+ Set the span query whose matches are filtered.
- @member ejs.SpanNotQuery
- @param {Object} spanQuery Any valid span type query.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.SpanNotQuery
+ @param {Object} spanQuery Any valid span type query.
+ @returns {Object} returns this so that calls can be chained.
+ */
include: function (spanQuery) {
if (spanQuery == null) {
return query.span_not.include;
}
-
+
if (!isQuery(spanQuery)) {
throw new TypeError('Argument must be a SpanQuery');
}
-
+
query.span_not.include = spanQuery._self();
return this;
},
/**
- Sets the span query whose matches must not overlap those returned.
+ Sets the span query whose matches must not overlap those returned.
- @member ejs.SpanNotQuery
- @param {Object} spanQuery Any valid span type query.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.SpanNotQuery
+ @param {Object} spanQuery Any valid span type query.
+ @returns {Object} returns this so that calls can be chained.
+ */
exclude: function (spanQuery) {
if (spanQuery == null) {
return query.span_not.exclude;
}
-
+
if (!isQuery(spanQuery)) {
throw new TypeError('Argument must be a SpanQuery');
}
-
+
query.span_not.exclude = spanQuery._self();
return this;
},
/**
- Sets the boost value of the Query.
+ Sets the boost value of the Query.
- @member ejs.SpanNotQuery
- @param {Double} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.SpanNotQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.span_not.boost;
@@ -15946,34 +16220,34 @@
query.span_not.boost = boost;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.SpanNotQuery
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.SpanNotQuery
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.SpanNotQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.SpanNotQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
- /**
- Retrieves the internal query object. This is typically used by
- internal API functions so use with caution.
- @member ejs.SpanNotQuery
- @returns {String} returns this object's internal query property.
- */
+ /**
+ Retrieves the internal query object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.SpanNotQuery
+ @returns {String} returns this object's internal query property.
+ */
_self: function () {
return query;
}
@@ -15981,26 +16255,26 @@
};
/**
- @class
- The spanOrQuery takes an array of SpanQuerys and will match if any of the - underlying SpanQueries match. The span or query maps to Lucene SpanOrQuery.
+ @class +The spanOrQuery takes an array of SpanQuerys and will match if any of the + underlying SpanQueries match. The span or query maps to Lucene SpanOrQuery.
- @name ejs.SpanOrQuery + @name ejs.SpanOrQuery - @desc - Matches the union of its span clauses. + @desc + Matches the union of its span clauses. - @param {Object} clauses A single SpanQuery or array of SpanQueries. + @param {Object} clauses A single SpanQuery or array of SpanQueries. - */ + */ ejs.SpanOrQuery = function (clauses) { /** - The internal query object.Use _self()
- @member ejs.SpanOrQuery
- @property {Object} query
- */
- var i,
+ The internal query object. Use _self()
+ @member ejs.SpanOrQuery
+ @property {Object} query
+ */
+ var i,
len,
query = {
span_or: {
@@ -16015,7 +16289,7 @@
if (!isQuery(clauses[i])) {
throw new TypeError('Argument must be array of SpanQueries');
}
-
+
query.span_or.clauses.push(clauses[i]._self());
}
} else {
@@ -16025,21 +16299,21 @@
return {
/**
- Sets the clauses used. If passed a single SpanQuery, it is added
- to the existing list of clauses. If passed an array of
- SpanQueries, they replace any existing clauses.
+ Sets the clauses used. If passed a single SpanQuery, it is added
+ to the existing list of clauses. If passed an array of
+ SpanQueries, they replace any existing clauses.
- @member ejs.SpanOrQuery
- @param {Query || Array} clauses A SpanQuery or array of SpanQueries.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.SpanOrQuery
+ @param {Query || Array} clauses A SpanQuery or array of SpanQueries.
+ @returns {Object} returns this so that calls can be chained.
+ */
clauses: function (clauses) {
var i, len;
-
+
if (clauses == null) {
return query.span_or.clauses;
}
-
+
if (isQuery(clauses)) {
query.span_or.clauses.push(clauses._self());
} else if (isArray(clauses)) {
@@ -16054,17 +16328,17 @@
} else {
throw new TypeError('Argument must be SpanQuery or array of SpanQueries');
}
-
+
return this;
},
/**
- Sets the boost value of the Query.
+ Sets the boost value of the Query.
- @member ejs.SpanOrQuery
- @param {Double} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.SpanOrQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.span_or.boost;
@@ -16073,34 +16347,34 @@
query.span_or.boost = boost;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.SpanOrQuery
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.SpanOrQuery
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.SpanOrQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.SpanOrQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
- /**
- Retrieves the internal query object. This is typically used by
- internal API functions so use with caution.
- @member ejs.SpanOrQuery
- @returns {String} returns this object's internal query property.
- */
+ /**
+ Retrieves the internal query object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.SpanOrQuery
+ @returns {String} returns this object's internal query property.
+ */
_self: function () {
return query;
}
@@ -16108,26 +16382,26 @@
};
/**
- @class
- A spanTermQuery is the basic unit of Lucene's Span Query which allows for nested, - positional restrictions when matching documents. The spanTermQuery simply matches - spans containing a term. It's essentially a termQuery with positional information asscoaited.
+ @class +A spanTermQuery is the basic unit of Lucene's Span Query which allows for nested, + positional restrictions when matching documents. The spanTermQuery simply matches + spans containing a term. It's essentially a termQuery with positional information asscoaited.
- @name ejs.SpanTermQuery + @name ejs.SpanTermQuery - @desc - Matches spans containing a term + @desc + Matches spans containing a term - @param {String} field the document field/field to query against - @param {String} value the literal value to be matched - */ + @param {String} field the document field/field to query against + @param {String} value the literal value to be matched + */ ejs.SpanTermQuery = function (field, value) { /** - The internal query object.Use get()
- @member ejs.SpanTermQuery
- @property {Object} query
- */
+ The internal query object. Use get()
+ @member ejs.SpanTermQuery
+ @property {Object} query
+ */
var query = {
span_term: {}
};
@@ -16139,15 +16413,15 @@
return {
/**
- Sets the field to query against.
+ Sets the field to query against.
- @member ejs.SpanTermQuery
- @param {String} f A valid field name.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.SpanTermQuery
+ @param {String} f A valid field name.
+ @returns {Object} returns this so that calls can be chained.
+ */
field: function (f) {
var oldValue = query.span_term[field];
-
+
if (f == null) {
return field;
}
@@ -16155,17 +16429,17 @@
delete query.span_term[field];
field = f;
query.span_term[f] = oldValue;
-
+
return this;
},
-
- /**
- Sets the term.
- @member ejs.SpanTermQuery
- @param {String} t A single term.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the term.
+
+ @member ejs.SpanTermQuery
+ @param {String} t A single term.
+ @returns {Object} returns this so that calls can be chained.
+ */
term: function (t) {
if (t == null) {
return query.span_term[field].term;
@@ -16174,14 +16448,14 @@
query.span_term[field].term = t;
return this;
},
-
- /**
- Sets the boost value for documents matching the Query.
- @member ejs.SpanTermQuery
- @param {Double} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the boost value for documents matching the Query.
+
+ @member ejs.SpanTermQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.span_term[field].boost;
@@ -16192,32 +16466,32 @@
},
/**
- Allows you to serialize this object into a JSON encoded string.
+ Allows you to serialize this object into a JSON encoded string.
- @member ejs.SpanTermQuery
- @returns {String} returns this object as a serialized JSON string.
- */
+ @member ejs.SpanTermQuery
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.SpanTermQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.SpanTermQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
- /**
- Retrieves the internal query object. This is typically used by
- internal API functions so use with caution.
- @member ejs.SpanTermQuery
- @returns {String} returns this object's internal query property.
- */
+ /**
+ Retrieves the internal query object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.SpanTermQuery
+ @returns {String} returns this object's internal query property.
+ */
_self: function () {
return query;
}
@@ -16225,28 +16499,28 @@
};
/**
- @class
- A TermQuery can be used to return documents containing a given
- keyword or term. For instance, you might want to retieve all the
- documents/objects that contain the term Javascript. Term filters
- often serve as the basis for more complex queries such as Boolean queries.
A TermQuery can be used to return documents containing a given
+ keyword or term. For instance, you might want to retieve all the
+ documents/objects that contain the term Javascript. Term filters
+ often serve as the basis for more complex queries such as Boolean queries.
Use get()
- @member ejs.TermQuery
- @property {Object} query
- */
+ The internal query object. Use get()
+ @member ejs.TermQuery
+ @property {Object} query
+ */
var query = {
term: {}
};
@@ -16258,15 +16532,15 @@
return {
/**
- Sets the fields to query against.
+ Sets the fields to query against.
- @member ejs.TermQuery
- @param {String} f A valid field name.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.TermQuery
+ @param {String} f A valid field name.
+ @returns {Object} returns this so that calls can be chained.
+ */
field: function (f) {
var oldValue = query.term[field];
-
+
if (f == null) {
return field;
}
@@ -16274,17 +16548,17 @@
delete query.term[field];
field = f;
query.term[f] = oldValue;
-
+
return this;
},
-
- /**
- Sets the term.
- @member ejs.TermQuery
- @param {String} t A single term.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the term.
+
+ @member ejs.TermQuery
+ @param {String} t A single term.
+ @returns {Object} returns this so that calls can be chained.
+ */
term: function (t) {
if (t == null) {
return query.term[field].term;
@@ -16293,14 +16567,14 @@
query.term[field].term = t;
return this;
},
-
- /**
- Sets the boost value for documents matching the Query.
- @member ejs.TermQuery
- @param {Number} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the boost value for documents matching the Query.
+
+ @member ejs.TermQuery
+ @param {Number} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.term[field].boost;
@@ -16311,32 +16585,32 @@
},
/**
- Allows you to serialize this object into a JSON encoded string.
+ Allows you to serialize this object into a JSON encoded string.
- @member ejs.TermQuery
- @returns {String} returns this object as a serialized JSON string.
- */
+ @member ejs.TermQuery
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.TermQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.TermQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
- /**
- Retrieves the internal query object. This is typically used by
- internal API functions so use with caution.
- @member ejs.TermQuery
- @returns {String} returns this object's internal query property.
- */
+ /**
+ Retrieves the internal query object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.TermQuery
+ @returns {String} returns this object's internal query property.
+ */
_self: function () {
return query;
}
@@ -16344,30 +16618,30 @@
};
/**
- @class
- A query that match on any (configurable) of the provided terms. This is - a simpler syntax query for using a bool query with several term queries - in the should clauses.
+ @class +A query that match on any (configurable) of the provided terms. This is + a simpler syntax query for using a bool query with several term queries + in the should clauses.
- @name ejs.TermsQuery + @name ejs.TermsQuery - @desc - A Query that matches documents containing provided terms. + @desc + A Query that matches documents containing provided terms. - @param {String} field the document field/key to query against - @param {String || Array} terms a single term or array of "terms" to match - */ + @param {String} field the document field/key to query against + @param {String || Array} terms a single term or array of "terms" to match + */ ejs.TermsQuery = function (field, terms) { /** - The internal query object.Use get()
- @member ejs.TermsQuery
- @property {Object} query
- */
+ The internal query object. Use get()
+ @member ejs.TermsQuery
+ @property {Object} query
+ */
var query = {
terms: {}
};
-
+
if (isString(terms)) {
query.terms[field] = [terms];
} else if (isArray(terms)) {
@@ -16375,19 +16649,19 @@
} else {
throw new TypeError('Argument must be string or array');
}
-
+
return {
/**
- Sets the fields to query against.
+ Sets the fields to query against.
- @member ejs.TermsQuery
- @param {String} f A valid field name.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.TermsQuery
+ @param {String} f A valid field name.
+ @returns {Object} returns this so that calls can be chained.
+ */
field: function (f) {
var oldValue = query.terms[field];
-
+
if (f == null) {
return field;
}
@@ -16395,19 +16669,19 @@
delete query.terms[field];
field = f;
query.terms[f] = oldValue;
-
+
return this;
},
-
- /**
- Sets the terms. If you t is a String, it is added to the existing
- list of terms. If t is an array, the list of terms replaces the
- existing terms.
- @member ejs.TermsQuery
- @param {String || Array} t A single term or an array or terms.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the terms. If you t is a String, it is added to the existing
+ list of terms. If t is an array, the list of terms replaces the
+ existing terms.
+
+ @member ejs.TermsQuery
+ @param {String || Array} t A single term or an array or terms.
+ @returns {Object} returns this so that calls can be chained.
+ */
terms: function (t) {
if (t == null) {
return query.terms[field];
@@ -16420,35 +16694,35 @@
} else {
throw new TypeError('Argument must be string or array');
}
-
+
return this;
},
/**
- Sets the minimum number of terms that need to match in a document
- before that document is returned in the results.
+ Sets the minimum number of terms that need to match in a document
+ before that document is returned in the results.
- @member ejs.TermsQuery
- @param {Integer} min A positive integer.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.TermsQuery
+ @param {Integer} min A positive integer.
+ @returns {Object} returns this so that calls can be chained.
+ */
minimumShouldMatch: function (min) {
if (min == null) {
return query.terms.minimum_should_match;
}
-
+
query.terms.minimum_should_match = min;
return this;
},
-
- /**
- Enables or disables similarity coordinate scoring of documents
- matching the Query. Default: false.
- @member ejs.TermsQuery
- @param {String} trueFalse A true/falsethis so that calls can be chained.
- */
+ /**
+ Enables or disables similarity coordinate scoring of documents
+ matching the Query. Default: false.
+
+ @member ejs.TermsQuery
+ @param {String} trueFalse A true/falsethis so that calls can be chained.
+ */
disableCoord: function (trueFalse) {
if (trueFalse == null) {
return query.terms.disable_coord;
@@ -16457,14 +16731,14 @@
query.terms.disable_coord = trueFalse;
return this;
},
-
- /**
- Sets the boost value for documents matching the Query.
- @member ejs.TermsQuery
- @param {Number} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the boost value for documents matching the Query.
+
+ @member ejs.TermsQuery
+ @param {Number} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.terms.boost;
@@ -16475,32 +16749,32 @@
},
/**
- Allows you to serialize this object into a JSON encoded string.
+ Allows you to serialize this object into a JSON encoded string.
- @member ejs.TermsQuery
- @returns {String} returns this object as a serialized JSON string.
- */
+ @member ejs.TermsQuery
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.TermsQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.TermsQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
- /**
- Retrieves the internal query object. This is typically used by
- internal API functions so use with caution.
- @member ejs.TermsQuery
- @returns {String} returns this object's internal query property.
- */
+ /**
+ Retrieves the internal query object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.TermsQuery
+ @returns {String} returns this object's internal query property.
+ */
_self: function () {
return query;
}
@@ -16508,34 +16782,34 @@
};
/**
- @class
- TThe top_children query runs the child query with an estimated hits size, - and out of the hit docs, aggregates it into parent docs. If there aren’t - enough parent docs matching the requested from/size search request, then it - is run again with a wider (more hits) search.
+ @class +TThe top_children query runs the child query with an estimated hits size, + and out of the hit docs, aggregates it into parent docs. If there aren’t + enough parent docs matching the requested from/size search request, then it + is run again with a wider (more hits) search.
-The top_children also provide scoring capabilities, with the ability to - specify max, sum or avg as the score type.
+The top_children also provide scoring capabilities, with the ability to + specify max, sum or avg as the score type.
- @name ejs.TopChildrenQuery + @name ejs.TopChildrenQuery - @desc - Returns child documents matching the query aggregated into the parent docs. + @desc + Returns child documents matching the query aggregated into the parent docs. - @param {Object} qry A valid query object. - @param {String} type The child type to execute the query on - */ + @param {Object} qry A valid query object. + @param {String} type The child type to execute the query on + */ ejs.TopChildrenQuery = function (qry, type) { if (!isQuery(qry)) { throw new TypeError('Argument must be a Query'); } - + /** - The internal query object.Use _self()
- @member ejs.TopChildrenQuery
- @property {Object} query
- */
+ The internal query object. Use _self()
+ @member ejs.TopChildrenQuery
+ @property {Object} query
+ */
var query = {
top_children: {
query: qry._self(),
@@ -16546,83 +16820,106 @@
return {
/**
- Sets the query
+ Sets the query
- @member ejs.TopChildrenQuery
- @param {Object} q A valid Query object
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.TopChildrenQuery
+ @param {Object} q A valid Query object
+ @returns {Object} returns this so that calls can be chained.
+ */
query: function (q) {
if (q == null) {
return query.top_children.query;
}
-
+
if (!isQuery(q)) {
throw new TypeError('Argument must be a Query');
}
-
+
query.top_children.query = q._self();
return this;
},
/**
- Sets the child document type to search against
+ Sets the child document type to search against
- @member ejs.TopChildrenQuery
- @param {String} t A valid type name
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.TopChildrenQuery
+ @param {String} t A valid type name
+ @returns {Object} returns this so that calls can be chained.
+ */
type: function (t) {
if (t == null) {
return query.top_children.type;
}
-
+
query.top_children.type = t;
return this;
},
/**
- Sets the scope of the query. A scope allows to run facets on the
- same scope name that will work against the child documents.
+ Sets the scope of the query. A scope allows to run facets on the
+ same scope name that will work against the child documents.
- @deprecated since elasticsearch 0.90
- @member ejs.TopChildrenQuery
- @param {String} s The scope name as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ @deprecated since elasticsearch 0.90
+ @member ejs.TopChildrenQuery
+ @param {String} s The scope name as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
scope: function (s) {
return this;
},
/**
- Sets the scoring type. Valid values are max, sum, or avg. If
- another value is passed it we silently ignore the value.
+ Sets the scoring type. Valid values are max, sum, or avg. If
+ another value is passed it we silently ignore the value.
- @member ejs.TopChildrenQuery
- @param {String} s The scoring type as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ @deprecated since elasticsearch 0.90.1, use scoreMode
+
+ @member ejs.TopChildrenQuery
+ @param {String} s The scoring type as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
score: function (s) {
if (s == null) {
return query.top_children.score;
}
-
+
s = s.toLowerCase();
- if (s === 'max' || s === 'sum' || s === 'avg') {
+ if (s === 'max' || s === 'sum' || s === 'avg' || s === 'total') {
query.top_children.score = s;
}
-
+
return this;
},
-
- /**
- Sets the factor which is the number of hits that are asked for in
- the child query. Defaults to 5.
- @member ejs.TopChildrenQuery
- @param {Integer} f A positive integer value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the scoring type. Valid values are max, sum, total, or avg.
+ If another value is passed it we silently ignore the value.
+
+ @member ejs.TopChildrenQuery
+ @param {String} s The scoring type as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
+ scoreMode: function (s) {
+ if (s == null) {
+ return query.top_children.score_mode;
+ }
+
+ s = s.toLowerCase();
+ if (s === 'max' || s === 'sum' || s === 'avg' || s === 'total') {
+ query.top_children.score_mode = s;
+ }
+
+ return this;
+ },
+
+ /**
+ Sets the factor which is the number of hits that are asked for in
+ the child query. Defaults to 5.
+
+ @member ejs.TopChildrenQuery
+ @param {Integer} f A positive integer value.
+ @returns {Object} returns this so that calls can be chained.
+ */
factor: function (f) {
if (f == null) {
return query.top_children.factor;
@@ -16633,14 +16930,14 @@
},
/**
- Sets the incremental factor. The incremental factor is used when not
- enough child documents are returned so the factor is multiplied by
- the incremental factor to fetch more results. Defaults to 52
+ Sets the incremental factor. The incremental factor is used when not
+ enough child documents are returned so the factor is multiplied by
+ the incremental factor to fetch more results. Defaults to 52
- @member ejs.TopChildrenQuery
- @param {Integer} f A positive integer value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.TopChildrenQuery
+ @param {Integer} f A positive integer value.
+ @returns {Object} returns this so that calls can be chained.
+ */
incrementalFactor: function (f) {
if (f == null) {
return query.top_children.incremental_factor;
@@ -16649,14 +16946,14 @@
query.top_children.incremental_factor = f;
return this;
},
-
- /**
- Sets the boost value of the Query.
- @member ejs.TopChildrenQuery
- @param {Double} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the boost value of the Query.
+
+ @member ejs.TopChildrenQuery
+ @param {Double} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.top_children.boost;
@@ -16665,34 +16962,34 @@
query.top_children.boost = boost;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.TopChildrenQuery
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.TopChildrenQuery
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.TopChildrenQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.TopChildrenQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
- /**
- Retrieves the internal query object. This is typically used by
- internal API functions so use with caution.
- @member ejs.TopChildrenQuery
- @returns {String} returns this object's internal query property.
- */
+ /**
+ Retrieves the internal query object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.TopChildrenQuery
+ @returns {String} returns this object's internal query property.
+ */
_self: function () {
return query;
}
@@ -16700,31 +16997,31 @@
};
/**
- @class
- Matches documents that have fields matching a wildcard expression - (not analyzed). Supported wildcards are *, which matches any character - sequence (including the empty one), and ?, which matches any single - character. Note this query can be slow, as it needs to iterate over many - wildcards. In order to prevent extremely slow wildcard queries, a wildcard - wildcard should not start with one of the wildcards * or ?. The wildcard query - maps to Lucene WildcardQuery.
+ @class +Matches documents that have fields matching a wildcard expression + (not analyzed). Supported wildcards are *, which matches any character + sequence (including the empty one), and ?, which matches any single + character. Note this query can be slow, as it needs to iterate over many + wildcards. In order to prevent extremely slow wildcard queries, a wildcard + wildcard should not start with one of the wildcards * or ?. The wildcard query + maps to Lucene WildcardQuery.
- @name ejs.WildcardQuery + @name ejs.WildcardQuery - @desc - A Query that matches documents containing a wildcard. This may be - combined with other wildcards with a BooleanQuery. + @desc + A Query that matches documents containing a wildcard. This may be + combined with other wildcards with a BooleanQuery. - @param {String} field the document field/key to query against - @param {String} value the literal value to be matched - */ + @param {String} field the document field/key to query against + @param {String} value the literal value to be matched + */ ejs.WildcardQuery = function (field, value) { /** - The internal query object.Use get()
- @member ejs.WildcardQuery
- @property {Object} query
- */
+ The internal query object. Use get()
+ @member ejs.WildcardQuery
+ @property {Object} query
+ */
var query = {
wildcard: {}
};
@@ -16736,15 +17033,15 @@
return {
/**
- Sets the fields to query against.
+ Sets the fields to query against.
- @member ejs.WildcardQuery
- @param {String} f A valid field name.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.WildcardQuery
+ @param {String} f A valid field name.
+ @returns {Object} returns this so that calls can be chained.
+ */
field: function (f) {
var oldValue = query.wildcard[field];
-
+
if (f == null) {
return field;
}
@@ -16752,17 +17049,17 @@
delete query.wildcard[field];
field = f;
query.wildcard[f] = oldValue;
-
+
return this;
},
-
- /**
- Sets the wildcard query value.
- @member ejs.WildcardQuery
- @param {String} v A single term.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the wildcard query value.
+
+ @member ejs.WildcardQuery
+ @param {String} v A single term.
+ @returns {Object} returns this so that calls can be chained.
+ */
value: function (v) {
if (v == null) {
return query.wildcard[field].value;
@@ -16771,62 +17068,62 @@
query.wildcard[field].value = v;
return this;
},
-
+
/**
- Sets rewrite method. Valid values are:
-
- constant_score_auto - tries to pick the best constant-score rewrite
- method based on term and document counts from the query
-
- scoring_boolean - translates each term into boolean should and
- keeps the scores as computed by the query
-
- constant_score_boolean - same as scoring_boolean, expect no scores
- are computed.
-
- constant_score_filter - first creates a private Filter, by visiting
- each term in sequence and marking all docs for that term
-
- top_terms_boost_N - first translates each term into boolean should
- and scores are only computed as the boost using the top N
- scoring terms. Replace N with an integer value.
-
- top_terms_N - first translates each term into boolean should
- and keeps the scores as computed by the query. Only the top N
- scoring terms are used. Replace N with an integer value.
-
- Default is constant_score_auto.
+ Sets rewrite method. Valid values are:
- This is an advanced option, use with care.
+ constant_score_auto - tries to pick the best constant-score rewrite
+ method based on term and document counts from the query
- @member ejs.WildcardQuery
- @param {String} m The rewrite method as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ scoring_boolean - translates each term into boolean should and
+ keeps the scores as computed by the query
+
+ constant_score_boolean - same as scoring_boolean, expect no scores
+ are computed.
+
+ constant_score_filter - first creates a private Filter, by visiting
+ each term in sequence and marking all docs for that term
+
+ top_terms_boost_N - first translates each term into boolean should
+ and scores are only computed as the boost using the top N
+ scoring terms. Replace N with an integer value.
+
+ top_terms_N - first translates each term into boolean should
+ and keeps the scores as computed by the query. Only the top N
+ scoring terms are used. Replace N with an integer value.
+
+ Default is constant_score_auto.
+
+ This is an advanced option, use with care.
+
+ @member ejs.WildcardQuery
+ @param {String} m The rewrite method as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
rewrite: function (m) {
if (m == null) {
return query.wildcard[field].rewrite;
}
-
+
m = m.toLowerCase();
if (m === 'constant_score_auto' || m === 'scoring_boolean' ||
m === 'constant_score_boolean' || m === 'constant_score_filter' ||
- m.indexOf('top_terms_boost_') === 0 ||
+ m.indexOf('top_terms_boost_') === 0 ||
m.indexOf('top_terms_') === 0) {
-
+
query.wildcard[field].rewrite = m;
}
-
+
return this;
},
-
- /**
- Sets the boost value for documents matching the Query.
- @member ejs.WildcardQuery
- @param {Number} boost A positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the boost value for documents matching the Query.
+
+ @member ejs.WildcardQuery
+ @param {Number} boost A positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
boost: function (boost) {
if (boost == null) {
return query.wildcard[field].boost;
@@ -16837,32 +17134,32 @@
},
/**
- Allows you to serialize this object into a JSON encoded string.
+ Allows you to serialize this object into a JSON encoded string.
- @member ejs.WildcardQuery
- @returns {String} returns this object as a serialized JSON string.
- */
+ @member ejs.WildcardQuery
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.WildcardQuery
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.WildcardQuery
+ @returns {String} the type of object
+ */
_type: function () {
return 'query';
},
-
- /**
- Retrieves the internal query object. This is typically used by
- internal API functions so use with caution.
- @member ejs.WildcardQuery
- @returns {String} returns this object's internal query property.
- */
+ /**
+ Retrieves the internal query object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.WildcardQuery
+ @returns {String} returns this object's internal query property.
+ */
_self: function () {
return query;
}
@@ -16870,19 +17167,1086 @@
};
/**
- @class
- A GeoPoint object that can be used in queries and filters that - take a GeoPoint. GeoPoint supports various input formats.
+ @class +The ClusterHealth object provides an interface for accessing
+ the health information of your cluster.
See http://www.elasticsearch.org/guide/reference/mapping/geo-point-type.html
+ @name ejs.ClusterHealth - @name ejs.GeoPoint + @desc Access the health of your cluster. + */ + ejs.ClusterHealth = function () { - @desc -Defines a point
+ var + params = {}, + paramExcludes = ['indices']; - @param {Array} p An optional point as an array in [lat, lon] format. - */ + return { + + /** +Set's the indices to get the health information for. If a + single value is passed in it will be appended to the current list + of indices. If an array is passed in it will replace all existing + indices.
+ + @member ejs.ClusterHealth + @param {String || Array} i An index name or list of index names. + @returns {Object} returnsthis so that calls can be chained.
+ */
+ indices: function (i) {
+ if (params.indices == null) {
+ params.indices = [];
+ }
+
+ if (i == null) {
+ return params.indices;
+ }
+
+ if (isString(i)) {
+ params.indices.push(i);
+ } else if (isArray(i)) {
+ params.indices = i;
+ } else {
+ throw new TypeError('Argument must be string or array');
+ }
+
+ return this;
+ },
+
+ /**
+ If the operation will run on the local node only
+ + @member ejs.ClusterHealth + @param {Boolean} trueFalse True to run on local node only + @returns {Object} returnsthis so that calls can be chained.
+ */
+ local: function (trueFalse) {
+ if (trueFalse == null) {
+ return params.local;
+ }
+
+ params.local = trueFalse;
+ return this;
+ },
+
+ /**
+ Set's a timeout for the response from the master node.
+ + @member ejs.ClusterHealth + @param {String} length The amount of time after which the operation + will timeout. + @returns {Object} returnsthis so that calls can be chained.
+ */
+ masterTimeout: function (length) {
+ if (length == null) {
+ return params.master_timeout;
+ }
+
+ params.master_timeout = length;
+ return this;
+ },
+
+ /**
+ Set's a timeout to use during any of the waitFor* options.
+ + @member ejs.ClusterHealth + @param {String} length The amount of time after which the operation + will timeout. + @returns {Object} returnsthis so that calls can be chained.
+ */
+ timeout: function (length) {
+ if (length == null) {
+ return params.timeout;
+ }
+
+ params.timeout = length;
+ return this;
+ },
+
+ /**
+ Set the cluster status to wait for (or until timeout). Valid + values are:
+ +greenyellowredthis so that calls can be chained.
+ */
+ waitForStatus: function (status) {
+ if (status == null) {
+ return params.wait_for_status;
+ }
+
+ status = status.toLowerCase();
+ if (status === 'green' || status === 'yellow' || status === 'red') {
+ params.wait_for_status = status;
+ }
+
+ return this;
+ },
+
+ /**
+ Set's the number of shards that can be relocating before + proceeding with the operation. Typically set to 0 meaning we + must wait for all shards to be done relocating.
+ + @member ejs.ClusterHealth + @param {Integer} num The number of acceptable relocating shards. + @returns {Object} returnsthis so that calls can be chained.
+ */
+ waitForRelocatingShards: function (num) {
+ if (num == null) {
+ return params.wait_for_relocating_shards;
+ }
+
+ params.wait_for_relocating_shards = num;
+ return this;
+ },
+
+ /**
+ Set's the number of shards that should be active before + proceeding with the operation.
+ + @member ejs.ClusterHealth + @param {Integer} num The number of active shards. + @returns {Object} returnsthis so that calls can be chained.
+ */
+ waitForActiveShards: function (num) {
+ if (num == null) {
+ return params.wait_for_active_shards;
+ }
+
+ params.wait_for_active_shards = num;
+ return this;
+ },
+
+ /**
+ Set's the number of nodes that must be available before
+ proceeding with the operation. The value can be specified
+ as an integer or as values such as >=N, <=N, >N, Set the level of details for the operation. Possible values
+ for the level are: Allows you to serialize this object into a JSON encoded string. The type of ejs object. For internal use only. Retrieves the internal Retrieves very simple status on the health of the cluster. The If the operation will run on the local node only Set's a timeout for the response from the master node. Sets if we should filter out the nodes part of the state
+ response. Sets if we should filter out the routing table part of the
+ state response. Sets if we should filter out the metadata part of the
+ state response. Sets if we should filter out the blocks part of the state
+ response. When not filtering metadata, a list of indices to include in
+ the metadata response. If a single value is passed in it
+ will be appended to the current list of indices. If an array is
+ passed in it will replace all existing indices. When not filtering metadata, a list of index templates to
+ include in the metadata response. If a single value is passed in
+ it will be appended to the current list of templates. If an
+ array is passed in it will replace all existing templates. Allows you to serialize this object into a JSON encoded string. The type of ejs object. For internal use only. Retrieves the internal Retrieves comprehensive state information of the whole cluster. The Set's the nodes to get the information for. If a
+ single value is passed in it will be appended to the current list
+ of nodes. If an array is passed in it will replace all existing
+ nodes. Nodes can be identified in the APIs either using their
+ internal node id, the node name, address, custom attributes, or
+ _local for only the node receiving the request. Clears all the flags (first). Useful, if you only want to
+ retrieve specific information. Enables all information flags. Get information about node settings. If stats about the os should be returned. If information about the process should be returned. If information about the jvm should be returned. If information about the thread pool should be returned. If information about the network should be returned. If information about the transport should be returned. If information about the http should be returned. If information about plugins should be returned. Allows you to serialize this object into a JSON encoded string. The type of ejs object. For internal use only. Retrieves the internal Retrieves very simple status on the health of the cluster. The Set's the nodes to get the stats information for. If a
+ single value is passed in it will be appended to the current list
+ of nodes. If an array is passed in it will replace all existing
+ nodes. Nodes can be identified in the APIs either using their
+ internal node id, the node name, address, custom attributes, or
+ _local for only the node receiving the request. Clears all the flags (first). Useful, if you only want to
+ retrieve specific stats. Enables all stats flags. If stats about indices should be returned. This is enabled
+ by default. If stats about the os should be returned. If stats about the process should be returned. If stats about the jvm should be returned. If stats about the thread pool should be returned. If stats about the network should be returned. If stats about the file system (fs) should be returned. If stats about the transport should be returned. If stats about the http should be returned. Allows you to serialize this object into a JSON encoded string. The type of ejs object. For internal use only. Retrieves the internal Retrieves very simple status on the health of the cluster. A GeoPoint object that can be used in queries and filters that
+ take a GeoPoint. GeoPoint supports various input formats. See http://www.elasticsearch.org/guide/reference/mapping/geo-point-type.html Defines a point Allows to highlight search results on one or more fields. In order to
- perform highlighting, the actual content of the field is required. If the
- field in question is stored (has store set to yes in the mapping), it will
- be used, otherwise, the actual _source will be loaded and the relevant
- field will be extracted from it. Allows to highlight search results on one or more fields. In order to
+ perform highlighting, the actual content of the field is required. If the
+ field in question is stored (has store set to yes in the mapping), it will
+ be used, otherwise, the actual _source will be loaded and the relevant
+ field will be extracted from it. If no term_vector information is provided (by setting it to
- with_positions_offsets in the mapping), then the plain highlighter will be
- used. If it is provided, then the fast vector highlighter will be used.
- When term vectors are available, highlighting will be performed faster at
- the cost of bigger index size. If no term_vector information is provided (by setting it to
+ with_positions_offsets in the mapping), then the plain highlighter will be
+ used. If it is provided, then the fast vector highlighter will be used.
+ When term vectors are available, highlighting will be performed faster at
+ the cost of bigger index size. See http://www.elasticsearch.org/guide/reference/api/search/highlighting.html See http://www.elasticsearch.org/guide/reference/api/search/highlighting.html Allows to highlight search results on one or more fields. Allows to highlight search results on one or more fields. A shape which has already been indexed in another index and/or index
- type. This is particularly useful for when you have a pre-defined list of
- shapes which are useful to your application and you want to reference this
- using a logical name (for example ‘New Zealand’) rather than having to
- provide their coordinates each time. A shape which has already been indexed in another index and/or index
+ type. This is particularly useful for when you have a pre-defined list of
+ shapes which are useful to your application and you want to reference this
+ using a logical name (for example ‘New Zealand’) rather than having to
+ provide their coordinates each time. Defines a shape that already exists in an index/type. Defines a shape that already exists in an index/type. The The Provides methods for executing search requests Provides methods for executing search requests Sets the search execution type for the request. Valid values are: This option is valid during the following operations:
+ Determines what type of indices to exclude from a request. The
+ value can be one of the following: This option is valid during the following operations:
+ The Provides methods for executing search requests Sets the sorting for the query. This accepts many input formats. Sets the sorting for the query. This accepts many input formats. Multi-level sorting is supported so the order in which sort fields
- are added to the query requests is relevant. It is recommended to use Multi-level sorting is supported so the order in which sort fields
+ are added to the query requests is relevant. It is recommended to use This option is valid during the following operations:
- This option is valid during the following operations:
+ This option is valid during the following operations:
- This option is valid during the following operations:
+ Sets the replication mode. Sets the replication mode. Valid values are: This option is valid during the following operations:
- Valid values are: This option is valid during the following operations:
+ Sets the write consistency. Sets the write consistency. Valid values are: This option is valid during the following operations:
- Valid values are: This option is valid during the following operations:
+ Sets the search execution type for the request. Sets the search execution type for the request. Valid values are: This option is valid during the following operations:
- Valid values are: This option is valid during the following operations:
+ Controls the preference of which shard replicas to execute the search request on.
- By default, the operation is randomized between the each shard replicas. The
- preference can be one of the following: Controls the preference of which shard replicas to execute the search request on.
+ By default, the operation is randomized between the each shard replicas. The
+ preference can be one of the following: This option is valid during the following operations:
- This option is valid during the following operations:
+ Determines what type of indices to exclude from a request. The
- value can be one of the following: If the operation will run on the local node only This option is valid during the following operations:
+ This option is valid during the following operations:
- Determines what type of indices to exclude from a request. The
+ value can be one of the following: This option is valid during the following operations:
+ ScriptField's allow you create dynamic fields on stored documents at query
- time. For example, you might have a set of document thats containsthe fields
- A method that allows to rescore queries with a typically more expensive. Computes dynamic document properties based on information from other fields. Defines an operation that rescores a query with another query. ScriptField's allow you create dynamic fields on stored documents at query
+ time. For example, you might have a set of document thats containsthe fields
+ Computes dynamic document properties based on information from other fields. A Shape object that can be used in queries and filters that
- take a Shape. Shape uses the GeoJSON format. A Shape object that can be used in queries and filters that
+ take a Shape. Shape uses the GeoJSON format. See http://www.geojson.org/ See http://www.geojson.org/ Defines a shape Defines a shape A Sort object that can be used in on the Request object to specify
- various types of sorting. A Sort object that can be used in on the Request object to specify
+ various types of sorting. See http://www.elasticsearch.org/guide/reference/api/search/sort.html See http://www.elasticsearch.org/guide/reference/api/search/sort.html Defines a sort value Defines a sort value Allows you to set a filter that nested objects must match
- in order to be considered during sorting. Allows you to set a filter that nested objects must match
+ in order to be considered during sorting. DirectGenerator is a candidate generator for DirectGenerator is a candidate generator for A candidate generator that generates terms based on edit distance. A candidate generator that generates terms based on edit distance. Sets an analyzer that is applied to each of the tokens passed to
- this generator. The analyzer is applied to the original tokens,
- not the generated tokens. Sets an analyzer that is applied to each of the tokens passed to
+ this generator. The analyzer is applied to the original tokens,
+ not the generated tokens. Sets an analyzer that is applied to each of the generated tokens
- before they are passed to the actual phrase scorer. Sets an analyzer that is applied to each of the generated tokens
+ before they are passed to the actual phrase scorer. Sets the field used to generate suggestions from. Sets the field used to generate suggestions from. Sets the number of suggestions returned for each token. Sets the number of suggestions returned for each token. Allows you to serialize this object into a JSON encoded string. Allows you to serialize this object into a JSON encoded string. Retrieves the internal Retrieves the internal The DirectSettingsMixin provides support for common options used across
- various The DirectSettingsMixin provides support for common options used across
+ various Sets the accuracy. How similar the suggested terms at least
- need to be compared to the original suggest text. Sets the accuracy. How similar the suggested terms at least
+ need to be compared to the original suggest text. Sets the suggest mode. Valid values are: Sets the suggest mode. Valid values are: Sets the sort mode. Valid values are: Sets the sort mode. Valid values are: Sets what string distance implementation to use for comparing
- how similar suggested terms are. Valid values are: Sets what string distance implementation to use for comparing
+ how similar suggested terms are. Valid values are: Sets the maximum edit distance candidate suggestions can have
- in order to be considered as a suggestion. Sets the maximum edit distance candidate suggestions can have
+ in order to be considered as a suggestion. The factor that is used to multiply with the size in order
- to inspect more candidate suggestions. The factor that is used to multiply with the size in order
+ to inspect more candidate suggestions. Sets a maximum threshold in number of documents a suggest text
- token can exist in order to be corrected. Sets a maximum threshold in number of documents a suggest text
+ token can exist in order to be corrected. Sets the number of minimal prefix characters that must match in
- order be a candidate suggestion. Sets the number of minimal prefix characters that must match in
+ order be a candidate suggestion. Sets the minimum length a suggest text term must have in order
- to be corrected. Sets the minimum length a suggest text term must have in order
+ to be corrected. Sets a minimal threshold of the number of documents a suggested
- term should appear in. Sets a minimal threshold of the number of documents a suggested
+ term should appear in. Retrieves the internal Retrieves the internal PhraseSuggester extends the PhraseSuggester extends the A suggester that suggests entire corrected phrases. A suggester that suggests entire corrected phrases. Sets the text to get suggestions for. If not set, the global
- suggestion text will be used. Sets the text to get suggestions for. If not set, the global
+ suggestion text will be used. Sets analyzer used to analyze the suggest text. Sets analyzer used to analyze the suggest text. Sets the field used to generate suggestions from. Sets the field used to generate suggestions from. Sets the number of suggestions returned for each token. Sets the number of suggestions returned for each token. Sets the maximum number of suggestions to be retrieved from
- each individual shard. Sets the maximum number of suggestions to be retrieved from
+ each individual shard. Sets the likelihood of a term being a misspelled even if the
- term exists in the dictionary. The default it 0.95 corresponding
- to 5% or the real words are misspelled. Sets the likelihood of a term being a misspelled even if the
+ term exists in the dictionary. The default it 0.95 corresponding
+ to 5% or the real words are misspelled. Sets the confidence level defines a factor applied to the input
- phrases score which is used as a threshold for other suggest
- candidates. Only candidates that score higher than the threshold
- will be included in the result. Sets the confidence level defines a factor applied to the input
+ phrases score which is used as a threshold for other suggest
+ candidates. Only candidates that score higher than the threshold
+ will be included in the result. Sets the separator that is used to separate terms in the bigram
- field. If not set the whitespce character is used as a
- separator. Sets the separator that is used to separate terms in the bigram
+ field. If not set the whitespce character is used as a
+ separator. Sets the maximum percentage of the terms that at most
- considered to be misspellings in order to form a correction. Sets the maximum percentage of the terms that at most
+ considered to be misspellings in order to form a correction. Sets the max size of the n-grams (shingles) in the field. If
- the field doesn't contain n-grams (shingles) this should be
- omitted or set to 1. Sets the max size of the n-grams (shingles) in the field. If
+ the field doesn't contain n-grams (shingles) this should be
+ omitted or set to 1. Forces the use of unigrams. Forces the use of unigrams. A smoothing model that takes the weighted mean of the unigrams,
- bigrams and trigrams based on user supplied weights (lambdas). The
- sum of tl, bl, and ul must equal 1. A smoothing model that takes the weighted mean of the unigrams,
+ bigrams and trigrams based on user supplied weights (lambdas). The
+ sum of tl, bl, and ul must equal 1. A smoothing model that uses an additive smoothing model where a
- constant (typically 1.0 or smaller) is added to all counts to
- balance weights, The default alpha is 0.5. A smoothing model that uses an additive smoothing model where a
+ constant (typically 1.0 or smaller) is added to all counts to
+ balance weights, The default alpha is 0.5. A simple backoff model that backs off to lower order n-gram
- models if the higher order count is 0 and discounts the lower
- order n-gram model by a constant factor. The default discount is
- 0.4. A simple backoff model that backs off to lower order n-gram
+ models if the higher order count is 0 and discounts the lower
+ order n-gram model by a constant factor. The default discount is
+ 0.4. Allows you to serialize this object into a JSON encoded string. Allows you to serialize this object into a JSON encoded string. Retrieves the internal Retrieves the internal TermSuggester suggests terms based on edit distance. The provided suggest
- text is analyzed before terms are suggested. The suggested terms are
- provided per analyzed suggest text token. This leaves the suggest-selection
- to the API consumer. For a higher level suggester, please use the
- TermSuggester suggests terms based on edit distance. The provided suggest
+ text is analyzed before terms are suggested. The suggested terms are
+ provided per analyzed suggest text token. This leaves the suggest-selection
+ to the API consumer. For a higher level suggester, please use the
+ A suggester that suggests terms based on edit distance. A suggester that suggests terms based on edit distance. Sets the text to get suggestions for. If not set, the global
- suggestion text will be used. Sets the text to get suggestions for. If not set, the global
+ suggestion text will be used. Sets analyzer used to analyze the suggest text. Sets analyzer used to analyze the suggest text. Sets the field used to generate suggestions from. Sets the field used to generate suggestions from. Sets the number of suggestions returned for each token. Sets the number of suggestions returned for each token. Sets the maximum number of suggestions to be retrieved from
- each individual shard. Sets the maximum number of suggestions to be retrieved from
+ each individual shard. Allows you to serialize this object into a JSON encoded string. Allows you to serialize this object into a JSON encoded string. Retrieves the internal Retrieves the internal this so that calls can be chained.
+ */
+ waitForNodes: function (num) {
+ if (num == null) {
+ return params.wait_for_nodes;
+ }
+
+ params.wait_for_nodes = num;
+ return this;
+ },
+
+ /**
+
+
+
+ @member ejs.ClusterHealth
+ @param {String} l The details level (cluster, indices, or shards)
+ @returns {Object} returns clusterindicesshardsthis so that calls can be chained.
+ */
+ level: function (l) {
+ if (l == null) {
+ return params.level;
+ }
+
+ l = l.toLowerCase();
+ if (l === 'cluster' || l === 'indices' || l === 'shards') {
+ params.level = l;
+ }
+
+ return this;
+ },
+
+ /**
+ document object. This is
+ typically used by internal API functions so use with caution.ClusterState object provides an interface for
+ accessing the state of your cluster.this so that calls can be chained.
+ */
+ local: function (trueFalse) {
+ if (trueFalse == null) {
+ return params.local;
+ }
+
+ params.local = trueFalse;
+ return this;
+ },
+
+ /**
+ this so that calls can be chained.
+ */
+ masterTimeout: function (length) {
+ if (length == null) {
+ return params.master_timeout;
+ }
+
+ params.master_timeout = length;
+ return this;
+ },
+
+ /**
+ this so that calls can be chained.
+ */
+ filterNodes: function (trueFalse) {
+ if (trueFalse == null) {
+ return params.filter_nodes;
+ }
+
+ params.filter_nodes = trueFalse;
+ return this;
+ },
+
+ /**
+ this so that calls can be chained.
+ */
+ filterRoutingTable: function (trueFalse) {
+ if (trueFalse == null) {
+ return params.filter_routing_table;
+ }
+
+ params.filter_routing_table = trueFalse;
+ return this;
+ },
+
+ /**
+ this so that calls can be chained.
+ */
+ filterMetadata: function (trueFalse) {
+ if (trueFalse == null) {
+ return params.filter_metadata;
+ }
+
+ params.filter_metadata = trueFalse;
+ return this;
+ },
+
+ /**
+ this so that calls can be chained.
+ */
+ filterBlocks: function (trueFalse) {
+ if (trueFalse == null) {
+ return params.filter_blocks;
+ }
+
+ params.filter_blocks = trueFalse;
+ return this;
+ },
+
+ /**
+ this so that calls can be chained.
+ */
+ filterIndices: function (i) {
+ if (params.filter_indices == null) {
+ params.filter_indices = [];
+ }
+
+ if (i == null) {
+ return params.filter_indices;
+ }
+
+ if (isString(i)) {
+ params.filter_indices.push(i);
+ } else if (isArray(i)) {
+ params.filter_indices = i;
+ } else {
+ throw new TypeError('Argument must be string or array');
+ }
+
+ return this;
+ },
+
+ /**
+ this so that calls can be chained.
+ */
+ filterIndexTemplates: function (i) {
+ if (params.filter_index_templates == null) {
+ params.filter_index_templates = [];
+ }
+
+ if (i == null) {
+ return params.filter_index_templates;
+ }
+
+ if (isString(i)) {
+ params.filter_index_templates.push(i);
+ } else if (isArray(i)) {
+ params.filter_index_templates = i;
+ } else {
+ throw new TypeError('Argument must be string or array');
+ }
+
+ return this;
+ },
+
+ /**
+ document object. This is
+ typically used by internal API functions so use with caution.NodeInfo object provides an interface for accessing
+ the information for one or more (or all) nodes in your cluster. Information
+ is available for settings, os, process, jvm, thread pool, network, plugins,
+ transport, and http.this so that calls can be chained.
+ */
+ nodes: function (n) {
+ if (params.nodes == null) {
+ params.nodes = [];
+ }
+
+ if (n == null) {
+ return params.nodes;
+ }
+
+ if (isString(n)) {
+ params.nodes.push(n);
+ } else if (isArray(n)) {
+ params.nodes = n;
+ } else {
+ throw new TypeError('Argument must be string or array');
+ }
+
+ return this;
+ },
+
+ /**
+ this so that calls can be chained.
+ */
+ clear: function (trueFalse) {
+ if (trueFalse == null) {
+ return params.clear;
+ }
+
+ params.clear = trueFalse;
+ return this;
+ },
+
+ /**
+ this so that calls can be chained.
+ */
+ all: function (trueFalse) {
+ if (trueFalse == null) {
+ return params.all;
+ }
+
+ params.all = trueFalse;
+ return this;
+ },
+
+ /**
+ this so that calls can be chained.
+ */
+ settings: function (trueFalse) {
+ if (trueFalse == null) {
+ return params.settings;
+ }
+
+ params.settings = trueFalse;
+ return this;
+ },
+
+ /**
+ this so that calls can be chained.
+ */
+ os: function (trueFalse) {
+ if (trueFalse == null) {
+ return params.os;
+ }
+
+ params.os = trueFalse;
+ return this;
+ },
+
+ /**
+ this so that calls can be chained.
+ */
+ process: function (trueFalse) {
+ if (trueFalse == null) {
+ return params.process;
+ }
+
+ params.process = trueFalse;
+ return this;
+ },
+
+ /**
+ this so that calls can be chained.
+ */
+ jvm: function (trueFalse) {
+ if (trueFalse == null) {
+ return params.jvm;
+ }
+
+ params.jvm = trueFalse;
+ return this;
+ },
+
+ /**
+ this so that calls can be chained.
+ */
+ threadPool: function (trueFalse) {
+ if (trueFalse == null) {
+ return params.thread_pool;
+ }
+
+ params.thread_pool = trueFalse;
+ return this;
+ },
+
+ /**
+ this so that calls can be chained.
+ */
+ network: function (trueFalse) {
+ if (trueFalse == null) {
+ return params.network;
+ }
+
+ params.network = trueFalse;
+ return this;
+ },
+
+ /**
+ this so that calls can be chained.
+ */
+ transport: function (trueFalse) {
+ if (trueFalse == null) {
+ return params.transport;
+ }
+
+ params.transport = trueFalse;
+ return this;
+ },
+
+ /**
+ this so that calls can be chained.
+ */
+ http: function (trueFalse) {
+ if (trueFalse == null) {
+ return params.http;
+ }
+
+ params.http = trueFalse;
+ return this;
+ },
+
+ /**
+ this so that calls can be chained.
+ */
+ plugin: function (trueFalse) {
+ if (trueFalse == null) {
+ return params.plugin;
+ }
+
+ params.plugin = trueFalse;
+ return this;
+ },
+
+ /**
+ document object. This is
+ typically used by internal API functions so use with caution.NodeStats object provides an interface for accessing
+ the stats for one or more (or all) nodes in your cluster. Stats are
+ available for indicies, os, process, jvm, thread pool, network, filesystem,
+ transport, and http.this so that calls can be chained.
+ */
+ nodes: function (n) {
+ if (params.nodes == null) {
+ params.nodes = [];
+ }
+
+ if (n == null) {
+ return params.nodes;
+ }
+
+ if (isString(n)) {
+ params.nodes.push(n);
+ } else if (isArray(n)) {
+ params.nodes = n;
+ } else {
+ throw new TypeError('Argument must be string or array');
+ }
+
+ return this;
+ },
+
+ /**
+ this so that calls can be chained.
+ */
+ clear: function (trueFalse) {
+ if (trueFalse == null) {
+ return params.clear;
+ }
+
+ params.clear = trueFalse;
+ return this;
+ },
+
+ /**
+ this so that calls can be chained.
+ */
+ all: function (trueFalse) {
+ if (trueFalse == null) {
+ return params.all;
+ }
+
+ params.all = trueFalse;
+ return this;
+ },
+
+ /**
+ this so that calls can be chained.
+ */
+ indices: function (trueFalse) {
+ if (trueFalse == null) {
+ return params.indices;
+ }
+
+ params.indices = trueFalse;
+ return this;
+ },
+
+ /**
+ this so that calls can be chained.
+ */
+ os: function (trueFalse) {
+ if (trueFalse == null) {
+ return params.os;
+ }
+
+ params.os = trueFalse;
+ return this;
+ },
+
+ /**
+ this so that calls can be chained.
+ */
+ process: function (trueFalse) {
+ if (trueFalse == null) {
+ return params.process;
+ }
+
+ params.process = trueFalse;
+ return this;
+ },
+
+ /**
+ this so that calls can be chained.
+ */
+ jvm: function (trueFalse) {
+ if (trueFalse == null) {
+ return params.jvm;
+ }
+
+ params.jvm = trueFalse;
+ return this;
+ },
+
+ /**
+ this so that calls can be chained.
+ */
+ threadPool: function (trueFalse) {
+ if (trueFalse == null) {
+ return params.thread_pool;
+ }
+
+ params.thread_pool = trueFalse;
+ return this;
+ },
+
+ /**
+ this so that calls can be chained.
+ */
+ network: function (trueFalse) {
+ if (trueFalse == null) {
+ return params.network;
+ }
+
+ params.network = trueFalse;
+ return this;
+ },
+
+ /**
+ this so that calls can be chained.
+ */
+ fs: function (trueFalse) {
+ if (trueFalse == null) {
+ return params.fs;
+ }
+
+ params.fs = trueFalse;
+ return this;
+ },
+
+ /**
+ this so that calls can be chained.
+ */
+ transport: function (trueFalse) {
+ if (trueFalse == null) {
+ return params.transport;
+ }
+
+ params.transport = trueFalse;
+ return this;
+ },
+
+ /**
+ this so that calls can be chained.
+ */
+ http: function (trueFalse) {
+ if (trueFalse == null) {
+ return params.http;
+ }
+
+ params.http = trueFalse;
+ return this;
+ },
+
+ /**
+ document object. This is
+ typically used by internal API functions so use with caution.this so that calls can be chained.
- */
+ Example:
+ {lat: 41.12, lon: -71.34}
+
+ @member ejs.GeoPoint
+ @param {Object} obj an object with a lat and lon property.
+ @returns {Object} returns this so that calls can be chained.
+ */
properties: function (obj) {
if (obj == null) {
return point;
}
-
+
if (isObject(obj) && has(obj, 'lat') && has(obj, 'lon')) {
point = {
lat: obj.lat,
lon: obj.lon
};
}
-
+
return this;
},
/**
- Sets the GeoPoint as a string. The format is "lat,lon".
-
- Example:
-
- "41.12,-71.34"
+ Sets the GeoPoint as a string. The format is "lat,lon".
- @member ejs.GeoPoint
- @param {String} s a String point in "lat,lon" format.
- @returns {Object} returns this so that calls can be chained.
- */
+ Example:
+
+ "41.12,-71.34"
+
+ @member ejs.GeoPoint
+ @param {String} s a String point in "lat,lon" format.
+ @returns {Object} returns this so that calls can be chained.
+ */
string: function (s) {
if (s == null) {
return point;
}
-
+
if (isString(s) && s.indexOf(',') !== -1) {
point = s;
}
-
+
return this;
},
-
- /**
- Sets the GeoPoint as a GeoHash. The hash is a string of
- alpha-numeric characters with a precision length that defaults to 12.
-
- Example:
- "drm3btev3e86"
- @member ejs.GeoPoint
- @param {String} hash an GeoHash as a string
- @param {Integer} precision an optional precision length, defaults
- to 12 if not specified.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the GeoPoint as a GeoHash. The hash is a string of
+ alpha-numeric characters with a precision length that defaults to 12.
+
+ Example:
+ "drm3btev3e86"
+
+ @member ejs.GeoPoint
+ @param {String} hash an GeoHash as a string
+ @param {Integer} precision an optional precision length, defaults
+ to 12 if not specified.
+ @returns {Object} returns this so that calls can be chained.
+ */
geohash: function (hash, precision) {
// set precision, default to 12
precision = (precision != null && isNumber(precision)) ? precision : 12;
-
+
if (hash == null) {
return point;
}
-
+
if (isString(hash) && hash.length === precision) {
point = hash;
}
-
+
return this;
},
-
- /**
- Sets the GeoPoint from an array point. The array must contain only
- 2 values. The first value is the lat and the 2nd value is the lon.
-
- Example:
- [41.12, -71.34]
- @member ejs.GeoPoint
- @param {Array} a an array of length 2.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the GeoPoint from an array point. The array must contain only
+ 2 values. The first value is the lat and the 2nd value is the lon.
+
+ Example:
+ [41.12, -71.34]
+
+ @member ejs.GeoPoint
+ @param {Array} a an array of length 2.
+ @returns {Object} returns this so that calls can be chained.
+ */
array: function (a) {
if (a == null) {
return point;
}
-
-
+
+
// convert to GeoJSON format of [lon, lat]
if (isArray(a) && a.length === 2) {
point = [a[1], a[0]];
}
-
+
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.GeoPoint
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.GeoPoint
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(point);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.GeoPoint
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.GeoPoint
+ @returns {String} the type of object
+ */
_type: function () {
return 'geo point';
},
-
- /**
- Retrieves the internal script object. This is typically used by
- internal API functions so use with caution.
- @member ejs.GeoPoint
- @returns {String} returns this object's internal object representation.
- */
+ /**
+ Retrieves the internal script object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.GeoPoint
+ @returns {String} returns this object's internal object representation.
+ */
_self: function () {
return point;
}
@@ -17030,45 +18394,45 @@
};
/**
- @class
- this so that calls can be chained.
- */
+ @member ejs.Highlight
+ @param {String || Array} vals A field name or array of field names.
+ @returns {Object} returns this so that calls can be chained.
+ */
fields: function (vals) {
if (vals == null) {
return highlight.fields;
}
-
+
if (isString(vals)) {
if (!has(highlight.fields, vals)) {
highlight.fields[vals] = {};
@@ -17108,160 +18472,160 @@
});
}
},
-
+
/**
- Sets the pre tags for highlighted fragments. You can apply the
- tags to a specific field by passing the field name in to the
- oField parameter.
-
- @member ejs.Highlight
- @param {String || Array} tags A single tag or an array of tags.
- @param {String} oField An optional field name
- @returns {Object} returns this so that calls can be chained.
- */
+ Sets the pre tags for highlighted fragments. You can apply the
+ tags to a specific field by passing the field name in to the
+ oField parameter.
+
+ @member ejs.Highlight
+ @param {String || Array} tags A single tag or an array of tags.
+ @param {String} oField An optional field name
+ @returns {Object} returns this so that calls can be chained.
+ */
preTags: function (tags, oField) {
if (tags === null && oField != null) {
return highlight.fields[oField].pre_tags;
} else if (tags == null) {
return highlight.pre_tags;
}
-
+
if (isString(tags)) {
addOption(oField, 'pre_tags', [tags]);
} else if (isArray(tags)) {
addOption(oField, 'pre_tags', tags);
}
-
+
return this;
},
/**
- Sets the post tags for highlighted fragments. You can apply the
- tags to a specific field by passing the field name in to the
- oField parameter.
-
- @member ejs.Highlight
- @param {String || Array} tags A single tag or an array of tags.
- @param {String} oField An optional field name
- @returns {Object} returns this so that calls can be chained.
- */
+ Sets the post tags for highlighted fragments. You can apply the
+ tags to a specific field by passing the field name in to the
+ oField parameter.
+
+ @member ejs.Highlight
+ @param {String || Array} tags A single tag or an array of tags.
+ @param {String} oField An optional field name
+ @returns {Object} returns this so that calls can be chained.
+ */
postTags: function (tags, oField) {
if (tags === null && oField != null) {
return highlight.fields[oField].post_tags;
} else if (tags == null) {
return highlight.post_tags;
}
-
+
if (isString(tags)) {
addOption(oField, 'post_tags', [tags]);
} else if (isArray(tags)) {
addOption(oField, 'post_tags', tags);
}
-
+
return this;
},
-
+
/**
- Sets the order of highlight fragments. You can apply the option
- to a specific field by passing the field name in to the
- oField parameter. Valid values for order are:
-
- score - the score calculated by Lucene's highlighting framework.
-
- @member ejs.Highlight
- @param {String} o The order. Currently only "score".
- @param {String} oField An optional field name
- @returns {Object} returns this so that calls can be chained.
- */
+ Sets the order of highlight fragments. You can apply the option
+ to a specific field by passing the field name in to the
+ oField parameter. Valid values for order are:
+
+ score - the score calculated by Lucene's highlighting framework.
+
+ @member ejs.Highlight
+ @param {String} o The order. Currently only "score".
+ @param {String} oField An optional field name
+ @returns {Object} returns this so that calls can be chained.
+ */
order: function (o, oField) {
if (o === null && oField != null) {
return highlight.fields[oField].order;
} else if (o == null) {
return highlight.order;
}
-
+
o = o.toLowerCase();
if (o === 'score') {
addOption(oField, 'order', o);
}
-
+
return this;
},
-
+
/**
- Sets the schema to be used for the tags. Valid values are:
-
- styled - 10 pre tags with css class of hltN, where N is 1-10
-
- @member ejs.Highlight
- @param {String} s The schema. Currently only "styled".
- @returns {Object} returns this so that calls can be chained.
- */
+ Sets the schema to be used for the tags. Valid values are:
+
+ styled - 10 pre tags with css class of hltN, where N is 1-10
+
+ @member ejs.Highlight
+ @param {String} s The schema. Currently only "styled".
+ @returns {Object} returns this so that calls can be chained.
+ */
tagsSchema: function (s) {
if (s == null) {
return highlight.tags_schema;
}
-
+
s = s.toLowerCase();
if (s === 'styled') {
highlight.tags_schema = s;
}
-
+
return this;
},
-
+
/**
- Enables highlights in documents matched by a filter.
- You can apply the option to a specific field by passing the field
- name in to the oField parameter. Defaults to false.
-
- @member ejs.Highlight
- @param {Boolean} trueFalse If filtered docs should be highlighted.
- @param {String} oField An optional field name
- @returns {Object} returns this so that calls can be chained.
- */
+ Enables highlights in documents matched by a filter.
+ You can apply the option to a specific field by passing the field
+ name in to the oField parameter. Defaults to false.
+
+ @member ejs.Highlight
+ @param {Boolean} trueFalse If filtered docs should be highlighted.
+ @param {String} oField An optional field name
+ @returns {Object} returns this so that calls can be chained.
+ */
highlightFilter: function (trueFalse, oField) {
if (trueFalse === null && oField != null) {
return highlight.fields[oField].highlight_filter;
} else if (trueFalse == null) {
return highlight.highlight_filter;
}
-
+
addOption(oField, 'highlight_filter', trueFalse);
return this;
},
-
+
/**
- Sets the size of each highlight fragment in characters.
- You can apply the option to a specific field by passing the field
- name in to the oField parameter. Default: 100
-
- @member ejs.Highlight
- @param {Integer} size The fragment size in characters.
- @param {String} oField An optional field name
- @returns {Object} returns this so that calls can be chained.
- */
+ Sets the size of each highlight fragment in characters.
+ You can apply the option to a specific field by passing the field
+ name in to the oField parameter. Default: 100
+
+ @member ejs.Highlight
+ @param {Integer} size The fragment size in characters.
+ @param {String} oField An optional field name
+ @returns {Object} returns this so that calls can be chained.
+ */
fragmentSize: function (size, oField) {
if (size === null && oField != null) {
return highlight.fields[oField].fragment_size;
} else if (size == null) {
return highlight.fragment_size;
}
-
+
addOption(oField, 'fragment_size', size);
return this;
},
-
- /**
- Sets the number of highlight fragments.
- You can apply the option to a specific field by passing the field
- name in to the oField parameter. Default: 5
- @member ejs.Highlight
- @param {Integer} cnt The fragment size in characters.
- @param {String} oField An optional field name
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the number of highlight fragments.
+ You can apply the option to a specific field by passing the field
+ name in to the oField parameter. Default: 5
+
+ @member ejs.Highlight
+ @param {Integer} cnt The fragment size in characters.
+ @param {String} oField An optional field name
+ @returns {Object} returns this so that calls can be chained.
+ */
numberOfFragments: function (cnt, oField) {
if (cnt === null && oField != null) {
return highlight.fields[oField].number_of_fragments;
@@ -17271,66 +18635,66 @@
addOption(oField, 'number_of_fragments', cnt);
return this;
- },
+ },
/**
- Sets highlight encoder. Valid values are:
-
- default - the default, no encoding
- html - to encode html characters if you use html tags
-
- @member ejs.Highlight
- @param {String} e The encoder. default or html
- @returns {Object} returns this so that calls can be chained.
- */
+ Sets highlight encoder. Valid values are:
+
+ default - the default, no encoding
+ html - to encode html characters if you use html tags
+
+ @member ejs.Highlight
+ @param {String} e The encoder. default or html
+ @returns {Object} returns this so that calls can be chained.
+ */
encoder: function (e) {
if (e == null) {
return highlight.encoder;
}
-
+
e = e.toLowerCase();
if (e === 'default' || e === 'html') {
highlight.encoder = e;
}
-
+
return this;
},
/**
- When enabled it will cause a field to be highlighted only if a
- query matched that field. false means that terms are highlighted
- on all requested fields regardless if the query matches
- specifically on them. You can apply the option to a specific
- field by passing the field name in to the oField
- parameter. Defaults to false.
-
- @member ejs.Highlight
- @param {Boolean} trueFalse If filtered docs should be highlighted.
- @param {String} oField An optional field name
- @returns {Object} returns this so that calls can be chained.
- */
+ When enabled it will cause a field to be highlighted only if a
+ query matched that field. false means that terms are highlighted
+ on all requested fields regardless if the query matches
+ specifically on them. You can apply the option to a specific
+ field by passing the field name in to the oField
+ parameter. Defaults to false.
+
+ @member ejs.Highlight
+ @param {Boolean} trueFalse If filtered docs should be highlighted.
+ @param {String} oField An optional field name
+ @returns {Object} returns this so that calls can be chained.
+ */
requireFieldMatch: function (trueFalse, oField) {
if (trueFalse === null && oField != null) {
return highlight.fields[oField].require_field_match;
} else if (trueFalse == null) {
return highlight.require_field_match;
}
-
+
addOption(oField, 'require_field_match', trueFalse);
return this;
},
/**
- Sets the max number of characters to scan while looking for the
- start of a boundary character. You can apply the option to a
- specific field by passing the field name in to the
- oField parameter. Default: 20
+ Sets the max number of characters to scan while looking for the
+ start of a boundary character. You can apply the option to a
+ specific field by passing the field name in to the
+ oField parameter. Default: 20
- @member ejs.Highlight
- @param {Integer} cnt The max characters to scan.
- @param {String} oField An optional field name
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.Highlight
+ @param {Integer} cnt The max characters to scan.
+ @param {String} oField An optional field name
+ @returns {Object} returns this so that calls can be chained.
+ */
boundaryMaxScan: function (cnt, oField) {
if (cnt === null && oField != null) {
return highlight.fields[oField].boundary_max_scan;
@@ -17340,117 +18704,143 @@
addOption(oField, 'boundary_max_scan', cnt);
return this;
- },
+ },
/**
- Set's the boundary characters. When highlighting a field that is
- mapped with term vectors, boundary_chars can be configured to
- define what constitutes a boundary for highlighting. It’s a single
- string with each boundary character defined in it. You can apply
- the option to a specific field by passing the field name in to
- the oField parameter. It defaults to ".,!? \t\n".
-
- @member ejs.Highlight
- @param {String} charStr The boundary chars in a string.
- @param {String} oField An optional field name
- @returns {Object} returns this so that calls can be chained.
- */
+ Set's the boundary characters. When highlighting a field that is
+ mapped with term vectors, boundary_chars can be configured to
+ define what constitutes a boundary for highlighting. It’s a single
+ string with each boundary character defined in it. You can apply
+ the option to a specific field by passing the field name in to
+ the oField parameter. It defaults to ".,!? \t\n".
+
+ @member ejs.Highlight
+ @param {String} charStr The boundary chars in a string.
+ @param {String} oField An optional field name
+ @returns {Object} returns this so that calls can be chained.
+ */
boundaryChars: function (charStr, oField) {
if (charStr === null && oField != null) {
return highlight.fields[oField].boundary_chars;
} else if (charStr == null) {
return highlight.boundary_chars;
}
-
+
addOption(oField, 'boundary_chars', charStr);
return this;
},
-
+
/**
- Sets the highligher type. You can apply the option
- to a specific field by passing the field name in to the
- oField parameter. Valid values for order are:
-
- fast-vector-highlighter - the fast vector based highligher
- highlighter - the slower plain highligher
-
- @member ejs.Highlight
- @param {String} t The highligher.
- @param {String} oField An optional field name
- @returns {Object} returns this so that calls can be chained.
- */
+ Sets the highligher type. You can apply the option
+ to a specific field by passing the field name in to the
+ oField parameter. Valid values for order are:
+
+ fast-vector-highlighter - the fast vector based highligher
+ highlighter - the slower plain highligher
+
+ @member ejs.Highlight
+ @param {String} t The highligher.
+ @param {String} oField An optional field name
+ @returns {Object} returns this so that calls can be chained.
+ */
type: function (t, oField) {
if (t === null && oField != null) {
return highlight.fields[oField].type;
} else if (t == null) {
return highlight.type;
}
-
+
t = t.toLowerCase();
if (t === 'fast-vector-highlighter' || t === 'highlighter') {
addOption(oField, 'type', t);
}
-
+
return this;
},
/**
- Sets the fragmenter type. You can apply the option
- to a specific field by passing the field name in to the
- oField parameter. Valid values for order are:
-
- simple - breaks text up into same-size fragments with no concerns
- over spotting sentence boundaries.
- span - breaks text up into same-size fragments but does not split
- up Spans.
-
- @member ejs.Highlight
- @param {String} f The fragmenter.
- @param {String} oField An optional field name
- @returns {Object} returns this so that calls can be chained.
- */
+ Sets the fragmenter type. You can apply the option
+ to a specific field by passing the field name in to the
+ oField parameter. Valid values for order are:
+
+ simple - breaks text up into same-size fragments with no concerns
+ over spotting sentence boundaries.
+ span - breaks text up into same-size fragments but does not split
+ up Spans.
+
+ @member ejs.Highlight
+ @param {String} f The fragmenter.
+ @param {String} oField An optional field name
+ @returns {Object} returns this so that calls can be chained.
+ */
fragmenter: function (f, oField) {
if (f === null && oField != null) {
return highlight.fields[oField].fragmenter;
} else if (f == null) {
return highlight.fragmenter;
}
-
+
f = f.toLowerCase();
if (f === 'simple' || f === 'span') {
addOption(oField, 'fragmenter', f);
}
-
+
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.Highlight
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Sets arbitrary options that can be passed to the highlighter
+ implementation in use.
+
+ @since elasticsearch 0.90.1
+
+ @member ejs.Highlight
+ @param {String} opts A map/object of option name and values.
+ @param {Object} oField An optional field name
+ @returns {Object} returns this so that calls can be chained.
+ */
+ options: function (opts, oField) {
+ if (opts === null && oField != null) {
+ return highlight.fields[oField].options;
+ } else if (opts == null) {
+ return highlight.options;
+ }
+
+ if (!isObject(opts) || isArray(opts) || isEJSObject(opts)) {
+ throw new TypeError('Parameter must be an object');
+ }
+
+ addOption(oField, 'options', opts);
+ return this;
+ },
+
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.Highlight
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(highlight);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.Highlight
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.Highlight
+ @returns {String} the type of object
+ */
_type: function () {
return 'highlight';
},
-
- /**
- Retrieves the internal script object. This is typically used by
- internal API functions so use with caution.
- @member ejs.Highlight
- @returns {String} returns this object's internal object representation.
- */
+ /**
+ Retrieves the internal script object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.Highlight
+ @returns {String} returns this object's internal object representation.
+ */
_self: function () {
return highlight;
}
@@ -17458,22 +18848,22 @@
};
/**
- @class
- this so that calls can be chained.
- */
+ @member ejs.IndexedShape
+ @param {String} t a valid shape type.
+ @returns {Object} returns this so that calls can be chained.
+ */
type: function (t) {
if (t == null) {
return indexedShape.type;
}
-
+
indexedShape.type = t;
return this;
},
/**
- Sets the document id of the indexed shape.
+ Sets the document id of the indexed shape.
- @member ejs.IndexedShape
- @param {String} id a valid document id.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.IndexedShape
+ @param {String} id a valid document id.
+ @returns {Object} returns this so that calls can be chained.
+ */
id: function (id) {
if (id == null) {
return indexedShape.id;
}
-
+
indexedShape.id = id;
return this;
},
/**
- Sets the index which the shape is indexed under.
- Defaults to "shapes".
+ Sets the index which the shape is indexed under.
+ Defaults to "shapes".
- @member ejs.IndexedShape
- @param {String} idx a valid index name.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.IndexedShape
+ @param {String} idx a valid index name.
+ @returns {Object} returns this so that calls can be chained.
+ */
index: function (idx) {
if (idx == null) {
return indexedShape.index;
}
-
+
indexedShape.index = idx;
return this;
},
/**
- Sets the field name containing the indexed shape.
- Defaults to "shape".
+ Sets the field name containing the indexed shape.
+ Defaults to "shape".
- @member ejs.IndexedShape
- @param {String} field a valid field name.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.IndexedShape
+ @param {String} field a valid field name.
+ @returns {Object} returns this so that calls can be chained.
+ */
shapeFieldName: function (field) {
if (field == null) {
return indexedShape.shape_field_name;
}
-
+
indexedShape.shape_field_name = field;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.IndexedShape
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.IndexedShape
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(indexedShape);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.IndexedShape
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.IndexedShape
+ @returns {String} the type of object
+ */
_type: function () {
return 'indexed shape';
},
-
- /**
- Retrieves the internal script object. This is typically used by
- internal API functions so use with caution.
- @member ejs.IndexedShape
- @returns {String} returns this object's internal object representation.
- */
+ /**
+ Retrieves the internal script object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.IndexedShape
+ @returns {String} returns this object's internal object representation.
+ */
_self: function () {
return indexedShape;
}
@@ -17583,30 +18973,30 @@
};
/**
- @class
- Request object provides methods generating and
- executing search requests.MultiSearchRequest object provides methods generating and
+ executing search requests.this so that calls can be
+ chained. Returns {Array} current value not specified.
+ */
+ requests: function (r) {
+ if (r == null) {
+ return requests;
+ }
+
+ if (isRequest(r)) {
+ requests.push(r);
+ } else if (isArray(r)) {
+ requests = r;
+ } else {
+ throw new TypeError('Argument must be request or array');
+ }
+
+ return this;
+ },
+
+ /**
+
+
+
+ dfs_query_then_fetch - same as query_then_fetch,
+ except distributed term frequencies are calculated first.dfs_query_and_fetch - same as query_and_fetch,
+ except distributed term frequencies are calculated first.query_then_fetch - executed against all
+ shards, but only enough information is returned. When ready,
+ only the relevant shards are asked for the actual document
+ contentquery_and_fetch - execute the query on all
+ relevant shards and return the results, including content.scan - efficiently scroll a large result setcount - special search type that returns the
+ count that matched the search request without any docs searchthis so that calls can be chained.
+ */
+ searchType: function (t) {
+ if (t == null) {
+ return params.search_type;
+ }
+
+ t = t.toLowerCase();
+ if (t === 'dfs_query_then_fetch' || t === 'dfs_query_and_fetch' ||
+ t === 'query_then_fetch' || t === 'query_and_fetch' ||
+ t === 'scan' || t === 'count') {
+
+ params.search_type = t;
+ }
+
+ return this;
+ },
+
+ /**
+ Allows you to set the specified indices on this request object. This is the
+ set of indices that will be used when the search is executed.
+
+ @member ejs.MultiSearchRequest
+ @param {Array} indexArray An array of collection names.
+ @returns {Object} returns this so that calls can be chained.
+ */
+ indices: function (indexArray) {
+ if (indexArray == null) {
+ return indices;
+ } else if (isString(indexArray)) {
+ indices = [indexArray];
+ } else if (isArray(indexArray)) {
+ indices = indexArray;
+ } else {
+ throw new TypeError('Argument must be a string or array');
+ }
+
+ // check that an index is specified when a type is
+ // if not, search across _all indices
+ if (indices.length === 0 && types.length > 0) {
+ indices = ["_all"];
+ }
+
+ return this;
+ },
+
+ /**
+ Allows you to set the specified content-types on this request object. This is the
+ set of indices that will be used when the search is executed.
+
+ @member ejs.MultiSearchRequest
+ @param {Array} typeArray An array of content-type names.
+ @returns {Object} returns this so that calls can be chained.
+ */
+ types: function (typeArray) {
+ if (typeArray == null) {
+ return types;
+ } else if (isString(typeArray)) {
+ types = [typeArray];
+ } else if (isArray(typeArray)) {
+ types = typeArray;
+ } else {
+ throw new TypeError('Argument must be a string or array');
+ }
+
+ // check that an index is specified when a type is
+ // if not, search across _all indices
+ if (indices.length === 0 && types.length > 0) {
+ indices = ["_all"];
+ }
+
+ return this;
+ },
+
+ /**
+
+
+
+ none - No indices / aliases will be excluded from a requestmissing - Indices / aliases that are missing will be excluded from a requestsearch, search shards, count and
+ delete by querythis so that calls can be chained.
+ */
+ ignoreIndices: function (ignoreType) {
+ if (ignoreType == null) {
+ return params.ignore_indices;
+ }
+
+ ignoreType = ignoreType.toLowerCase();
+ if (ignoreType === 'none' || ignoreType === 'missing') {
+ params.ignore_indices = ignoreType;
+ }
+
+ return this;
+ },
+
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.MultiSearchRequest
+ @returns {String} returns this object as a serialized JSON string.
+ */
+ toString: function () {
+ var i, len, reqs = [];
+ for (i = 0, len = requests.length; i < len; i++) {
+ reqs.push(requests[i]._self());
+ }
+ return JSON.stringify(reqs);
+ },
+
+ /**
+ The type of ejs object. For internal use only.
+
+ @member ejs.MultiSearchRequest
+ @returns {String} the type of object
+ */
+ _type: function () {
+ return 'multi search request';
+ },
+
+ /**
+ Retrieves the internal query object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.MultiSearchRequest
+ @returns {String} returns this object's internal object representation.
+ */
+ _self: function () {
+ var i, len, reqs = [];
+ for (i = 0, len = requests.length; i < len; i++) {
+ reqs.push(requests[i]._self());
+ }
+ return reqs;
+ },
+
+ /**
+ Executes the search.
+
+ @member ejs.MultiSearchRequest
+ @param {Function} successcb A callback function that handles the search response.
+ @param {Function} errorcb A callback function that handles errors.
+ @returns {Object} Returns a client specific object.
+ */
+ doSearch: function (successcb, errorcb) {
+ var i, len, request, query, header, data = '';
+
+ // make sure the user has set a client
+ if (ejs.client == null) {
+ throw new Error("No Client Set");
+ }
+
+ // generate the data
+ // data consists of a header for each request + newline + request + newline
+ for (i = 0, len = requests.length; i < len; i++) {
+ request = requests[i];
+ header = {};
+
+ // add indices
+ if (request.indices().length > 0) {
+ header.indices = request.indices();
+ }
+
+ // add types
+ if (request.types().length > 0) {
+ header.types = request.types();
+ }
+
+ // add search type
+ if (request.searchType() != null) {
+ header.search_type = request.searchType();
+ }
+
+ // add preference
+ if (request.preference() != null) {
+ header.preference = request.preference();
+ }
+
+ // add routing
+ if (request.routing() != null) {
+ header.routing = request.routing();
+ }
+
+ // add ignore indices
+ if (request.ignoreIndices() != null) {
+ header.ignore_indices = request.ignoreIndices();
+ }
+
+ // add the generated header
+ data = data + JSON.stringify(header) + '\n';
+
+ // certain params need to be moved into the query body from request
+ // params, do that here
+ query = request._self();
+ if (request.timeout() != null) {
+ query.timeout = request.timeout();
+ }
+
+ // add the query to the data
+ data = data + JSON.stringify(query) + '\n';
+ }
+
+
+ return ejs.client.post(getRestPath(), data, successcb, errorcb);
+ }
+
+ };
+ };
+
+ /**
+ @class
+ Request object provides methods generating and
+ executing search requests.
-
+ sort() - The current sorting values are returned.sort(fieldName) - Adds the field to the current list of sorting values.sort(fieldName, order) - Adds the field to the current list of
- sorting with the specified order. Order must be asc or desc.sort(ejs.Sort) - Adds the Sort value to the current list of sorting values.sort(array) - Replaces all current sorting values with values
- from the array. The array must contain only strings and Sort objects.Sort objects when possible.this so that calls can be chained.
- */
+
+
+
+ sort() - The current sorting values are returned.sort(fieldName) - Adds the field to the current list of sorting values.sort(fieldName, order) - Adds the field to the current list of
+ sorting with the specified order. Order must be asc or desc.sort(ejs.Sort) - Adds the Sort value to the current list of sorting values.sort(array) - Replaces all current sorting values with values
+ from the array. The array must contain only strings and Sort objects.Sort objects when possible.this so that calls can be chained.
+ */
sort: function () {
var i, len;
-
+
if (!has(query, "sort")) {
query.sort = [];
}
@@ -17709,11 +19454,11 @@
if (arguments.length === 0) {
return query.sort;
}
-
+
// if passed a single argument
if (arguments.length === 1) {
var sortVal = arguments[0];
-
+
if (isString(sortVal)) {
// add a single field name
query.sort.push(sortVal);
@@ -17737,12 +19482,12 @@
} else {
// Invalid object type as argument.
throw new TypeError('Argument must be string, Sort, or array');
- }
+ }
} else if (arguments.length === 2) {
// handle the case where a single field name and order are passed
var field = arguments[0],
order = arguments[1];
-
+
if (isString(field) && isString(order)) {
order = order.toLowerCase();
if (order === 'asc' || order === 'desc') {
@@ -17757,207 +19502,208 @@
},
/**
- Enables score computation and tracking during sorting. Be default,
- when sorting scores are not computed.
+ Enables score computation and tracking during sorting. Be default,
+ when sorting scores are not computed.
- @member ejs.Request
- @param {Boolean} trueFalse If scores should be computed and tracked.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.Request
+ @param {Boolean} trueFalse If scores should be computed and tracked.
+ @returns {Object} returns this so that calls can be chained.
+ */
trackScores: function (trueFalse) {
if (trueFalse == null) {
return query.track_scores;
}
-
+
query.track_scores = trueFalse;
return this;
},
-
- /**
- Sets the number of results/documents to be returned. This is set on a per page basis.
- @member ejs.Request
- @param {Integer} s The number of results that are to be returned by the search.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the number of results/documents to be returned. This is set on a per page basis.
+
+ @member ejs.Request
+ @param {Integer} s The number of results that are to be returned by the search.
+ @returns {Object} returns this so that calls can be chained.
+ */
size: function (s) {
if (s == null) {
return query.size;
}
-
+
query.size = s;
return this;
},
/**
- A timeout, bounding the request to be executed within the
- specified time value and bail when expired. Defaults to no timeout.
+ A timeout, bounding the request to be executed within the
+ specified time value and bail when expired. Defaults to no timeout.
- search and delete by querythis so that calls can be chained.
- */
+ search and delete by querythis so that calls can be chained.
+ */
timeout: function (t) {
if (t == null) {
return params.timeout;
}
-
+
params.timeout = t;
return this;
},
-
- /**
- Sets the shard routing parameter. Only shards matching routing
- values will be searched. Set to an empty string to disable routing.
- Disabled by default.
- search, count and delete by querythis so that calls can be chained.
- */
+ /**
+ Sets the shard routing parameter. Only shards matching routing
+ values will be searched. Set to an empty string to disable routing.
+ Disabled by default.
+
+ search, search shards, count and
+ delete by querythis so that calls can be chained.
+ */
routing: function (route) {
if (route == null) {
return params.routing;
}
-
+
params.routing = route;
return this;
},
/**
-
-
-
- async - asynchronous replication to slavessync - synchronous replication to the slavesdefault - the currently configured system default.delete by querythis so that calls can be chained.
- */
+
+
+
+ async - asynchronous replication to slavessync - synchronous replication to the slavesdefault - the currently configured system default.delete by querythis so that calls can be chained.
+ */
replication: function (r) {
if (r == null) {
return params.replication;
}
-
+
r = r.toLowerCase();
if (r === 'async' || r === 'sync' || r === 'default') {
params.replication = r;
}
-
+
return this;
},
-
+
/**
-
-
-
- one - only requires write to one shardquorum - requires writes to quorum (N/2 + 1)all - requires write to succeed on all shardsdefault - the currently configured system defaultdelete by querythis so that calls can be chained.
- */
+
+
+
+ one - only requires write to one shardquorum - requires writes to quorum (N/2 + 1)all - requires write to succeed on all shardsdefault - the currently configured system defaultdelete by querythis so that calls can be chained.
+ */
consistency: function (c) {
if (c == null) {
return params.consistency;
}
-
+
c = c.toLowerCase();
if (c === 'default' || c === 'one' || c === 'quorum' || c === 'all') {
params.consistency = c;
}
-
+
return this;
},
-
+
/**
-
-
-
- dfs_query_then_fetch - same as query_then_fetch,
- except distributed term frequencies are calculated first.dfs_query_and_fetch - same as query_and_fetch,
- except distributed term frequencies are calculated first.query_then_fetch - executed against all
- shards, but only enough information is returned. When ready,
- only the relevant shards are asked for the actual document
- contentquery_and_fetch - execute the query on all
- relevant shards and return the results, including content.scan - efficiently scroll a large result setcount - special search type that returns the
- count that matched the search request without any docs searchthis so that calls can be chained.
- */
+
+
+
+ dfs_query_then_fetch - same as query_then_fetch,
+ except distributed term frequencies are calculated first.dfs_query_and_fetch - same as query_and_fetch,
+ except distributed term frequencies are calculated first.query_then_fetch - executed against all
+ shards, but only enough information is returned. When ready,
+ only the relevant shards are asked for the actual document
+ contentquery_and_fetch - execute the query on all
+ relevant shards and return the results, including content.scan - efficiently scroll a large result setcount - special search type that returns the
+ count that matched the search request without any docs searchthis so that calls can be chained.
+ */
searchType: function (t) {
if (t == null) {
return params.search_type;
}
-
+
t = t.toLowerCase();
- if (t === 'dfs_query_then_fetch' || t === 'dfs_query_and_fetch' ||
- t === 'query_then_fetch' || t === 'query_and_fetch' ||
+ if (t === 'dfs_query_then_fetch' || t === 'dfs_query_and_fetch' ||
+ t === 'query_then_fetch' || t === 'query_and_fetch' ||
t === 'scan' || t === 'count') {
-
+
params.search_type = t;
}
-
+
return this;
},
-
- /**
- By default, searches return full documents, meaning every property or field.
- This method allows you to specify which fields you want returned.
-
- Pass a single field name and it is appended to the current list of
- fields. Pass an array of fields and it replaces all existing
- fields.
- @member ejs.Request
- @param {String || Array} s The field as a string or fields as array
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ By default, searches return full documents, meaning every property or field.
+ This method allows you to specify which fields you want returned.
+
+ Pass a single field name and it is appended to the current list of
+ fields. Pass an array of fields and it replaces all existing
+ fields.
+
+ @member ejs.Request
+ @param {String || Array} s The field as a string or fields as array
+ @returns {Object} returns this so that calls can be chained.
+ */
fields: function (fieldList) {
if (fieldList == null) {
return query.fields;
}
-
+
if (query.fields == null) {
query.fields = [];
}
-
+
if (isString(fieldList)) {
query.fields.push(fieldList);
} else if (isArray(fieldList)) {
@@ -17965,58 +19711,80 @@
} else {
throw new TypeError('Argument must be string or array');
}
-
+
return this;
},
/**
- A search result set could be very large (think Google). Setting the
- from parameter allows you to page through the result set
- by making multiple request. This parameters specifies the starting
- result/document number point. Combine with size() to achieve paging.
+ Once a query executes, you can use rescore to run a secondary, more
+ expensive query to re-order the results.
- @member ejs.Request
- @param {Array} f The offset at which to start fetching results/documents from the result set.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.Request
+ @param {Rescore} r The rescore configuration.
+ @returns {Object} returns this so that calls can be chained.
+ */
+ rescore: function (r) {
+ if (r == null) {
+ return query.rescore;
+ }
+
+ if (!isRescore(r)) {
+ throw new TypeError('Argument must be a Rescore');
+ }
+
+ query.rescore = r._self();
+
+ return this;
+ },
+
+ /**
+ A search result set could be very large (think Google). Setting the
+ from parameter allows you to page through the result set
+ by making multiple request. This parameters specifies the starting
+ result/document number point. Combine with size() to achieve paging.
+
+ @member ejs.Request
+ @param {Array} f The offset at which to start fetching results/documents from the result set.
+ @returns {Object} returns this so that calls can be chained.
+ */
from: function (f) {
if (f == null) {
return query.from;
}
-
+
query.from = f;
return this;
},
/**
- Allows you to set the specified query on this search object. This is the
- query that will be used when the search is executed.
+ Allows you to set the specified query on this search object. This is the
+ query that will be used when the search is executed.
- @member ejs.Request
- @param {Query} someQuery Any valid Query object.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.Request
+ @param {Query} someQuery Any valid Query object.
+ @returns {Object} returns this so that calls can be chained.
+ */
query: function (someQuery) {
if (someQuery == null) {
return query.query;
}
-
+
if (!isQuery(someQuery)) {
throw new TypeError('Argument must be a Query');
}
-
+
query.query = someQuery._self();
return this;
},
/**
- Allows you to set the specified indices on this request object. This is the
- set of indices that will be used when the search is executed.
+ Allows you to set the specified indices on this request object. This is the
+ set of indices that will be used when the search is executed.
- @member ejs.Request
- @param {Array} indexArray An array of collection names.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.Request
+ @param {Array} indexArray An array of collection names.
+ @returns {Object} returns this so that calls can be chained.
+ */
indices: function (indexArray) {
if (indexArray == null) {
return indices;
@@ -18038,13 +19806,13 @@
},
/**
- Allows you to set the specified content-types on this request object. This is the
- set of indices that will be used when the search is executed.
+ Allows you to set the specified content-types on this request object. This is the
+ set of indices that will be used when the search is executed.
- @member ejs.Request
- @param {Array} typeArray An array of content-type names.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.Request
+ @param {Array} typeArray An array of content-type names.
+ @returns {Object} returns this so that calls can be chained.
+ */
types: function (typeArray) {
if (typeArray == null) {
return types;
@@ -18066,64 +19834,64 @@
},
/**
- Allows you to set the specified facet on this request object. Multiple facets can
- be set, all of which will be returned when the search is executed.
+ Allows you to set the specified facet on this request object. Multiple facets can
+ be set, all of which will be returned when the search is executed.
- @member ejs.Request
- @param {Facet} facet Any valid Facet object.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.Request
+ @param {Facet} facet Any valid Facet object.
+ @returns {Object} returns this so that calls can be chained.
+ */
facet: function (facet) {
if (facet == null) {
return query.facets;
}
-
+
if (query.facets == null) {
query.facets = {};
}
-
+
if (!isFacet(facet)) {
throw new TypeError('Argument must be a Facet');
}
-
+
extend(query.facets, facet._self());
return this;
},
/**
- Allows you to set a specified filter on this request object.
+ Allows you to set a specified filter on this request object.
- @member ejs.Request
- @param {Object} filter Any valid Filter object.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.Request
+ @param {Object} filter Any valid Filter object.
+ @returns {Object} returns this so that calls can be chained.
+ */
filter: function (filter) {
if (filter == null) {
return query.filter;
}
-
+
if (!isFilter(filter)) {
throw new TypeError('Argument must be a Filter');
}
-
+
query.filter = filter._self();
return this;
},
/**
- Performs highlighting based on the Highlight
- settings.
+ Performs highlighting based on the Highlight
+ settings.
- @member ejs.Request
- @param {Highlight} h A valid Highlight object
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.Request
+ @param {Highlight} h A valid Highlight object
+ @returns {Object} returns this so that calls can be chained.
+ */
highlight: function (h) {
if (h == null) {
return query.highlight;
}
-
+
if (!isHighlight(h)) {
throw new TypeError('Argument must be a Highlight object');
}
@@ -18133,27 +19901,27 @@
},
/**
- Allows you to set the specified suggester on this request object.
- Multiple suggesters can be set, all of which will be returned when
- the search is executed. Global suggestion text can be set by
- passing in a string vs. a Suggest object.
+ Allows you to set the specified suggester on this request object.
+ Multiple suggesters can be set, all of which will be returned when
+ the search is executed. Global suggestion text can be set by
+ passing in a string vs. a Suggest object.
- @since elasticsearch 0.90
-
- @member ejs.Request
- @param {String || Suggest} s A valid Suggest object or a String to
- set as the global suggest text.
- @returns {Object} returns this so that calls can be chained.
- */
+ @since elasticsearch 0.90
+
+ @member ejs.Request
+ @param {String || Suggest} s A valid Suggest object or a String to
+ set as the global suggest text.
+ @returns {Object} returns this so that calls can be chained.
+ */
suggest: function (s) {
if (s == null) {
return query.suggest;
}
-
+
if (query.suggest == null) {
query.suggest = {};
}
-
+
if (isString(s)) {
query.suggest.text = s;
} else if (isSuggest(s)) {
@@ -18164,97 +19932,117 @@
return this;
},
-
- /**
- Computes a document property dynamically based on the supplied ScriptField.
- @member ejs.Request
- @param {ScriptField} oScriptField A valid ScriptField.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Computes a document property dynamically based on the supplied ScriptField.
+
+ @member ejs.Request
+ @param {ScriptField} oScriptField A valid ScriptField.
+ @returns {Object} returns this so that calls can be chained.
+ */
scriptField: function (oScriptField) {
if (oScriptField == null) {
return query.script_fields;
}
-
+
if (query.script_fields == null) {
query.script_fields = {};
}
-
+
if (!isScriptField(oScriptField)) {
throw new TypeError('Argument must be a ScriptField');
}
-
+
extend(query.script_fields, oScriptField._self());
return this;
},
/**
-
-
+ _primary - the operation will only be executed on primary shards_local - the operation will prefer to be executed on local shards_only_node:$nodeid - the search will only be executed on node with id $nodeidcustom - any string, will guarentee searches always happen on same node.
+
- _primary - the operation will only be executed on primary shards_local - the operation will prefer to be executed on local shards_only_node:$nodeid - the search will only be executed on node with id $nodeidcustom - any string, will guarentee searches always happen on same node.search and count_primary, _local,
- _only_:$nodeid, or a custom string value.
- @returns {Object} returns this so that calls can be chained.
- */
+ search, search shards, and count_primary, _local,
+ _only_:$nodeid, or a custom string value.
+ @returns {Object} returns this so that calls can be chained.
+ */
preference: function (perf) {
if (perf == null) {
return params.preference;
}
-
+
params.preference = perf;
return this;
},
/**
-
-
+ none - No indices / aliases will be excluded from a requestmissing - Indices / aliases that are missing will be excluded from a requestsearch shardssearch, count and delete by querythis so that calls can be chained.
- */
+ @member ejs.Request
+ @param {Boolean} trueFalse True to run on local node only
+ @returns {Object} returns this so that calls can be chained.
+ */
+ local: function (trueFalse) {
+ if (trueFalse == null) {
+ return params.local;
+ }
+
+ params.local = trueFalse;
+ return this;
+ },
+
+ /**
+
+
+
+ none - No indices / aliases will be excluded from a requestmissing - Indices / aliases that are missing will be excluded from a requestsearch, search shards, count and
+ delete by querythis so that calls can be chained.
+ */
ignoreIndices: function (ignoreType) {
if (ignoreType == null) {
return params.ignore_indices;
}
-
+
ignoreType = ignoreType.toLowerCase();
if (ignoreType === 'none' || ignoreType === 'missing') {
params.ignore_indices = ignoreType;
}
-
+
return this;
},
-
- /**
- Boosts hits in the specified index by the given boost value.
- @member ejs.Request
- @param {String} index the index to boost
- @param {Double} boost the boost value
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Boosts hits in the specified index by the given boost value.
+
+ @member ejs.Request
+ @param {String} index the index to boost
+ @param {Double} boost the boost value
+ @returns {Object} returns this so that calls can be chained.
+ */
indexBoost: function (index, boost) {
if (query.indices_boost == null) {
query.indices_boost = {};
@@ -18263,165 +20051,335 @@
if (arguments.length === 0) {
return query.indices_boost;
}
-
+
query.indices_boost[index] = boost;
return this;
},
/**
- Enable/Disable explanation of score for each search result.
+ Enable/Disable explanation of score for each search result.
- @member ejs.Request
- @param {Boolean} trueFalse true to enable, false to disable
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.Request
+ @param {Boolean} trueFalse true to enable, false to disable
+ @returns {Object} returns this so that calls can be chained.
+ */
explain: function (trueFalse) {
if (trueFalse == null) {
return query.explain;
- }
-
+ }
+
query.explain = trueFalse;
return this;
},
/**
- Enable/Disable returning version number for each search result.
+ Enable/Disable returning version number for each search result.
- @member ejs.Request
- @param {Boolean} trueFalse true to enable, false to disable
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.Request
+ @param {Boolean} trueFalse true to enable, false to disable
+ @returns {Object} returns this so that calls can be chained.
+ */
version: function (trueFalse) {
if (trueFalse == null) {
return query.version;
}
-
+
query.version = trueFalse;
return this;
},
/**
- Filters out search results will scores less than the specified minimum score.
+ Filters out search results will scores less than the specified minimum score.
- @member ejs.Request
- @param {Double} min a positive double value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.Request
+ @param {Double} min a positive double value.
+ @returns {Object} returns this so that calls can be chained.
+ */
minScore: function (min) {
if (min == null) {
return query.min_score;
}
-
+
query.min_score = min;
return this;
},
/**
- Allows you to serialize this object into a JSON encoded string.
+ Allows you to serialize this object into a JSON encoded string.
- @member ejs.Request
- @returns {String} returns this object as a serialized JSON string.
- */
+ @member ejs.Request
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(query);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.Request
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.Request
+ @returns {String} the type of object
+ */
_type: function () {
return 'request';
},
-
- /**
- Retrieves the internal query object. This is typically used by
- internal API functions so use with caution.
- @member ejs.Request
- @returns {String} returns this object's internal object representation.
- */
+ /**
+ Retrieves the internal query object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.Request
+ @returns {String} returns this object's internal object representation.
+ */
_self: function () {
return query;
},
/**
- Executes a delete by query request using the current query.
-
- @member ejs.Request
- @param {Function} successcb A callback function that handles the response.
- @param {Function} errorcb A callback function that handles errors.
- @returns {Object} Returns a client specific object.
- */
+ Executes a delete by query request using the current query.
+
+ @member ejs.Request
+ @param {Function} successcb A callback function that handles the response.
+ @param {Function} errorcb A callback function that handles errors.
+ @returns {Object} Returns a client specific object.
+ */
doDeleteByQuery: function (successcb, errorcb) {
var queryData = JSON.stringify(query.query);
-
+
// make sure the user has set a client
if (ejs.client == null) {
throw new Error("No Client Set");
}
-
+
return ejs.client.del(getRestPath('_query'), queryData, successcb, errorcb);
},
/**
- Executes a count request using the current query.
-
- @member ejs.Request
- @param {Function} successcb A callback function that handles the count response.
- @param {Function} errorcb A callback function that handles errors.
- @returns {Object} Returns a client specific object.
- */
+ Executes a count request using the current query.
+
+ @member ejs.Request
+ @param {Function} successcb A callback function that handles the count response.
+ @param {Function} errorcb A callback function that handles errors.
+ @returns {Object} Returns a client specific object.
+ */
doCount: function (successcb, errorcb) {
var queryData = JSON.stringify(query.query);
-
+
// make sure the user has set a client
if (ejs.client == null) {
throw new Error("No Client Set");
}
-
+
return ejs.client.post(getRestPath('_count'), queryData, successcb, errorcb);
},
-
- /**
- Executes the search.
- @member ejs.Request
- @param {Function} successcb A callback function that handles the search response.
- @param {Function} errorcb A callback function that handles errors.
- @returns {Object} Returns a client specific object.
- */
+ /**
+ Executes the search.
+
+ @member ejs.Request
+ @param {Function} successcb A callback function that handles the search response.
+ @param {Function} errorcb A callback function that handles errors.
+ @returns {Object} Returns a client specific object.
+ */
doSearch: function (successcb, errorcb) {
var queryData = JSON.stringify(query);
-
+
// make sure the user has set a client
if (ejs.client == null) {
throw new Error("No Client Set");
}
-
+
return ejs.client.post(getRestPath('_search'), queryData, successcb, errorcb);
+ },
+
+ /**
+ Executes the search request as configured but only returns back
+ the shards and nodes that the search is going to execute on. This
+ is a cluster admin method.
+
+ @member ejs.Request
+ @param {Function} successcb A callback function that handles the response.
+ @param {Function} errorcb A callback function that handles errors.
+ @returns {Object} Returns a client specific object.
+ */
+ doSearchShards: function (successcb, errorcb) {
+ // make sure the user has set a client
+ if (ejs.client == null) {
+ throw new Error("No Client Set");
+ }
+
+ // we don't need to send in the body data, just use empty string
+ return ejs.client.post(getRestPath('_search_shards'), '', successcb, errorcb);
}
+
};
};
/**
- @class
- price and quantity. At query time, you could define a computed
- property that dynamically creates a new field called totalin each document
- based on the calculation price * quantity.this so that calls can be chained.
+ */
+ rescoreQuery: function (someQuery) {
+ if (someQuery == null) {
+ return rescore.query.rescore_query;
+ }
+
+ if (!isQuery(someQuery)) {
+ throw new TypeError('Argument must be a Query');
+ }
+
+ rescore.query.rescore_query = someQuery._self();
+ return this;
+ },
+
+ /**
+ Sets the weight assigned to the original query of the rescoring.
+
+ @member ejs.Rescore
+ @param {Number} weight a valid query weight.
+ @returns {Object} returns this so that calls can be chained.
+ */
+ queryWeight: function (weight) {
+ if (weight == null) {
+ return rescore.query.query_weight;
+ }
+
+ if (!isNumber(weight)) {
+ throw new TypeError('Argument must be a Number');
+ }
+
+ rescore.query.query_weight = weight;
+ return this;
+ },
+
+ /**
+ Sets the weight assigned to the query used to rescore the original query.
+
+ @member ejs.Rescore
+ @param {Number} weight a valid rescore query weight.
+ @returns {Object} returns this so that calls can be chained.
+ */
+ rescoreQueryWeight: function (weight) {
+ if (weight == null) {
+ return rescore.query.rescore_query_weight;
+ }
+
+ if (!isNumber(weight)) {
+ throw new TypeError('Argument must be a Number');
+ }
+
+ rescore.query.rescore_query_weight = weight;
+ return this;
+ },
+
+ /**
+ Sets the window_size parameter of the rescoring.
+
+ @member ejs.Rescore
+ @param {Number} size a valid window size.
+ @returns {Object} returns this so that calls can be chained.
+ */
+ windowSize: function (size) {
+ if (size == null) {
+ return rescore.window_size;
+ }
+
+ if (!isNumber(size)) {
+ throw new TypeError('Argument must be a Number');
+ }
+
+ rescore.window_size = size;
+ return this;
+ },
+
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.Rescore
+ @returns {String} returns this object as a serialized JSON string.
+ */
+ toString: function () {
+ return JSON.stringify(rescore);
+ },
+
+ /**
+ The type of ejs object. For internal use only.
+
+ @member ejs.Rescore
+ @returns {String} the type of object
+ */
+ _type: function () {
+ return 'rescore';
+ },
+
+ /**
+ Retrieves the internal script object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.Rescore
+ @returns {String} returns this object's internal object representation.
+ */
+ _self: function () {
+ return rescore;
+ }
+ };
+ };
+ /**
+ @class
+ price and quantity. At query time, you could define a computed
+ property that dynamically creates a new field called totalin each document
+ based on the calculation price * quantity.javascript and mvel.
+ The script language being used. Currently supported values are
+ javascript and mvel.
- @member ejs.ScriptField
- @param {String} language The language of the script.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.ScriptField
+ @param {String} language The language of the script.
+ @returns {Object} returns this so that calls can be chained.
+ */
lang: function (language) {
if (language == null) {
return script[fieldName].lang;
}
-
+
script[fieldName].lang = language;
return this;
},
/**
- Sets the script/code that will be used to perform the calculation.
+ Sets the script/code that will be used to perform the calculation.
- @member ejs.ScriptField
- @param {String} expression The script/code to use.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.ScriptField
+ @param {String} expression The script/code to use.
+ @returns {Object} returns this so that calls can be chained.
+ */
script: function (expression) {
if (expression == null) {
return script[fieldName].script;
}
-
+
script[fieldName].script = expression;
return this;
},
/**
- Allows you to set script parameters to be used during the execution of the script.
+ Allows you to set script parameters to be used during the execution of the script.
- @member ejs.ScriptField
- @param {Object} oParams An object containing key/value pairs representing param name/value.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.ScriptField
+ @param {Object} oParams An object containing key/value pairs representing param name/value.
+ @returns {Object} returns this so that calls can be chained.
+ */
params: function (oParams) {
if (oParams == null) {
return script[fieldName].params;
}
-
+
script[fieldName].params = oParams;
return this;
},
/**
- If execeptions thrown from the script should be ignored or not.
- Default: false
+ If execeptions thrown from the script should be ignored or not.
+ Default: false
- @member ejs.ScriptField
- @param {Boolean} trueFalse if execptions should be ignored
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.ScriptField
+ @param {Boolean} trueFalse if execptions should be ignored
+ @returns {Object} returns this so that calls can be chained.
+ */
ignoreFailure: function (trueFalse) {
if (trueFalse == null) {
return script[fieldName].ignore_failure;
}
-
+
script[fieldName].ignore_failure = trueFalse;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.ScriptField
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.ScriptField
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(script);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.ScriptField
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.ScriptField
+ @returns {String} the type of object
+ */
_type: function () {
return 'script field';
},
-
- /**
- Retrieves the internal script object. This is typically used by
- internal API functions so use with caution.
- @member ejs.ScriptField
- @returns {String} returns this object's internal facet property.
- */
+ /**
+ Retrieves the internal script object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.ScriptField
+ @returns {String} returns this object's internal facet property.
+ */
_self: function () {
return script;
}
@@ -18529,73 +20487,73 @@
};
/**
- @class
- this so that calls can be chained.
- */
+ @member ejs.Shape
+ @param {String} t a valid shape type.
+ @returns {Object} returns this so that calls can be chained.
+ */
type: function (t) {
if (t == null) {
return shape.type;
}
-
+
t = t.toLowerCase();
if (validType(t)) {
shape.type = t;
}
-
+
return this;
},
/**
- Sets the coordinates for the shape definition. Note, the coordinates
- are not validated in this api. Please see GeoJSON and ElasticSearch
- documentation for correct coordinate definitions.
+ Sets the coordinates for the shape definition. Note, the coordinates
+ are not validated in this api. Please see GeoJSON and ElasticSearch
+ documentation for correct coordinate definitions.
- @member ejs.Shape
- @param {Array} c a valid coordinates definition for the shape.
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.Shape
+ @param {Array} c a valid coordinates definition for the shape.
+ @returns {Object} returns this so that calls can be chained.
+ */
coordinates: function (c) {
if (c == null) {
return shape.coordinates;
@@ -18604,34 +20562,34 @@
shape.coordinates = c;
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.Shape
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.Shape
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(shape);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.Shape
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.Shape
+ @returns {String} the type of object
+ */
_type: function () {
return 'shape';
},
-
- /**
- Retrieves the internal script object. This is typically used by
- internal API functions so use with caution.
- @member ejs.Shape
- @returns {String} returns this object's internal object representation.
- */
+ /**
+ Retrieves the internal script object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.Shape
+ @returns {String} returns this object's internal object representation.
+ */
_self: function () {
return shape;
}
@@ -18639,254 +20597,254 @@
};
/**
- @class
- this so that calls can be chained.
- */
+ @member ejs.Sort
+ @param {String} f The name of a field
+ @returns {Object} returns this so that calls can be chained.
+ */
field: function (f) {
var oldValue = sort[key];
-
+
if (f == null) {
return fieldName;
}
-
- delete sort[key];
+
+ delete sort[key];
fieldName = f;
key = f;
sort[key] = oldValue;
-
+
return this;
},
/**
- Enables sorting based on a distance from a GeoPoint
+ Enables sorting based on a distance from a GeoPoint
- @member ejs.Sort
- @param {GeoPoint} point A valid GeoPoint object
- @returns {Object} returns this so that calls can be chained.
- */
+ @member ejs.Sort
+ @param {GeoPoint} point A valid GeoPoint object
+ @returns {Object} returns this so that calls can be chained.
+ */
geoDistance: function (point) {
var oldValue = sort[key];
-
+
if (point == null) {
return sort[key][fieldName];
}
-
+
if (!isGeoPoint(point)) {
throw new TypeError('Argument must be a GeoPoint');
}
-
+
delete sort[key];
key = geo_key;
sort[key] = oldValue;
sort[key][fieldName] = point._self();
-
+
return this;
},
-
- /**
- Enables sorting based on a script.
- @member ejs.Sort
- @param {String} scriptCode The script code as a string
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Enables sorting based on a script.
+
+ @member ejs.Sort
+ @param {String} scriptCode The script code as a string
+ @returns {Object} returns this so that calls can be chained.
+ */
script: function (scriptCode) {
var oldValue = sort[key];
-
+
if (scriptCode == null) {
return sort[key].script;
}
-
+
delete sort[key];
key = script_key;
sort[key] = oldValue;
sort[key].script = scriptCode;
-
+
return this;
},
-
- /**
- Sets the sort order. Valid values are:
-
- asc - for ascending order
- desc - for descending order
- Valid during sort types: field, geo distance, and script
-
- @member ejs.Sort
- @param {String} o The sort order as a string, asc or desc.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the sort order. Valid values are:
+
+ asc - for ascending order
+ desc - for descending order
+
+ Valid during sort types: field, geo distance, and script
+
+ @member ejs.Sort
+ @param {String} o The sort order as a string, asc or desc.
+ @returns {Object} returns this so that calls can be chained.
+ */
order: function (o) {
if (o == null) {
return sort[key].order;
}
-
+
o = o.toLowerCase();
if (o === 'asc' || o === 'desc') {
- sort[key].order = o;
+ sort[key].order = o;
}
-
+
return this;
},
-
+
/**
- Sets the sort order to ascending (asc). Same as calling
- order('asc').
-
- @member ejs.Sort
- @returns {Object} returns this so that calls can be chained.
- */
+ Sets the sort order to ascending (asc). Same as calling
+ order('asc').
+
+ @member ejs.Sort
+ @returns {Object} returns this so that calls can be chained.
+ */
asc: function () {
sort[key].order = 'asc';
return this;
},
-
+
/**
- Sets the sort order to descending (desc). Same as calling
- order('desc').
-
- @member ejs.Sort
- @returns {Object} returns this so that calls can be chained.
- */
+ Sets the sort order to descending (desc). Same as calling
+ order('desc').
+
+ @member ejs.Sort
+ @returns {Object} returns this so that calls can be chained.
+ */
desc: function () {
sort[key].order = 'desc';
return this;
},
-
- /**
- Sets the order with a boolean value.
-
- true = descending sort order
- false = ascending sort order
- Valid during sort types: field, geo distance, and script
-
- @member ejs.Sort
- @param {Boolean} trueFalse If sort should be in reverse order.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the order with a boolean value.
+
+ true = descending sort order
+ false = ascending sort order
+
+ Valid during sort types: field, geo distance, and script
+
+ @member ejs.Sort
+ @param {Boolean} trueFalse If sort should be in reverse order.
+ @returns {Object} returns this so that calls can be chained.
+ */
reverse: function (trueFalse) {
if (trueFalse == null) {
return sort[key].reverse;
}
-
- sort[key].reverse = trueFalse;
+
+ sort[key].reverse = trueFalse;
return this;
},
-
- /**
- Sets the value to use for missing fields. Valid values are:
-
- _last - to put documents with the field missing last
- _first - to put documents with the field missing first
- {String} - any string value to use as the sort value.
- Valid during sort types: field
-
- @member ejs.Sort
- @param {String} m The value to use for documents with the field missing.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the value to use for missing fields. Valid values are:
+
+ _last - to put documents with the field missing last
+ _first - to put documents with the field missing first
+ {String} - any string value to use as the sort value.
+
+ Valid during sort types: field
+
+ @member ejs.Sort
+ @param {String} m The value to use for documents with the field missing.
+ @returns {Object} returns this so that calls can be chained.
+ */
missing: function (m) {
if (m == null) {
return sort[key].missing;
}
-
- sort[key].missing = m;
+
+ sort[key].missing = m;
return this;
},
-
- /**
- Sets if the sort should ignore unmapped fields vs throwing an error.
- Valid during sort types: field
-
- @member ejs.Sort
- @param {Boolean} trueFalse If sort should ignore unmapped fields.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets if the sort should ignore unmapped fields vs throwing an error.
+
+ Valid during sort types: field
+
+ @member ejs.Sort
+ @param {Boolean} trueFalse If sort should ignore unmapped fields.
+ @returns {Object} returns this so that calls can be chained.
+ */
ignoreUnmapped: function (trueFalse) {
if (trueFalse == null) {
return sort[key].ignore_unmapped;
}
-
- sort[key].ignore_unmapped = trueFalse;
+
+ sort[key].ignore_unmapped = trueFalse;
return this;
},
-
- /**
- Sets the distance unit. Valid values are "mi" for miles or "km"
- for kilometers. Defaults to "km".
- Valid during sort types: geo distance
-
- @member ejs.Sort
- @param {Number} unit the unit of distance measure.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the distance unit. Valid values are "mi" for miles or "km"
+ for kilometers. Defaults to "km".
+
+ Valid during sort types: geo distance
+
+ @member ejs.Sort
+ @param {Number} unit the unit of distance measure.
+ @returns {Object} returns this so that calls can be chained.
+ */
unit: function (unit) {
if (unit == null) {
return sort[key].unit;
}
-
+
unit = unit.toLowerCase();
if (unit === 'mi' || unit === 'km') {
sort[key].unit = unit;
}
-
+
return this;
},
-
- /**
- If the lat/long points should be normalized to lie within their
- respective normalized ranges.
-
- Normalized ranges are:
- lon = -180 (exclusive) to 180 (inclusive) range
- lat = -90 to 90 (both inclusive) range
- Valid during sort types: geo distance
-
- @member ejs.Sort
- @param {String} trueFalse True if the coordinates should be normalized. False otherwise.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ If the lat/long points should be normalized to lie within their
+ respective normalized ranges.
+
+ Normalized ranges are:
+ lon = -180 (exclusive) to 180 (inclusive) range
+ lat = -90 to 90 (both inclusive) range
+
+ Valid during sort types: geo distance
+
+ @member ejs.Sort
+ @param {String} trueFalse True if the coordinates should be normalized. False otherwise.
+ @returns {Object} returns this so that calls can be chained.
+ */
normalize: function (trueFalse) {
if (trueFalse == null) {
return sort[key].normalize;
@@ -18895,17 +20853,17 @@
sort[key].normalize = trueFalse;
return this;
},
-
- /**
- How to compute the distance. Can either be arc (better precision)
- or plane (faster). Defaults to arc.
- Valid during sort types: geo distance
-
- @member ejs.Sort
- @param {String} type The execution type as a string.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ How to compute the distance. Can either be arc (better precision)
+ or plane (faster). Defaults to arc.
+
+ Valid during sort types: geo distance
+
+ @member ejs.Sort
+ @param {String} type The execution type as a string.
+ @returns {Object} returns this so that calls can be chained.
+ */
distanceType: function (type) {
if (type == null) {
return sort[key].distance_type;
@@ -18915,39 +20873,39 @@
if (type === 'arc' || type === 'plane') {
sort[key].distance_type = type;
}
-
+
return this;
},
-
- /**
- Sets parameters that will be applied to the script. Overwrites
- any existing params.
- Valid during sort types: script
-
- @member ejs.Sort
- @param {Object} p An object where the keys are the parameter name and
- values are the parameter value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets parameters that will be applied to the script. Overwrites
+ any existing params.
+
+ Valid during sort types: script
+
+ @member ejs.Sort
+ @param {Object} p An object where the keys are the parameter name and
+ values are the parameter value.
+ @returns {Object} returns this so that calls can be chained.
+ */
params: function (p) {
if (p == null) {
return sort[key].params;
}
-
+
sort[key].params = p;
return this;
},
-
- /**
- Sets the script language.
- Valid during sort types: script
-
- @member ejs.Sort
- @param {String} lang The script language, default mvel.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the script language.
+
+ Valid during sort types: script
+
+ @member ejs.Sort
+ @param {String} lang The script language, default mvel.
+ @returns {Object} returns this so that calls can be chained.
+ */
lang: function (lang) {
if (lang == null) {
return sort[key].lang;
@@ -18956,21 +20914,21 @@
sort[key].lang = lang;
return this;
},
-
- /**
- Sets the script sort type. Valid values are:
-
-
-
string - script return value is sorted as a stringnumber - script return value is sorted as a number
- Valid during sort types: script
-
- @member ejs.Sort
- @param {String} type The sort type. Either string or number.
- @returns {Object} returns
this so that calls can be chained.
- */
+ /**
+ Sets the script sort type. Valid values are:
+
+
+
string - script return value is sorted as a stringnumber - script return value is sorted as a number
+
+ Valid during sort types: script
+
+ @member ejs.Sort
+ @param {String} type The sort type. Either string or number.
+ @returns {Object} returns
this so that calls can be chained.
+ */
type: function (type) {
if (type == null) {
return sort[key].type;
@@ -18980,27 +20938,27 @@
if (type === 'string' || type === 'number') {
sort[key].type = type;
}
-
+
return this;
},
/**
- Sets the sort mode. Valid values are:
-
-
-
min - sort by lowest valuemax - sort by highest valuesum - sort by the sum of all valuesavg - sort by the average of all values
-
- Valid during sort types: field
-
- @since elasticsearch 0.90
- @member ejs.Sort
- @param {String} m The sort mode. Either min, max, sum, or avg.
- @returns {Object} returns
this so that calls can be chained.
- */
+ Sets the sort mode. Valid values are:
+
+
+
min - sort by lowest valuemax - sort by highest valuesum - sort by the sum of all valuesavg - sort by the average of all values
+
+ Valid during sort types: field, geo distance
+
+ @since elasticsearch 0.90
+ @member ejs.Sort
+ @param {String} m The sort mode. Either min, max, sum, or avg.
+ @returns {Object} returns
this so that calls can be chained.
+ */
mode: function (m) {
if (m == null) {
return sort[key].mode;
@@ -19010,20 +20968,20 @@
if (m === 'min' || m === 'max' || m === 'sum' || m === 'avg') {
sort[key].mode = m;
}
-
+
return this;
},
-
- /**
- Sets the path of the nested object.
- Valid during sort types: field
-
- @since elasticsearch 0.90
- @member ejs.Sort
- @param {String} path The nested path value.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Sets the path of the nested object.
+
+ Valid during sort types: field, geo distance
+
+ @since elasticsearch 0.90
+ @member ejs.Sort
+ @param {String} path The nested path value.
+ @returns {Object} returns this so that calls can be chained.
+ */
nestedPath: function (path) {
if (path == null) {
return sort[key].nested_path;
@@ -19032,56 +20990,58 @@
sort[key].nested_path = path;
return this;
},
-
- /**
- Filter object.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Filter object.
+ @returns {Object} returns this so that calls can be chained.
+ */
nestedFilter: function (oFilter) {
if (oFilter == null) {
return sort[key].nested_filter;
}
-
+
if (!isFilter(oFilter)) {
throw new TypeError('Argument must be a Filter');
}
-
+
sort[key].nested_filter = oFilter._self();
return this;
},
-
- /**
- Allows you to serialize this object into a JSON encoded string.
- @member ejs.Sort
- @returns {String} returns this object as a serialized JSON string.
- */
+ /**
+ Allows you to serialize this object into a JSON encoded string.
+
+ @member ejs.Sort
+ @returns {String} returns this object as a serialized JSON string.
+ */
toString: function () {
return JSON.stringify(sort);
},
/**
- The type of ejs object. For internal use only.
-
- @member ejs.Sort
- @returns {String} the type of object
- */
+ The type of ejs object. For internal use only.
+
+ @member ejs.Sort
+ @returns {String} the type of object
+ */
_type: function () {
return 'sort';
},
-
- /**
- Retrieves the internal script object. This is typically used by
- internal API functions so use with caution.
- @member ejs.Sort
- @returns {String} returns this object's internal object representation.
- */
+ /**
+ Retrieves the internal script object. This is typically used by
+ internal API functions so use with caution.
+
+ @member ejs.Sort
+ @returns {String} returns this object's internal object representation.
+ */
_self: function () {
return sort;
}
@@ -19089,140 +21049,140 @@
};
/**
- @class
- PhraseSuggester.
- It generates terms based on edit distance and operators much like the
- TermSuggester.PhraseSuggester.
+ It generates terms based on edit distance and operators much like the
+ TermSuggester.this so that calls can be chained.
- */
+ @member ejs.DirectGenerator
+ @param {String} analyzer A valid analyzer name.
+ @returns {Object} returns this so that calls can be chained.
+ */
preFilter: function (analyzer) {
if (analyzer == null) {
return generator.pre_filter;
}
-
+
generator.pre_filter = analyzer;
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
postFilter: function (analyzer) {
if (analyzer == null) {
return generator.post_filter;
}
-
+
generator.post_filter = analyzer;
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
field: function (field) {
if (field == null) {
return generator.field;
}
-
+
generator.field = field;
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
size: function (s) {
if (s == null) {
return generator.size;
}
-
+
generator.size = s;
return this;
},
-
- /**
- generator object. This is typically used by
- internal API functions so use with caution.generator property.
- */
+ /**
+ generator object. This is typically used by
+ internal API functions so use with caution.generator property.
+ */
_self: function () {
return generator;
}
@@ -19230,231 +21190,231 @@
};
/**
- @mixin
- Suggester implementations. This object should not be
- used directly.Suggester implementations. This object should not be
+ used directly.this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
accuracy: function (a) {
if (a == null) {
return settings.accuracy;
}
-
+
settings.accuracy = a;
return this;
},
-
+
/**
-
-
+ missing - Only suggest terms in the suggest text that aren't in the indexpopular - Only suggest suggestions that occur in more docs then the original suggest text termalways - Suggest any matching suggestions based on terms in the suggest text
+
- @member ejs.DirectSettingsMixin
- @param {String} m The mode of missing, popular, or always.
- @returns {Object} returns missing - Only suggest terms in the suggest text that aren't in the indexpopular - Only suggest suggestions that occur in more docs then the original suggest text termalways - Suggest any matching suggestions based on terms in the suggest textthis so that calls can be chained.
- */
+ @member ejs.DirectSettingsMixin
+ @param {String} m The mode of missing, popular, or always.
+ @returns {Object} returns this so that calls can be chained.
+ */
suggestMode: function (m) {
if (m == null) {
return settings.suggest_mode;
}
-
+
m = m.toLowerCase();
if (m === 'missing' || m === 'popular' || m === 'always') {
settings.suggest_mode = m;
}
-
+
return this;
},
-
+
/**
-
-
+ score - Sort by score first, then document frequency, and then the term itselffrequency - Sort by document frequency first, then simlarity score and then the term itself
+
- @member ejs.DirectSettingsMixin
- @param {String} s The score type of score or frequency.
- @returns {Object} returns score - Sort by score first, then document frequency, and then the term itselffrequency - Sort by document frequency first, then simlarity score and then the term itselfthis so that calls can be chained.
- */
+ @member ejs.DirectSettingsMixin
+ @param {String} s The score type of score or frequency.
+ @returns {Object} returns this so that calls can be chained.
+ */
sort: function (s) {
if (s == null) {
return settings.sort;
}
-
+
s = s.toLowerCase();
if (s === 'score' || s === 'frequency') {
settings.sort = s;
}
-
+
return this;
},
-
+
/**
-
-
+ internal - based on damerau_levenshtein but but highly optimized for comparing string distance for terms inside the indexdamerau_levenshtein - String distance algorithm based on Damerau-Levenshtein algorithmlevenstein - String distance algorithm based on Levenstein edit distance algorithmjarowinkler - String distance algorithm based on Jaro-Winkler algorithmngram - String distance algorithm based on character n-grams
+
- @member ejs.DirectSettingsMixin
- @param {String} s The string distance algorithm name.
- @returns {Object} returns internal - based on damerau_levenshtein but but highly optimized for comparing string distance for terms inside the indexdamerau_levenshtein - String distance algorithm based on Damerau-Levenshtein algorithmlevenstein - String distance algorithm based on Levenstein edit distance algorithmjarowinkler - String distance algorithm based on Jaro-Winkler algorithmngram - String distance algorithm based on character n-gramsthis so that calls can be chained.
- */
+ @member ejs.DirectSettingsMixin
+ @param {String} s The string distance algorithm name.
+ @returns {Object} returns this so that calls can be chained.
+ */
stringDistance: function (s) {
if (s == null) {
return settings.string_distance;
}
-
+
s = s.toLowerCase();
- if (s === 'internal' || s === 'damerau_levenshtein' ||
- s === 'levenstein' || s === 'jarowinkler' || s === 'ngram') {
+ if (s === 'internal' || s === 'damerau_levenshtein' ||
+ s === 'levenstein' || s === 'jarowinkler' || s === 'ngram') {
settings.string_distance = s;
}
-
+
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
maxEdits: function (max) {
if (max == null) {
return settings.max_edits;
}
-
+
settings.max_edits = max;
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
maxInspections: function (max) {
if (max == null) {
return settings.max_inspections;
}
-
+
settings.max_inspections = max;
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
maxTermFreq: function (max) {
if (max == null) {
return settings.max_term_freq;
}
-
+
settings.max_term_freq = max;
return this;
},
-
- /**
- this so that calls can be chained.
- */
- prefixLength: function (len) {
+ /**
+ this so that calls can be chained.
+ */
+ prefixLen: function (len) {
if (len == null) {
- return settings.prefix_length;
+ return settings.prefix_len;
}
-
- settings.prefix_length = len;
+
+ settings.prefix_len = len;
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
minWordLen: function (len) {
if (len == null) {
return settings.min_word_len;
}
-
+
settings.min_word_len = len;
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
minDocFreq: function (min) {
if (min == null) {
return settings.min_doc_freq;
}
-
+
settings.min_doc_freq = min;
return this;
},
-
- /**
- settings object. This is typically used by
- internal API functions so use with caution.settings property.
- */
+ /**
+ settings object. This is typically used by
+ internal API functions so use with caution.settings property.
+ */
_self: function () {
return settings;
}
@@ -19462,238 +21422,238 @@
};
/**
- @class
- PhraseSuggester and suggests
- entire corrected phrases instead of individual tokens. The individual
- phrase suggestions are weighted based on ngram-langugage models. In practice
- it will be able to make better decision about which tokens to pick based on
- co-occurence and frequencies.PhraseSuggester and suggests
+ entire corrected phrases instead of individual tokens. The individual
+ phrase suggestions are weighted based on ngram-langugage models. In practice
+ it will be able to make better decision about which tokens to pick based on
+ co-occurence and frequencies.this so that calls can be chained.
- */
+ @member ejs.PhraseSuggester
+ @param {String} txt A string to get suggestions for.
+ @returns {Object} returns this so that calls can be chained.
+ */
text: function (txt) {
if (txt == null) {
return suggest[name].text;
}
-
+
suggest[name].text = txt;
return this;
},
/**
- this so that calls can be chained.
- */
+ @member ejs.PhraseSuggester
+ @param {String} analyzer A valid analyzer name.
+ @returns {Object} returns this so that calls can be chained.
+ */
analyzer: function (analyzer) {
if (analyzer == null) {
return suggest[name].phrase.analyzer;
}
-
+
suggest[name].phrase.analyzer = analyzer;
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
field: function (field) {
if (field == null) {
return suggest[name].phrase.field;
}
-
+
suggest[name].phrase.field = field;
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
size: function (s) {
if (s == null) {
return suggest[name].phrase.size;
}
-
+
suggest[name].phrase.size = s;
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
shardSize: function (s) {
if (s == null) {
return suggest[name].phrase.shard_size;
}
-
+
suggest[name].phrase.shard_size = s;
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
realWorldErrorLikelihood: function (l) {
if (l == null) {
return suggest[name].phrase.real_world_error_likelihood;
}
-
+
suggest[name].phrase.real_world_error_likelihood = l;
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
confidence: function (c) {
if (c == null) {
return suggest[name].phrase.confidence;
}
-
+
suggest[name].phrase.confidence = c;
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
separator: function (sep) {
if (sep == null) {
return suggest[name].phrase.separator;
}
-
+
suggest[name].phrase.separator = sep;
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
maxErrors: function (max) {
if (max == null) {
return suggest[name].phrase.max_errors;
}
-
+
suggest[name].phrase.max_errors = max;
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
gramSize: function (s) {
if (s == null) {
return suggest[name].phrase.gram_size;
}
-
+
suggest[name].phrase.gram_size = s;
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
forceUnigrams: function (trueFalse) {
if (trueFalse == null) {
return suggest[name].phrase.force_unigrams;
}
-
+
suggest[name].phrase.force_unigrams = trueFalse;
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
linearSmoothing: function (tl, bl, ul) {
if (arguments.length === 0) {
return suggest[name].phrase.smoothing;
}
-
+
suggest[name].phrase.smoothing = {
linear: {
trigram_lambda: tl,
@@ -19701,67 +21661,67 @@
unigram_lambda: ul
}
};
-
+
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
laplaceSmoothing: function (alpha) {
if (alpha == null) {
return suggest[name].phrase.smoothing;
}
-
+
suggest[name].phrase.smoothing = {
laplace: {
alpha: alpha
}
};
-
+
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
stupidBackoffSmoothing: function (discount) {
if (discount == null) {
return suggest[name].phrase.smoothing;
}
-
+
suggest[name].phrase.smoothing = {
stupid_backoff: {
discount: discount
}
};
-
+
return this;
},
-
- /**
- Adds a direct generator. If passed a single Generator
- it is added to the list of existing generators. If passed an
- array of Generators, they replace all existing generators.
- @member ejs.PhraseSuggester
- @param {Generator || Array} oGenerator A valid Generator or
- array of Generator objects.
- @returns {Object} returns this so that calls can be chained.
- */
+ /**
+ Adds a direct generator. If passed a single Generator
+ it is added to the list of existing generators. If passed an
+ array of Generators, they replace all existing generators.
+
+ @member ejs.PhraseSuggester
+ @param {Generator || Array} oGenerator A valid Generator or
+ array of Generator objects.
+ @returns {Object} returns this so that calls can be chained.
+ */
directGenerator: function (oGenerator) {
var i, len;
@@ -19790,34 +21750,34 @@
return this;
},
-
- /**
- suggest object. This is typically used by
- internal API functions so use with caution.suggest property.
- */
+ /**
+ suggest object. This is typically used by
+ internal API functions so use with caution.suggest property.
+ */
_self: function () {
return suggest;
}
@@ -19825,159 +21785,159 @@
};
/**
- @class
- PhraseSuggester.PhraseSuggester.this so that calls can be chained.
- */
+ @member ejs.TermSuggester
+ @param {String} txt A string to get suggestions for.
+ @returns {Object} returns this so that calls can be chained.
+ */
text: function (txt) {
if (txt == null) {
return suggest[name].text;
}
-
+
suggest[name].text = txt;
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
analyzer: function (analyzer) {
if (analyzer == null) {
return suggest[name].term.analyzer;
}
-
+
suggest[name].term.analyzer = analyzer;
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
field: function (field) {
if (field == null) {
return suggest[name].term.field;
}
-
+
suggest[name].term.field = field;
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
size: function (s) {
if (s == null) {
return suggest[name].term.size;
}
-
+
suggest[name].term.size = s;
return this;
},
-
- /**
- this so that calls can be chained.
- */
+ /**
+ this so that calls can be chained.
+ */
shardSize: function (s) {
if (s == null) {
return suggest[name].term.shard_size;
}
-
+
suggest[name].term.shard_size = s;
return this;
},
-
- /**
- suggest object. This is typically used by
- internal API functions so use with caution.suggest property.
- */
+ /**
+ suggest object. This is typically used by
+ internal API functions so use with caution.suggest property.
+ */
_self: function () {
return suggest;
}
@@ -19989,5 +21949,5 @@
root.ejs = _ejs;
return this;
};
-
+
}).call(this);