EDIT

// $Id$

/**

* Copyright (C) 2007 EDIT

* European Distributed Institute of Taxonomy 

* http://www.e-taxonomy.eu

* 

* The contents of this file are subject to the Mozilla Public License Version 1.1

* See LICENSE.TXT at the top of this package for the full license terms.

*/

package eu.etaxonomy.cdm.io.common.mapping;

import java.sql.ResultSet;

import java.sql.SQLException;

import java.util.Set;

import org.apache.log4j.Logger;

import eu.etaxonomy.cdm.common.CdmUtils;

import eu.etaxonomy.cdm.io.common.DbImportStateBase;

import eu.etaxonomy.cdm.model.common.CdmBase;

import eu.etaxonomy.cdm.model.common.DescriptionElementSource;

import eu.etaxonomy.cdm.model.description.DescriptionElementBase;

import eu.etaxonomy.cdm.model.description.TaxonDescription;

import eu.etaxonomy.cdm.model.reference.ReferenceBase;

import eu.etaxonomy.cdm.model.taxon.Synonym;

import eu.etaxonomy.cdm.model.taxon.Taxon;

import eu.etaxonomy.cdm.model.taxon.TaxonBase;

/**

 * @author a.mueller

 * @created 11.03.2010

 * @version 1.0

 */

public abstract class DbImportDescriptionElementCreationMapperBase<ELEMENT extends DescriptionElementBase, STATE extends DbImportStateBase<?,?>> extends DbImportObjectCreationMapperBase<ELEMENT, STATE> {

	private static final Logger logger = Logger.getLogger(DbImportDescriptionElementCreationMapperBase.class);

//******************************* ATTRIBUTES ***************************************/

	protected String taxonNamespace;

	protected String dbTaxonFkAttribute;

	protected boolean isImageGallery = false;

	protected String dbCitationAttribute;  //if there is a single source available

	protected String sourceNamespace;

	protected String dbMicroCitationAttribute;

//********************************* CONSTRUCTOR ****************************************/

	/**

	 * @param mappingImport

	 */

	protected DbImportDescriptionElementCreationMapperBase(String dbIdAttribute, String objectToCreateNamespace, String dbTaxonFkAttribute, String taxonNamespace) {

		super(dbIdAttribute, objectToCreateNamespace);

		this.taxonNamespace = taxonNamespace;

		this.dbTaxonFkAttribute = dbTaxonFkAttribute;

	}

//************************************ METHODS *******************************************/

	public DbImportDescriptionElementCreationMapperBase setSource(String dbCitationAttribute, String sourceNamespace, String dbMicroCitationAttribute){

		this.dbCitationAttribute = dbCitationAttribute;

		this.sourceNamespace = sourceNamespace;

		this.dbMicroCitationAttribute = dbMicroCitationAttribute;

		return this;

	}

	/* (non-Javadoc)

	 * @see eu.etaxonomy.cdm.io.common.mapping.IDbImportMapper#invoke(java.sql.ResultSet, eu.etaxonomy.cdm.model.common.CdmBase)

	 */

	@Override

	protected ELEMENT doInvoke(ResultSet rs, ELEMENT element) throws SQLException {

		Taxon taxon = getAcceptedTaxon(rs);

		if (taxon != null){

			addDescriptionElement(taxon, element);

		}else{

			logger.info("Taxon could not be determined. Description element was not add to any description or taxon");

		}

		//Source

		if (CdmUtils.isNotEmpty(dbCitationAttribute)){

			addSource(rs, element);

		}

		return element;

	}

	/**

	 * @param rs

	 * @param element

	 * @throws SQLException 

	 */

	private void addSource(ResultSet rs, ELEMENT element) throws SQLException {

		String microCitation = getStringDbValue(rs, dbMicroCitationAttribute);

		ReferenceBase citation = (ReferenceBase) getState().getRelatedObject(sourceNamespace, String.valueOf(rs.getObject(dbCitationAttribute)));

		element.addSource(null, null, citation, microCitation);

	}

	/**

	 * @param taxonFk

	 * @return

	 * @throws SQLException 

	 */

	protected Taxon getAcceptedTaxon(ResultSet rs) throws SQLException {

		String taxonFk = getForeignKey(rs, dbTaxonFkAttribute);

		TaxonBase taxonBase = (TaxonBase)getRelatedObject(taxonNamespace, taxonFk);

		Taxon taxon = null;

		if (taxonBase == null){

			logger.warn("TaxonBase not found: " + taxonFk);

		}else if (taxonBase instanceof Taxon){

			taxon = (Taxon)taxonBase;

		}else if (taxonBase instanceof Synonym){

			Synonym synonym = CdmBase.deproxy(taxonBase, Synonym.class);

			Set<Taxon> taxa = synonym.getAcceptedTaxa();

			if (taxa.size() == 0){

				logger.warn("Synonym '" + synonym.getTitleCache() + "' ("+ taxonFk + ") has no accepted taxon. Can't define a taxon to add the description element to");

			}else if (taxa.size() == 1){

				taxon = taxa.iterator().next();

			}else{

				logger.warn("Synonym '" + synonym.getTitleCache() + "' ("+ taxonFk + ") has more than one accepted taxon. Can't decide which one to take");

			}

		}else{ //null

			throw new IllegalStateException("TaxonBase must either be null, Taxon or Synonym but was something else");

		}

		return taxon;

	}

	/**

	 * Adds a description element to the taxon's first description which is not an image gallery.

	 * If no such description exists a new one is generated. Returns the element or, if null if taxon is null.

	 * @param taxon

	 * @param element

	 */

	protected ELEMENT addDescriptionElement(Taxon taxon, ELEMENT element) {

		if (taxon == null){

			return null;

		}else{

			TaxonDescription description = getTaxonDescription(taxon, isImageGallery);

			description.addElement(element);

			return element;

		}

	}

	/**

	 * @param taxon

	 * @return

	 */

	protected TaxonDescription getTaxonDescription(Taxon taxon, boolean isImageGallery) {

		Set<TaxonDescription> descriptions = taxon.getDescriptions();

		TaxonDescription description = null;

		if (descriptions.size() > 0){

			for (TaxonDescription desc : descriptions){

				if ( desc.isImageGallery() == isImageGallery ){

					description = desc;

					break;

				}

			}

		}

		if (description == null){

			description = TaxonDescription.NewInstance(taxon, isImageGallery);

		}

		return description;

	}

}