package fr.ifremer.quadrige3.core.dao.data.survey;
   
   /*-
    * #%L
    * Quadrige3 Core :: Quadrige3 Client Core
    * $Id:$
    * $HeadURL:$
    * %%
    * Copyright (C) 2017 Ifremer
   * %%
   * This program is free software: you can redistribute it and/or modify
   * it under the terms of the GNU Affero General Public License as published by
   * the Free Software Foundation, either version 3 of the License, or
   * (at your option) any later version.
   * 
   * This program 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 General Public License for more details.
   * 
   * You should have received a copy of the GNU Affero General Public License
   * along with this program.  If not, see <http://www.gnu.org/licenses/>.
   * #L%
   */
  
  import com.google.common.collect.Lists;
  import fr.ifremer.quadrige3.core.dao.ObjectTypes;
  import fr.ifremer.quadrige3.core.dao.administration.program.Program;
  import fr.ifremer.quadrige3.core.dao.data.measurement.Measurement;
  import fr.ifremer.quadrige3.core.dao.data.measurement.MeasurementExtendDao;
  import fr.ifremer.quadrige3.core.dao.data.measurement.TaxonMeasurement;
  import fr.ifremer.quadrige3.core.dao.data.measurement.TaxonMeasurementExtendDao;
  import fr.ifremer.quadrige3.core.dao.data.samplingoperation.SamplingOperation;
  import fr.ifremer.quadrige3.core.dao.referential.monitoringLocation.MonitoringLocation;
  import fr.ifremer.quadrige3.core.dao.system.synchronization.DeletedItemHistoryExtendDao;
  import fr.ifremer.quadrige3.core.dao.system.synchronization.SynchronizationStatus;
  import fr.ifremer.quadrige3.core.dao.technical.Assert;
  import fr.ifremer.quadrige3.core.dao.technical.Daos;
  import fr.ifremer.quadrige3.core.vo.administration.program.ProgramVO;
  import fr.ifremer.quadrige3.core.vo.data.survey.LightSurveyVO;
  import fr.ifremer.quadrige3.core.vo.referential.monitoringLocation.MonitoringLocationVO;
  import fr.ifremer.quadrige3.synchro.meta.data.DataSynchroTables;
  import org.apache.commons.collections4.CollectionUtils;
  import org.apache.commons.logging.Log;
  import org.apache.commons.logging.LogFactory;
  import org.hibernate.Query;
  import org.hibernate.Session;
  import org.hibernate.SessionFactory;
  import org.hibernate.type.IntegerType;
  import org.hibernate.type.StringType;
  import org.springframework.beans.factory.annotation.Autowired;
  import org.springframework.stereotype.Repository;
  
  import javax.annotation.Resource;
  import java.util.Collection;
  import java.util.List;
  import java.util.Set;
  
  /**
   * <p>
   * SurveyDaoImpl class.
   * </p>
   * 
   */
  @Repository("surveyDao")
  public class SurveyDaoImpl extends SurveyDaoBase implements SurveyExtendDao {
  
  	/**
  	 * Logger.
  	 */
  	private static final Log log = LogFactory.getLog(SurveyDaoImpl.class);
  
  	private static final Set<String> surveyObjectTypesCodes = ObjectTypes.getObjectTypeFromTableName(DataSynchroTables.SURVEY.name());
  
  	private static final String[] SYNCHRONIZATION_STATUS_NOT_EXPORTED = new String[] {
  			SynchronizationStatus.DIRTY.getValue(),
  			SynchronizationStatus.READY_TO_SYNCHRONIZE.getValue()
  	};
  
  	@Resource
  	private DeletedItemHistoryExtendDao deletedItemHistoryDao;
  
  	@Resource
  	private MeasurementExtendDao measurementDao;
  
  	@Resource
  	private TaxonMeasurementExtendDao taxonMeasurementDao;
  
  	/**
  	 * <p>
  	 * Constructor for SurveyDaoImpl.
  	 * </p>
  	 * 
  	 * @param sessionFactory
  	 *            a {@link org.hibernate.SessionFactory} object.
  	 */
  	@Autowired
  	public SurveyDaoImpl(SessionFactory sessionFactory) {
  		super();
 		setSessionFactory(sessionFactory);
 	}
 
 	/** {@inheritDoc} */
 	@Override
 	public LightSurveyVO getLightSurveyById(int surveyId) {
 
 		// Load entity by id
 		Survey source = get(surveyId);
 		if (source == null)
 			return null;
 
 		return toLightSurveyVO(source);
 	}
 
 	/** {@inheritDoc} */
 	@Override
 	public void removeUsingDeletedItemHistory(int surveyId, Integer recorderPersonId) {
 		// Load entity by id
 		Survey survey = get(surveyId);
 		boolean hasBeenSynchronized = (survey.getRemoteId() != null);
 
 		// in classic remove AND with deletedItemHistory
 
 		// If entity is not in server: do a classic remove
 		if (!hasBeenSynchronized) {
 			remove(survey.getSurveyId());
 			return;
 		}
 
 		Assert.notNull(recorderPersonId, "Argument 'recorderPersonId' must not be null");
 
 		// Add a record into DeletedItemHistory
 		deletedItemHistoryDao.insertDeletedItem(
 				SurveyImpl.class,
 				survey,
 				recorderPersonId);
 
 		// Change synchronization status to DELETED
 		survey.setSynchronizationStatus(SynchronizationStatus.DELETED.getValue());
 		getSession().save(survey);
 	}
 
 	/** {@inheritDoc} */
 	@Override
 	public void removeByIds(Collection<Integer> ids) {
 		for (Integer id : ids) {
 			remove(id);
 		}
 	}
 
 	/** {@inheritDoc} */
 	@Override
 	public int updateSynchronizationStatus(int surveyId, SynchronizationStatus synchronizationStatus) {
 		return updateSynchronizationStatus(Lists.newArrayList(surveyId), synchronizationStatus);
 	}
 
 	/** {@inheritDoc} */
 	@Override
 	public int updateSynchronizationStatus(List<Integer> surveyIds, SynchronizationStatus synchronizationStatus) {
 		Assert.notNull(synchronizationStatus);
 		return queryUpdate("updateSurveySynchronizationStatus",
 				"surveyIds", null, surveyIds,
 				"synchronizationStatus", StringType.INSTANCE, synchronizationStatus.getValue());
 	}
 
 	/** {@inheritDoc} */
 	@Override
 	public int updateHasMeasFlag(int surveyId) {
 		return updateHasMeasFlag(Lists.newArrayList(surveyId));
 	}
 
 	/** {@inheritDoc} */
 	@Override
 	public int updateHasMeasFlag(List<Integer> surveyIds) {
 		Assert.notEmpty(surveyIds);
 
 		if (log.isDebugEnabled()) {
 			log.debug(String.format("Updating HAS_MEAS flag on surveys: %s", surveyIds.toString()));
 		}
 		int rowCount = 0;
 
 		// get surveys WITH meas
 		final List<Integer> surveyIdsWithMeas = queryListTyped("surveyIdsWithMeas",
 				"surveyIds", null, surveyIds);
 		boolean hasSurveysWithMeas = CollectionUtils.isNotEmpty(surveyIdsWithMeas);
 
 		// get surveys WITHOUT meas
 		List<Integer> surveyIdsNoMeas;
 		if (!hasSurveysWithMeas) {
 			surveyIdsNoMeas = surveyIds;
 		}
 		else {
 			// remove surveyIdsNoMeas from the input list
 			surveyIdsNoMeas = Lists.newArrayList(surveyIds);
 			surveyIdsNoMeas.removeAll(surveyIdsWithMeas);
 		}
 
 		// Update surveys WITH meas
 		if (hasSurveysWithMeas) {
 			rowCount += queryUpdate("updateSurveyHasMeas",
 					"surveyHasMeas", StringType.INSTANCE, Daos.convertToString(true),
 					"surveyIds", null, surveyIdsWithMeas);
 		}
 
 		// Update surveys WITHOUT meas
 		if (CollectionUtils.isNotEmpty(surveyIdsNoMeas)) {
 			rowCount += queryUpdate("updateSurveyHasMeas",
 					"surveyHasMeas", StringType.INSTANCE, Daos.convertToString(false),
 					"surveyIds", null, surveyIdsNoMeas);
 		}
 
 		return rowCount;
 	}
 
 	/** {@inheritDoc} */
 	@Override
 	public boolean isReadyToSynchronizeStatusForRecorderPerson(int recorderPersonId) {
 
 		// TODO: add also DELETED ITEMS !!!!!!!!!!!
 
 		// count observed locations
 		Long nb = queryUniqueTyped("countSurveyBySynchronizationStatus",
 				"recorderPersonId", IntegerType.INSTANCE, recorderPersonId,
 				"synchronizationStatus", StringType.INSTANCE, SynchronizationStatus.READY_TO_SYNCHRONIZE.value());
 
 		return nb > 0;
 	}
 
 	/** {@inheritDoc} */
 	@Override
 	@SuppressWarnings("unchecked")
 	public List<Integer> getCleanableSurveyIds() {
 		Query query = createQuery("cleanableSurveyIds",
 				"syncSynchronizationStatus", StringType.INSTANCE, SynchronizationStatus.SYNCHRONIZED.value());
 		query.setParameterList("objectTypes", surveyObjectTypesCodes);
 
 		return (List<Integer>) query.list();
 	}
 
 	@Override
 	public void applySurveyProgramsToChildren(int surveyId) {
 		// Get the survey
 		Survey survey = get(SurveyImpl.class, surveyId);
 		Assert.size(survey.getPrograms(), 1);
 
 		List<Integer> samplingOperIds = Lists.newArrayList();
 
 		// Update sampling operations prog
 		Session session = getSession();
 		for (SamplingOperation so: survey.getSamplingOperations()) {
 			so.getPrograms().clear();
 			so.getPrograms().addAll(survey.getPrograms());
 			session.update(so);
 
 			samplingOperIds.add(so.getSamplingOperId());
 		}
 
 		// Update survey measurements
 		{
 			// Measurements
 			List<Measurement> measurements = measurementDao.loadBySurveyId(surveyId);
 			for (Measurement m: measurements) {
 				m.getPrograms().clear();
 				m.getPrograms().addAll(survey.getPrograms());
 				session.update(m);
 			}
 			// Taxon measurements
 			List<TaxonMeasurement> taxonMeasurements = taxonMeasurementDao.loadBySurveyId(surveyId);
 			for (TaxonMeasurement m: taxonMeasurements) {
 				m.getPrograms().clear();
 				m.getPrograms().addAll(survey.getPrograms());
 				session.update(m);
 			}
 		}
 
 		// Update sampling operation measurements
 		if (CollectionUtils.isNotEmpty(samplingOperIds)){
 			// Measurements
 			List<Measurement> measurements = measurementDao.loadBySamplingOperIds(samplingOperIds);
 			for (Measurement m: measurements) {
 				m.getPrograms().clear();
 				m.getPrograms().addAll(survey.getPrograms());
 				session.update(m);
 			}
 			// Taxon measurements
 			List<TaxonMeasurement> taxonMeasurements = taxonMeasurementDao.loadBySamplingOperIds(samplingOperIds);
 			for (TaxonMeasurement m: taxonMeasurements) {
 				m.getPrograms().clear();
 				m.getPrograms().addAll(survey.getPrograms());
 				session.update(m);
 			}
 
 			// TODO (if sample used in a client application): update measurements on sample
 		}
 
 	}
 
 	/* -- Internal methods -- */
 
 	/**
 	 * <p>
 	 * toLightSurveyVO.
 	 * </p>
 	 * 
 	 * @param source
 	 *            a {@link fr.ifremer.quadrige3.core.dao.data.survey.Survey} object.
 	 * @return a {@link fr.ifremer.quadrige3.core.vo.data.survey.LightSurveyVO} object.
 	 */
 	protected LightSurveyVO toLightSurveyVO(Survey source) {
 		LightSurveyVO target = new LightSurveyVO();
 
 		toLightSurveyVO(source, target);
 
 		return target;
 	}
 
 	/**
 	 * <p>
 	 * toLightSurveyVO.
 	 * </p>
 	 * 
 	 * @param source
 	 *            a {@link fr.ifremer.quadrige3.core.dao.data.survey.Survey} object.
 	 * @param target
 	 *            a {@link fr.ifremer.quadrige3.core.vo.data.survey.LightSurveyVO} object.
 	 */
 	protected void toLightSurveyVO(Survey source, LightSurveyVO target) {
 
 		// survey date
 		target.setSurveyDt(source.getSurveyDt());
 
 		// monitoring location
 		if (source.getMonitoringLocation() == null) {
 			target.setMonitoringLocation(null);
 		}
 		else {
 			target.setMonitoringLocation(toMonitoringLocationVO(source.getMonitoringLocation()));
 		}
 
 		// programs
 		if (CollectionUtils.isEmpty(source.getPrograms())) {
 			target.setPrograms(null);
 		}
 		else {
 			List<ProgramVO> programList = Lists.newArrayList();
 			for (Program program : source.getPrograms()) {
 				ProgramVO vo = toProgramVO(program);
 				programList.add(vo);
 			}
 			target.setPrograms(programList.toArray(new ProgramVO[programList.size()]));
 		}
 	}
 
 	/**
 	 * <p>
 	 * toMonitoringLocationVO.
 	 * </p>
 	 * 
 	 * @param source
 	 *            a {@link fr.ifremer.quadrige3.core.dao.referential.monitoringLocation.MonitoringLocation} object.
 	 * @return a {@link fr.ifremer.quadrige3.core.vo.referential.monitoringLocation.MonitoringLocationVO} object.
 	 */
 	protected MonitoringLocationVO toMonitoringLocationVO(MonitoringLocation source) {
 		MonitoringLocationVO target = new MonitoringLocationVO();
 
 		// id
 		target.setId(source.getMonLocId());
 
 		// label
 		target.setLabel(source.getMonLocLb());
 
 		// name
 		target.setName(source.getMonLocNm());
 
 		return target;
 	}
 
 	/**
 	 * <p>
 	 * toProgramVO.
 	 * </p>
 	 * 
 	 * @param source
 	 *            a {@link fr.ifremer.quadrige3.core.dao.administration.program.Program} object.
 	 * @return a {@link fr.ifremer.quadrige3.core.vo.administration.program.ProgramVO} object.
 	 */
 	protected ProgramVO toProgramVO(Program source) {
 		ProgramVO target = new ProgramVO();
 
 		// code
 		target.setProgCd(source.getProgCd());
 
 		// name
 		target.setProgNm(source.getProgNm());
 
 		return target;
 	}
 
 }