models-dao/src/main/java/org/onap/policy/models/dao/impl/DefaultPfDao.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019-2021 Nordix Foundation.
   4  *  Modifications Copyright (C) 2019-2021 AT&T Intellectual Property. All rights reserved.
   5  * ================================================================================
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.models.dao.impl;
  23
  24 import java.sql.Timestamp;
  25 import java.time.Instant;
  26 import java.util.Collection;
  27 import java.util.Collections;
  28 import java.util.List;
  29 import javax.persistence.EntityManager;
  30 import javax.persistence.EntityManagerFactory;
  31 import javax.persistence.Persistence;
  32 import javax.persistence.TypedQuery;
  33 import javax.ws.rs.core.Response;
  34 import org.apache.commons.lang3.StringUtils;
  35 import org.onap.policy.models.base.PfConcept;
  36 import org.onap.policy.models.base.PfConceptKey;
  37 import org.onap.policy.models.base.PfGeneratedIdKey;
  38 import org.onap.policy.models.base.PfModelException;
  39 import org.onap.policy.models.base.PfModelRuntimeException;
  40 import org.onap.policy.models.base.PfReferenceKey;
  41 import org.onap.policy.models.base.PfReferenceTimestampKey;
  42 import org.onap.policy.models.base.PfTimestampKey;
  43 import org.onap.policy.models.base.PfUtils;
  44 import org.onap.policy.models.dao.DaoParameters;
  45 import org.onap.policy.models.dao.PfDao;
  46 import org.onap.policy.models.dao.PfFilter;
  47 import org.onap.policy.models.dao.PfFilterFactory;
  48 import org.onap.policy.models.dao.PfFilterParametersIntfc;
  49 import org.slf4j.Logger;
  50 import org.slf4j.LoggerFactory;
  51
  52 /**
  53  * The Class DefaultPfDao is an JPA implementation of the {@link PfDao} class for Policy Framework concepts
  54  * ({@link PfConcept}). It uses the default JPA implementation in the javax {@link Persistence} class.
  55  */
  56 public class DefaultPfDao implements PfDao {
  57     private static final Logger LOGGER = LoggerFactory.getLogger(DefaultPfDao.class);
  58
  59     // @formatter:off
  60     private static final String NAME           = "name";
  61     private static final String VERSION        = "version";
  62     private static final String TIMESTAMP      = "timeStamp";
  63     private static final String GENERATEDID    = "Id";
  64     private static final String PARENT_NAME    = "parentname";
  65     private static final String PARENT_VERSION = "parentversion";
  66     private static final String LOCAL_NAME     = "localname";
  67
  68     private static final String TABLE_TOKEN = "__TABLE__";
  69
  70     private static final String DELETE_FROM_TABLE = "DELETE FROM __TABLE__ c";
  71
  72     private static final String SELECT_FROM_TABLE = "SELECT c FROM __TABLE__ c";
  73
  74     private static final String WHERE      = " WHERE ";
  75     private static final String AND        = " AND ";
  76     private static final String ORDER_BY        = " ORDER BY c.";
  77
  78     private static final String NAME_FILTER            = "c.key.name = :name";
  79     private static final String VERSION_FILTER         = "c.key.version = :version";
  80     private static final String TIMESTAMP_FILTER       = "c.key.timeStamp = :timeStamp";
  81     private static final String TIMESTAMP_FILTER_NOKEY = "c.timeStamp = :timeStamp";
  82     private static final String GENERATED_ID_FILTER    = "c.key.generatedId = :Id";
  83     private static final String PARENT_NAME_FILTER     = "c.key.parentKeyName = :parentname";
  84     private static final String PARENT_VERSION_FILTER  = "c.key.parentKeyVersion = :parentversion";
  85     private static final String LOCAL_NAME_FILTER      = "c.key.localName = :localname";
  86
  87     private static final String CLONE_ERR_MSG = "Could not clone object of class \"{}\"";
  88
  89     private static final String DELETE_BY_CONCEPT_KEY =
  90             DELETE_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER;
  91
  92     private static final String DELETE_BY_TIMESTAMP_KEY =
  93             DELETE_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER  + AND + TIMESTAMP_FILTER;
  94
  95     private static final String DELETE_BY_GENERATED_ID_KEY =
  96             DELETE_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER  + AND + GENERATED_ID_FILTER;
  97
  98     private static final String DELETE_BY_REFERENCE_KEY =
  99             DELETE_FROM_TABLE + WHERE + PARENT_NAME_FILTER + AND + PARENT_VERSION_FILTER + AND + LOCAL_NAME_FILTER;
 100
 101     private static final String SELECT_ALL_FOR_PARENT =
 102             SELECT_FROM_TABLE + WHERE + PARENT_NAME_FILTER + AND + PARENT_VERSION_FILTER;
 103
 104     private static final String SELECT_ALL_VERSIONS_FOR_PARENT =
 105             SELECT_FROM_TABLE + WHERE + PARENT_NAME_FILTER;
 106
 107     private static final String SELECT_ALL_VERSIONS = SELECT_FROM_TABLE + WHERE + NAME_FILTER;
 108
 109     private static final String SELECT_BY_CONCEPT_KEY =
 110             SELECT_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER;
 111
 112     private static final String SELECT_BY_TIMESTAMP_NOKEY =
 113             SELECT_FROM_TABLE + WHERE + NAME_FILTER + AND + VERSION_FILTER + AND + TIMESTAMP_FILTER_NOKEY;
 114
 115     private static final String SELECT_BY_REFERENCE_KEY =
 116             SELECT_FROM_TABLE + WHERE + PARENT_NAME_FILTER + AND + PARENT_VERSION_FILTER + AND + LOCAL_NAME_FILTER;
 117     // @formatter:on
 118
 119     // Entity manager for JPA
 120     private EntityManagerFactory emf = null;
 121
 122     @Override
 123     public void init(final DaoParameters daoParameters) throws PfModelException {
 124         if (daoParameters == null || daoParameters.getPersistenceUnit() == null) {
 125             LOGGER.error("Policy Framework persistence unit parameter not set");
 126             throw new PfModelException(Response.Status.INTERNAL_SERVER_ERROR,
 127                     "Policy Framework persistence unit parameter not set");
 128         }
 129
 130         LOGGER.debug("Creating Policy Framework persistence unit \"{}\" . . .", daoParameters.getPersistenceUnit());
 131         try {
 132             emf = Persistence.createEntityManagerFactory(daoParameters.getPersistenceUnit(),
 133                     daoParameters.getJdbcProperties());
 134         } catch (final Exception ex) {
 135             String errorMessage = "Creation of Policy Framework persistence unit \""
 136                     + daoParameters.getPersistenceUnit() + "\" failed";
 137             LOGGER.warn(errorMessage);
 138             throw new PfModelException(Response.Status.INTERNAL_SERVER_ERROR, errorMessage, ex);
 139         }
 140         LOGGER.debug("Created Policy Framework persistence unit \"{}\"", daoParameters.getPersistenceUnit());
 141     }
 142
 143     /**
 144      * Gets the entity manager for this DAO.
 145      *
 146      * @return the entity manager
 147      */
 148     protected final synchronized EntityManager getEntityManager() {
 149         if (emf == null) {
 150             LOGGER.warn("Policy Framework DAO has not been initialized");
 151             throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR,
 152                     "Policy Framework DAO has not been initialized");
 153         }
 154
 155         return emf.createEntityManager();
 156     }
 157
 158     @Override
 159     public final void close() {
 160         if (emf != null) {
 161             emf.close();
 162         }
 163     }
 164
 165     @Override
 166     public <T extends PfConcept> void create(final T obj) {
 167         if (obj == null) {
 168             return;
 169         }
 170         final var mg = getEntityManager();
 171         try {
 172             mg.getTransaction().begin();
 173             mg.merge(obj);
 174             mg.getTransaction().commit();
 175         } finally {
 176             mg.close();
 177         }
 178     }
 179
 180     @Override
 181     public <T extends PfConcept> void delete(final T obj) {
 182         if (obj == null) {
 183             return;
 184         }
 185         final var mg = getEntityManager();
 186         try {
 187             mg.getTransaction().begin();
 188             mg.remove(mg.contains(obj) ? obj : mg.merge(obj));
 189             mg.getTransaction().commit();
 190         } finally {
 191             mg.close();
 192         }
 193     }
 194
 195     @Override
 196     public <T extends PfConcept> void delete(final Class<T> someClass, final PfConceptKey key) {
 197         if (key == null) {
 198             return;
 199         }
 200         final var mg = getEntityManager();
 201         try {
 202             // @formatter:off
 203             mg.getTransaction().begin();
 204             mg.createQuery(setQueryTable(DELETE_BY_CONCEPT_KEY, someClass), someClass)
 205                 .setParameter(NAME,    key.getName())
 206                 .setParameter(VERSION, key.getVersion())
 207                 .executeUpdate();
 208             mg.getTransaction().commit();
 209             // @formatter:on
 210         } finally {
 211             mg.close();
 212         }
 213     }
 214
 215     @Override
 216     public <T extends PfConcept> void delete(final Class<T> someClass, final PfReferenceKey key) {
 217         if (key == null) {
 218             return;
 219         }
 220         final var mg = getEntityManager();
 221         try {
 222             // @formatter:off
 223             mg.getTransaction().begin();
 224             mg.createQuery(setQueryTable(DELETE_BY_REFERENCE_KEY, someClass), someClass)
 225                 .setParameter(PARENT_NAME,    key.getParentKeyName())
 226                 .setParameter(PARENT_VERSION, key.getParentKeyVersion())
 227                 .setParameter(LOCAL_NAME,     key.getLocalName())
 228                 .executeUpdate();
 229             mg.getTransaction().commit();
 230             // @formatter:on
 231         } finally {
 232             mg.close();
 233         }
 234     }
 235
 236     @Override
 237     public <T extends PfConcept> void delete(final Class<T> someClass, final PfTimestampKey key) {
 238         if (key == null) {
 239             return;
 240         }
 241         final var mg = getEntityManager();
 242         try {
 243             // @formatter:off
 244             mg.getTransaction().begin();
 245             mg.createQuery(setQueryTable(DELETE_BY_TIMESTAMP_KEY, someClass), someClass)
 246                     .setParameter(NAME,    key.getName())
 247                     .setParameter(VERSION, key.getVersion())
 248                     .setParameter(TIMESTAMP, key.getTimeStamp())
 249                     .executeUpdate();
 250             mg.getTransaction().commit();
 251             // @formatter:on
 252         } finally {
 253             mg.close();
 254         }
 255     }
 256
 257     @Override
 258     public <T extends PfConcept> void delete(final Class<T> someClass, final PfGeneratedIdKey key) {
 259         if (key == null) {
 260             return;
 261         }
 262         final var mg = getEntityManager();
 263         try {
 264             // @formatter:off
 265             mg.getTransaction().begin();
 266             mg.createQuery(setQueryTable(DELETE_BY_GENERATED_ID_KEY, someClass), someClass)
 267                     .setParameter(NAME,    key.getName())
 268                     .setParameter(VERSION, key.getVersion())
 269                     .setParameter(GENERATEDID, key.getGeneratedId())
 270                     .executeUpdate();
 271             mg.getTransaction().commit();
 272             // @formatter:on
 273         } finally {
 274             mg.close();
 275         }
 276     }
 277
 278     @Override
 279     public <T extends PfConcept> void createCollection(final Collection<T> objs) {
 280         if (objs == null || objs.isEmpty()) {
 281             return;
 282         }
 283         final var mg = getEntityManager();
 284         try {
 285             mg.getTransaction().begin();
 286             for (final T t : objs) {
 287                 mg.merge(t);
 288             }
 289             mg.getTransaction().commit();
 290         } finally {
 291             mg.close();
 292         }
 293     }
 294
 295     @Override
 296     public <T extends PfConcept> void deleteCollection(final Collection<T> objs) {
 297         if (objs == null || objs.isEmpty()) {
 298             return;
 299         }
 300         final var mg = getEntityManager();
 301         try {
 302             mg.getTransaction().begin();
 303             for (final T t : objs) {
 304                 mg.remove(mg.contains(t) ? t : mg.merge(t));
 305             }
 306             mg.getTransaction().commit();
 307         } finally {
 308             mg.close();
 309         }
 310     }
 311
 312     @Override
 313     public <T extends PfConcept> int deleteByConceptKey(final Class<T> someClass, final Collection<PfConceptKey> keys) {
 314         if (keys == null || keys.isEmpty()) {
 315             return 0;
 316         }
 317         var deletedCount = 0;
 318         final var mg = getEntityManager();
 319         try {
 320             // @formatter:off
 321             mg.getTransaction().begin();
 322             for (final PfConceptKey key : keys) {
 323                 deletedCount += mg.createQuery(setQueryTable(DELETE_BY_CONCEPT_KEY, someClass), someClass)
 324                     .setParameter(NAME,    key.getName())
 325                     .setParameter(VERSION, key.getVersion())
 326                     .executeUpdate();
 327             }
 328             mg.getTransaction().commit();
 329             // @formatter:on
 330         } finally {
 331             mg.close();
 332         }
 333         return deletedCount;
 334     }
 335
 336     @Override
 337     public <T extends PfConcept> int deleteByReferenceKey(final Class<T> someClass,
 338             final Collection<PfReferenceKey> keys) {
 339         if (keys == null || keys.isEmpty()) {
 340             return 0;
 341         }
 342         var deletedCount = 0;
 343         final var mg = getEntityManager();
 344         try {
 345             // @formatter:off
 346             mg.getTransaction().begin();
 347             for (final PfReferenceKey key : keys) {
 348                 deletedCount += mg.createQuery(setQueryTable(DELETE_BY_REFERENCE_KEY, someClass), someClass)
 349                     .setParameter(PARENT_NAME,    key.getParentKeyName())
 350                     .setParameter(PARENT_VERSION, key.getParentKeyVersion())
 351                     .setParameter(LOCAL_NAME,     key.getLocalName())
 352                     .executeUpdate();
 353             }
 354             mg.getTransaction().commit();
 355             // @formatter:on
 356         } finally {
 357             mg.close();
 358         }
 359         return deletedCount;
 360     }
 361
 362     @Override
 363     public <T extends PfConcept> void deleteAll(final Class<T> someClass) {
 364         final var mg = getEntityManager();
 365         try {
 366             mg.getTransaction().begin();
 367             mg.createQuery(setQueryTable(DELETE_FROM_TABLE, someClass), someClass).executeUpdate();
 368             mg.getTransaction().commit();
 369         } finally {
 370             mg.close();
 371         }
 372     }
 373
 374     @Override
 375     public <T extends PfConcept> List<T> getFiltered(final Class<T> someClass, final String name,
 376             final String version) {
 377         if (name == null) {
 378             return getAll(someClass);
 379         }
 380
 381         if (version == null) {
 382             return getAllVersions(someClass, name);
 383         }
 384
 385         var foundConcept = get(someClass, new PfConceptKey(name, version));
 386
 387         return (foundConcept == null ? Collections.emptyList() : Collections.singletonList(foundConcept));
 388     }
 389
 390     @Override
 391     public <T extends PfConcept> List<T> getFiltered(final Class<T> someClass, PfFilterParametersIntfc filterParams) {
 392         final var mg = getEntityManager();
 393
 394         try {
 395             PfFilter filter = new PfFilterFactory().createFilter(someClass);
 396             var filterQueryString = SELECT_FROM_TABLE
 397                             + filter.genWhereClause(filterParams)
 398                             + filter.genOrderClause(filterParams);
 399
 400             TypedQuery<T> query = mg.createQuery(setQueryTable(filterQueryString, someClass), someClass);
 401             filter.setParams(query, filterParams);
 402
 403             LOGGER.debug("filterQueryString is  \"{}\"", filterQueryString);
 404             return query.getResultList();
 405         } finally {
 406             mg.close();
 407         }
 408     }
 409
 410     @Override
 411     public <T extends PfConcept> T get(final Class<T> someClass, final PfConceptKey key) {
 412         return genericGet(someClass, key);
 413     }
 414
 415     @Override
 416     public <T extends PfConcept> T get(final Class<T> someClass, final PfReferenceKey key) {
 417         return genericGet(someClass, key);
 418     }
 419
 420     @Override
 421     public <T extends PfConcept> T get(final Class<T> someClass, final PfGeneratedIdKey key) {
 422         return genericGet(someClass, key);
 423     }
 424
 425     @Override
 426     public <T extends PfConcept> T get(final Class<T> someClass, final PfTimestampKey key) {
 427         return genericGet(someClass, key);
 428     }
 429
 430     @Override
 431     public <T extends PfConcept> T get(final Class<T> someClass, final PfReferenceTimestampKey key) {
 432         return genericGet(someClass, key);
 433     }
 434
 435     private <T extends PfConcept> T genericGet(final Class<T> someClass, final Object key) {
 436         if (someClass == null) {
 437             return null;
 438         }
 439         final var mg = getEntityManager();
 440         try {
 441             final var t = mg.find(someClass, key);
 442             if (t != null) {
 443                 mg.refresh(t);
 444             }
 445             return checkAndReturn(someClass, t);
 446         } finally {
 447             mg.close();
 448         }
 449     }
 450
 451     @Override
 452     public <T extends PfConcept> List<T> getAll(final Class<T> someClass) {
 453         if (someClass == null) {
 454             return Collections.emptyList();
 455         }
 456         final var mg = getEntityManager();
 457         try {
 458             return mg.createQuery(setQueryTable(SELECT_FROM_TABLE, someClass), someClass).getResultList();
 459         } finally {
 460             mg.close();
 461         }
 462     }
 463
 464     @Override
 465     public <T extends PfConcept> List<T> getAll(final Class<T> someClass, final PfConceptKey parentKey) {
 466         if (someClass == null) {
 467             return Collections.emptyList();
 468         }
 469         final var mg = getEntityManager();
 470         try {
 471             // @formatter:off
 472             return mg.createQuery(setQueryTable(SELECT_ALL_FOR_PARENT, someClass), someClass)
 473                     .setParameter(PARENT_NAME,    parentKey.getName())
 474                     .setParameter(PARENT_VERSION, parentKey.getVersion())
 475                     .getResultList();
 476             // @formatter:on
 477         } finally {
 478             mg.close();
 479         }
 480     }
 481
 482     @Override
 483     public <T extends PfConcept> List<T> getAll(Class<T> someClass, String orderBy, Integer numRecords) {
 484
 485         if (someClass == null) {
 486             return Collections.emptyList();
 487         }
 488         final var mg = getEntityManager();
 489         try {
 490             String query = setQueryTable(SELECT_FROM_TABLE, someClass);
 491
 492             if (StringUtils.isNotBlank(orderBy)) {
 493                 query = query.concat(ORDER_BY).concat(orderBy);
 494             }
 495
 496             return mg.createQuery(query, someClass).setMaxResults(numRecords)
 497                     .getResultList();
 498         } finally {
 499             mg.close();
 500         }
 501     }
 502
 503     @Override
 504     public <T extends PfConcept> List<T> getAllVersionsByParent(final Class<T> someClass, final String parentKeyName) {
 505         if (someClass == null || parentKeyName == null) {
 506             return Collections.emptyList();
 507         }
 508         final var mg = getEntityManager();
 509         try {
 510             // @formatter:off
 511             return mg.createQuery(setQueryTable(SELECT_ALL_VERSIONS_FOR_PARENT, someClass), someClass)
 512                     .setParameter(PARENT_NAME, parentKeyName)
 513                     .getResultList();
 514             // @formatter:on
 515         } finally {
 516             mg.close();
 517         }
 518     }
 519
 520     @Override
 521     public <T extends PfConcept> List<T> getAllVersions(final Class<T> someClass, final String conceptName) {
 522         if (someClass == null || conceptName == null) {
 523             return Collections.emptyList();
 524         }
 525         final var mg = getEntityManager();
 526         try {
 527             // @formatter:off
 528             return mg.createQuery(setQueryTable(SELECT_ALL_VERSIONS, someClass), someClass)
 529                     .setParameter(NAME, conceptName)
 530                     .getResultList();
 531             // @formatter:on
 532         } finally {
 533             mg.close();
 534         }
 535     }
 536
 537     @Override
 538     public <T extends PfConcept> List<T> getByTimestamp(final Class<T> someClass, final PfGeneratedIdKey key,
 539             final Instant timeStamp) {
 540         if (someClass == null || key == null || timeStamp == null) {
 541             return Collections.emptyList();
 542         }
 543
 544         final var mg = getEntityManager();
 545         try {
 546             // @formatter:off
 547             return mg.createQuery(setQueryTable(SELECT_BY_TIMESTAMP_NOKEY, someClass), someClass)
 548                     .setParameter(NAME,    key.getName())
 549                     .setParameter(VERSION, key.getVersion())
 550                     .setParameter(TIMESTAMP, Timestamp.from(timeStamp))
 551                     .getResultList();
 552             // @formatter:on
 553         } finally {
 554             mg.close();
 555         }
 556     }
 557
 558     @Override
 559     public <T extends PfConcept> T getConcept(final Class<T> someClass, final PfConceptKey key) {
 560         if (someClass == null || key == null) {
 561             return null;
 562         }
 563         final var mg = getEntityManager();
 564         List<T> ret;
 565         try {
 566             // @formatter:off
 567             ret = mg.createQuery(setQueryTable(SELECT_BY_CONCEPT_KEY, someClass), someClass)
 568                     .setParameter(NAME,    key.getName())
 569                     .setParameter(VERSION, key.getVersion())
 570                     .getResultList();
 571             // @formatter:on
 572         } finally {
 573             mg.close();
 574         }
 575
 576         return getSingleResult(someClass, key.getId(), ret);
 577     }
 578
 579     @Override
 580     public <T extends PfConcept> T getConcept(final Class<T> someClass, final PfReferenceKey key) {
 581         if (someClass == null || key == null) {
 582             return null;
 583         }
 584         final var mg = getEntityManager();
 585         List<T> ret;
 586         try {
 587             // @formatter:off
 588             ret = mg.createQuery(setQueryTable(SELECT_BY_REFERENCE_KEY, someClass), someClass)
 589                     .setParameter(PARENT_NAME,    key.getParentKeyName())
 590                     .setParameter(PARENT_VERSION, key.getParentKeyVersion())
 591                     .setParameter(LOCAL_NAME,     key.getLocalName())
 592                     .getResultList();
 593             // @formatter:on
 594         } finally {
 595             mg.close();
 596         }
 597
 598         return getSingleResult(someClass, key.getId(), ret);
 599     }
 600
 601     @Override
 602     public <T extends PfConcept> T update(final T obj) {
 603         final var mg = getEntityManager();
 604         T ret;
 605         try {
 606             mg.getTransaction().begin();
 607             ret = mg.merge(obj);
 608             mg.flush();
 609             mg.getTransaction().commit();
 610         } finally {
 611             mg.close();
 612         }
 613         return ret;
 614     }
 615
 616     @Override
 617     public <T extends PfConcept> long size(final Class<T> someClass) {
 618         if (someClass == null) {
 619             return 0;
 620         }
 621         final var mg = getEntityManager();
 622         long size = 0;
 623         try {
 624             /*
 625              * The invoking code only passes well-known classes into this method, thus
 626              * disabling the sonar about SQL injection.
 627              */
 628             size = mg.createQuery("SELECT COUNT(c) FROM " + someClass.getSimpleName() + " c", Long.class)   // NOSONAR
 629                     .getSingleResult();
 630         } finally {
 631             mg.close();
 632         }
 633         return size;
 634     }
 635
 636     /**
 637      * Add the table to a query string.
 638      *
 639      * @param queryString the query string
 640      * @param tableClass the class name of the table
 641      * @return the updated query string
 642      */
 643     private <T extends PfConcept> String setQueryTable(final String queryString, final Class<T> tableClass) {
 644         return queryString.replace(TABLE_TOKEN, tableClass.getSimpleName());
 645     }
 646
 647     /**
 648      * Check that a query returned one and only one entry and return that entry.
 649      *
 650      * @param someClass the class being searched for
 651      * @param searchFilter the search filter
 652      * @param resultList the result list returned by the query
 653      * @return the single unique result
 654      */
 655     private <T extends PfConcept> T getSingleResult(final Class<T> someClass, final String searchFilter,
 656                     List<T> resultList) {
 657         if (resultList == null || resultList.isEmpty()) {
 658             return null;
 659         }
 660         if (resultList.size() > 1) {
 661             throw new IllegalArgumentException("More than one result was returned query on " + someClass
 662                     + " with filter " + searchFilter + ": " + resultList);
 663         }
 664         return resultList.get(0);
 665     }
 666
 667     /**
 668      * check the result get from database and return the object.
 669      *
 670      * @param <T> the type of the object to get, a subclass of {@link PfConcept}
 671      * @param someClass the class of the object to get, a subclass of {@link PfConcept}
 672      * @param objToCheck the object that was retrieved from the database
 673      * @return the checked object or null
 674      */
 675     private <T extends PfConcept> T checkAndReturn(final Class<T> someClass, final T objToCheck) {
 676         if (objToCheck != null) {
 677             try {
 678                 return PfUtils.makeCopy(objToCheck);
 679             } catch (final Exception e) {
 680                 LOGGER.warn(CLONE_ERR_MSG, someClass.getName(), e);
 681             }
 682         }
 683         return null;
 684     }
 685 }