/*
    * Fsgrep is a simple Java application which allows a user to
    * search all files in a directory structure for lines matching
    * a given pattern.  Its functionality is a combination of the
    * Unix 'find' and 'grep' utilities.
    * Visit [http://fsgrep.sourceforge.net/] for more information.
    * 
    * Copyright (C) 2003-2006 Murali Krishnan [murali_ca_us@users.sourceforge.net]
    * 
   * Fsgrep is free software; you can redistribute it and/or modify
   * it under the terms of version 2 of the GNU General Public
   * License as published by the Free Software Foundation.
   * 
   * Fsgrep 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 General Public License for more details.
   * 
   * You should have received a copy of the GNU General Public License
   * along with Fsgrep (see the file named LICENSE.txt); if not, write
   * to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
   * Boston, MA  02111-1307  USA
   */
  
  package mk.fsgrep.gui;
  
  
  import java.util.*;
  
  import mk.fsgrep.Fsgrep;
  import mk.fsgrep.find.Finder;
  import mk.fsgrep.find.ScanProfile;
  import mk.fsgrep.util.MRUList;
  
  
  /***
   * A utility that keep a record of recently referenced scan profiles.
   * 
   * @author  Murali Krishnan
   *
   */
  public class RecentProfiles {
  
      //------------------------------------------------------------
      //- Class Variables
  
  
      protected static final String PERSISTENT_PREFIX = "recent_profile_";
  
  
      //------------------------------------------------------------
      //- Class Functions
  
  
  
      //------------------------------------------------------------
      //- Instance Variables
  
      private MRUList _list = new MRUList();
      private Map<String,Finder> _map = new HashMap<String,Finder>();
  
  
  
      //------------------------------------------------------------
      //- Constructors
  
      protected RecentProfiles() {
      }
  
  
      //------------------------------------------------------------
      //- Accessors
  
      protected MRUList getList() {return _list;}
      protected Map<String,Finder> getMap() {return _map;}
  
  
  
      //------------------------------------------------------------
      //- Settors
  
  
  
      //------------------------------------------------------------
      //- Private/Protected Utility Functions
  
      /***
       * Clear the map, then (re)populate it.
       *
       * @param model  The underlying model containing the data.
       */
      protected void refreshMap(Fsgrep model) {
          getMap().clear();
          Iterator<String> iterator = iterator();
          while (iterator.hasNext()) {
              String spec = iterator.next();
              getMap().put(spec, new Finder(model, new ScanProfile(spec)));
          }
      }
 
 
     //------------------------------------------------------------
     //- Public Interface Functions
 
     public String toString() {
         String result = "RecentProfiles[" + getList() + "]";
 
         return result;
     }
 
 
     /***
      * Add an entry to the (front of) list.  If it already exists, then just
      * move it to the front.  Also add the association to the map.
      * 
      * @param  entry  The string spec.
      * @param  pFinder  The associated Finder object.
      */
     public void add(String entry, Finder pFinder) {
         getList().add(entry);
         getMap().put(entry, pFinder);
     }
 
 
     /***
      * Lookup the Finder object for a given spec.
      * 
      * @return  The Finder object associated with the given spec.
      * @param  key  The string spec.
      */
     public Finder get(String key) {
         Finder result = getMap().get(key);
 
         return result;
     }
 
 
     /***
      * A callback function for the GUI that gets called when the user selects
      * a spec from the list.  The list gets reordered with the selected entry
      * moved to the front, and then it is persisted.
      * 
      * @param  key  The string spec chosen by the user.
      */
     public void select(String key) {
         Finder value = get(key);
 
         if (value != null) {
             add(key, value);
         }
 
         getList().saveData();
     }
 
 
     /***
      * Give the "currently selected spec" by giving the first one on the list.
      * 
      * @return  The String spec.
      */
     public String getCurrent() {
         String result = getList().getFirst();
 
         return result;
     }
 
 
     /***
      * Determine whether the given spec is on the list.
      * 
      * @return  boolean flag
      * @param  key  The String spec.
      */
     public boolean contains(String key) {
         boolean result = getList().contains(key);
 
         return result;
     }
 
 
     /***
      * Determine whether the list of specs is empty.
      * 
      * @return  boolean flag
      */
     public boolean isEmpty() {
         boolean result = getList().isEmpty();
 
         return result;
     }
 
 
     /***
      * Remove all items except the first one (current).
      * 
      */
     public void keepFirst() {
         if (!isEmpty()) {
             String currentString = getCurrent();
             Finder currentFinder = get(currentString);
 
             getList().clear();
             getMap().clear();
             add(currentString, currentFinder);
 
             getList().saveData();
         }
     }
 
 
     /***
      * Read the stored profiles from the persistent data.  This will
      * instantiate the Finder objects for each using the passed model.
      * 
      * @param  model  The model object that the finder will reference.
      */
     public void readData(Fsgrep model) {
         getList().readData(PERSISTENT_PREFIX);
         refreshMap(model);
     }
 
 
     /***
      *
      * @return  All the strings in order.
      */
     public Iterator<String> iterator() {
         return getList().iterator();
     }
 
 
     //------------------------------------------------------------
     //- Class Interface Functions
 
 
 
     //------------------------------------------------------------
     //- Inner Classes
 
 
 
     //------------------------------------------------------------
     //- Main
 
 
 
 }