MeasurementAbstractInterceptor

package fr.ifremer.quadrige2.synchro.intercept.data.measurement;

/*-
 * #%L
 * Quadrige2 Core :: Quadrige2 Synchro 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.eventbus.Subscribe;
import fr.ifremer.common.synchro.dao.SynchroBaseDao;
import fr.ifremer.common.synchro.dao.SynchroTableDao;
import fr.ifremer.common.synchro.intercept.SynchroInterceptorBase;
import fr.ifremer.common.synchro.intercept.SynchroOperationRepository;
import fr.ifremer.common.synchro.meta.SynchroJoinMetadata;
import fr.ifremer.common.synchro.meta.SynchroTableMetadata;
import fr.ifremer.common.synchro.meta.event.LoadJoinEvent;
import fr.ifremer.common.synchro.meta.event.LoadTableEvent;
import fr.ifremer.quadrige2.core.exception.Quadrige2TechnicalException;
import fr.ifremer.quadrige2.core.dao.technical.Daos;
import fr.ifremer.quadrige2.synchro.intercept.data.AbstractDataInterceptor;
import fr.ifremer.quadrige2.synchro.meta.DatabaseColumns;
import fr.ifremer.quadrige2.synchro.meta.data.DataSynchroTables;
import fr.ifremer.quadrige2.synchro.meta.referential.ReferentialSynchroTables;
import fr.ifremer.quadrige2.synchro.service.SynchroDirection;
import fr.ifremer.quadrige2.synchro.service.data.DataSynchroDatabaseConfiguration;

import java.io.IOException;
import java.math.BigDecimal;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.List;

/**
 * <p>
 * Abstract MeasurementAbstractInterceptor class.
 * </p>
 *
 */
public abstract class MeasurementAbstractInterceptor extends AbstractDataInterceptor {

	private boolean enableIntegrityConstraints = true;

	private String selectParentIdFromSamplingOperIdQuery;
	private String selectRemoteIdAndParentIdsFromSampleIdQuery;
	private String selectPmfmQuery;
	private String selectRemoteIdBySurveyIdQuery;
	private String selectRemoteIdBySamplingOperIdQuery;
	private String selectRemoteIdBySampleIdQuery;
	private PreparedStatement selectParentIdFromSamplingOperIdStatement = null;
	private PreparedStatement selectRemoteIdAndParentIdsFromSampleIdStatement = null;

	private int surveyIdIndex = -1;
	private int samplingOperIdIndex = -1;
	private int sampleIdIndex = -1;
	private int pmfmIdIndex = -1;
	private int parCdIndex = -1;
	private int matrixIdIndex = -1;
	private int fractionIdIndex = -1;
	private int methodIdIndex = -1;
	private int objectIdIndex = -1;
	private int measDigitNumberIndex = -1;
	private int measNumerValueIndex = -1;
	private final String measDigitNumberColumnName;
	private final String measNumerValueColumnName;
	private SynchroDirection direction;

	public MeasurementAbstractInterceptor() {
		this(null, null);
	}

	/**
	 * <p>
	 * Constructor for MeasurementAbstractInterceptor.
	 * </p>
	 * @param measDigitNumberColumnName
	 * @param measNumerValueColumnName
	 */
	public MeasurementAbstractInterceptor(String measDigitNumberColumnName, String measNumerValueColumnName) {
		super();
		setEnableOnWrite(true);
		this.selectParentIdFromSamplingOperIdQuery = initSelectRemoteIdAndParentIdFromSamplingOperIdQuery();
		this.selectRemoteIdAndParentIdsFromSampleIdQuery = initSelectRemoteIdAndParentIdFromSampleIdQuery();
		this.selectPmfmQuery = initSelectPmfm();
		this.selectRemoteIdBySurveyIdQuery = initSelectRemoteId(DataSynchroTables.SURVEY.name(), DatabaseColumns.SURVEY_ID.name());
		this.selectRemoteIdBySamplingOperIdQuery = initSelectRemoteId(DataSynchroTables.SAMPLING_OPERATION.name(),
				DatabaseColumns.SAMPLING_OPER_ID.name());
		this.selectRemoteIdBySampleIdQuery = initSelectRemoteId(DataSynchroTables.SAMPLE.name(), DatabaseColumns.SAMPLE_ID.name());
		this.measDigitNumberColumnName = measDigitNumberColumnName;
		this.measNumerValueColumnName = measNumerValueColumnName;
	}

