Java tutorial
/************************************************************************************************* * This file is part of ISPyB. * * ISPyB is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * ISPyB is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public License * along with ISPyB. If not, see <http://www.gnu.org/licenses/>. * * Contributors : S. Delageniere, R. Leal, L. Launer, K. Levik, S. Veyrier, P. Brenchereau, M. Bodin, A. De Maria Antolinos ****************************************************************************************************/ package ispyb.server.mx.daos.collections; import ispyb.server.mx.vos.collections.DataCollectionGroup3VO; import java.util.List; import javax.ejb.Stateless; import javax.persistence.EntityManager; import javax.persistence.NoResultException; import javax.persistence.PersistenceContext; import org.apache.log4j.Logger; import org.hibernate.Criteria; import org.hibernate.FetchMode; import org.hibernate.Session; import org.hibernate.criterion.Order; import org.hibernate.criterion.Restrictions; /** * <p> * The data access object for DataCollectionGroup3 objects (rows of table DataCollectionGroup). * </p> * * @see {@link DataCollectionGroup3DAO} */ @Stateless public class DataCollectionGroup3DAOBean implements DataCollectionGroup3DAO { private final static Logger LOG = Logger.getLogger(DataCollectionGroup3DAOBean.class); // Generic HQL request to find instances of DataCollectionGroup3 by pk private static final String FIND_BY_PK(boolean fetchDataCollection, boolean fetchScreening) { return "from DataCollectionGroup3VO vo " + (fetchDataCollection ? "left join fetch vo.dataCollectionVOs " : "") + (fetchScreening ? "left join fetch vo.screeningVOs " : "") + "where vo.dataCollectionGroupId = :pk"; } // Generic HQL request to find all instances of DataCollectionGroup3 private static final String FIND_ALL(boolean fetchDataCollection) { return "from DataCollectionGroup3VO vo " + (fetchDataCollection ? "left join fetch vo.dataCollectionVOs " : ""); } @PersistenceContext(unitName = "ispyb_db") private EntityManager entityManager; /* Creation/Update methods ---------------------------------------------- */ /** * <p> * Insert the given value object. TODO update this comment for insertion details. * </p> */ public void create(DataCollectionGroup3VO vo) throws Exception { this.checkAndCompleteData(vo, true); this.entityManager.persist(vo); } /** * <p> * Update the given value object. TODO update this comment for update details. * </p> */ public DataCollectionGroup3VO update(DataCollectionGroup3VO vo) throws Exception { this.checkAndCompleteData(vo, false); return entityManager.merge(vo); } /* Deletion methods ----------------------------------------------------- */ /** * <p> * Deletes the given value object. * </p> * * @param vo * the value object to delete. */ public void delete(DataCollectionGroup3VO vo) { entityManager.remove(vo); } /* Find methods --------------------------------------------------------- */ /** * <p> * Returns the DataCollectionGroup3VO instance matching the given primary key. * </p> * <p> * <u>Please note</u> that the booleans to fetch relationships are needed <u>ONLY</u> if the value object has to be * used out the EJB container. * </p> * * @param pk * the primary key of the object to load. * @param fetchRelation1 * if true, the linked instances by the relation "relation1" will be set. * @param fetchRelation2 * if true, the linked instances by the relation "relation2" will be set. */ public DataCollectionGroup3VO findByPk(Integer pk, boolean fetchDataCollection, boolean fetchScreening) { try { return (DataCollectionGroup3VO) entityManager .createQuery(FIND_BY_PK(fetchDataCollection, fetchScreening)).setParameter("pk", pk) .getSingleResult(); } catch (NoResultException e) { return null; } } /** * <p> * Returns the DataCollectionGroup3VO instances. * </p> * <p> * <u>Please note</u> that the booleans to fetch relationships are needed <u>ONLY</u> if the value object has to be * used out the EJB container. * </p> * * @param fetchRelation1 * if true, the linked instances by the relation "relation1" will be set. * @param fetchRelation2 * if true, the linked instances by the relation "relation2" will be set. */ @SuppressWarnings("unchecked") public List<DataCollectionGroup3VO> findAll(boolean fetchDataCollection) { return entityManager.createQuery(FIND_ALL(fetchDataCollection)).getResultList(); } /* Private methods ------------------------------------------------------ */ /** * Checks the data for integrity. E.g. if references and categories exist. * * @param vo * the data to check * @param create * should be true if the value object is just being created in the DB, this avoids some checks like * testing the primary key * @exception VOValidateException * if data is not correct */ private void checkAndCompleteData(DataCollectionGroup3VO vo, boolean create) throws Exception { if (create) { if (vo.getDataCollectionGroupId() != null) { throw new IllegalArgumentException( "Primary key is already set! This must be done automatically. Please, set it to null!"); } } else { if (vo.getDataCollectionGroupId() == null) { throw new IllegalArgumentException("Primary key is not set for update!"); } } // check value object vo.checkValues(create); // TODO check primary keys for existence in DB } @SuppressWarnings("unchecked") public List<DataCollectionGroup3VO> findFiltered(Integer sessionId, boolean fetchDataCollection, boolean fetchScreening, Integer workflowId, Integer blSampleId) { List<DataCollectionGroup3VO> resultList; Session session = (Session) this.entityManager.getDelegate(); Criteria crit = session.createCriteria(DataCollectionGroup3VO.class); crit.setResultTransformer(Criteria.DISTINCT_ROOT_ENTITY); // DISTINCT RESULTS ! if (sessionId != null) { Criteria subCritSession = crit.createCriteria("sessionVO"); subCritSession.add(Restrictions.eq("sessionId", sessionId)); } if (fetchDataCollection) { crit.setFetchMode("dataCollectionVOs", FetchMode.JOIN); } if (fetchScreening) { crit.setFetchMode("screeningVOs", FetchMode.JOIN); } if (workflowId != null) { Criteria subCritWorkflow = crit.createCriteria("workflowVO"); subCritWorkflow.add(Restrictions.eq("workflowId", workflowId)); } if (blSampleId != null) { Criteria subCritSample = crit.createCriteria("blSampleVO"); subCritSample.add(Restrictions.eq("blSampleId", blSampleId)); } crit.addOrder(Order.desc("startTime")); resultList = crit.list(); // TODO understand why crit.setMaxResults does not work ??? return resultList; } }