/**
 * FinchDataAbstract
 * <P>
 * Your FinchData class must extends this abstract class.  This class stores
 * the "master action list" that is represented by your program.  The class 
 * provides:
 * <OL>
 * <LI> A set of methods for manipulating the master action list.  It is through
 * these methods that your FinchDisplay class will manipulate the action list.
 * <LI> A set of methods for interacting with the Finch.  Note: your FinchDisplay
 * class <B>WILL NOT</B> touch the Finch directly.
 * </OL>
 * <P>
 * Notes:
 * <OL>
 * <LI> You may need to introduce private helper methods (in particular, you have
 * already implemented some of these in previous projects and labs).
 * <LI> You should not have to introduce any other public methods.
 * </OL>
 * <P>
 * 
 * @author Andrew H. Fagg
 * 
 */

import java.io.*;
import java.util.Collections;

import finch.*;

abstract public class FinchDataAbstract {
	
	/**
	 * A reference to the Finch object
	 */
	protected Finch myFinch;
	
	
	/**
	 * The master action list
	 */
	protected FinchActionList actionList;
	
	/**
	 * Constructor
	 * 
	 * <P>
	 * @param myFinch A reference to the Finch object
	 * <P>
	 * Postconditions:
	 * <OL>
	 * <LI> The master action list is initialized with an empty list
	 * </OL>
	 */
	public FinchDataAbstract(Finch myFinch){
		this.myFinch = myFinch;
		this.actionList = new FinchActionList();
	}
	
	
	/**
	 * Accessor to the master action list.
	 * <P>
	 * @return The master action list.
	 */
	public FinchActionList getFinchActionList() {
		return(actionList);
	}
	
	/**
	 * Return the subset of the master action list that matches strg
	 * 
	 * <P>
	 * 
	 * @param strg String key
	 * @return An action list that contains only those entries of the
	 * master action list that match the name specified by strg
	 */
	abstract public FinchActionList getFinchActionList(String strg);
	
	/**
	 * Load a text file containing an action list.
	 * <P>
	 * 
	 * <P>
	 * Postconditions:
	 * <OL>
	 * <LI> The master action list is modified (assuming no file errors)
	 * </OL>
	 * <P>
	 * 
	 * @param file The name of the file to load
	 * @param merge_flag Indicates whether the loaded action list replaces
	 * the master action list or the loaded action list is merged into the 
	 * existing action list
	 */
	abstract public void loadText(File file, boolean merge_flag);
	
	
	/**
	 * Load an action list from a binary file.
	 * <P>
	 * 
	 * <P>
	 * Postconditions:
	 * <OL>
	 * <LI> The master action list is modified (assuming no file errors)
	 * </OL>
	 * <P>
	 * 
	 * @param file  The name of the file to load
	 * @param merge_flag Indicates whether the loaded action list replaces
	 * the master action list or the loaded action list is merged into the 
	 * existing action list
	 */
	abstract public void loadBinary(File file, boolean merge_flag);
	
	
	/**
	 * Write the master action list to a binary file.
	 * <P>
	 * Postconditions:
	 * <OL>
	 * <LI> The specified file is created if it does not exist.  If it
	 * does exist, the file is replaced.
	 * </OL>
	 * 
	 * <P> 
	 * @param file The name of the file to be written.
	 */
	abstract public void saveBinary(File file);
	
	
	/**
	 * Clean the master action list by deleting all duplicate entries.
	 * 
	 * <P>
	 * 
	 * Postconditions:
	 * <OL>
	 * <LI> The master action list does not have duplicate entries 
	 * (defined by name and priority)
	 * </OL>
	 *
	 */
	abstract public void clean();
	
	
	/**
	 * Delete the specified FinchAction from the master action list. 
	 * 
	 * <P>
	 * Note: equality is defined by the equality of the reference
	 * (hint: review the available ArrayList methods)
	 *
	 * 
	 * <P>
	 * Postconditions:
	 * <OL>
	 * <LI> The master action list is modified.
	 * </OL>
	 * 
	 * <P>
	 * @param action A FinchAction to be deleted
	 */
	
	abstract public void delete(FinchAction action);

	/**
	 * Add a FinchAction to the master action list
	 * 
	 * @param action The FinchAction to be added to the master action list.
	 * 
	 * <P>
	 * Postconditions:
	 * <OL>
	 * <LI> The master action list is modified.
	 * <LI> The master action list is sorted.
	 * </OL>
	 */
	abstract public void add(FinchAction action);
	
	/**
	 * Execute the master action list (or a subset of it).
	 * 
	 * 
	 * <P>
	 * Postconditions:
	 * <OL>
	 * <LI> The Finch executed the specified actions.
	 * </OL>
	 * 
	 * <P>
	 * @param name The action names to execute.  If "all", then
	 * execute all actions.
	 * @param reverse If true, then execute the actions in reverse order.
	 * Note that ordering is defined first by name and then by priority.
	 * 
	 */
	abstract public void execute(String name, boolean reverse);
	
}