com.gtcgroup.justify.jpa.po.internal.BaseJpaPO Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of justify-jpa Show documentation

JPA MODULE: PED Central is the home for the open-source �Justify� suite of software engineering modules. Justify seeks API alignment between Java 1.8+ application code and JUnit 5 test code.

There is a newer version: 8.5.0-alpha5

Show newest version

/*
 * [Licensed per the Open Source "MIT License".]
 *
 * Copyright (c) 2006 - 2017 by
 * Global Technology Consulting Group, Inc. at
 * http://gtcGroup.com
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
 * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
package com.gtcgroup.justify.jpa.po.internal;

import java.util.Map;

import javax.persistence.EntityManager;

import com.gtcgroup.justify.core.base.JstBasePO;
import com.gtcgroup.justify.core.exception.internal.JustifyRuntimeException;
import com.gtcgroup.justify.jpa.helper.JstEntityManagerFactoryCacheHelper;

/**
 * This Parameter Object base class supports queries and transactions using a
 * Resource Manager.
 *
 * 
 * Copyright (c) 2006 - 2017 by Global Technology Consulting Group, Inc. at
 * gtcGroup.com .
 * 
 *
 * @author Marvin Toll
 * @since v.6.2
 */
public abstract class BaseJpaPO extends JstBasePO {

	protected boolean suppressExceptionForNull = false;

	protected EntityManager entityManager;

	protected boolean entityManagerNeedsToBeClosed = false;

	protected String persistenceUnitName;

	protected Map persistencePropertyMapOrNull = null;

	protected boolean suppressForceDatabaseTrip = false;

	/**
	 * Constructor
	 */
	protected BaseJpaPO(final boolean suppressExceptionForNull) {

		super();
		this.suppressExceptionForNull = suppressExceptionForNull;
		return;
	}

	/**
	 * This method closes the {@link EntityManager} if the creation is
	 * encapsulated within this PO.
	 */
	public void closeEntityManagerIfCreatedWithPersistenceUnitName() {

		if (this.entityManagerNeedsToBeClosed) {
			JstEntityManagerFactoryCacheHelper.closeEntityManager(this.entityManager);
		}
	}

	/**
	 * @return {@link EntityManager}
	 */
	public EntityManager getEntityManager() {

		if (!isEntityManager()) {

			throw new JustifyRuntimeException("A persistence unit name, or entity manager, was not entered.");
		}

		return this.entityManager;
	}

	/**
	 * @return boolean
	 */
	protected boolean isEntityManager() {
		return null != this.entityManager;
	}

	/**
	 * @return boolean
	 */
	public boolean isSuppressExceptionForNull() {
		return this.suppressExceptionForNull;
	}

	/**
	 * @return boolean
	 */
	public boolean isSuppressForceDatabaseTrip() {
		return this.suppressForceDatabaseTrip;
	}

	/**
	 * @return {@link BaseJpaPO}
	 */
	public BaseJpaPO withSuppressForceDatabaseTrip(final boolean suppressForceDatabaseTrip) {

		this.suppressForceDatabaseTrip = suppressForceDatabaseTrip;
		return this;
	}

	/**
	 * @return {@link BaseJpaPO}
	 */
	public BaseJpaPO withPersistenceUnitName(final String persistenceUnitName) {

		this.persistenceUnitName = persistenceUnitName;
		this.entityManager = JstEntityManagerFactoryCacheHelper.createEntityManagerToBeClosed(persistenceUnitName);
		
		return this;
	}

	/**
	 * @return {@link BaseJpaPO}
	 */
	public BaseJpaPO withEntityManager(EntityManager entityManager) {

		this.entityManager = entityManager;
		return this;
	}

	/**
	 * @return {@link BaseJpaPO}
	 */
	public BaseJpaPO withPersistencePropertyMap(Map persistencePropertyMap) {

		this.persistencePropertyMapOrNull = persistencePropertyMap;
		return this;
	}
}