sparkybe-onap-service/src/main/java/org/onap/aai/sparky/search/SearchResponse.java

   1 /**
   2  * ============LICENSE_START===================================================
   3  * SPARKY (AAI UI service)
   4  * ============================================================================
   5  * Copyright © 2017 AT&T Intellectual Property.
   6  * Copyright © 2017 Amdocs
   7  * All rights reserved.
   8  * ============================================================================
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  * ============LICENSE_END=====================================================
  21  *
  22  * ECOMP and OpenECOMP are trademarks
  23  * and service marks of AT&T Intellectual Property.
  24  */
  25 package org.onap.aai.sparky.search;
  26
  27 import java.util.ArrayList;
  28 import java.util.List;
  29
  30 import org.onap.aai.sparky.search.entity.SearchSuggestion;
  31
  32 /**
  33  * The Class SearchResponse.
  34  */
  35 public class SearchResponse {
  36
  37   private long processingTimeInMs;
  38   private int totalFound;
  39
  40   private List<SearchSuggestion> suggestions;
  41
  42   /**
  43    * Instantiates a new search response.
  44    */
  45   public SearchResponse() {
  46     this.suggestions = new ArrayList<SearchSuggestion>();
  47     this.processingTimeInMs = 0;
  48     this.totalFound = 0;
  49   }
  50
  51   public long getProcessingTimeInMs() {
  52     return processingTimeInMs;
  53   }
  54
  55   public void setProcessingTimeInMs(long processingTimeInMs) {
  56     this.processingTimeInMs = processingTimeInMs;
  57   }
  58
  59   public int getTotalFound() {
  60     return totalFound;
  61   }
  62
  63   public void setTotalFound(int totalFound) {
  64     this.totalFound = totalFound;
  65   }
  66
  67   public List<SearchSuggestion> getSuggestions() {
  68     return suggestions;
  69   }
  70
  71   public void setSuggestions(List<SearchSuggestion> suggestions) {
  72     this.suggestions = suggestions;
  73   }
  74
  75   /**
  76    * Adds the entity entry.
  77    *
  78    * @param suggestionEntry that will be converted to JSON
  79    */
  80   public void addSuggestion(SearchSuggestion suggestionEntity){
  81     suggestions.add(suggestionEntity);
  82   }
  83
  84   /**
  85    * Increments the total number of hits for this SearchResponse by
  86    *  the value passed in.
  87    *
  88    * @param additionalCount - Count to increment the total found
  89    */
  90   public void addToTotalFound(int additionalCount) {
  91     totalFound += additionalCount;
  92   }
  93
  94   @Override
  95   public String toString() {
  96     return "SearchResponse [processingTimeInMs=" + processingTimeInMs + ", totalFound=" + totalFound
  97         + ", " + (suggestions != null ? "suggestions=" + suggestions : "") + "]";
  98   }
  99
 100
 101
 102 }