	/** {@inheritDoc} */
	@Override
	public void init(DataSynchroDatabaseConfiguration config) {
		super.init(config);
		this.direction = config.getDirection();
		this.enableIntegrityConstraints = direction == SynchroDirection.EXPORT_TEMP2SERVER
				|| direction == SynchroDirection.IMPORT_TEMP2LOCAL;
	}

	/** {@inheritDoc} */
	@Override
	public SynchroInterceptorBase clone() {
		MeasurementAbstractInterceptor newBean = (MeasurementAbstractInterceptor) super.clone();
		newBean.direction = this.direction;
		newBean.enableIntegrityConstraints = this.enableIntegrityConstraints;
		newBean.selectParentIdFromSamplingOperIdQuery = this.selectParentIdFromSamplingOperIdQuery;
		newBean.selectRemoteIdAndParentIdsFromSampleIdQuery = this.selectRemoteIdAndParentIdsFromSampleIdQuery;
		newBean.selectPmfmQuery = this.selectPmfmQuery;
		newBean.selectRemoteIdBySurveyIdQuery = this.selectRemoteIdBySurveyIdQuery;
		newBean.selectRemoteIdBySamplingOperIdQuery = this.selectRemoteIdBySamplingOperIdQuery;
		newBean.selectRemoteIdBySampleIdQuery = this.selectRemoteIdBySampleIdQuery;

		newBean.surveyIdIndex = this.surveyIdIndex;
		newBean.samplingOperIdIndex = this.samplingOperIdIndex;
		newBean.sampleIdIndex = this.sampleIdIndex;
		newBean.pmfmIdIndex = this.pmfmIdIndex;
		newBean.parCdIndex = this.parCdIndex;
		newBean.matrixIdIndex = this.matrixIdIndex;
		newBean.fractionIdIndex = this.fractionIdIndex;
		newBean.methodIdIndex = this.methodIdIndex;
		newBean.objectIdIndex = this.objectIdIndex;
		newBean.measDigitNumberIndex = this.measDigitNumberIndex;
		newBean.measNumerValueIndex = this.measNumerValueIndex;
		return newBean;
	}

	/**
	 * <p>
	 * handleJoinLoad.
	 * </p>
	 *
	 * @param e
	 *            a {@link fr.ifremer.common.synchro.meta.event.LoadJoinEvent} object.
	 */
	@Subscribe
	public void handleJoinLoad(LoadJoinEvent e) {
		SynchroJoinMetadata join = e.join;
		// Do not apply if mirror database
		if (!join.isValid()) {
			return;
		}

		SynchroTableMetadata pkTable = join.getPkTable();
		String pkTableName = pkTable.getName();
		SynchroDirection direction = getConfig().getDirection();

		// IMPORT: Server DB -> Temp DB
		if (direction == SynchroDirection.IMPORT_SERVER2TEMP) {

			// Only keep link to SURVEY (survey_id)
			if (DataSynchroTables.SAMPLING_OPERATION.name().equalsIgnoreCase(pkTableName)
					|| DataSynchroTables.SAMPLE.name().equalsIgnoreCase(pkTableName)) {

				join.setIsValid(false);
			}
		}
	}

