src/main/java/org/onap/aai/sparky/search/filters/entity/SearchFilter.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.sparky.search.filters.entity;
  24
  25 import java.util.ArrayList;
  26 import java.util.Arrays;
  27 import java.util.List;
  28
  29 /**
  30  * A base entity to contain the details of the filter id and values from the FE to the BE for the
  31  * purpose of driving DAL calls into ElasticSearch, Search Abstraction Service, or as a utility
  32  * object within the query builders.
  33  *
  34  * The class has unique identifier for the filter id, and then 1 or more filter values. The value
  35  * list has been introduced to help us with a multi-select use case that will need to be supported
  36  * eventually.
  37  */
  38 public class SearchFilter {
  39
  40   private String filterId;
  41   private List<String> values;
  42
  43   public SearchFilter() {
  44     values = new ArrayList<String>();
  45   }
  46
  47   public SearchFilter(String filterId) {
  48     this();
  49     this.filterId = filterId;
  50   }
  51
  52   public SearchFilter(String filterId, String... values) {
  53     this();
  54     this.filterId = filterId;
  55     this.values.addAll(Arrays.asList(values));
  56   }
  57
  58   public String getFilterId() {
  59     return filterId;
  60   }
  61
  62   public void setFilterId(String filterId) {
  63     this.filterId = filterId;
  64   }
  65
  66   public List<String> getValues() {
  67     return values;
  68   }
  69
  70   public void setValues(List<String> values) {
  71     this.values = values;
  72   }
  73
  74   public void addValue(String v) {
  75     if (!values.contains(v)) {
  76       values.add(v);
  77     }
  78
  79   }
  80
  81   @Override
  82   public String toString() {
  83     return "SearchFilter [filterId=" + filterId + ", values=" + values + "]";
  84   }
  85
  86 }