src/main/java/org/onap/aai/sa/searchdbabstraction/searchapi/AbstractAggregation.java

   1 /**
   2  * ============LICENSE_START=======================================================
   3  * org.onap.aai
   4  * ================================================================================
   5  * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
   6  * Copyright © 2017-2018 Amdocs
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *       http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  */
  21 package org.onap.aai.sa.searchdbabstraction.searchapi;
  22
  23 import com.fasterxml.jackson.annotation.JsonProperty;
  24
  25
  26 /**
  27  * This is the common parent from which all aggregation types inherit.  It defines
  28  * the common fields that all aggregations must include.
  29  */
  30 public abstract class AbstractAggregation {
  31
  32   /**
  33    * The name of the field to apply the aggregation against.
  34    */
  35   protected String field;
  36
  37   /**
  38    * Optionally allows the number of buckets for the aggregation to be
  39    * specified.
  40    */
  41   protected Integer size;
  42
  43   /**
  44    * Optionally sets the minimum number of matches that must occur before
  45    * a particular bucket is included in the aggregation result.
  46    */
  47   @JsonProperty("min-threshold")
  48   protected Integer minThreshold;
  49
  50
  51   public String getField() {
  52     return field;
  53   }
  54
  55   public void setField(String field) {
  56     this.field = field;
  57   }
  58
  59   public Integer getSize() {
  60     return size;
  61   }
  62
  63   public void setSize(Integer size) {
  64     this.size = size;
  65   }
  66
  67   public Integer getMinThreshold() {
  68     return minThreshold;
  69   }
  70
  71   public void setMinThreshold(Integer minThreshold) {
  72     this.minThreshold = minThreshold;
  73   }
  74
  75   public abstract String toElasticSearch();
  76
  77   public abstract String toString();
  78 }