elastic.js-update/src/aggregations/NestedAggregation.js

Javascript API for ElasticSearch DSL

  /**
    @class
    <p>A special single bucket aggregation that enables aggregating nested
    documents.</p>

    @name ejs.NestedAggregation
    @ejs aggregation
    @borrows ejs.AggregationMixin.aggregation as aggregation
    @borrows ejs.AggregationMixin.agg as agg
    @borrows ejs.AggregationMixin._type as _type
    @borrows ejs.AggregationMixin.toJSON as toJSON

    @desc
    <p>A special single bucket aggregation that enables aggregating nested
    documents.</p>

    @param {String} name The name which be used to refer to this aggregation.

    */
  ejs.NestedAggregation = function (name) {

    var
      _common = ejs.AggregationMixin(name),
      agg = _common.toJSON();

    agg[name].nested = {};

    return extend(_common, {

      /**
      <p>Sets the nested path.</p>

      @member ejs.NestedAggregation
      @param {String} path The nested path value.
      @returns {Object} returns <code>this</code> so that calls can be chained.
      */
      path: function (path) {
        if (path == null) {
          return agg[name].nested.path;
        }

        agg[name].nested.path = path;
        return this;
      }

    });
  };