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.taxeditor.model;

import java.lang.reflect.InvocationTargetException;

import java.lang.reflect.Method;

import java.util.Arrays;

import java.util.List;

import java.util.Set;

import org.apache.commons.lang.StringUtils;

import org.hibernate.LazyInitializationException;

import eu.etaxonomy.cdm.api.service.DefaultCategoricalDescriptionBuilder;

import eu.etaxonomy.cdm.api.service.DefaultQuantitativeDescriptionBuilder;

import eu.etaxonomy.cdm.api.service.DescriptionBuilder;

import eu.etaxonomy.cdm.common.CdmUtils;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

import eu.etaxonomy.cdm.model.media.Media;

import eu.etaxonomy.cdm.model.name.HomotypicalGroup;

import eu.etaxonomy.cdm.model.name.HybridRelationship;

import eu.etaxonomy.cdm.model.name.NameRelationship;

import eu.etaxonomy.cdm.model.name.NameTypeDesignation;

import eu.etaxonomy.cdm.model.name.SpecimenTypeDesignation;

import eu.etaxonomy.cdm.model.name.TaxonNameBase;

import eu.etaxonomy.cdm.model.name.TypeDesignationBase;

import eu.etaxonomy.cdm.model.name.TypeDesignationStatusBase;

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

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

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

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

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

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

import eu.etaxonomy.taxeditor.store.CdmStore;

/**

 * <p>DescriptionHelper class.</p>

 *

 * @author p.ciardelli

 * @author n.hoffmann

 * @created 02.04.2009

 */

public class DescriptionHelper {

	/**

	 * Returns whatever the element's title cache equivalent is,

	 * depending on its class.

	 *

	 * @param element a {@link eu.etaxonomy.cdm.model.description.DescriptionElementBase} object.

	 * @param language a {@link eu.etaxonomy.cdm.model.common.Language} object.

	 * @return a {@link java.lang.String} object.

	 */

	public static String getCache(DescriptionElementBase element,

			Language language) {

		String mainElementLabel= null;

		DescriptionBase<?> descr = element.getInDescription();

		if (descr != null){

			if (descr.isInstanceOf(TaxonDescription.class)){

				Taxon taxon = CdmBase.deproxy(descr, TaxonDescription.class).getTaxon();

				if (taxon != null){

					mainElementLabel = taxon.getTitleCache();

				}

			}else if (descr.isInstanceOf(SpecimenDescription.class)){

				SpecimenOrObservationBase<?> specimen = CdmBase.deproxy(descr, SpecimenDescription.class).getDescribedSpecimenOrObservation();

				if (specimen != null){

					mainElementLabel = specimen.getTitleCache();

				}

			}else if (descr.isInstanceOf(TaxonNameDescription.class)){

				TaxonNameBase<?, ?> name = CdmBase.deproxy(descr, TaxonNameDescription.class).getTaxonName();

				if (name != null){

					mainElementLabel = name.getTitleCache();

				}

			}

		}

		String cache = null;

		if (element instanceof TextData) {

			cache = ((TextData) element).getText(language);

		}

		if (element instanceof CommonTaxonName) {

			cache = ((CommonTaxonName) element).getName();

		}

		if (element instanceof TaxonInteraction) {

			Taxon taxon2 = ((TaxonInteraction) element).getTaxon2();

			if(taxon2 != null && taxon2.getName() != null){

				cache = taxon2.getName().getTitleCache();

			}else{

				cache = "No taxon chosen";

			}

		}

		if (element instanceof Distribution) {

			Distribution distribution = (Distribution) element;

			NamedArea area = distribution.getArea();

			if(area != null){

				cache =  area.getLabel();

				PresenceAbsenceTerm status = distribution.getStatus();

				if (status == null){

					cache += ", no status";

				}else {

					cache += ", " + status.getLabel();

				}

			}

		}

		String result = cache == null ? "" : cache;

		if (StringUtils.isNotBlank(mainElementLabel)){

			result = CdmUtils.concat(" ", result, "(" + mainElementLabel + ")");

		}

		return result;

	}

	/**

	 * Returns whatever the element's title cache equivalent is,

	 * depending on its class, using the default language.

	 *

	 * @param element a {@link eu.etaxonomy.cdm.model.description.DescriptionElementBase} object.

	 * @return a {@link java.lang.String} object.

	 */

	public static String getCache(DescriptionElementBase element) {

		return getCache(element, CdmStore.getDefaultLanguage());

	}

