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

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