EDIT

// $Id$

/**

* Copyright (C) 2009 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.api.facade;

import java.util.UUID;

import org.apache.log4j.Logger;

import eu.etaxonomy.cdm.common.CdmUtils;

import eu.etaxonomy.cdm.model.agent.Institution;

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

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

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

import eu.etaxonomy.cdm.model.location.NamedArea;

import eu.etaxonomy.cdm.model.occurrence.Collection;

import eu.etaxonomy.cdm.model.occurrence.DerivedUnitBase;

import eu.etaxonomy.cdm.strategy.StrategyBase;

import eu.etaxonomy.cdm.strategy.cache.common.IIdentifiableEntityCacheStrategy;

/**

 * @author a.mueller

 * @date 03.06.2010

 *

 */

public class DerivedUnitFacadeCacheStrategy extends StrategyBase implements IIdentifiableEntityCacheStrategy<DerivedUnitBase> {

	private static final long serialVersionUID = 1578628591216605619L;

	@SuppressWarnings("unused")

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

	private static final UUID uuid = UUID.fromString("df4672c1-ce5c-4724-af6d-91e2b326d4a4");

	/* (non-Javadoc)

	 * @see eu.etaxonomy.cdm.strategy.StrategyBase#getUuid()

	 */

	@Override

	protected UUID getUuid() {

		return uuid;

	}

	private boolean includeEmptySeconds = false;

	private boolean includeReferenceSystem = true;

	/* (non-Javadoc)

	 * @see eu.etaxonomy.cdm.strategy.cache.common.IIdentifiableEntityCacheStrategy#getTitleCache(eu.etaxonomy.cdm.model.common.IdentifiableEntity)

	 */

	@Override

	public String getTitleCache(DerivedUnitBase derivedUnit) {

		String ALTITUDE_PREFIX = "alt. ";

		String ALTITUDE_POSTFIX = " m";

		String result = "";

		DerivedUnitFacade facade;

		try {

			facade = DerivedUnitFacade.NewInstance(derivedUnit);

			//country

			String strCountry = null;

			NamedArea country = facade.getCountry();

			Representation repCountry = country == null ? null : country.getRepresentation(Language.DEFAULT());

			//TODO currently the label is the 3 digit representation of the country and text is the full text.

			//this is against the common way of handling text, label and labelabbrev in defined terms

			strCountry = repCountry == null ? null: repCountry.getText();

			result = CdmUtils.concat(", ", result, strCountry);

			// FIXME hasGatheringEvent needed;

			//locality

			result = CdmUtils.concat(", ", result, facade.getLocalityText());

			//elevation

			if (facade.getAbsoluteElevation() != null){

				result = CdmUtils.concat(", " , result, ALTITUDE_PREFIX);

				result += facade.getAbsoluteElevation() + ALTITUDE_POSTFIX;

			}

			//exact locality

			if (facade.getExactLocation() != null){

				String exactLocation = facade.getExactLocation().toSexagesimalString(this.includeEmptySeconds, this.includeReferenceSystem);

				result = CdmUtils.concat(", ", result, exactLocation);

			}

			//ecology

			result = CdmUtils.concat(", ", result, facade.getEcology());

			//gathering period

			//TODO period.toString ??

			TimePeriod gatheringPeriod = facade.getGatheringPeriod();

			result = CdmUtils.concat(", ", result, (gatheringPeriod == null? null : gatheringPeriod.toString()));

			//Herbarium & accession number

			String code = getCode(facade);

			String collectionData = CdmUtils.concat(" ", code, facade.getAccessionNumber());

			if (CdmUtils.isNotEmpty(collectionData)) {

				result = (result + " (" +  collectionData + ")").trim();

			}

			//plant description

			result = CdmUtils.concat("; ", result, facade.getPlantDescription());

			if (CdmUtils.isNotEmpty(result)){

				result += ".";

			}

		} catch (DerivedUnitFacadeNotSupportedException e) {

			e.printStackTrace();

		}

		return result;

	}

	/**

	 * @param facade

	 */

	private String getCode(DerivedUnitFacade facade) {

		String code = "";

		if(facade.getCollection() != null){			

			code = facade.getCollection().getCode();

			if (CdmUtils.isEmpty(code)){

				Institution institution = facade.getCollection().getInstitute();

				if (institution != null){

					code = institution.getCode();

				}

				if (CdmUtils.isEmpty(code)){

					Collection superCollection = facade.getCollection().getSuperCollection();

					if (superCollection != null){

						code = superCollection.getCode();

					}

				}

			}

		} 

		return code;

	}

// ************************** GETTER / SETTER ******************************************************

	public boolean isIncludeSeconds() {

		return includeEmptySeconds;

	}

	public void setIncludeSeconds(boolean includeSeconds) {

		this.includeEmptySeconds = includeSeconds;

	}

	public void setIncludeReferenceSystem(boolean includeReferenceSystem) {

		this.includeReferenceSystem = includeReferenceSystem;

	}

	public boolean isIncludeReferenceSystem() {

		return includeReferenceSystem;

	}

}