/**************************************
 * HangmanFlavours is a final (non-extendable) class embodying a full collection of
 * 'flavours' (e.g. "composers", "instruments") ready for use with constructor
 * new HangmanData(FLAVOUR) which extracts a single flavour.
 *
 * HangmanFlavours provides methods for getting basic info about the flavours and
 * the data itself, which is needed to populate a new instantiation of HangmanData.
 *
 * 2-D arrays are used for fieldnames and gueassable/clueable flags as these might
 * be queried before a final choice of flavour is made. But data itself only needs
 * to be passed as one string tokenizer as random access is only needed once the
 * flavour has been chosen and a new HangmanData extension is being instantiated.
 *
 * Methods:	getNumFlavours()							int
 *			getFlavourName(int FLAVOUR)					String
 *			getMaxFields(int FLAVOUR)					int
 *			getFieldName(int FLAVOUR, int fieldIndex)	String
 *			getTokenizer(int FLAVOUR)					StringTokenizer
 *			isGuessable(int FLAVOUR, int fieldIndex)	boolean
 *			isClueable(int FLAVOUR, int fieldIndex)		boolean
 *
 * There is now a max of 5 fields per flavour.
 *
 * Andy Murray 08/12/02
 */

import java.util.StringTokenizer;

public final class HangmanFlavours
{
	static final int	COMPOSERS = 0,
						INSTRUMENTS = 1,
						FORMS = 2,
						DEVICES = 3;
	private static int			intNumFlavours = 4,
								intMaxFields = 5;
	private static String[]		strFlavours = {"Composers & pieces", "Musical instruments", "Musical forms", "Musical devices"};
	private static String[][]	strFieldNames = new String[intNumFlavours][intMaxFields];
	private static boolean[][]	isGuessable = new boolean[intNumFlavours][intMaxFields],
								isClueable = new boolean[intNumFlavours][intMaxFields];
	private StringTokenizer		stData;

	// this final class needs no counstructor.

	/**
	 * Method getNumFlavours() returns the number of flavours (areas of knowledge)
	 * available in this class as an int.
	 */
	public static int getNumFlavours()
	{
		return strFlavours.length;
	}

	/**
	 * Method getFlavourName(int) returns the name of the referenced flavour as a string.
	 */
	public static String getFlavourName(int flavourIndex)
	{
		return ((flavourIndex>-1) && (flavourIndex<strFlavours.length)) ? strFlavours[flavourIndex] : null;
	}

	/**
	 * Method getMaxFields() returns the absolute max no. of fields for all flavours, as
	 * an int. This is currently fixed at 5, but is included as a method in case there
	 * is some later need to increase the number.
	 */
	public static int getMaxFields()
	{
		return intMaxFields;
	}

	/**
	 * Method getFieldNames(int) returns a 5-element array of field names for the
	 * referenced flavour
	 */
	public static String getFieldName(int flavourIndex, int fieldIndex)
	{	//set all possible fieldnames
		strFieldNames[COMPOSERS][0]="composer";
		strFieldNames[COMPOSERS][1]="first name";
		strFieldNames[COMPOSERS][2]="nationality";
		strFieldNames[COMPOSERS][3]="life span";
		strFieldNames[COMPOSERS][4]="notable piece";

		strFieldNames[INSTRUMENTS][0]="instrument name";
		strFieldNames[INSTRUMENTS][1]="instrument family";
		strFieldNames[INSTRUMENTS][2]="performer's name";
		strFieldNames[INSTRUMENTS][3]="";
		strFieldNames[INSTRUMENTS][4]="";

		strFieldNames[FORMS][0]="form";
		strFieldNames[FORMS][1]="description";
		strFieldNames[FORMS][2]="";
		strFieldNames[FORMS][3]="";
		strFieldNames[FORMS][4]="";

		strFieldNames[DEVICES][0]="device name";
		strFieldNames[DEVICES][1]="description";
		strFieldNames[DEVICES][2]="";
		strFieldNames[DEVICES][3]="";
		strFieldNames[DEVICES][4]="";

		//then return the relevant one
		return strFieldNames[flavourIndex][fieldIndex];
	}

	/**
	 * Method isGuessable(int, int) returns an appropriate boolean to learn whether
	 * this field is appropriate to be used as the hangman word to guess.
	 */
	public static boolean isGuessable(int FLAVOUR, int fieldIndex)
	{
		//set all true by default
		for (int i=0;i<intNumFlavours;i++)
		{
			for (int j=0;j<intMaxFields;j++)
			{
				isGuessable[i][j]=true;
			}
		}
		//add any false guessables below for all flavours

		//COMPOSERS all guessable

		//INSTRUMENTS
		isGuessable[INSTRUMENTS][1]=false;	//prevent guess family

		//FORMS
		isGuessable[FORMS][1]=false;	//prevent guess description

		//DEVICES all guessable

		//finally return the relevant boolean
		return isGuessable[FLAVOUR][fieldIndex];
	}

	/**
	 * Method isClueable(int, int) returns an appropriate boolean to learn whether
	 * this field is appropriate to be used as a hangman clue.
	 */
	public static boolean isClueable(int FLAVOUR, int fieldIndex)
	{
		//set all defaults to true
		for (int i=0;i<intNumFlavours;i++)
		{
			for (int j=0;j<intMaxFields;j++)
			{
				isClueable[i][j]=true;
			}
		}
		//add any false clueables here for all flavours

		//COMPOSERS all clueable

		//INSTRUMENTS all clueable

		//FORMS
		isClueable[FORMS][0]=false;		//prevent clue form name

		//DEVICES all clueable

		//finally return the relevant boolean
		return isClueable[FLAVOUR][fieldIndex];
	}