	/**
	 * <p>
	 * handleTableLoad.
	 * </p>
	 *
	 * @param e
	 *            a {@link fr.ifremer.common.synchro.meta.event.LoadTableEvent} object.
	 */
	@Subscribe
	public void handleTableLoad(LoadTableEvent e) {
		SynchroTableMetadata table = e.table;

		surveyIdIndex = table.getSelectColumnIndex(DatabaseColumns.SURVEY_ID.name());
		samplingOperIdIndex = table.getSelectColumnIndex(DatabaseColumns.SAMPLING_OPER_ID.name());
		sampleIdIndex = table.getSelectColumnIndex(DatabaseColumns.SAMPLE_ID.name());
		pmfmIdIndex = table.getSelectColumnIndex(DatabaseColumns.PMFM_ID.name());
		parCdIndex = table.getSelectColumnIndex(DatabaseColumns.PAR_CD.name());
		matrixIdIndex = table.getSelectColumnIndex(DatabaseColumns.MATRIX_ID.name());
		fractionIdIndex = table.getSelectColumnIndex(DatabaseColumns.FRACTION_ID.name());
		methodIdIndex = table.getSelectColumnIndex(DatabaseColumns.METHOD_ID.name());
		objectIdIndex = table.getSelectColumnIndex(DatabaseColumns.OBJECT_ID.name());
		if (measNumerValueColumnName != null) measNumerValueIndex = table.getSelectColumnIndex(measNumerValueColumnName);
		if (measDigitNumberColumnName != null) measDigitNumberIndex = table.getSelectColumnIndex(measDigitNumberColumnName);

		// EXPORT: Temp DB -> Server DB
		if (direction == SynchroDirection.EXPORT_TEMP2SERVER) {

			// When select by SURVEY_ID, some other ID should be NULL
			table.addSelectByFksWhereClause(DatabaseColumns.SURVEY_ID.name(),
					String.format("t.%s IS NULL AND t.%s IS NULL",
							DatabaseColumns.SAMPLING_OPER_ID.name(),
							DatabaseColumns.SAMPLE_ID.name()));

			// When select by SAMPLING_OPER_ID, SAMPLE_ID should be NULL
			table.addSelectByFksWhereClause(DatabaseColumns.SAMPLING_OPER_ID.name(),
					String.format("t.%s IS NULL",
							DatabaseColumns.SAMPLE_ID.name()));
		}
	}

	/** {@inheritDoc} */
	@Override
	protected void doOnWrite(Object[] data, List<Object> pk, SynchroTableDao sourceDao, SynchroTableDao targetDao, SynchroOperationRepository buffer,
			boolean insert)
			throws SQLException {

		// IMPORT: Server DB -> Temp DB
		if (direction == SynchroDirection.IMPORT_SERVER2TEMP) {
			// delete surveyId if samplingOperId is set
			if (data[samplingOperIdIndex] != null) {
				data[surveyIdIndex] = null;
			}

			// delete samplingOperId if sampleId is set
			if (data[sampleIdIndex] != null) {
				data[samplingOperIdIndex] = null;
			}
		}

		// EXPORT: Local DB -> Temp DB
		else if (direction == SynchroDirection.EXPORT_LOCAL2TEMP) {

			if (data[pmfmIdIndex] != null) {
				long pmfmId = Long.parseLong(data[pmfmIdIndex].toString());

				// Fill back PMFM parts
				List<Object> pmfmParts = getPmfmParts(sourceDao, pmfmId);

				data[parCdIndex] = pmfmParts.get(0);
				data[matrixIdIndex] = Long.parseLong(pmfmParts.get(1).toString());
				data[fractionIdIndex] = Long.parseLong(pmfmParts.get(2).toString());
				data[methodIdIndex] = Long.parseLong(pmfmParts.get(3).toString());

			}

			// Make sure precision is valid (workaround for mantis #37438)
			// A better solution can be to user BigDecimal in Hib mapping
			if (measNumerValueIndex != -1 && measDigitNumberIndex != -1) {
				BigDecimal measNumerValue = (BigDecimal) data[measNumerValueIndex];
				if (measNumerValue != null && data[measDigitNumberIndex] != null) {
					Double measDigitNumber = Double.parseDouble(data[measDigitNumberIndex].toString());
					data[measNumerValueIndex] = Daos.convertToBigDecimal(measNumerValue, measDigitNumber.intValue());
				}
			}
		}

		// EXPORT: Temp DB -> Server DB
		else if (direction == SynchroDirection.EXPORT_TEMP2SERVER) {
			// Make sure the objectId is rewrite with remote identifier
			{
				Number objectId;

				// If parent object is a sample
				if (data[sampleIdIndex] != null) {
					Long localSampleId = Long.parseLong(data[sampleIdIndex].toString());
					Number[] ids = getRemoteIdAndParentIdFromSampleId(sourceDao, localSampleId);
					objectId = ids[0];
					data[surveyIdIndex] = ids[1];
					data[samplingOperIdIndex] = ids[2];
				}

				// If parent object is a sampling operation
				else if (data[samplingOperIdIndex] != null) {
					Long localSamplingOperId = Long.parseLong(data[samplingOperIdIndex].toString());
					Number[] ids = getRemoteIdAndParentIdFromSamplingOperId(sourceDao, localSamplingOperId);
					objectId = ids[0];
					data[surveyIdIndex] = ids[1];
				}

				// If parent is survey
				else if (data[surveyIdIndex] != null) {
					objectId = getRemoteIdFromSurveyId(sourceDao, Long.parseLong(data[surveyIdIndex].toString()));
				}

				// Else (should never append)
				else {
					throw new Quadrige2TechnicalException("Measurement found, without any parent filled. This should never append.");
				}

				data[objectIdIndex] = objectId;
			}
		}
	}

