root/trunk/cdmlib/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/taxon/TaxonComparator.java

/**
* 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.model.taxon;

import java.io.Serializable;
import java.util.Comparator;
import java.util.Iterator;
import java.util.Set;

import org.apache.log4j.Logger;

import org.joda.time.DateTime;

import eu.etaxonomy.cdm.model.name.NomenclaturalStatus;
import eu.etaxonomy.cdm.model.name.NomenclaturalStatusType;
import eu.etaxonomy.cdm.model.name.TaxonNameBase;
import eu.etaxonomy.cdm.model.name.ZoologicalName;
import eu.etaxonomy.cdm.model.reference.INomenclaturalReference;
import eu.etaxonomy.cdm.model.reference.Reference;

/**
 * This class makes available a method to compare two {@link TaxonBase taxa} by
 * comparing the publication dates of the corresponding 
 * {@link eu.etaxonomy.cdm.model.name.TaxonNameBase taxon names}.
 *
 * @author a.mueller
 * @created 11.06.2008
 * @version 1.0
 */
public class TaxonComparator implements Comparator<TaxonBase>, Serializable {
    private static final Logger logger = Logger.getLogger(TaxonComparator.class);

    /* (non-Javadoc)
     * @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
     */
    /**
     * Returns an integer generated by comparing the 
     * {@link eu.etaxonomy.cdm.model.name.INomenclaturalReference#getYear() publication years}
     * of both {@link eu.etaxonomy.cdm.model.name.TaxonNameBase taxon names} 
     * used in the given {@link TaxonBase taxa}.
     * Returns a negative value if the publication year corresponding to the
     * first given taxon precedes the publication year corresponding to the
     * second given taxon. Returns a positive value if the contrary is true and
     * 0 if both publication years and the date, when they are created, are identical. 
     * In case one of the publication
     * years is "null" and the other is not, the "empty" publication year will
     * be considered to be always preceded by the "not null" publication year.
     * If both publication years are "null" the creation date is used for the comparison
     *
     *
     * @see             java.lang.String#compareTo(String)
     * @see             java.util.Comparator#compare(java.lang.Object, java.lang.Object)
     */
    public int compare(TaxonBase taxonBase1, TaxonBase taxonBase2) {
        int result;
        //boolean invalOrNudForTaxon1 = false;
        //boolean invalOrNudForTaxon2 = false;

        boolean invalTaxon1 = false;
        boolean invalTaxon2 = false;
        boolean nudumTaxon1 = false;
        boolean nudumTaxon2 = false;

        //if a taxon has nomenclatural status "nom. inval." or "nom. nud."
        //TODO: Überprüfen!!!
        Set status = taxonBase1.getName().getStatus();
        Iterator iterator = status.iterator();
        if (iterator.hasNext()){
            NomenclaturalStatus nomStatus1 = (NomenclaturalStatus) iterator.next();
            Set status2 = taxonBase2.getName().getStatus();
            iterator = status2.iterator(); // is that right? or better iterator = status2.iterator(); ???
            if (iterator.hasNext()){
                NomenclaturalStatus nomStatus2 = (NomenclaturalStatus)iterator.next();
/*
                if (nomStatus1.getType().equals(NomenclaturalStatusType.NUDUM()) ||
                        nomStatus1.getType().equals(NomenclaturalStatusType.INVALID())){
                    invalOrNudForTaxon1 = true;
                }
                if (nomStatus2.getType().equals(NomenclaturalStatusType.NUDUM()) || nomStatus2.getType().equals(NomenclaturalStatusType.INVALID())){
                    invalOrNudForTaxon2 = true;
                }
                if (invalOrNudForTaxon1 && !invalOrNudForTaxon2){
                    return 1;
                }else if (!invalOrNudForTaxon1 && invalOrNudForTaxon2){
                    return -1;
                }
                else{ // both taxon are invalid or nudum
                    //result = 0;
                }
*/
                // #####
                if (nomStatus1.getType().equals(NomenclaturalStatusType.INVALID())){
                    invalTaxon1 = true;
                }
                if (nomStatus1.getType().equals(NomenclaturalStatusType.NUDUM())){
                    nudumTaxon1 = true;
                }
                if (nomStatus2.getType().equals(NomenclaturalStatusType.INVALID())){
                    invalTaxon2 = true;
                }
                if (nomStatus2.getType().equals(NomenclaturalStatusType.NUDUM())){
                    nudumTaxon2 = true;
                }
                if (nudumTaxon1 && !nudumTaxon2){
                    return 1;
                }else if (nudumTaxon1 && nudumTaxon2){
                    //continue
                }else if (invalTaxon1 && !nudumTaxon2){
                    if (invalTaxon2){
                        //continue
                    }else{
                        return 1;
                    }
                }else if (nudumTaxon2 && !nudumTaxon1){
                    return -1;
                }else if(invalTaxon2){
                    return -1;
                }
                // #####


            }else{//if taxonbase2.getName().getStatus = NULL and taxonbase2 not
                return 1;
            }
        }else{//if taxonbase1.getName().getStatus = NULL
            iterator = taxonBase2.getName().getStatus().iterator();
            if (!iterator.hasNext()){
            //if (taxonBase2.getName().getStatus() == null){ // both are null, continue checking
            }else{
                return -1;
            }
        }

        Integer intDate1 = getIntegerDate(taxonBase1);
        Integer intDate2 = getIntegerDate(taxonBase2);

        if (intDate1 == null && intDate2 == null){
            result = 0;
        }else if (intDate1 == null){
            return 1;
        }else if (intDate2 == null){
            return -1;
        }else{
            result = intDate1.compareTo(intDate2);
        }

        if (result == 0){
            TaxonNameBase taxName1 = taxonBase1.getName();
            TaxonNameBase taxName2 = taxonBase2.getName();

            return taxName1.compareTo(taxName2);

        }

        if (result == 0){
            DateTime date11 = taxonBase1.getCreated();
            DateTime date12 = taxonBase2.getCreated();
            if (date11 == null && date12 == null) {
                return 0;
            }
            if (date11 == null) {
                return 1;
            }
            if (date12 == null) {
                return -1;
            }
            result = date11.compareTo(date12);
        }

        //for ticket #393 if the publication year is the same, the order is alphabetically

        if (result == 0){
            TaxonNameBase taxName1 = taxonBase1.getName();
            TaxonNameBase taxName2 = taxonBase2.getName();

            return taxName1.compareTo(taxName2);

        }

        return result;

    }


