com.gtcgroup.justify.jpa.po.JstFindAllJpaPO 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;

import javax.persistence.EntityManager;
import javax.persistence.Query;
import javax.persistence.TypedQuery;
import javax.persistence.criteria.CriteriaQuery;
import javax.persistence.criteria.Root;

import com.gtcgroup.justify.core.exception.internal.JustifyRuntimeException;
import com.gtcgroup.justify.jpa.po.internal.BaseQueryJpaPO;

/**
 * This Parameter Object class supports finding all entities.
 *
 * 
 * Copyright (c) 2006 - 2017 by Global Technology Consulting Group, Inc. at
 * gtcGroup.com .
 * 
 *
 * @author Marvin Toll
 * @since v.6.2
 */
public class JstFindAllJpaPO extends BaseQueryJpaPO {

	/**
	 * This method initializes the class.
	 *
	 * @return {@link JstFindAllJpaPO}
	 */
	public static JstFindAllJpaPO withFindAll() {

		return new JstFindAllJpaPO(false);
	}

	/**
	 * This method initializes the class.
	 *
	 * @return {@link JstFindAllJpaPO}
	 */
	public static JstFindAllJpaPO withFindAll(final boolean suppressExceptionForNull) {

		return new JstFindAllJpaPO(suppressExceptionForNull);
	}

	protected Class entityClass;

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

		super(suppressExceptionForNull);
		return;
	}

	/**
	 * @return {@link TypedQuery}
	 */
	protected  TypedQuery createCriteriaQuery(final Class resultClass) {

		final CriteriaQuery criteriaQuery = getEntityManager().getCriteriaBuilder().createQuery(resultClass);
		final Root rootEntry = criteriaQuery.from(resultClass);
		final CriteriaQuery criteria = criteriaQuery.select(rootEntry);

		return getEntityManager().createQuery(criteria);
	}

	/**
	 * @return {@link Query}
	 */
	@Override
	public Query getQuery() {

		if (null == this.query) {

			if (isResultClass()) {
				try {
					this.query = createCriteriaQuery(getEntityClass());
				} catch (final Exception e) {
					throw new JustifyRuntimeException(e);
				}
			} else {
				throw new JustifyRuntimeException(
						"Verify that a result class is defined in the PO [" + this.getClass().getName() + "].");
			}

		}
		return this.query;
	}

	/**
	 * @return {@link Class}
	 */
	@SuppressWarnings("unchecked")
	public  Class getEntityClass() {

		return (Class) this.entityClass;
	}

	/**
	 * @return boolean
	 */
	public boolean isResultClass() {

		return null != this.entityClass;
	}

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

		return (JstFindAllJpaPO) super.withEntityManager(entityManager);
	}

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

		return (JstFindAllJpaPO) super.withPersistenceUnitName(persistenceUnitName);
	}

	/**
	 * @return {@link JstFindAllJpaPO}
	 */
	public  JstFindAllJpaPO withEntityClass(final Class entityClass) {

		this.entityClass = entityClass;
		return this;
	}

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

		return (JstFindAllJpaPO) super.withSuppressForceDatabaseTrip(suppressForceDatabaseTrip);
	}
}