	/**

	 * Set whatever the element's title cache equivalent is,

	 * depending on its class.

	 *

	 * @param element a {@link eu.etaxonomy.cdm.model.description.DescriptionElementBase} object.

	 * @param value a {@link java.lang.String} object.

	 * @param language a {@link eu.etaxonomy.cdm.model.common.Language} object.

	 */

	public static void setCache(DescriptionElementBase element,

			String value, Language language) {

		if (element instanceof TextData) {

			((TextData) element).putText(language, value);

			return;

		}else if (element instanceof CommonTaxonName) {

			((CommonTaxonName) element).setName(value);

			return;

		}else if (element instanceof TaxonInteraction) {

		}else if(element instanceof Distribution){

			MessagingUtils.warn(DescriptionHelper.class, "trying to set cache on distribution, don't know what to do at the moment.");

			return;

		}else{

			MessagingUtils.warn(DescriptionHelper.class, "No matching subclass found for DescriptionElementBase object, 'cache' not set.");

		}

	}

	/**

	 * Set whatever the element's title cache equivalent is,

	 * depending on its class, using the default language.

	 *

	 * @param element a {@link eu.etaxonomy.cdm.model.description.DescriptionElementBase} object.

	 * @param value a {@link java.lang.String} object.

	 */

	public static void setCache(DescriptionElementBase element,

			String value) {

		setCache(element, value, CdmStore.getDefaultLanguage());

	}

	/**

	 * <p>getObjectDescription</p>

	 *

	 * @param element a {@link java.lang.Object} object.

	 * @return a {@link java.lang.String} object.

	 */

	public static String getObjectDescription(Object element) {

		if (element instanceof IdentifiableEntity) {

			try{

				return ((IdentifiableEntity) element).getTitleCache();

			}catch(LazyInitializationException e){

				String result = "No Session to initialize title cache for IdentifiableEntity";

				MessagingUtils.error(DescriptionHelper.class, result, e);

				return "TODO: " + result;

			}

		}else if (element instanceof OriginalSourceBase) {

			try{

				OriginalSourceBase<?> originalSource = (OriginalSourceBase<?>) element;

//				ISourceable sourcedObject = originalSource.getSourcedObj();

				//due to #5743 the bidirectionality for sourced object had to be removed 

				String sourceObjectTitle = "sourced object data not available (#5743)";

//				if(sourcedObject instanceof IIdentifiableEntity){

//					sourceObjectTitle = ((IdentifiableEntity) sourcedObject).getTitleCache();

//				}else if(sourcedObject instanceof DescriptionElementBase){

//					sourceObjectTitle = "Element for description: " + ((DescriptionElementBase) sourcedObject).getInDescription().getTitleCache();

//				}else{

//					throw new IllegalStateException("Unknown ISourceable object for given OriginalSourceBase");

//				}

				return CdmUtils.concat("; ", new String[]{originalSource.getIdNamespace(), originalSource.getIdInSource(), sourceObjectTitle});

			}catch(LazyInitializationException e){

				String result = "Error initializing title cache for ISourceable of an OriginalSourceBase";

				MessagingUtils.error(DescriptionHelper.class, result, e);

				return "TODO: " + result;

			}

		}else if (element instanceof LanguageStringBase) {

			return ((LanguageStringBase) element).getText();

		}else if (element instanceof DescriptionElementBase) {

			return getCache((DescriptionElementBase) element);

		}else if (element instanceof RelationshipBase<?, ?, ?>) {

			return getCache((RelationshipBase<?, ?, ?>) element);

		}else if (element instanceof TypeDesignationBase<?>) {

			return getCache((TypeDesignationBase<?>) element);

		}else if (element instanceof HomotypicalGroup) {

			return getCache((HomotypicalGroup) element);

		}else if (element instanceof TaxonNode) {

			return getCache((TaxonNode) element);

		}else if (element instanceof Marker) {

			Marker marker = (Marker) element;

			MarkerType type = marker.getMarkerType();

			return (type == null ? "- no marker type -" : marker.getMarkerType().getLabel()) + " (" + marker.getFlag() + ")";

		}else if (element instanceof User) {

			User user = (User) element;

			return user.getUsername();

		}else if (element instanceof Group) {

			Group group = (Group) element;

			return group.getName();

		}else{

			// TODO write return texts for HomotypicalGroup, etc.

			return element.toString();

		}

	}

