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

   1 /**
   2  * ============LICENSE_START=======================================================
   3  * org.onap.aai
   4  * ================================================================================
   5  * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
   6  * Copyright © 2017 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  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  22  */
  23 package org.onap.aai.sa.searchdbabstraction.searchapi;
  24
  25 import com.fasterxml.jackson.annotation.JsonProperty;
  26
  27
  28 /**
  29  * This is the common parent from which all aggregation types inherit.  It defines
  30  * the common fields that all aggregations must include.
  31  */
  32 public abstract class AbstractAggregation {
  33
  34   /**
  35    * The name of the field to apply the aggregation against.
  36    */
  37   protected String field;
  38
  39   /**
  40    * Optionally allows the number of buckets for the aggregation to be
  41    * specified.
  42    */
  43   protected Integer size;
  44
  45   /**
  46    * Optionally sets the minimum number of matches that must occur before
  47    * a particular bucket is included in the aggregation result.
  48    */
  49   @JsonProperty("min-threshold")
  50   protected Integer minThreshold;
  51
  52
  53   public String getField() {
  54     return field;
  55   }
  56
  57   public void setField(String field) {
  58     this.field = field;
  59   }
  60
  61   public Integer getSize() {
  62     return size;
  63   }
  64
  65   public void setSize(Integer size) {
  66     this.size = size;
  67   }
  68
  69   public Integer getMinThreshold() {
  70     return minThreshold;
  71   }
  72
  73   public void setMinThreshold(Integer minThreshold) {
  74     this.minThreshold = minThreshold;
  75   }
  76
  77   public abstract String toElasticSearch();
  78
  79   public abstract String toString();
  80 }