/*
 * This is eMonocot, a global online biodiversity information resource.
 *
 * Copyright © 2011–2015 The Board of Trustees of the Royal Botanic Gardens, Kew and The University of Oxford
 *
 * eMonocot is free software: you can redistribute it and/or modify it under the terms of the
 * GNU Affero General Public License as published by the Free Software Foundation, either version 3
 * of the License, or (at your option) any later version.
 *
 * eMonocot is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * The complete text of the GNU Affero General Public License is in the source repository as the file
 * ‘COPYING’.  It is also available from <http://www.gnu.org/licenses/>.
 */
package org.emonocot.job.taxonmatch;

import static org.easymock.EasyMock.expect;
import static org.easymock.EasyMock.replay;
import static org.junit.Assert.assertEquals;

import java.util.ArrayList;
import java.util.List;

import org.easymock.EasyMock;
import org.emonocot.api.match.Match;
import org.emonocot.api.match.MatchStatus;
import org.emonocot.api.match.taxon.TaxonMatcher;
import org.emonocot.model.Taxon;
import org.junit.Before;
import org.junit.Test;

/**
 * @author jk00kg
 *
 */
public class CompositeTaxonMatcherTest {

	CompositeTaxonMatcher underTest;

	/**
	 *
	 */
	TaxonMatcher mock1 = EasyMock.createMock(TaxonMatcher.class);
	/**
	 *
	 */
	TaxonMatcher mock2 = EasyMock.createMock(TaxonMatcher.class);

	/**
	 *
	 */
	private List<Match<Taxon>> singleExact;

	/**
	 *
	 */
	private List<Match<Taxon>> partials;

	/**
	 * Tests that only one matcher is used when possible to minimise unnecessary processing
	 *
	 * Test method for {@link org.emonocot.job.taxonmatch.CompositeTaxonMatcher#match(org.gbif.ecat.model.ParsedName)}.
	 *
	 * @throws Exception
	 */
	@Test
	public void testPrimaryMatch() throws Exception {
		String input = "Test name Arch.";
		expect(mock1.match(EasyMock.eq(input))).andReturn(singleExact);

		replay(mock1, mock2);
		List<Match<Taxon>> actuals = underTest.match(input);
		assertEquals("We should have the single EXACT_MATCH", singleExact, actuals);
	}

	/**
	 * Tests that more matchers are used when only partial matches are found
	 *
	 * Test method for {@link org.emonocot.job.taxonmatch.CompositeTaxonMatcher#match(org.gbif.ecat.model.ParsedName)}.
	 *
	 * @throws Exception
	 */
	@Test
	public void testSecondaryMatch() throws Exception {
		String input = "Test name Arch.";
		expect(mock1.match(EasyMock.eq(input))).andReturn(partials);
		expect(mock2.match(EasyMock.eq(input))).andReturn(singleExact);

		replay(mock1, mock2);
		List<Match<Taxon>> actuals = underTest.match(input);
		assertEquals("We should have the single EXACT_MATCH", singleExact, actuals);
	}


	/**
	 * @throws Exception
	 */
	@Before
	public void setUp() throws Exception{
		singleExact = new ArrayList<Match<Taxon>>();
		Taxon t = new Taxon();
		t.setScientificName("Test name Arch.");
		t.setIdentifier("exact1");
		Match<Taxon> m = new Match<Taxon>();
		m.setInternal(t);
		m.setStatus(MatchStatus.EXACT);
		singleExact.add(m);

		partials = new ArrayList<Match<Taxon>>();
		for (int i = 0; i < 2; i++) {
			t = new Taxon();
			t.setScientificName("Test part Arch.");
			t.setIdentifier("partial" + i);
			m = new Match<Taxon>();
			m.setInternal(t);
			m.setStatus(MatchStatus.PARTIAL);
			partials.add(m);
		}
		underTest = new CompositeTaxonMatcher();
		underTest.setMatchers(new TaxonMatcher[] {mock1, mock2});
	}

}