JPA concepts for TOSCA
[policy/models.git] / models-base / src / main / java / org / onap / policy / models / base / PfConceptContainer.java
index 949cb96..863a3ef 100644 (file)
@@ -21,6 +21,7 @@
 
 package org.onap.policy.models.base;
 
+import com.google.re2j.Pattern;
 import java.lang.reflect.ParameterizedType;
 import java.util.ArrayList;
 import java.util.LinkedHashMap;
@@ -30,21 +31,20 @@ import java.util.Map.Entry;
 import java.util.NavigableMap;
 import java.util.Set;
 import java.util.TreeMap;
-
+import java.util.TreeSet;
+import java.util.function.Function;
 import javax.persistence.CascadeType;
 import javax.persistence.EmbeddedId;
-import javax.persistence.Entity;
 import javax.persistence.JoinColumn;
 import javax.persistence.JoinTable;
 import javax.persistence.ManyToMany;
 import javax.persistence.MappedSuperclass;
 import javax.persistence.Table;
 import javax.ws.rs.core.Response;
-
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.NonNull;
-
+import org.apache.commons.lang3.StringUtils;
 import org.onap.policy.models.base.PfValidationResult.ValidationResult;
 
 // @formatter:off
@@ -61,7 +61,6 @@ import org.onap.policy.models.base.PfValidationResult.ValidationResult;
  */
 //@formatter:on
 @MappedSuperclass
-@Entity
 @Table(name = "PfConceptContainer")
 @Data
 @EqualsAndHashCode(callSuper = false)
@@ -70,6 +69,8 @@ public class PfConceptContainer<C extends PfConcept, A extends PfNameVersion> ex
         implements PfConceptGetter<C>, PfAuthorative<List<Map<String, A>>> {
     private static final long serialVersionUID = -324211738823208318L;
 
+    private static final Pattern KEY_ID_PATTERN = Pattern.compile(PfKey.KEY_ID_REGEXP);
+
     @EmbeddedId
     private PfConceptKey key;
 
@@ -103,7 +104,7 @@ public class PfConceptContainer<C extends PfConcept, A extends PfNameVersion> ex
      * @param key the concept key
      */
     public PfConceptContainer(@NonNull final PfConceptKey key) {
-        this(key, new TreeMap<PfConceptKey, C>());
+        this(key, new TreeMap<>());
     }
 
     /**
@@ -151,7 +152,7 @@ public class PfConceptContainer<C extends PfConcept, A extends PfNameVersion> ex
     public List<Map<String, A>> toAuthorative() {
         // The returned list is a list of map singletons with one map for each map
         // entry in the concept container
-        List<Map<String, A>> toscaPolicyMapList = new ArrayList<>();
+        List<Map<String, A>> toscaConceptMapList = new ArrayList<>();
 
         for (Entry<PfConceptKey, C> conceptEntry : getConceptMap().entrySet()) {
             // Create a map to hold this entry
@@ -163,10 +164,10 @@ public class PfConceptContainer<C extends PfConcept, A extends PfNameVersion> ex
             toscaPolicyMap.put(conceptEntry.getKey().getName(), authoritiveImpl.toAuthorative());
 
             // Add the map to the returned list
-            toscaPolicyMapList.add(toscaPolicyMap);
+            toscaConceptMapList.add(toscaPolicyMap);
         }
 
-        return toscaPolicyMapList;
+        return toscaConceptMapList;
     }
 
     @Override
@@ -178,31 +179,32 @@ public class PfConceptContainer<C extends PfConcept, A extends PfNameVersion> ex
         for (Map<String, A> incomingConceptMap : authorativeList) {
             // Add the map entries one by one
             for (Entry<String, A> incomingConceptEntry : incomingConceptMap.entrySet()) {
-                C jpaConcept = getConceptNewInstance();
 
+                PfConceptKey conceptKey = new PfConceptKey();
+                if (KEY_ID_PATTERN.matches(incomingConceptEntry.getKey())) {
+                    conceptKey = new PfConceptKey(incomingConceptEntry.getKey());
+                } else {
+                    conceptKey.setName(incomingConceptEntry.getKey());
+                    if (incomingConceptEntry.getValue().getVersion() != null) {
+                        conceptKey.setVersion(incomingConceptEntry.getValue().getVersion());
+                    } else {
+                        conceptKey.setVersion(PfKey.NULL_KEY_VERSION);
+                    }
+                }
+
+                incomingConceptEntry.getValue().setName(findConceptField(conceptKey, conceptKey.getName(),
+                        incomingConceptEntry.getValue(), PfNameVersion::getName));
+                incomingConceptEntry.getValue().setVersion(findConceptField(conceptKey, conceptKey.getVersion(),
+                        incomingConceptEntry.getValue(), PfNameVersion::getVersion));
+
+                C jpaConcept = getConceptNewInstance();
                 // This cast allows us to call the fromAuthorative method
                 @SuppressWarnings("unchecked")
                 PfAuthorative<A> authoritiveImpl = (PfAuthorative<A>) jpaConcept;
 
-                if (incomingConceptEntry.getValue().getName() == null) {
-                    incomingConceptEntry.getValue().setName(incomingConceptEntry.getKey());
-                }
-
                 // Set the key name and the rest of the values on the concept
                 authoritiveImpl.fromAuthorative(incomingConceptEntry.getValue());
 
-                // This cast gets the key of the concept
-                PfConceptKey conceptKey = (PfConceptKey) jpaConcept.getKey();
-
-                // Set the concept key of the concept
-                conceptKey.setName(incomingConceptEntry.getValue().getName());
-
-                if (incomingConceptEntry.getValue().getVersion() != null) {
-                    conceptKey.setVersion(incomingConceptEntry.getValue().getVersion());
-                } else {
-                    conceptKey.setVersion(PfKey.NULL_KEY_VERSION);
-                }
-
                 // After all that, save the map entry
                 conceptMap.put(conceptKey, jpaConcept);
             }
@@ -214,6 +216,21 @@ public class PfConceptContainer<C extends PfConcept, A extends PfNameVersion> ex
         }
     }
 
+    /**
+     * Get an authorative list of the concepts in this container.
+     *
+     * @return the authorative list of concepts
+     */
+    public List<A> toAuthorativeList() {
+        List<A> toscaConceptList = new ArrayList<>();
+
+        for (Map<String, A> toscaConceptMap : toAuthorative()) {
+            toscaConceptList.addAll(toscaConceptMap.values());
+        }
+
+        return toscaConceptList;
+    }
+
     @Override
     public void clean() {
         key.clean();
@@ -288,16 +305,36 @@ public class PfConceptContainer<C extends PfConcept, A extends PfNameVersion> ex
             return retVal;
         }
 
-        if (!conceptMap.equals(other.conceptMap)) {
-            return (conceptMap.hashCode() - other.conceptMap.hashCode());
-        }
+        return PfUtils.compareMaps(conceptMap, other.conceptMap);
+    }
 
