gerrit.onap Code Review - ccsdk/features.git/blob

   1 /*
   2  * ============LICENSE_START=======================================================
   3  * ONAP : ccsdk features
   4  * ================================================================================
   5  * Copyright (C) 2021 highstreet technologies GmbH Intellectual Property.
   6  * All rights reserved.
   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  */
  22 package org.onap.ccsdk.features.sdnr.wt.dataprovider.database.sqldb.query;
  23
  24 import java.util.ArrayList;
  25 import java.util.Arrays;
  26 import java.util.List;
  27 import java.util.Map;
  28 import java.util.Set;
  29 import java.util.stream.Collectors;
  30 import org.eclipse.jdt.annotation.Nullable;
  31 import org.onap.ccsdk.features.sdnr.wt.dataprovider.database.sqldb.data.PropertyList;
  32 import org.onap.ccsdk.features.sdnr.wt.dataprovider.database.sqldb.database.SqlDBMapper;
  33 import org.onap.ccsdk.features.sdnr.wt.dataprovider.database.sqldb.query.filters.SqlDBSearchFilter;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.EntityInput;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.SortOrder;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.entity.input.Filter;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.entity.input.FilterBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.entity.input.FilterKey;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.entity.input.Pagination;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.entity.input.Sortorder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.entity.input.SortorderKey;
  42 import org.slf4j.Logger;
  43 import org.slf4j.LoggerFactory;
  44
  45 public class SelectQuery implements SqlQuery {
  46
  47     private static final Logger LOG = LoggerFactory.getLogger(SelectQuery.class);
  48
  49     private static final long DEFAULT_PAGESIZE = 20;
  50     private static final long DEFAULT_PAGE = 1;
  51     private final String tableName;
  52     private final List<Filter> filters;
  53     private final List<String> sortExpressions;
  54     private final String controllerId;
  55     private long page;
  56     private long pageSize;
  57     private final List<String> fields;
  58     private final List<String> groups;
  59     private SqlDBSearchFilter allPropertyFilter;
  60
  61     public SelectQuery(String tableName) {
  62         this(tableName, (String)null);
  63     }
  64     public SelectQuery(String tableName, String controllerId) {
  65         this(tableName, Arrays.asList("*"), controllerId);
  66     }
  67     public SelectQuery(String tableName, List<String> fields, String controllerId) {
  68         this.tableName = tableName;
  69         this.fields = fields;
  70         this.filters = new ArrayList<>();
  71         this.sortExpressions = new ArrayList<>();
  72         this.groups = new ArrayList<>();
  73         this.page = DEFAULT_PAGE;
  74         this.pageSize = DEFAULT_PAGESIZE;
  75         this.controllerId = controllerId;
  76         this.allPropertyFilter = null;
  77         if (controllerId != null) {
  78             this.addFilter(SqlDBMapper.ODLID_DBCOL, controllerId);
  79         }
  80     }
  81
  82     public SelectQuery(String tableName, String field, String controllerId) {
  83         this(tableName, Arrays.asList(field), controllerId);
  84     }
  85
  86     public SelectQuery(String tableName, EntityInput input) {
  87         this(tableName, input, null);
  88     }
  89
  90     public SelectQuery(String tableName, EntityInput input, String controllerId) {
  91         this(tableName);
  92         Map<FilterKey, Filter> filter = input != null ? input.getFilter() : null;
  93         if (filter != null && filter.size() > 0) {
  94             for (Filter f : filter.values()) {
  95                 this.addFilter(f);
  96             }
  97         }
  98         if (controllerId != null) {
  99             this.addFilter(SqlDBMapper.ODLID_DBCOL, controllerId);
 100         }
 101
 102         Map<SortorderKey, Sortorder> so = input != null ? input.getSortorder() : null;
 103         if (so != null && !so.isEmpty()) {
 104             for (Sortorder s : so.values()) {
 105                 this.addSortOrder(s.getProperty(), s.getSortorder() == SortOrder.Ascending ? "ASC" : "DESC");
 106             }
 107         }
 108         Pagination pagination = input != null ? input.getPagination() : null;
 109         if (pagination != null) {
 110             this.setPagination(pagination.getPage().longValue(), pagination.getSize().longValue());
 111         } else {
 112             this.setPagination(1, 30);
 113         }
 114
 115     }
 116
 117     public SelectQuery addFilter(String property, String filtervalue) {
 118         this.addFilter(new FilterBuilder().setProperty(property).setFiltervalue(filtervalue).build());
 119         return this;
 120     }
 121
 122     private static Filter cleanFilter(Filter filter) {
 123         final String sFilter = filter.getFiltervalue();
 124         final Set<String> sFilters = filter.getFiltervalues();
 125         //if only single filter value is set
 126         if (sFilter != null && (sFilters == null || sFilter.isEmpty())) {
 127             return "*".equals(filter.getFiltervalue()) ? null : filter;
 128         } else {
 129             List<String> list = new ArrayList<>(filter.getFiltervalues());
 130             if (sFilter != null && !sFilter.isEmpty()) {
 131                 list.add(sFilter);
 132             }
 133             if (list.size() == 1 && "*".equals(list.get(0))) {
 134                 return null;
 135             } ;
 136             return new FilterBuilder().setProperty(filter.getProperty()).setFiltervalue(filter.getFiltervalue())
 137                     .setFiltervalues(
 138                             filter.getFiltervalues().stream().filter(e -> !"*".equals(e)).collect(Collectors.toSet()))
 139                     .build();
 140         }
 141     }
 142
 143     public void addFilter(Filter filter) {
 144         Filter tmp = cleanFilter(filter);
 145         if (tmp == null) {
 146             LOG.debug("ignore unneccessary filter for {}", filter);
 147         } else {
 148             this.filters.add(tmp);
 149         }
 150     }
 151
 152     public void addSortOrder(String col, String order) {
 153         this.sortExpressions.add(String.format("`%s` %s", col, order));
 154     }
 155     public void setAllPropertyFilter(String filter, PropertyList propertyList) {
 156         this.allPropertyFilter = new SqlDBSearchFilter(propertyList, filter);
 157     }
 158     public void setPagination(long page, long pageSize) {
 159         this.page = page;
 160         this.pageSize = pageSize;
 161     }
 162
 163     public void setPagination(@Nullable Pagination pagination) {
 164         long page = DEFAULT_PAGE;
 165         long pageSize = DEFAULT_PAGESIZE;
 166         if (pagination != null) {
 167             if (pagination.getPage() != null) {
 168                 page = pagination.getPage().longValue();
 169             }
 170             if (pagination.getSize() != null) {
 171                 pageSize = pagination.getSize().longValue();
 172             }
 173         }
 174         this.setPagination(page, pageSize);
 175
 176     }
 177
 178     @Override
 179     public String toSql() {
 180         StringBuilder sb = new StringBuilder();
 181         if (this.fields.size() == 1 && this.fields.contains("*")) {
 182             sb.append(String.format("SELECT * FROM `%s`", this.tableName));
 183         } else {
 184             sb.append(String.format("SELECT `%s` FROM `%s`", String.join("`,`", this.fields), this.tableName));
 185         }
 186         sb.append(SqlQuery.getWhereExpression(this.filters, this.controllerId, this.allPropertyFilter));
 187         if (this.groups.size() > 0) {
 188             sb.append(String.format(" GROUP BY `%s`", String.join("`,`", this.groups)));
 189         }
 190         if (this.sortExpressions.size() > 0) {
 191             sb.append(" ORDER BY " + String.join(",", this.sortExpressions));
 192         }
 193         sb.append(String.format(" LIMIT %d,%d;", (this.page - 1) * this.pageSize, this.pageSize));
 194         return sb.toString();
 195     }
 196
 197     public long getPage() {
 198         return this.page;
 199     }
 200
 201     public long getPageSize() {
 202         return this.pageSize;
 203     }
 204
 205     public SelectQuery groupBy(String group) {
 206         this.groups.add(group);
 207         return this;
 208     }
 209     @Override
 210     public String toString() {
 211         StringBuilder builder = new StringBuilder();
 212         builder.append("SelectQuery [tableName=");
 213         builder.append(tableName);
 214         builder.append(", filters=");
 215         builder.append(filters);
 216         builder.append(", sortExpressions=");
 217         builder.append(sortExpressions);
 218         builder.append(", page=");
 219         builder.append(page);
 220         builder.append(", pageSize=");
 221         builder.append(pageSize);
 222         builder.append(", fields=");
 223         builder.append(fields);
 224         builder.append(", groups=");
 225         builder.append(groups);
 226         builder.append("]");
 227         return builder.toString();
 228     }
 229
 230
 231
 232 }