Implement validation and hierarchical get
[policy/models.git] / models-dao / src / main / java / org / onap / policy / models / dao / impl / DefaultPfDao.java
index f7659b2..6707e70 100644 (file)
@@ -1,6 +1,7 @@
 /*-
  * ============LICENSE_START=======================================================
- *  Copyright (C) 2019 Nordix Foundation.
+ *  Copyright (C) 2019-2020 Nordix Foundation.
+ *  Modifications Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
  * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,11 +23,14 @@ package org.onap.policy.models.dao.impl;
 
 import java.util.Collection;
 import java.util.Collections;
+import java.util.Date;
 import java.util.List;
+import java.util.Map;
 
 import javax.persistence.EntityManager;
 import javax.persistence.EntityManagerFactory;
 import javax.persistence.Persistence;
+import javax.persistence.TypedQuery;
 import javax.ws.rs.core.Response;
 
 import org.onap.policy.models.base.PfConcept;
@@ -34,6 +38,8 @@ import org.onap.policy.models.base.PfConceptKey;
 import org.onap.policy.models.base.PfModelException;
 import org.onap.policy.models.base.PfModelRuntimeException;
 import org.onap.policy.models.base.PfReferenceKey;
+import org.onap.policy.models.base.PfTimestampKey;
+import org.onap.policy.models.base.PfUtils;
 import org.onap.policy.models.dao.DaoParameters;
 import org.onap.policy.models.dao.PfDao;
 import org.slf4j.Logger;
@@ -49,6 +55,7 @@ public class DefaultPfDao implements PfDao {
     // @formatter:off
     private static final String NAME           = "name";
     private static final String VERSION        = "version";
+    private static final String TIMESTAMP      = "timeStamp";
     private static final String PARENT_NAME    = "parentname";
     private static final String PARENT_VERSION = "parentversion";
     private static final String LOCAL_NAME     = "localname";
@@ -61,17 +68,25 @@ public class DefaultPfDao implements PfDao {
 
     private static final String WHERE      = " WHERE ";
     private static final String AND        = " AND ";
+    private static final String ORDER      = " ORDER BY ";
 
-    private static final String NAME_FILTER           = "c.key.name = :name";
-    private static final String VERSION_FILTER        = "c.key.version = :version";
-    private static final String PARENT_NAME_FILTER    = "c.key.parentKeyName = :parentname";
-    private static final String PARENT_VERSION_FILTER = "c.key.parentKeyVersion = :parentversion";
-    private static final String LOCAL_NAME_FILTER     = "c.key.localName = :localname";
-    private static final String MAX_VERISON_FILTER    = "c.key.version = (SELECT MAX(c.key.version) FROM __TABLE__ c)";
+    private static final String NAME_FILTER            = "c.key.name = :name";
+    private static final String VERSION_FILTER         = "c.key.version = :version";
+    private static final String TIMESTAMP_FILTER       = "c.key.timeStamp = :timeStamp";
+    private static final String TIMESTAMP_START_FILTER = "c.key.timeStamp >= :startTime";
+    private static final String TIMESTAMP_END_FILTER   = "c.key.timeStamp <= :endTime";
+    private static final String PARENT_NAME_FILTER     = "c.key.parentKeyName = :parentname";
+    private static final String PARENT_VERSION_FILTER  = "c.key.parentKeyVersion = :parentversion";
+    private static final String LOCAL_NAME_FILTER      = "c.key.localName = :localname";
+
+    private static final String CLONE_ERR_MSG = "Could not clone object of class \"{}\"";
 
     private static final String DELETE_BY_CONCEPT_KEY =
             DELETE_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER;
 
+    private static final String DELETE_BY_TIMESTAMP_KEY =
+            DELETE_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER  + AND + TIMESTAMP_FILTER;
+
     private static final String DELETE_BY_REFERENCE_KEY =
             DELETE_FROM_TABLE + WHERE + PARENT_NAME_FILTER + AND + PARENT_VERSION_FILTER + AND + LOCAL_NAME_FILTER;
 
@@ -80,12 +95,6 @@ public class DefaultPfDao implements PfDao {
 
     private static final String SELECT_ALL_VERSIONS = SELECT_FROM_TABLE + WHERE + NAME_FILTER;
 
-    private static final String SELECT_LATEST_VERSION =
-            SELECT_FROM_TABLE + WHERE + NAME_FILTER + AND + MAX_VERISON_FILTER;
-
-    private static final String SELECT_LATEST_VERSIONS =
-            "SELECT c FROM __TABLE__ c WHERE c.key.version = (SELECT MAX(c.key.version) FROM __TABLE__ c)";
-
     private static final String SELECT_BY_CONCEPT_KEY =
             SELECT_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER;
 
@@ -180,7 +189,7 @@ public class DefaultPfDao implements PfDao {
             mg.getTransaction().begin();
             mg.createQuery(setQueryTable(DELETE_BY_CONCEPT_KEY, someClass), someClass)
                 .setParameter(NAME,    key.getName())
-                .setParameter("version", key.getVersion())
+                .setParameter(VERSION, key.getVersion())
                 .executeUpdate();
             mg.getTransaction().commit();
             // @formatter:on
@@ -210,6 +219,27 @@ public class DefaultPfDao implements PfDao {
         }
     }
 
+    @Override
+    public <T extends PfConcept> void delete(final Class<T> someClass, final PfTimestampKey key) {
+        if (key == null) {
+            return;
+        }
+        final EntityManager mg = getEntityManager();
+        try {
+            // @formatter:off
+            mg.getTransaction().begin();
+            mg.createQuery(setQueryTable(DELETE_BY_TIMESTAMP_KEY, someClass), someClass)
+                    .setParameter(NAME,    key.getName())
+                    .setParameter(VERSION, key.getVersion())
+                    .setParameter(TIMESTAMP, key.getTimeStamp())
+                    .executeUpdate();
+            mg.getTransaction().commit();
+            // @formatter:on
+        } finally {
+            mg.close();
+        }
+    }
+
     @Override
     public <T extends PfConcept> void createCollection(final Collection<T> objs) {
         if (objs == null || objs.isEmpty()) {
@@ -257,7 +287,7 @@ public class DefaultPfDao implements PfDao {
             for (final PfConceptKey key : keys) {
                 deletedCount += mg.createQuery(setQueryTable(DELETE_BY_CONCEPT_KEY, someClass), someClass)
                     .setParameter(NAME,    key.getName())
-                    .setParameter("version", key.getVersion())
+                    .setParameter(VERSION, key.getVersion())
                     .executeUpdate();
             }
             mg.getTransaction().commit();
@@ -307,48 +337,76 @@ public class DefaultPfDao implements PfDao {
     }
 
     @Override
-    public <T extends PfConcept> List<T> getFiltered(Class<T> someClass, PfConceptKey key) {
-        if (key.getName() == null) {
+    public <T extends PfConcept> List<T> getFiltered(final Class<T> someClass, final String name,
+            final String version) {
+        if (name == null) {
             return getAll(someClass);
         }
 
-        if (key.getVersion() == null) {
-            return getAllVersions(someClass, key.getName());
+        if (version == null) {
+            return getAllVersions(someClass, name);
         }
 
-        T foundConcept = get(someClass, key);
+        T foundConcept = get(someClass, new PfConceptKey(name, version));
 
         return (foundConcept == null ? Collections.emptyList() : Collections.singletonList(foundConcept));
     }
 
     @Override
-    public <T extends PfConcept> T get(final Class<T> someClass, final PfConceptKey key) {
-        if (someClass == null) {
-            return null;
-        }
+    public <T extends PfConcept> List<T> getFiltered(final Class<T> someClass, final String name, final String version,
+            final Date startTime, final Date endTime, final Map<String, Object> filterMap, final String sortOrder,
+            final int getRecordNum) {
         final EntityManager mg = getEntityManager();
+
+        String filterQueryString = SELECT_FROM_TABLE + WHERE;
+
         try {
-            final T t = mg.find(someClass, key);
-            if (t != null) {
-                // This clone is created to force the JPA DAO to recurse down through the object
-                try {
-                    final T clonedT = someClass.newInstance();
-                    t.copyTo(clonedT);
-                    return clonedT;
-                } catch (final Exception e) {
-                    LOGGER.warn("Could not clone object of class \"" + someClass.getCanonicalName() + "\"", e);
-                    return null;
+            if (filterMap != null) {
+                StringBuilder bld = new StringBuilder(filterQueryString);
+                for (String key : filterMap.keySet()) {
+                    bld.append("c." + key + "= :" + key + AND);
+                }
+                filterQueryString = bld.toString();
+            }
+            filterQueryString = addKeyFilterString(filterQueryString, name, startTime, endTime);
+            if (getRecordNum > 0) {
+                filterQueryString += ORDER + " c.key.timeStamp " + sortOrder;
+            }
+            TypedQuery<T> query = mg.createQuery(setQueryTable(filterQueryString, someClass), someClass);
+
+            if (filterMap != null) {
+                for (Map.Entry<String, Object> entry : filterMap.entrySet()) {
+                    query.setParameter(entry.getKey(), entry.getValue());
+                }
+            }
+            if (name != null) {
+                query.setParameter("name", name);
+            }
+            if (startTime != null) {
+                if (endTime != null) {
+                    query.setParameter("startTime", startTime);
+                    query.setParameter("endTime", endTime);
+                } else {
+                    query.setParameter("startTime", startTime);
                 }
             } else {
-                return null;
+                if (endTime != null) {
+                    query.setParameter("endTime", endTime);
+                }
             }
+            if (getRecordNum > 0) {
+                query.setMaxResults(getRecordNum);
+            }
+
+            LOGGER.error("filterQueryString is  \"{}\"", filterQueryString);
+            return query.getResultList();
         } finally {
             mg.close();
         }
     }
 
     @Override
-    public <T extends PfConcept> T get(final Class<T> someClass, final PfReferenceKey key) {
+    public <T extends PfConcept> T get(final Class<T> someClass, final PfConceptKey key) {
         if (someClass == null) {
             return null;
         }
@@ -356,80 +414,72 @@ public class DefaultPfDao implements PfDao {
         try {
             final T t = mg.find(someClass, key);
             if (t != null) {
-                try {
-                    final T clonedT = someClass.newInstance();
-                    t.copyTo(clonedT);
-                    return clonedT;
-                } catch (final Exception e) {
-                    LOGGER.warn("Could not clone object of class \"" + someClass.getCanonicalName() + "\"", e);
-                    return null;
-                }
-            } else {
-                return null;
+                mg.refresh(t);
             }
+            return checkAndReturn(someClass, t);
         } finally {
             mg.close();
         }
     }
 
     @Override
-    public <T extends PfConcept> List<T> getAll(final Class<T> someClass) {
+    public <T extends PfConcept> T get(final Class<T> someClass, final PfReferenceKey key) {
         if (someClass == null) {
-            return Collections.emptyList();
+            return null;
         }
         final EntityManager mg = getEntityManager();
         try {
-            return mg.createQuery(setQueryTable(SELECT_FROM_TABLE, someClass), someClass).getResultList();
+            final T t = mg.find(someClass, key);
+            if (t != null) {
+                mg.refresh(t);
+            }
+            return checkAndReturn(someClass, t);
         } finally {
             mg.close();
         }
     }
 
     @Override
-    public <T extends PfConcept> List<T> getAll(final Class<T> someClass, final PfConceptKey parentKey) {
+    public <T extends PfConcept> T get(final Class<T> someClass, final PfTimestampKey key) {
         if (someClass == null) {
-            return Collections.emptyList();
+            return null;
         }
         final EntityManager mg = getEntityManager();
         try {
-            // @formatter:off
-            return mg.createQuery(setQueryTable(SELECT_ALL_FOR_PARENT, someClass), someClass)
-                    .setParameter(PARENT_NAME,    parentKey.getName())
-                    .setParameter(PARENT_VERSION, parentKey.getVersion())
-                    .getResultList();
-            // @formatter:on
+            final T t = mg.find(someClass, key);
+            if (t != null) {
+                mg.refresh(t);
+            }
+            return checkAndReturn(someClass, t);
         } finally {
             mg.close();
         }
     }
 
     @Override
-    public <T extends PfConcept> List<T> getAllVersions(final Class<T> someClass, final String conceptName) {
-        if (someClass == null || conceptName == null) {
+    public <T extends PfConcept> List<T> getAll(final Class<T> someClass) {
+        if (someClass == null) {
             return Collections.emptyList();
         }
         final EntityManager mg = getEntityManager();
         try {
-            // @formatter:off
-            return mg.createQuery(setQueryTable(SELECT_ALL_VERSIONS, someClass), someClass)
-                    .setParameter(NAME, conceptName)
-                    .getResultList();
-            // @formatter:on
+            return mg.createQuery(setQueryTable(SELECT_FROM_TABLE, someClass), someClass).getResultList();
         } finally {
             mg.close();
         }
     }
 
     @Override
-    public <T extends PfConcept> List<T> getLatestVersions(final Class<T> someClass) {
+    public <T extends PfConcept> List<T> getAll(final Class<T> someClass, final PfConceptKey parentKey) {
         if (someClass == null) {
             return Collections.emptyList();
         }
         final EntityManager mg = getEntityManager();
-        List<T> ret;
         try {
             // @formatter:off
-            return mg.createQuery(setQueryTable(SELECT_LATEST_VERSIONS, someClass), someClass)
+            return mg.createQuery(setQueryTable(SELECT_ALL_FOR_PARENT, someClass), someClass)
+                    .setParameter(PARENT_NAME,    parentKey.getName())
+                    .setParameter(PARENT_VERSION, parentKey.getVersion())
                     .getResultList();
             // @formatter:on
         } finally {
@@ -438,23 +488,20 @@ public class DefaultPfDao implements PfDao {
     }
 
     @Override
-    public <T extends PfConcept> T getLatestVersion(final Class<T> someClass, final String conceptName) {
+    public <T extends PfConcept> List<T> getAllVersions(final Class<T> someClass, final String conceptName) {
         if (someClass == null || conceptName == null) {
-            return null;
+            return Collections.emptyList();
         }
         final EntityManager mg = getEntityManager();
-        List<T> ret;
         try {
             // @formatter:off
-            ret = mg.createQuery(setQueryTable(SELECT_LATEST_VERSION, someClass), someClass)
+            return mg.createQuery(setQueryTable(SELECT_ALL_VERSIONS, someClass), someClass)
                     .setParameter(NAME, conceptName)
                     .getResultList();
             // @formatter:on
         } finally {
             mg.close();
         }
-
-        return getSingleResult(someClass, conceptName, ret);
     }
 
     @Override
@@ -560,4 +607,56 @@ public class DefaultPfDao implements PfDao {
         }
         return ret.get(0);
     }
+
+    /**
+     * generate filter string with the filter value in TimestampKey.
+     *
+     * @param inputFilterString current filterString generated from FilterMap
+     * @param name the pdp name the start timeStamp to filter from database, filter rule: startTime <= filteredRecord
+     *        timeStamp <= endTime. null for ignore start time.
+     * @param endTime the end timeStamp to filter from database, filter rule: startTime <= filteredRecord timeStamp <=
+     *        endTime. null for ignore end time
+     * @return the filter string to query database
+     */
+    private String addKeyFilterString(String inputFilterString, final String name, final Date startTime,
+            final Date endTime) {
+        String filterQueryString;
+        if (name != null) {
+            inputFilterString += NAME_FILTER + AND;
+        }
+        if (startTime != null) {
+            if (endTime != null) {
+                filterQueryString = inputFilterString + TIMESTAMP_START_FILTER + AND + TIMESTAMP_END_FILTER;
+            } else {
+                filterQueryString = inputFilterString + TIMESTAMP_START_FILTER;
+            }
+        } else {
+            if (endTime != null) {
+                filterQueryString = inputFilterString + TIMESTAMP_END_FILTER;
+            } else {
+                filterQueryString = inputFilterString.substring(0, inputFilterString.length() - AND.length());
+            }
+        }
+
+        return filterQueryString;
+    }
+
+    /**
+     * check the result get from database and return the object.
+     *
+     * @param <T> the type of the object to get, a subclass of {@link PfConcept}
+     * @param someClass the class of the object to get, a subclass of {@link PfConcept}
+     * @param t the object that was retrieved from the database
+     * @return the checked object or null
+     */
+    private <T extends PfConcept> T checkAndReturn(final Class<T> someClass, final T objToCheck) {
+        if (objToCheck != null) {
+            try {
+                return PfUtils.makeCopy(objToCheck);
+            } catch (final Exception e) {
+                LOGGER.warn(CLONE_ERR_MSG, someClass.getName(), e);
+            }
+        }
+        return null;
+    }
 }