	private static String getCache(TaxonNode taxonNode) {

		String result = "";

		Classification classification = taxonNode.getClassification();

		if (classification != null){

			String classificationStr = classification.getName() == null ? "" : classification.getName().getText();

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

			if (StringUtils.isBlank(result)){

				result = classification.toString();

			}

		}

		String parentStr;

		TaxonNode parentNode = taxonNode.getParent();

		if (parentNode == null){

			parentStr = "no parent";

		}else{

			Taxon parentTaxon = parentNode.getTaxon();

			if (parentTaxon == null){

				parentStr = "no parent taxon";

			}else{

				TaxonNameBase<?,?> parentName = parentTaxon.getName();

				if (parentName == null){

					parentStr = parentTaxon.getTitleCache();

				}else{

					parentStr = parentName.getTitleCache();

				}

			}

		}

		result = CdmUtils.concat(": ", result, parentStr);

		return null;

	}

	private static String getCache(TypeDesignationBase<?> designation) {

		designation = CdmBase.deproxy(designation);

		TypeDesignationStatusBase<?> status = designation.getTypeStatus();

		Set<TaxonNameBase> from;

		IdentifiableEntity<?> to;

		from = designation.getTypifiedNames();

		if (designation.isInstanceOf(SpecimenTypeDesignation.class)){

			to = ((SpecimenTypeDesignation)designation).getTypeSpecimen();

		}else if (designation.isInstanceOf(NameTypeDesignation.class)){

			to = ((NameTypeDesignation)designation).getTypeName();	

		}else{

			throw new RuntimeException("Type Designation class not supported: " +  designation.getClass().getName());

		}

		String typeLabel = null;

		if (status != null){

			Representation typeRepr = status.getPreferredRepresentation(CdmStore.getDefaultLanguage());

			if (typeRepr != null){

				typeLabel = typeRepr.getAbbreviatedLabel();

			}

			if (StringUtils.isBlank(typeLabel) && typeRepr != null){

				typeLabel = typeRepr.getLabel();

			}

			if (StringUtils.isBlank(typeLabel) ){

				typeLabel = status.getSymbol();

			}

			if (StringUtils.isBlank(typeLabel)){

				typeLabel = status.getTitleCache();

			}

		}

		if (StringUtils.isBlank(typeLabel)){

			typeLabel = "->";

		}

		String fromString = "";

		for (TaxonNameBase<?,?> name : from){

			CdmUtils.concat(",", fromString, name.getTitleCache());

		}

		String result = CdmUtils.concat(" ", new String[]{from == null ? null : fromString, 

				typeLabel, to == null? null : to.getTitleCache()});

		return result;

	}

	private static String getCache(RelationshipBase<?, ?, ?> rel) {

		rel = CdmBase.deproxy(rel);

		RelationshipTermBase<?> type = rel.getType();

		IdentifiableEntity<?> from;

		IdentifiableEntity<?> to;

		if (rel.isInstanceOf(SynonymRelationship.class)){

			from = ((SynonymRelationship)rel).getSynonym();

			to = ((SynonymRelationship)rel).getAcceptedTaxon();

		}else if (rel.isInstanceOf(NameRelationship.class)){

			from = ((NameRelationship)rel).getFromName();

			to = ((NameRelationship)rel).getToName();

		}else if (rel.isInstanceOf(HybridRelationship.class)){

			from = ((HybridRelationship)rel).getParentName();

			to = ((HybridRelationship)rel).getHybridName();

		}else if (rel.isInstanceOf(TaxonRelationship.class)){

			from = ((TaxonRelationship)rel).getFromTaxon();

			to = ((TaxonRelationship)rel).getToTaxon();

		}else{

			try {

				Method fromMethod = rel.getClass().getMethod("getRelatedFrom");

				Method toMethod = rel.getClass().getMethod("getRelatedFrom");

				fromMethod.setAccessible(true);

				toMethod.setAccessible(true);

				from = (IdentifiableEntity<?>)fromMethod.invoke(rel);

				to = (IdentifiableEntity<?>)toMethod.invoke(rel);

			} catch (NoSuchMethodException e) {

				throw new RuntimeException(e);

			} catch (SecurityException e) {

				throw new RuntimeException(e);

			} catch (IllegalAccessException e) {

				throw new RuntimeException(e);

			} catch (IllegalArgumentException e) {

				throw new RuntimeException(e);

			} catch (InvocationTargetException e) {

				throw new RuntimeException(e);

			}

		}

		String typeLabel = null;

		if (type != null){

			Representation typeRepr = type.getPreferredRepresentation(CdmStore.getDefaultLanguage());

			if (typeRepr != null){

				typeLabel = typeRepr.getAbbreviatedLabel();

			}

			if (StringUtils.isBlank(typeLabel) && typeRepr != null){

				typeLabel = typeRepr.getLabel();

			}

			if (StringUtils.isBlank(typeLabel) ){

				typeLabel = type.getSymbol();

			}

			if (StringUtils.isBlank(typeLabel)){

				typeLabel = type.getTitleCache();

			}

		}

		if (StringUtils.isBlank(typeLabel)){

			typeLabel = "->";

		}

		String result = CdmUtils.concat(" ", new String[]{from == null ? null : from.getTitleCache(), 

				typeLabel, to == null? null : to.getTitleCache()});

		return result;

	}

