package fr.ifremer.quadrige2.synchro.intercept.referential;
   
   /*-
    * #%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.intercept.SynchroInterceptorBase;
  import fr.ifremer.common.synchro.meta.SynchroTableMetadata;
  import fr.ifremer.common.synchro.meta.event.CreateQueryEvent;
  import fr.ifremer.common.synchro.meta.event.LoadTableEvent;
  import fr.ifremer.common.synchro.query.SynchroQueryBuilder;
  import fr.ifremer.common.synchro.query.SynchroQueryName;
  import fr.ifremer.common.synchro.query.SynchroQueryOperator;
  import fr.ifremer.quadrige2.core.dao.referential.StatusCode;
  import fr.ifremer.quadrige2.synchro.meta.DatabaseColumns;
  import fr.ifremer.quadrige2.synchro.meta.referential.ReferentialSynchroTables;
  import fr.ifremer.quadrige2.synchro.service.SynchroDirection;
  import fr.ifremer.quadrige2.synchro.service.referential.ReferentialSynchroDatabaseConfiguration;
  import org.apache.commons.collections4.CollectionUtils;
  import org.apache.commons.logging.Log;
  import org.apache.commons.logging.LogFactory;
  
  import java.util.Set;
  
  /**
   * Manage table TAXON_REFERENCE :
   * <ul>
   * <li>Define this table as a root table, even if filtering on status</li>
   * <li>If filtering on a local status, then add a where clause 'REF_TAXON_ID &lt; 0'</li>
   * </ul>
   * 
   * @author Benoit Lavenier <benoit.lavenier@e-is.pro>
   * @since 1.0
   */
  public class ReferenceTaxonInterceptor extends AbstractReferentialInterceptor {
  
  	private static final Log log = LogFactory.getLog(ReferenceTaxonInterceptor.class);
  
  	private String localOnlyWhereClause;
  
  	/**
  	 * <p>
  	 * Constructor for ReferenceTaxonInterceptor.
  	 * </p>
  	 */
  	public ReferenceTaxonInterceptor() {
  		super(ReferentialSynchroTables.REFERENCE_TAXON.name());
  	}
  
  	/** {@inheritDoc} */
  	@Override
  	protected void init(ReferentialSynchroDatabaseConfiguration config) {
  		localOnlyWhereClause = createLocalOnlyWhereClause(config);
  	}
  
  	/** {@inheritDoc} */
  	@Override
  	public SynchroInterceptorBase clone() {
  		ReferenceTaxonInterceptor result = (ReferenceTaxonInterceptor) super.clone();
  		result.localOnlyWhereClause = this.localOnlyWhereClause;
  		return result;
  	}
  
  	/**
  	 * <p>
  	 * handleQuery.
  	 * </p>
  	 * 
  	 * @param e
  	 *            a {@link fr.ifremer.common.synchro.meta.event.CreateQueryEvent} object.
  	 */
  	@Subscribe
  	public void handleQuery(CreateQueryEvent e) {
  
  		switch (e.queryName) {
  		case count:
  		case countFromUpdateDate:
  		case select:
  		case selectFromUpdateDate:
 		case selectMaxUpdateDate:
 			// Add restriction
 			e.sql = addRestriction(e.source, e.queryName, e.sql);
 
 		default:
 			break;
 		}
 	}
 
 	/**
 	 * <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;
 		SynchroDirection direction = getConfig().getDirection();
 
 		// Set has root (if not already done by ReferentialTableInterceptor)
 		if (!table.isRoot()
 				&& localOnlyWhereClause != null) {
 			table.setRoot(true);
 		}
 	}
 
 	/* -- Internal methods -- */
 
 	/**
 	 * <p>
 	 * createLocalOnlyWhereClause.
 	 * </p>
 	 * 
 	 * @param config
 	 *            a {@link fr.ifremer.quadrige2.synchro.service.referential.ReferentialSynchroDatabaseConfiguration}
 	 *            object.
 	 * @return a {@link java.lang.String} object.
 	 */
 	protected String createLocalOnlyWhereClause(ReferentialSynchroDatabaseConfiguration config) {
 
 		Set<String> statusCodeIncludes = config.getStatusCodeIncludes();
 		if (CollectionUtils.isEmpty(statusCodeIncludes)
 				|| (!statusCodeIncludes.contains(StatusCode.LOCAL_DISABLE.getValue())
 				&& !statusCodeIncludes.contains(StatusCode.LOCAL_ENABLE.getValue()))) {
 			return null;
 		}
 
 		// Filter on ID, because this table does NOT have a STATUS_CD
 		return String.format("t.%s < 0",
 				DatabaseColumns.REF_TAXON_ID);
 	}
 
 	/**
 	 * <p>
 	 * addRestriction.
 	 * </p>
 	 * 
 	 * @param table
 	 *            a {@link fr.ifremer.common.synchro.meta.SynchroTableMetadata} object.
 	 * @param queryName
 	 *            a {@link fr.ifremer.common.synchro.query.SynchroQueryName} object.
 	 * @param sql
 	 *            a {@link java.lang.String} object.
 	 * @return a {@link java.lang.String} object.
 	 */
 	protected String addRestriction(SynchroTableMetadata table, SynchroQueryName queryName, String sql) {
 
 		// where: add status filter
 		if (localOnlyWhereClause == null) {
 			return sql;
 		}
 
 		SynchroQueryBuilder queryBuilder = SynchroQueryBuilder.newBuilder(sql);
 		queryBuilder.addWhere(SynchroQueryOperator.AND, localOnlyWhereClause);
 
 		return queryBuilder.build();
 	}
 
 }