org.jboss.seam.framework.EntityQuery Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jboss-seam Show documentation
Seam core module for Seam framework integrated with JSF2
There is a newer version: 3.2.26.ayg
package org.jboss.seam.framework;

import java.util.List;
import java.util.Map;

import javax.persistence.EntityManager;
import javax.persistence.NonUniqueResultException;
import javax.persistence.PersistenceContext;
import javax.transaction.SystemException;

import org.jboss.seam.annotations.Transactional;
import org.jboss.seam.persistence.PersistenceProvider;
import org.jboss.seam.persistence.QueryParser;
import org.jboss.seam.persistence.PersistenceProvider.Feature;
import org.jboss.seam.transaction.Transaction;

/**
 * A Query object for JPA.
 * 
 * @author Gavin King
 *
 */
public class EntityQuery extends Query {

	private static final long serialVersionUID = 1L;
	private List resultList;
	private E singleResult;
	private Long resultCount;
	private Map hints;

	/**
	* Validate the query
	* 
	* @throws IllegalStateException if the query is not valid
	*/
	@Override
	public void validate() {
		super.validate();
		if (getEntityManager() == null) {
			throw new IllegalStateException("entityManager is null");
		}

		if (!PersistenceProvider.instance().supportsFeature(Feature.WILDCARD_AS_COUNT_QUERY_SUBJECT)) {
			setUseWildcardAsCountQuerySubject(false);
		}
	}

	@Override
	@Transactional
	public boolean isNextExists() {
		return getResultCount() > (getFirstResult() != null ? getFirstResult() : 0) + getMaxResults();
	}

	/**
	* Get the list of results this query returns
	* 
	* Any changed restriction values will be applied
	*/
	@Transactional
	@Override
	public List getResultList() {
		if (isAnyParameterDirty()) {
			refresh();
		}
		initResultList();
		return truncResultList(resultList);
	}

	@SuppressWarnings("unchecked")
	private void initResultList() {
		if (resultList == null) {
			javax.persistence.Query query = createQuery();
			resultList = query == null ? null : query.getResultList();
		}
	}

	/**
	* Get a single result from the query
	* 
	* Any changed restriction values will be applied
	* 
	* @throws NonUniqueResultException if there is more than one result
	*/
	@Transactional
	@Override
	public E getSingleResult() {
		if (isAnyParameterDirty()) {
			refresh();
		}
		initSingleResult();
		return singleResult;
	}

	@SuppressWarnings("unchecked")
	private void initSingleResult() {
		if (singleResult == null) {
			javax.persistence.Query query = createQuery();
			singleResult = (E) (query == null ? null : query.getSingleResult());
		}
	}

	/**
	* Get the number of results this query returns
	* 
	* Any changed restriction values will be applied
	*/
	@Transactional
	@Override
	public Long getResultCount() {
		if (isAnyParameterDirty()) {
			refresh();
		}
		initResultCount();
		return resultCount;
	}

	private void initResultCount() {
		if (resultCount == null) {
			javax.persistence.Query query = createCountQuery();
			resultCount = query == null ? null : (Long) query.getSingleResult();
		}
	}

	/**
	* The refresh method will cause the result to be cleared.  The next access
	* to the result set will cause the query to be executed.
	* 
	* This method does not cause the ejbql or restrictions to reread.
	* If you want to update the ejbql or restrictions you must call 
	* {@link #setEjbql(String)} or {@link #setRestrictions(List)}
	*/
	@Override
	public void refresh() {
		super.refresh();
		resultCount = null;
		resultList = null;
		singleResult = null;
	}

	public EntityManager getEntityManager() {
		return getPersistenceContext();
	}

	public void setEntityManager(EntityManager entityManager) {
		setPersistenceContext(entityManager);
	}

	@Override
	protected String getPersistenceContextName() {
		final PersistenceContext ctx = getClass().getAnnotation(PersistenceContext.class);
		if (ctx != null) {
			return ctx.name();
		}
		return "entityManager";
	}

	protected javax.persistence.Query createQuery() {
		parseEjbql();

		evaluateAllParameters();

		joinTransaction();

		javax.persistence.Query query = getEntityManager().createQuery(getRenderedEjbql());
		setParameters(query, getQueryParameterValues(), 0);
		setParameters(query, getRestrictionParameterValues(), getQueryParameterValues().size());
		if (getFirstResult() != null) {
			query.setFirstResult(getFirstResult());
		}
		if (getMaxResults() != null) {
			query.setMaxResults(getMaxResults());
		}
		if (getHints() != null) {
			for (Map.Entry me : getHints().entrySet()) {
				query.setHint(me.getKey(), me.getValue());
			}
		}
		return query;
	}

	protected javax.persistence.Query createCountQuery() {
		parseEjbql();

		evaluateAllParameters();

		joinTransaction();

		javax.persistence.Query query = getEntityManager().createQuery(getCountEjbql());
		setParameters(query, getQueryParameterValues(), 0);
		setParameters(query, getRestrictionParameterValues(), getQueryParameterValues().size());
		return query;
	}

	private void setParameters(javax.persistence.Query query, List