dcae-analytics-model/src/main/java/org/openecomp/dcae/apod/analytics/model/domain/BaseDynamicPropertiesProvider.java

   1 /*
   2  * ===============================LICENSE_START======================================
   3  *  dcae-analytics
   4  * ================================================================================
   5  *    Copyright © 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  *  Licensed under the Apache License, Version 2.0 (the "License");
   8  *  you may not use this file except in compliance with the License.
   9  *   You may obtain a copy of the License at
  10  *
  11  *          http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  *  Unless required by applicable law or agreed to in writing, software
  14  *  distributed under the License is distributed on an "AS IS" BASIS,
  15  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  *  See the License for the specific language governing permissions and
  17  *  limitations under the License.
  18  *  ============================LICENSE_END===========================================
  19  */
  20
  21 package org.openecomp.dcae.apod.analytics.model.domain;
  22
  23 import lombok.Data;
  24
  25 import java.util.LinkedHashMap;
  26 import java.util.Map;
  27
  28 /**
  29  * <p>
  30  *     Base Dynamic Provider provide functionality so that all the
  31  *     additional dynamic Properties can be accumalated in a map.
  32  * </p>
  33  *
  34  * @author Rajiv Singla . Creation Date: 11/5/2016.
  35  */
  36 @Data
  37 public abstract class BaseDynamicPropertiesProvider implements DynamicPropertiesProvider {
  38
  39     /**
  40      * All non-required properties should be captured in additional properties
  41      *
  42      * @param dynamicProperties Dynamic properties
  43      * @return dynamic properties
  44      */
  45     private Map<String, Object> dynamicProperties = new LinkedHashMap<>();
  46
  47
  48     /**
  49      * Add a dynamic property to Common Event Format Entity
  50      *
  51      * @param propertyName property name
  52      * @param propertyValue property value
  53      */
  54     @Override
  55     public void addDynamicProperties(String propertyName, Object propertyValue) {
  56         dynamicProperties.put(propertyName, propertyValue);
  57     }
  58
  59     /**
  60      * Determines if dynamic properties are present for the CEF Entity
  61      *
  62      * @return return true if Dynamic Properties are present
  63      */
  64     public boolean isDynamicPropertiesPresent() {
  65         return dynamicProperties.isEmpty();
  66     }
  67 }