com.gtcgroup.justify.jpa.po.JstQueryAllJPO 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.
The newest version!
/*
 * [Licensed per the Open Source "MIT License".]
 *
 * Copyright (c) 2006 - 2018 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.jpa.po.internal.BaseQueryPO;

/**
 * This Parameter Object class supports finding all entities from a table or
 * view.
 *
 * 
 * Copyright (c) 2006 - 2018 by Global Technology Consulting Group, Inc. at
 * gtcGroup.com .
 * 
 *
 * @author Marvin Toll
 * @since v.6.2
 */
public class JstQueryAllJPO extends BaseQueryPO {

	/**
	 * This method initializes the class.
	 *
	 * @return {@link JstQueryAllJPO}
	 */
	public static JstQueryAllJPO withPersistenceUnitName(final String persistenceUnitName) {

		return new JstQueryAllJPO(persistenceUnitName);
	}

	/**
	 * @return {@link TypedQuery}
	 */
	protected static  TypedQuery createCriteriaQuery(final EntityManager entityManager,
			final Class resultClass) {

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

		return entityManager.createQuery(criteria);
	}

	/**
	 * Constructor
	 */
	protected JstQueryAllJPO(final String persistenceUnitName) {

		super(persistenceUnitName);
		return;
	}

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

		return createCriteriaQuery(getEntityManager(), getEntityClass());
	}

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

		setEntityClass(entityClass);
		return this;
	}

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

		super.setEntityManager(entityManager);
		return this;
	}

	/**
	 * @return {@link JstQueryAllJPO}
	 */
	public JstQueryAllJPO withForceDatabaseTripWhenNoCacheCoordination() {

		super.setForceDatabaseTripWhenNoCacheCoordination();
		return this;
	}

	/**
	 * @return {@link JstQueryAllJPO}
	 */
	public JstQueryAllJPO withQueryHint(final String key, final Object value) {

		super.setQueryHint(key, value);
		return this;
	}

	/**
	 * @return {@link JstQueryAllJPO}
	 */
	public JstQueryAllJPO withReadOnly() {

		super.setReadOnly();
		return this;
	}
}