models-dao/src/main/java/org/onap/policy/models/dao/PfFilter.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021 Nordix Foundation.
   4  *  Modifications Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
   5  * ================================================================================
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.models.dao;
  23
  24 import java.time.Instant;
  25 import java.util.Map;
  26 import lombok.Data;
  27 /**
  28  * This abstract class is used as a base for the filter implementations.
  29  *
  30  */
  31
  32 @Data
  33 public abstract class PfFilter {
  34     private static final String AND        = " AND ";
  35     private static final String ORDER      = " ORDER BY ";
  36
  37     private String nameFilter;
  38     private String timeStampStartFilter;
  39     private String timeStampEndFilter;
  40     private String timeStampFilter;
  41     private String nameParameter;
  42     private String keyPrefix;
  43
  44     /**
  45      * Generates filter string.
  46      *
  47      * @param inputFilterString current filterString generated from FilterMap
  48      * @param name the pdpInstance name for the PDP statistics to get
  49      * @param startTime the start timeStamp to filter from database, filter rule:
  50      *     startTime <= filteredRecord timeStamp <= endTime. null for ignore end time
  51      * @param endTime the end timeStamp to filter from database, filter rule:
  52      *     startTime <= filteredRecord timeStamp <= endTime. null for ignore end time
  53      * @param filterMap Map store extra key/value used to filter from database, can be null     *
  54      * @param sortOrder sortOrder to query database
  55      * @param getRecordNum Total query count from database
  56
  57      */
  58     public String addFilter(final String inputFilterString,
  59         final String name, final Instant startTime, final Instant endTime,
  60         final Map<String, Object> filterMap, final String sortOrder, final int getRecordNum) {
  61         var filterQueryString = new StringBuilder(inputFilterString);
  62         if (filterMap != null) {
  63             for (String key : filterMap.keySet()) {
  64                 filterQueryString.append(getKeyPrefix() + key + "= :" + key + AND);
  65             }
  66         }
  67
  68         if (name != null) {
  69             filterQueryString.append(getNameFilter() + AND);
  70         }
  71
  72         if (startTime != null) {
  73             if (endTime != null) {
  74                 filterQueryString.append(getTimeStampStartFilter());
  75                 filterQueryString.append(AND);
  76                 filterQueryString.append(getTimeStampEndFilter());
  77             } else {
  78                 filterQueryString.append(getTimeStampStartFilter());
  79             }
  80         } else {
  81             if (endTime != null) {
  82                 filterQueryString.append(getTimeStampEndFilter());
  83             } else {
  84                 filterQueryString.delete(filterQueryString.length() - AND.length(), filterQueryString.length());
  85             }
  86         }
  87
  88         if (getRecordNum > 0) {
  89             filterQueryString.append(ORDER + getTimeStampFilter() + sortOrder);
  90         }
  91         return filterQueryString.toString();
  92     }
  93 }