	/* -- Internal methods -- */

	/**
	 * <p>
	 * initSelectRemoteIdAndParentIdFromSamplingOperIdQuery.
	 * </p>
	 *
	 * @return a {@link java.lang.String} object.
	 */
	protected String initSelectRemoteIdAndParentIdFromSamplingOperIdQuery() {
		return String.format("select %s, %s from %s where %s = ?",
				DatabaseColumns.REMOTE_ID.name(),
				DatabaseColumns.SURVEY_ID.name(),
				DataSynchroTables.SAMPLING_OPERATION.name(),
				DatabaseColumns.SAMPLING_OPER_ID.name()
				);
	}

	/**
	 * <p>
	 * initSelectRemoteIdAndParentIdFromSampleIdQuery.
	 * </p>
	 *
	 * @return a {@link java.lang.String} object.
	 */
	protected String initSelectRemoteIdAndParentIdFromSampleIdQuery() {
		return String.format("select %s, %s, %s from %s where %s = ?",
				DatabaseColumns.REMOTE_ID.name(),
				DatabaseColumns.SURVEY_ID.name(),
				DatabaseColumns.SAMPLING_OPER_ID.name(),
				DataSynchroTables.SAMPLE.name(),
				DatabaseColumns.SAMPLE_ID.name()
				);
	}

	/**
	 * <p>
	 * initSelectPmfm.
	 * </p>
	 *
	 * @return a {@link java.lang.String} object.
	 */
	protected String initSelectPmfm() {
		return String.format("select %s || '%s' || %s || '%s' || %s || '%s' || %s from %s where %s = ?",
				DatabaseColumns.PAR_CD.name(),
				SynchroTableMetadata.PK_SEPARATOR,
				DatabaseColumns.MATRIX_ID.name(),
				SynchroTableMetadata.PK_SEPARATOR,
				DatabaseColumns.FRACTION_ID.name(),
				SynchroTableMetadata.PK_SEPARATOR,
				DatabaseColumns.METHOD_ID.name(),
				ReferentialSynchroTables.PMFM.name(),
				DatabaseColumns.PMFM_ID.name()
				);
	}

	/**
	 * <p>
	 * initSelectRemoteId.
	 * </p>
	 *
	 * @param tableName
	 *            a {@link java.lang.String} object.
	 * @param pkColumnName
	 *            a {@link java.lang.String} object.
	 * @return a {@link java.lang.String} object.
	 */
	protected String initSelectRemoteId(String tableName, String pkColumnName) {
		return String.format("select %s from %s where %s = ?",
				DatabaseColumns.REMOTE_ID.name(),
				tableName,
				pkColumnName);
	}

	/**
	 * <p>
	 * getRemoteIdAndParentIdFromSamplingOperId.
	 * </p>
	 *
	 * @param dao
	 *            a {@link fr.ifremer.common.synchro.dao.SynchroBaseDao} object.
	 * @param samplingOperId
	 *            a long.
	 * @return an array of {@link java.lang.Number} objects.
	 * @throws java.sql.SQLException
	 *             if any.
	 */
	protected Number[] getRemoteIdAndParentIdFromSamplingOperId(SynchroBaseDao dao, long samplingOperId) throws SQLException {
		if (selectParentIdFromSamplingOperIdStatement == null || selectParentIdFromSamplingOperIdStatement.isClosed()) {
			selectParentIdFromSamplingOperIdStatement = dao.getPreparedStatement(selectParentIdFromSamplingOperIdQuery);
		}
		selectParentIdFromSamplingOperIdStatement.setLong(1, samplingOperId);
		ResultSet resultSet = null;
		try {
			resultSet = selectParentIdFromSamplingOperIdStatement.executeQuery();
			if (!resultSet.next()) {
				return null;
			}
			Number remoteId = null;
			if (resultSet.getObject(1) != null) {
				remoteId = (Number) resultSet.getObject(1);
			}
			Number surveyId = null;
			if (resultSet.getObject(2) != null) {
				surveyId = (Number) resultSet.getObject(2);
			}
			return new Number[] { remoteId, surveyId };
		} finally {
			Daos.closeSilently(resultSet);
		}
	}

