EDIT

/**

* 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.strategy.cache.taxon;

import static org.junit.Assert.assertEquals;

import org.apache.log4j.Logger;

import org.junit.Assert;

import org.junit.Before;

import org.junit.Test;

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

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

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

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

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

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

//import eu.etaxonomy.cdm.model.reference.Book;

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

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

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

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

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

import eu.etaxonomy.cdm.strategy.parser.NonViralNameParserImpl;

import eu.etaxonomy.cdm.test.TermTestBase;

/**

 * @author a.mueller

 * @since 21.09.2009

 */

public class TaxonBaseDefaultCacheStrategyTest extends TermTestBase {

	@SuppressWarnings("unused")

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

	private final String expectedNameTitleCache = "Abies alba (L.) Mill.";

	private final String expectedNameCache = "Abies alba";

	private IBotanicalName name;

	private Reference sec;

	@Before

	public void setUp() throws Exception {

		name = TaxonNameFactory.NewBotanicalInstance(Rank.SPECIES());

		name.setGenusOrUninomial("Abies");

		name.setSpecificEpithet("alba");

		Person combinationAuthor = Person.NewInstance();

		combinationAuthor.setNomenclaturalTitle("Mill.");

		Person basionymAuthor = Person.NewInstance();

		basionymAuthor.setNomenclaturalTitle("L.");

		name.setCombinationAuthorship(combinationAuthor);

		name.setBasionymAuthorship(basionymAuthor);

		assertEquals("Namecache should be Abies alba", expectedNameCache, name.getNameCache());

		assertEquals("Titlecache should be Abies alba (Mill.) L.", expectedNameTitleCache, name.getTitleCache());

		sec = ReferenceFactory.newBook();

		sec.setTitle("Sp.Pl.");

	}

//******************************* TESTS ********************************************************

	@Test

	public void testGetTitleCache() {

		TaxonBase<?> taxonBase = Taxon.NewInstance(name, sec);

		assertEquals("Taxon titlecache is wrong", expectedNameTitleCache + " sec. Sp.Pl.", taxonBase.getTitleCache());

		//without sec.

		taxonBase.setSec(null);

		assertEquals("Taxon titlecache is wrong", expectedNameTitleCache + " sec. ???", taxonBase.getTitleCache());

		//appended phrase without sec.

		String appendedPhrase = "aff. 'schippii'";

		taxonBase.setAppendedPhrase(appendedPhrase);

		assertEquals("Taxon titlecache is wrong", expectedNameTitleCache + " aff. 'schippii'", taxonBase.getTitleCache());

		//appended phrase with sec.

		taxonBase.setSec(sec);

		assertEquals("Taxon titlecache is wrong", expectedNameTitleCache + " aff. 'schippii' sec. Sp.Pl.", taxonBase.getTitleCache());

		//use name cache

		taxonBase.setUseNameCache(true);

		assertEquals("Taxon titlecache is wrong", expectedNameCache + " aff. 'schippii' sec. Sp.Pl.", taxonBase.getTitleCache());

		taxonBase.setDoubtful(true);

        assertEquals("Taxon titlecache is wrong", "?" + expectedNameCache + " aff. 'schippii' sec. Sp.Pl.", taxonBase.getTitleCache());

        //with nom status

        taxonBase.setAppendedPhrase(null);

        taxonBase.setUseNameCache(false);

        taxonBase.setDoubtful(false);

        name.addStatus(NomenclaturalStatusType.ILLEGITIMATE(), null, null);

        assertEquals("Taxon titlecache is wrong", expectedNameTitleCache + ", nom. illeg., sec. Sp.Pl.", taxonBase.getTitleCache());

	}

	//same as for accepted taxa but with syn. sec. instead of sec.

    @Test

