model/policy-model/src/main/java/org/onap/policy/apex/model/policymodel/concepts/AxStateFinalizerLogic.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
   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.apex.model.policymodel.concepts;
  22
  23 import javax.persistence.Entity;
  24 import javax.persistence.Inheritance;
  25 import javax.persistence.InheritanceType;
  26 import javax.persistence.Table;
  27 import javax.xml.bind.annotation.XmlAccessType;
  28 import javax.xml.bind.annotation.XmlAccessorType;
  29 import javax.xml.bind.annotation.XmlRootElement;
  30 import javax.xml.bind.annotation.XmlType;
  31 import org.onap.policy.apex.model.basicmodel.concepts.AxReferenceKey;
  32
  33 /**
  34  * This class holds State Finalizer Logic for {@link AxState} states in Apex. It is a specialization
  35  * of the {@link AxLogic} class, so that State Finalizer Logic in Apex states can be strongly typed.
  36  *
  37  * <p>State Finalizer Logic is used to select the output {@link AxStateOutput} that a state will use.
  38  * The logic uses fields emitted by the executed {@link AxTask} task and information from the
  39  * context albums available on a state to decide what state output {@link AxStateOutput} to select
  40  * in a given context. State Finalizer Logic must marshal the output fields from the task onto the
  41  * output event in whatever manner is appropriate for the domain being handled.
  42  *
  43  * <p>Validation uses standard Apex Logic validation, see validation in {@link AxLogic}.
  44  */
  45 @Entity
  46 @Table(name = "AxStateFinalizerLogic")
  47 @Inheritance(strategy = InheritanceType.TABLE_PER_CLASS)
  48
  49 @XmlAccessorType(XmlAccessType.FIELD)
  50 @XmlRootElement(name = "apexStateFinalizerLogic", namespace = "http://www.onap.org/policy/apex-pdp")
  51 @XmlType(name = "AxStateFinalizerLogic", namespace = "http://www.onap.org/policy/apex-pdp")
  52
  53 public class AxStateFinalizerLogic extends AxLogic {
  54     private static final long serialVersionUID = 2090324845463750391L;
  55
  56     /**
  57      * The Default Constructor creates a logic instance with a null key, undefined logic flavour and
  58      * a null logic string.
  59      */
  60     public AxStateFinalizerLogic() {
  61         super();
  62     }
  63
  64     /**
  65      * The Key Constructor creates a logic instance with the given reference key, undefined logic
  66      * flavour and a null logic string.
  67      *
  68      * @param key the reference key of the logic
  69      */
  70     public AxStateFinalizerLogic(final AxReferenceKey key) {
  71         super(key, LOGIC_FLAVOUR_UNDEFINED, "");
  72     }
  73
  74     /**
  75      * This Constructor creates a logic instance with a reference key constructed from the parents
  76      * key and the logic local name and all of its fields defined.
  77      *
  78      * @param parentKey the reference key of the parent of this logic
  79      * @param logicName the logic name, held as the local name of the reference key of this logic
  80      * @param logicFlavour the flavour of this logic
  81      * @param logic the actual logic as a string
  82      */
  83     public AxStateFinalizerLogic(final AxReferenceKey parentKey, final String logicName, final String logicFlavour,
  84             final String logic) {
  85         super(parentKey, logicName, logicFlavour, logic);
  86     }
  87
  88     /**
  89      * This Constructor creates a logic instance with the given reference key and all of its fields
  90      * defined.
  91      *
  92      * @param key the reference key of this logic
  93      * @param logicFlavour the flavour of this logic
  94      * @param logic the actual logic as a string
  95      */
  96     public AxStateFinalizerLogic(final AxReferenceKey key, final String logicFlavour, final String logic) {
  97         super(key, logicFlavour, logic);
  98     }
  99
 100     /**
 101      * This Constructor creates a logic instance by cloning the fields from another logic instance
 102      * into this logic instance.
 103      *
 104      * @param logic the logic instance to clone from
 105      */
 106     public AxStateFinalizerLogic(final AxLogic logic) {
 107         super(new AxReferenceKey(logic.getKey()), logic.getLogicFlavour(), logic.getLogic());
 108     }
 109
 110     /**
 111      * This Constructor creates a logic instance with a reference key constructed from the parents
 112      * key and the logic local name, the given logic flavour, with the logic being provided by the
 113      * given logic reader instance.
 114      *
 115      * @param parentKey the reference key of the parent of this logic
 116      * @param logicName the logic name, held as the local name of the reference key of this logic
 117      * @param logicFlavour the flavour of this logic
 118      * @param logicReader the logic reader to use to read the logic for this logic instance
 119      */
 120     public AxStateFinalizerLogic(final AxReferenceKey parentKey, final String logicName, final String logicFlavour,
 121             final AxLogicReader logicReader) {
 122         super(new AxReferenceKey(parentKey, logicName), logicFlavour, logicReader);
 123     }
 124
 125     /**
 126      * This Constructor creates a logic instance with the given reference key and logic flavour, the
 127      * logic is provided by the given logic reader instance.
 128      *
 129      * @param key the reference key of this logic
 130      * @param logicFlavour the flavour of this logic
 131      * @param logicReader the logic reader to use to read the logic for this logic instance
 132      */
 133     public AxStateFinalizerLogic(final AxReferenceKey key, final String logicFlavour, final AxLogicReader logicReader) {
 134         super(key, logicFlavour, logicReader);
 135     }
 136 }