/*
 *  eXist Open Source Native XML Database
 *  Copyright (C) 2009 The eXist Project
 *  http://exist-db.org
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public License
 *  as published by the Free Software Foundation; either version 2
 *  of the License, or (at your option) any later version.
 *
 *  This program 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 Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * $Id$
 */

package org.exist.util.sorters;

import java.lang.reflect.Method;

import junit.framework.Test;
import junit.framework.TestSuite;

/**
 * Test case to check methods that use comparators.
 * <p>
 * This work was undertaken as part of the development of the taxonomic
 * repository at http://biodiversity.org.au . See <A
 * href="ghw-at-anbg.gov.au">Greg Whitbread</A> for further details.
 * 
 * @author pmurray@bigpond.com
 * @author pmurray@anbg.gov.au
 * @author https://sourceforge.net/users/paulmurray
 * @author http://www.users.bigpond.com/pmurray
 * 
 */

public abstract class ComparatorChecker extends SortMethodChecker {

	enum SortOrder {
		ASCENDING, DESCENDING, UNSTABLE, RANDOM
	};

	ComparatorChecker(SortingAlgorithmTester sorter) {
		super(sorter);
	}

	abstract void check(SortOrder sortOrder, int lo, int hi) throws Exception;

	abstract void sort(SortOrder sortOrder, int lo, int hi) throws Exception;

	void sort(SortOrder sortOrder) throws Exception {
		sort(sortOrder, 0, getLength() - 1);
	}

	void check(SortOrder sortOrder) throws Exception {
		check(sortOrder, 0, getLength() - 1);
	}

	public Test suite() {
		TestSuite s = new TestSuite();
		s.setName(sorter.getClass().getSimpleName() + " "
				+ getClass().getSimpleName());
		String testSuiteName=s.getName();
		for (Method m : SortTestComparator.class.getMethods()) {
			if (m.getName().startsWith("test")) {
				s.addTest(new SortTestComparator<ComparatorChecker>(
					this,
					m.getName(),
					testSuiteName
				));
			}
		}

		return s;
	}
}