	private static String getCache(HomotypicalGroup hg) {

		String result = "";

		for (TaxonNameBase<?,?> tnb : hg.getTypifiedNames()){

			result = CdmUtils.concat(", ", result, tnb.getTitleCache());

		}

		if (StringUtils.isBlank(result)){

			result = "No typified names";

		}

		return result;

	}

	/**

	 * <p>getObjectClassname</p>

	 *

	 * @param element a {@link java.lang.Object} object.

	 * @return a {@link java.lang.String} object.

	 */

	public static String getObjectClassname(Object element) {

		return element.getClass().getSimpleName();

	}

	/**

	 * <p>getFeatureNodeContainerText</p>

	 *

	 * @param element a {@link eu.etaxonomy.taxeditor.model.FeatureNodeContainer} object.

	 * @return a {@link java.lang.String} object.

	 */

	public static String getFeatureNodeContainerText(FeatureNodeContainer element) {

		String result = null;

		if(element.getFeatureNode() != null && element.getFeatureNode().getFeature() != null){

			result = element.getFeatureNode().getFeature().getLabel(CdmStore.getDefaultLanguage());

		} else{

			return "No label set";

		}

		if (result == null){

			result = element.getFeatureNode().getFeature().getLabel();

		}

		return result;

	}

	/**

	 * <p>getQuantitativeDataText</p>

	 *

	 * @param element a {@link eu.etaxonomy.cdm.model.description.QuantitativeData} object.

	 * @return a {@link java.lang.String} object.

	 */

	public static String getQuantitativeDataText(QuantitativeData element) {

		TextData textData = quantitativeDescriptionBuilder.build(element, getLanguageList());

		return textData.getText(CdmStore.getDefaultLanguage());

	}

	/**

	 * <p>getCategoricalDataText</p>

	 *

	 * @param element a {@link eu.etaxonomy.cdm.model.description.CategoricalData} object.

	 * @return a {@link java.lang.String} object.

	 */

	public static String getCategoricalDataText(CategoricalData element) {

		TextData textData = categoricalDescriptionBuilder.build(element, getLanguageList());

		return textData.getText(CdmStore.getDefaultLanguage());

	}

	private static List<Language> getLanguageList(){

		return Arrays.asList(new Language[]{CdmStore.getDefaultLanguage()});

	}

	private static DescriptionBuilder<QuantitativeData> quantitativeDescriptionBuilder = new DefaultQuantitativeDescriptionBuilder();

	private static DescriptionBuilder<CategoricalData> categoricalDescriptionBuilder = new DefaultCategoricalDescriptionBuilder();

	/**

	 * <p>getDistributionText</p>

	 *

	 * @param element a {@link eu.etaxonomy.cdm.model.description.Distribution} object.

	 * @return a {@link java.lang.String} object.

	 */

	public static String getDistributionText(Distribution element) {

		String text = "EMPTY";

		Distribution distribution = element;

		NamedArea area = distribution.getArea();

		if(area != null){

			text = NamedArea.labelWithLevel(area, CdmStore.getDefaultLanguage());

			PresenceAbsenceTerm status = distribution.getStatus();

			if (status != null) {

				text += ", " + status.getLabel();

			}else{

				text += ", NO STATUS";

			}

		}

		return text;

	}

	/**

	 * <p>getImageText</p>

	 *

	 * @param media a {@link eu.etaxonomy.cdm.model.media.Media} object.

	 * @return a {@link java.lang.String} object.

	 */

	public static  String getImageText(Media media) {

		 LanguageString title = media.getTitle(CdmStore.getDefaultLanguage());

		if (title != null) {

			return title.getText();

		}

		return "No title.";

	}

	/**

	 * <p>getElementText</p>

	 *

	 * @param element a {@link eu.etaxonomy.cdm.model.description.TextData} object.

	 * @return a {@link java.lang.String} object.

	 */