-        return 0;
+    /**
+     * Get all the concepts that match the given name and version.
+     *
+     * @param conceptKeyName the name of the concept, if null, return all names
+     * @param conceptKeyVersion the version of the concept, if null, return all versions
+     * @return conceptKeyVersion
+     */
+    public Set<C> getAllNamesAndVersions(final String conceptKeyName, final String conceptKeyVersion) {
+        if (conceptKeyName == null || conceptKeyVersion == null || PfKey.NULL_KEY_VERSION.equals(conceptKeyVersion)) {
+            return getAll(conceptKeyName, conceptKeyVersion);
+        } else {
+            final Set<C> returnSet = new TreeSet<>();
+            C foundConcept = get(conceptKeyName, conceptKeyVersion);
+            if (foundConcept != null) {
+                returnSet.add(foundConcept);
+            }
+            return returnSet;
+        }
     }
 
     @Override
     public C get(final PfConceptKey conceptKey) {
-        return new PfConceptGetterImpl<>((NavigableMap<PfConceptKey, C>) conceptMap).get(conceptKey);
+        if (conceptKey.isNullVersion()) {
+            return get(conceptKey.getName());
+        } else {
+            return new PfConceptGetterImpl<>((NavigableMap<PfConceptKey, C>) conceptMap).get(conceptKey);
+        }
     }
 
     @Override
@@ -338,4 +375,17 @@ public class PfConceptContainer<C extends PfConcept, A extends PfNameVersion> ex
                     "failed to instantiate instance of container concept class", ex);
         }
     }
+
+    private String findConceptField(final PfConceptKey conceptKey, final String keyFieldValue,
+            final PfNameVersion concept, final Function<PfNameVersion, String> fieldGetterFunction) {
+
+        String conceptField = fieldGetterFunction.apply(concept);
+
+        if (StringUtils.isBlank(conceptField) || keyFieldValue.equals(conceptField)) {
+            return keyFieldValue;
+        } else {
+            throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, "Key " + conceptKey.getId() + " field "
+                    + keyFieldValue + " does not match the value " + conceptField + " in the concept field");
+        }
+    }
 }