meka.gui.core.RecentFilesHandler Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of meka Show documentation

The MEKA project provides an open source implementation of methods for multi-label classification and evaluation. It is based on the WEKA Machine Learning Toolkit. Several benchmark methods are also included, as well as the pruned sets and classifier chains methods, other methods from the scientific literature, and a wrapper to the MULAN framework.

There is a newer version: 1.9.7

Show newest version

/*
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation, either version 3 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 General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program.  If not, see .
 */

/*
 * RecentFilesHandler.java
 * Copyright (C) 2009-2013 University of Waikato, Hamilton, New Zealand
 */

package meka.gui.core;

import meka.core.FileUtils;

import java.io.File;
import java.util.HashSet;

/**
 * A class that handles a list of recent files. Reads/writes them from/to
 * a props file in the application's home directory.
 *
 * @author  fracpete (fracpete at waikato dot ac dot nz)
 * @version $Revision: 10824 $
 */
public class RecentFilesHandler
  extends AbstractRecentItemsHandler {

  /** for serialization. */
  private static final long serialVersionUID = 7532226757387619342L;

  /** the property for storing the number of recent files. */
  public final static String RECENTFILES_COUNT = "RecentFilesCount";

  /** the property prefix for a recent file. */
  public final static String RECENTFILES_PREFIX = "RecentFile.";

  /** the minimum number of parent directories to use. */
  protected int m_MinNumParentDirs;
  
  /**
   * Initializes the handler with a maximum of 5 items.
   *
   * @param propsFile	the props file to store the files in
   * @param menu	the menu to add the recent files as subitems to
   */
  public RecentFilesHandler(String propsFile, M menu) {
    super(propsFile, menu);
  }

  /**
   * Initializes the handler.
   *
   * @param propsFile	the props file to store the files in
   * @param maxCount	the maximum number of files to keep in menu
   * @param menu	the menu to add the recent files as subitems to
   */
  public RecentFilesHandler(String propsFile, int maxCount, M menu) {
    super(propsFile, maxCount, menu);
  }

  /**
   * Initializes the handler.
   *
   * @param propsFile	the props file to store the files in
   * @param propPrefix	the properties prefix, use null to ignore
   * @param maxCount	the maximum number of files to keep in menu
   * @param menu	the menu to add the recent files as subitems to
   */
  public RecentFilesHandler(String propsFile, String propPrefix, int maxCount, M menu) {
    super(propsFile, propPrefix, maxCount, menu);
  }

  /**
   * Checks the item after obtaining from the props file.
   * 


   * File must exist.
   * 
   * @param item	the item to check
   * @return		true if checks passed
   */
  @Override
  protected boolean check(File item) {
    return item.exists();
  }
  
  /**
   * Determines the minimum number of parent directories that need to be
   * included in the filename to make the filenames in the menu distinguishable.
   *
   * @return		the minimum number of parent directories, -1 means
   * 			full path
   */
  protected synchronized int determineMinimumNumberOfParentDirs() {
    int			result;
    HashSet files;
    int			num;
    int			i;
    int			max;

    result = -1;

    max = 0;
    for (i = 0; i < m_RecentItems.size(); i++)
      max = Math.max(max, FileUtils.getDirectoryDepth(m_RecentItems.get(i)));

    num = 0;
    do {
      files = new HashSet();
      for (i = 0; i < m_RecentItems.size(); i++)
	files.add(FileUtils.createPartialFilename(m_RecentItems.get(i), num));
      if (files.size() == m_RecentItems.size())
	result = num;
      else
	num++;
    }
    while ((files.size() < m_RecentItems.size()) && (num <= max));

    return result;
  }

  /**
   * Returns the key to use for the counts in the props file.
   * 
   * @return		the key
   */
  @Override
  protected String getCountKey() {
    return RECENTFILES_COUNT;
  }

  /**
   * Returns the key prefix to use for the items in the props file.
   * 
   * @return		the prefix
   */
  @Override
  protected String getItemPrefix() {
    return RECENTFILES_PREFIX;
  }

  /**
   * Turns an object into a string for storing in the props.
   * 
   * @param obj		the object to convert
   * @return		the string representation
   */
  @Override
  protected String toString(File obj) {
    return obj.getAbsolutePath();
  }

  /**
   * Turns the string obtained from the props into an object again.
   * 
   * @param s		the string representation
   * @return		the parsed object
   */
  @Override
  protected File fromString(String s) {
    return new File(s);
  }

  /**
   * Hook method which gets executed just before updating the menu.
   */
  @Override
  protected void preUpdateMenu() {
    super.preUpdateMenu();
    
    m_MinNumParentDirs = determineMinimumNumberOfParentDirs();
  }

  /**
   * Generates the text for the menuitem.
   * 
   * @param index	the index of the item
   * @param item	the item itself
   * @return		the generated text
   */
  @Override
  protected String createMenuItemText(int index, File item) {
    return FileUtils.createPartialFilename(item, m_MinNumParentDirs);
  }
}