	/**
	 * <p>
	 * getRemoteIdAndParentIdFromSampleId.
	 * </p>
	 *
	 * @param dao
	 *            a {@link fr.ifremer.common.synchro.dao.SynchroBaseDao} object.
	 * @param sampleId
	 *            a long.
	 * @return an array of {@link java.lang.Number} objects.
	 * @throws java.sql.SQLException
	 *             if any.
	 */
	protected Number[] getRemoteIdAndParentIdFromSampleId(SynchroBaseDao dao, long sampleId) throws SQLException {
		if (selectRemoteIdAndParentIdsFromSampleIdStatement == null || selectRemoteIdAndParentIdsFromSampleIdStatement.isClosed()) {
			selectRemoteIdAndParentIdsFromSampleIdStatement = dao.getPreparedStatement(selectRemoteIdAndParentIdsFromSampleIdQuery);
		}

		selectRemoteIdAndParentIdsFromSampleIdStatement.setLong(1, sampleId);
		ResultSet resultSet = null;
		try {
			resultSet = selectParentIdFromSamplingOperIdStatement.executeQuery();
			if (!resultSet.next()) {
				return null;
			}
			Number remoteId = null;
			if (resultSet.getObject(1) != null) {
				remoteId = (Number) resultSet.getObject(1);
			}
			Number surveyId = null;
			if (resultSet.getObject(2) != null) {
				surveyId = (Number) resultSet.getObject(2);
			}
			Number samplingOperId = null;
			if (resultSet.getObject(3) != null) {
				samplingOperId = (Number) resultSet.getObject(3);
			}

			return new Number[] { remoteId, surveyId, samplingOperId };
		} finally {
			Daos.closeSilently(resultSet);
		}
	}

	/**
	 * <p>
	 * getPmfmParts.
	 * </p>
	 *
	 * @param dao
	 *            a {@link fr.ifremer.common.synchro.dao.SynchroBaseDao} object.
	 * @param pmfmId
	 *            a long.
	 * @return a {@link java.util.List} object.
	 * @throws java.sql.SQLException
	 *             if any.
	 */
	protected List<Object> getPmfmParts(SynchroBaseDao dao, long pmfmId) throws SQLException {
		String resultStr = dao.getUniqueTyped(selectPmfmQuery, new Object[] { pmfmId });
		return SynchroTableMetadata.fromPkStr(resultStr);
	}

	/**
	 * <p>
	 * getRemoteIdFromSurveyId.
	 * </p>
	 *
	 * @param dao
	 *            a {@link fr.ifremer.common.synchro.dao.SynchroBaseDao} object.
	 * @param surveyId
	 *            a long.
	 * @return a {@link java.lang.Number} object.
	 * @throws java.sql.SQLException
	 *             if any.
	 */
	protected Number getRemoteIdFromSurveyId(SynchroBaseDao dao, long surveyId) throws SQLException {
		Number result = dao.getUniqueTyped(selectRemoteIdBySurveyIdQuery, new Object[] { surveyId });
		return result;
	}

	/** {@inheritDoc} */
	@Override
	protected void doClose() throws IOException {
		super.doClose();

		// Close first statement
		Daos.closeSilently(selectParentIdFromSamplingOperIdStatement);
		selectParentIdFromSamplingOperIdStatement = null;

		// Close second statement
		Daos.closeSilently(selectRemoteIdAndParentIdsFromSampleIdStatement);
		selectRemoteIdAndParentIdsFromSampleIdStatement = null;
	}
}