	/**
	 * Method getTokenizer(int FLAVOUR) returns the StringTokenizer necessary for
	 * populating a new HangmanData instantiation, via the call new HangmanData(FLAVOUR)
	 */
	public static StringTokenizer getTokenizer(int FLAVOUR)
	{
		StringBuffer strb = new StringBuffer();

		switch (FLAVOUR)
		{
			case COMPOSERS:
			{
				//(All guessable/clueable)
				strb.append("|Allegri, Gregorio, Italian, 1582-1652, Miserere");
				strb.append("|Bach, Johann, German, 1685-1750, The Art of Fugue");
				strb.append("|Copland, Aaron, American, 1900-1990, Fanfare for the Common Man");
				strb.append("|Debussy, Claude, French, 1862-1918, La Mer");
				strb.append("|Elgar, Edward, English, 1857-1934, Enigma Variations");
				strb.append("|Fucik, Julius, Czech, 1872-1916, Entry of the Gladiators");
				strb.append("|Gounod, Charles, French, 1818-1893, The Damnation of Faust");
				strb.append("|Handel, George, English, 1685-1759, Water Music");
				strb.append("|Isaac, Heinrich, Flemish, 1450-1517, Innsbruck Ich muss dich lassen");
				strb.append("|Joplin, Scott, American, 1868-1917, Maple Leaf Rag");
				strb.append("|Khachaturian, Aram, Armenian, 1903-1978, Sabre Dance");
				strb.append("|Lehar, Franz, Hungarian, 1870-1948, The Merry Widow");
				strb.append("|Mozart, Wolfgang, Austrian, 1756-1791, The Marriage of Figaro");
				strb.append("|Nielsen, Carl, Danish, 1865-1931, The Inextinguishable Symphony");
				strb.append("|Orff, Carl, German, 1895-1982, Carmina Burana");
				strb.append("|Prokofiev, Sergei, Russian, 1891-1953, Peter and the Wolf");
				strb.append("|Quilter, Roger, English, 1877-1953, O Mistress Mine");
				strb.append("|Rossini, Gioacchino, Italian, 1792-1868, The Barber of Seville");
				strb.append("|Sibelius, Jean, Finnish, 1865-1957, Karelia Suite");
				strb.append("|Tchaikovsky, Pyotr, Russian, 1840-1893, Swan Lake");
				strb.append("|Umlauf, Ignaz, Austrian, 1746-1796, Sophie's Song");
				strb.append("|Vivaldi, Antonio, Italian, 1678-1741, The Four Seasons");
				strb.append("|Wagner, Richard, German, 1813-1883, The Ride of the Valkyrie");
				strb.append("|Xenakis, Iannis, Greek, 1922-2001, Metastasis");
				strb.append("|Yradier, Sebastián, Spanish, 1809-1865, La Paloma");
				strb.append("|Zielenski, Mikolaj, Polish, 1555-1620, Vox in Rama");
				break;
			}
			case INSTRUMENTS:
			{
				//(prevent guess family)
				strb.append("|Violin, String, Joshua Bell");
				strb.append("|Cabasa, Percussion, ???");
				strb.append("|Balalaika, String, ???");
				strb.append("|Shakuhachi, Wind, ???");
				strb.append("|Ukulele, String, George Formby");
				strb.append("|Harmonica, Wind, Larry Adler");
				strb.append("|Harpsichord, Keyboard, Christopher Hogwood");
				strb.append("|Classical guitar, String, Julian Bream");
				strb.append("|Sitar, String, Ravi Shankar");
				break;
			}
			case FORMS:
			{
				//(prevent guess description)
				//(prevent clue form name)
				strb.append("|Fugue, Voices enter in turn");
				strb.append("|Canon, Voices enter in turn");
				strb.append("|Round, Voices enter in turn");

				strb.append("|Minuet, Dance in triple time");
				strb.append("|Waltz, Dance in triple time");

				strb.append("|Aria, Type of vocal piece");
				strb.append("|Ballad, Type of vocal piece");
				strb.append("|Chanson, Type of vocal piece");
				strb.append("|Lied, Type of vocal piece");
				strb.append("|Lute song, Type of vocal piece");
				strb.append("|Recitative, Type of vocal piece");
				strb.append("|Song, Type of vocal piece");

				strb.append("|Anthem, Type of choral piece");
				strb.append("|Chorale, Type of choral piece");
				strb.append("|Madrigal, Type of choral piece");

				strb.append("|Concerto, Type of orchestral piece");
				strb.append("|Orchestral suite, Type of orchestral piece");
				strb.append("|Symphony, Type of orchestral piece");
				strb.append("|Tone poem, Type of orchestral piece");
				break;
			}
			case DEVICES:
			{
				//(both clueable/guessable)
				strb.append("|Sequence, A pattern shifted in pitch");
				strb.append("|Augmentation, A rhythm stretched");
				strb.append("|Diminution, A rhythm compressed");
				strb.append("|Homophonic, Parts all move together");
				strb.append("|Polyphonic, Parts move independently");
				strb.append("|Crescendo, Getting louder");
				strb.append("|Diminuendo, Getting quieter");
				strb.append("|Cadence, How a phrase ends");
				strb.append("|Perfect, Type of cadence");
				strb.append("|Imperfect, Type of cadence");
				strb.append("|Plagal, Type of cadence");
				strb.append("|Interrupted, Type of cadence");
				strb.append("|Hemiola, double rhythm");
				break;
			}
		}

		return new StringTokenizer(strb.toString(), "|,");
	}
}