	public static  String getElementText(TextData element) {

		String text = null;

		if(element.getFeature().equals(Feature.CITATION())){

			text = "";

			for(DescriptionElementSource source : element.getSources()){

				if(source.getCitation() != null){

					text += source.getCitation().getTitleCache();

				}

				if(source.getNameUsedInSource() != null){

					text += " [ " + source.getNameUsedInSource().getTitleCache() + " ]";

				}

			}

			if(CdmUtils.isEmpty(text)){

				text = "No sources provided";

			}

		}else{

			List<Language> languages = Arrays.asList(new Language[]{CdmStore.getDefaultLanguage()});

			LanguageString languageString = element.getPreferredLanguageString(languages);

			text = languageString != null ? languageString.getText() : null;

		}

		return CdmUtils.isEmpty(text) ? "No text provided" : text;

	}

	/**

	 * <p>getTaxonInteractionText</p>

	 *

	 * @param element a {@link eu.etaxonomy.cdm.model.description.TaxonInteraction} object.

	 * @return a {@link java.lang.String} object.

	 */

	public static  String getTaxonInteractionText(TaxonInteraction element) {

		String text = "";

		Taxon taxon2 = element.getTaxon2();

		if(taxon2 != null && taxon2.getName() != null){

			text = taxon2.getName().getTitleCache();

		}else{

			text = "No taxon chosen";

		}

		return text;

	}

	/**

	 * <p>getCommonNameText</p>

	 *

	 * @param commonName a {@link eu.etaxonomy.cdm.model.description.CommonTaxonName} object.

	 * @return a {@link java.lang.String} object.

	 */

	public static  String getCommonNameText(CommonTaxonName commonName) {

		String name = commonName.getName();

		if (name == null || name.length() == 0) {

			name = "No name provided";

		}

		Language language = commonName.getLanguage();

		if (language == null) {

			name += " (No language provided)";

		} else {

			name += " (" + language.getDescription() + ")";

		}

		return name;

	}

	/**

	 * <p>getDescriptionText</p>

	 *

	 * @param element a {@link eu.etaxonomy.cdm.model.description.DescriptionBase} object.

	 * @return a {@link java.lang.String} object.

	 */

	public static  String getDescriptionText(DescriptionBase element) {

		String text = element.getTitleCache();

		if (text == null || text.length() == 0) {

			text = "No label provided";

		}

		return text;

	}

	/**

	 * <p>getIndividualsAssociationText</p>

	 *

	 * @param element a {@link eu.etaxonomy.cdm.model.description.IndividualsAssociation} object.

	 * @return a {@link java.lang.String} object.

	 */

	public static  String getIndividualsAssociationText(IndividualsAssociation element) {

		SpecimenOrObservationBase derivedUnit = element.getAssociatedSpecimenOrObservation();

		if(derivedUnit != null){

			return derivedUnit.getTitleCache();

		}

		return "No unit chosen";

	}

	/**

	 * <p>getLabel</p>

	 *

	 * @param element a {@link java.lang.Object} object.

	 * @return a {@link java.lang.String} object.

	 */

	public static String getLabel(Object element){

	    String noLabelString = "[no label]";

		if (element instanceof FeatureNodeContainer){

			return getFeatureNodeContainerText((FeatureNodeContainer) element);

		}

		else if (element instanceof DescriptionBase) {

			return getDescriptionText((DescriptionBase) element);

		}

		else if(element instanceof CategoricalData){

			String categoricalDataText = getCategoricalDataText((CategoricalData) element);

			if(categoricalDataText==null || categoricalDataText.isEmpty()){

			    categoricalDataText = noLabelString;

			}

            return categoricalDataText;

		}

		else if (element instanceof CommonTaxonName) {

			return getCommonNameText((CommonTaxonName) element);

		}

		else if (element instanceof Distribution) {

			return getDistributionText((Distribution) element);

		}

		else if (element instanceof IndividualsAssociation) {

			return getIndividualsAssociationText((IndividualsAssociation) element);

		}

		else if (element instanceof QuantitativeData) {

			String quantitativeDataText = getQuantitativeDataText((QuantitativeData) element);

			if(quantitativeDataText==null || quantitativeDataText.isEmpty()){

                quantitativeDataText = noLabelString;

			}

            return quantitativeDataText;

		}

		else if (element instanceof TaxonInteraction) {

			return getTaxonInteractionText((TaxonInteraction) element);

		}

		else if (element instanceof TextData) {

			return getElementText((TextData) element);

		}

		else{

			return element.toString();

		}

	}

}