    private Integer getIntegerDate(TaxonBase taxonBase){
        Integer result;

        if (taxonBase == null){
            result = null;
        }else{
            TaxonNameBase name = taxonBase.getName();
           if (name == null){
                result = null;
            }else{
                if (name instanceof ZoologicalName){

                    result = (((ZoologicalName)name).getPublicationYear());
                }else{
                    Reference ref = (Reference) name.getNomenclaturalReference();
                    if (ref == null){
                        result = null;
                    }else{
                        if (ref.getDatePublished() == null){
                                Reference inRef = ref.getInReference();
                                if (inRef == null){
                                result = null;
                            }else{
                                if (inRef.getDatePublished() == null){
                                        result = null;
                                }else{
                                        result = ref.getInReference().getDatePublished().getStartYear();
                                }
                            }
                        }else{
                            result = ref.getDatePublished().getStartYear();
                        }
                    }
                }
            }
        }

        return result;
    }

    @SuppressWarnings("unchecked")
    @Deprecated
    private String getDate(TaxonBase taxonBase){
        String result = null;
        if (taxonBase == null){
            result = null;
        }else{
            TaxonNameBase name = taxonBase.getName();
            if (name == null){
                result = null;
            }else{
                if (name instanceof ZoologicalName){

                    result = String.valueOf(((ZoologicalName)name).getPublicationYear());
                }else{
                     INomenclaturalReference ref = name.getNomenclaturalReference();
                    if (ref == null){
                        result = null;
                    }else{
                        result = ref.getYear();
                    }
                }
            }
        }
        if (result != null){
            result = result.trim();
        }
        if ("".equals(result)){
            result = null;
        }
        return result;
    }

}