    public void testSynSec() {

        Synonym taxonBase = Synonym.NewInstance(name, sec);

        assertEquals("Taxon titlecache is wrong", expectedNameTitleCache + " syn. sec. Sp.Pl.", taxonBase.getTitleCache());

        //without sec.

        taxonBase.setSec(null);

        assertEquals("Taxon titlecache is wrong", expectedNameTitleCache + " syn. sec. ???", taxonBase.getTitleCache());

        //appended phrase without sec.

        String appendedPhrase = "aff. 'schippii'";

        taxonBase.setAppendedPhrase(appendedPhrase);

        assertEquals("Taxon titlecache is wrong", expectedNameTitleCache + " aff. 'schippii'", taxonBase.getTitleCache());

        //appended phrase with sec.

        taxonBase.setSec(sec);

        assertEquals("Taxon titlecache is wrong", expectedNameTitleCache + " aff. 'schippii' syn. sec. Sp.Pl.", taxonBase.getTitleCache());

        //use name cache

        taxonBase.setUseNameCache(true);

        assertEquals("Taxon titlecache is wrong", expectedNameCache + " aff. 'schippii' syn. sec. Sp.Pl.", taxonBase.getTitleCache());

        taxonBase.setDoubtful(true);

        assertEquals("Taxon titlecache is wrong", "?" + expectedNameCache + " aff. 'schippii' syn. sec. Sp.Pl.", taxonBase.getTitleCache());

        //with nom status

        taxonBase.setAppendedPhrase(null);

        taxonBase.setUseNameCache(false);

        taxonBase.setDoubtful(false);

        name.addStatus(NomenclaturalStatusType.ILLEGITIMATE(), null, null);

        assertEquals("Taxon titlecache is wrong", expectedNameTitleCache + ", nom. illeg., syn. sec. Sp.Pl.", taxonBase.getTitleCache());

    }

   @Test

    public void testGetTitleCacheWithoutName() {

        TaxonBase<?> taxonBase = Taxon.NewInstance(null, sec);

        assertEquals("Taxon titlecache is wrong", "??? sec. Sp.Pl.", taxonBase.getTitleCache());

    }

	//test missing "&" in title cache  #3822

	@Test

	public void testAndInTitleCache() {

		TaxonBase<?> taxonBase = Taxon.NewInstance(name, sec);

		Team team = Team.NewInstance();

		team.addTeamMember((Person)name.getCombinationAuthorship());

		team.addTeamMember((Person)name.getBasionymAuthorship());

		name.setCombinationAuthorship(team);

//		System.out.println(taxonBase.generateTitle());

		assertEquals("Abies alba (L.) Mill. \u0026 L. sec. Sp.Pl.", taxonBase.generateTitle());

		name = TaxonNameFactory.NewBotanicalInstance(null);

		NonViralNameParserImpl.NewInstance().parseFullName(name, "Cichorium glandulosum Boiss. \u0026 A. Huet", null, true);

		Taxon taxon = Taxon.NewInstance(name, sec);

		assertEquals("Cichorium glandulosum Boiss. \u0026 A. Huet sec. Sp.Pl.", taxon.getTitleCache());

	}

    @Test

	public void testProtectedTitleCache(){

	    TaxonBase<?> taxonBase = Taxon.NewInstance(name, sec);

        taxonBase.setTitleCache("abc", true);

        taxonBase.setDoubtful(true);

        Assert.assertEquals("abc", taxonBase.getTitleCache());

	}

    @Test

    public void testProtectedSecTitleCache(){

        TaxonBase<?> taxonBase = Taxon.NewInstance(name, sec);

        sec.setTitleCache("My protected sec ref", true);

        taxonBase.setDoubtful(true);

        taxonBase.setSecMicroReference("123");

        Assert.assertEquals("?Abies alba (L.) Mill. sec. My protected sec ref: 123", taxonBase.getTitleCache());

    }

    @Test

    public void testMicroReference(){

        TaxonBase<?> taxonBase = Taxon.NewInstance(name, sec);

        String secMicroRef = "p. 553";

        taxonBase.setSecMicroReference(secMicroRef);

        assertEquals("Taxon titlecache is wrong", expectedNameTitleCache + " sec. Sp.Pl.: " + secMicroRef,

                taxonBase.getTitleCache());

    }

}