src/main/java/org/onap/aai/sparky/search/filters/entity/UiFilterEntity.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176

/**
 * ============LICENSE_START=======================================================
 * org.onap.aai
 * ================================================================================
 * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
 * Copyright © 2017-2018 Amdocs
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ============LICENSE_END=========================================================
 */
package org.onap.aai.sparky.search.filters.entity;

import java.util.ArrayList;
import java.util.List;

import org.onap.aai.sparky.search.filters.config.UiFilterConfig;
import org.onap.aai.sparky.search.filters.config.UiFilterOptionsValuesConfig;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;

/**
 * Stores data for a single filter for a given UI view.
 * <p>
 * When a UI view wants to know which filters it should display, an object of this class is created for each
 * filter discovered and stores data for that filter. Each filter/object of this class is added to a
 * ViewFilterList object which is then serialized to JSON and returned to the view in the response body. 
 */
@JsonInclude(Include.NON_NULL)
public class UiFilterEntity {
  private String filterId;
  private String filterName;
  private String displayName;
  private String dataType;
  
  private String multiSelect;
  private String watermark;
  private UiFilterOptionsValuesConfig defaultValue;
  private String optionsType;
  
  private List<UiFilterOptionsValuesConfig> optionsValues;
  
  private List<UiFilterValueEntity> filterValueList;

  public UiFilterEntity() {}
  
  public UiFilterEntity(UiFilterConfig filterConfig) {
    if (filterConfig.getFilterId() != null) {
      this.setFilterId(filterConfig.getFilterId());
    }
    if (filterConfig.getFilterName() != null) {
      this.setFilterName(filterConfig.getFilterName());
    }
    if (filterConfig.getDisplayName() != null) {
      this.setDisplayName(filterConfig.getDisplayName());
    }
    if (filterConfig.getDataType() != null) {
      this.setDataType(filterConfig.getDataType());
    }
    if (filterConfig.getMultiSelect() != null) {
      this.setMultiSelect(filterConfig.getMultiSelect());
    }
    if (filterConfig.getWatermark() != null) {
      this.setWatermark(filterConfig.getWatermark());
    }
    if (filterConfig.getDefaultValue() != null) {
      this.setDefaultValue(filterConfig.getDefaultValue());
    }
    if (filterConfig.getOptionsType() != null) {
      this.setOptionsType(filterConfig.getOptionsType());
    }
    if(filterConfig.getOptionsValues() != null && !filterConfig.getOptionsValues().isEmpty()) {
      this.setOptionsValues(filterConfig.getOptionsValues());
    } else {
      this.optionsValues = new ArrayList<UiFilterOptionsValuesConfig>();
    }
  }
  
  public void addFilterValue(UiFilterValueEntity valueEntity) {
    if (null == filterValueList) {
      filterValueList = new ArrayList<>();
    }

    this.filterValueList.add(valueEntity);
  }

  public String getFilterId() {
    return filterId;
  }

  public String getFilterName() {
    return filterName;
  }
  
  public String getDisplayName() {
    return displayName;
  }

  public String getDataType() {
    return dataType;
  }
  
  public UiFilterOptionsValuesConfig getDefaultValue() {
    return defaultValue;
  }
  
  public List<UiFilterValueEntity> getFilterValueList() {
    return filterValueList;
  }

  public void setFilterId(String filterId) {
    this.filterId = filterId;
  }

  public void setFilterName(String filterName) {
    this.filterName = filterName;
  }
  
  public void setDisplayName(String displayName) {
    this.displayName = displayName;
  }

  public void setDataType(String dataType) {
    this.dataType = dataType;
  }
  
  public String getMultiSelect() {
    return multiSelect;
  }

  public void setMultiSelect(String multiSelect) {
    this.multiSelect = multiSelect;
  }

  public String getWatermark() {
    return watermark;
  }

  public void setWatermark(String watermark) {
    this.watermark = watermark;
  }

  public String getOptionsType() {
    return optionsType;
  }

  public void setOptionsType(String optionsType) {
    this.optionsType = optionsType;
  }
  
  public List<UiFilterOptionsValuesConfig> getOptionsValues() {
    return optionsValues;
  }

  public void setOptionsValues(List<UiFilterOptionsValuesConfig> optionsValues) {
    this.optionsValues = optionsValues;
  }

  public void setDefaultValue(UiFilterOptionsValuesConfig defaultValue) {
    this.defaultValue = defaultValue;
  }
  
  public void setFilterValueList(List<UiFilterValueEntity> values) {
    this.filterValueList = values;
  }
}