• Home
• nz.ac.waikato.cms.weka
• weka-dev
• 3.7.12
• source code
• AbstractFileBasedStopwords.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

weka.core.stopwords.AbstractFileBasedStopwords Maven / Gradle / Ivy

/*
 *   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 .
 */

/*
 * AbstractFileBasedStopwords.java
 * Copyright (C) 2014 University of Waikato, Hamilton, New Zealand
 */

package weka.core.stopwords;

import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Enumeration;
import java.util.List;
import java.util.Vector;

import weka.core.Option;
import weka.core.Utils;

/**
 * Ancestor for file-based stopword schemes.
 *
 * @author  fracpete (fracpete at waikato dot ac dot nz)
 * @version $Revision: 10982 $
 */
public abstract class AbstractFileBasedStopwords
  extends AbstractStopwords {

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

  /** a file containing stopwords. */
  protected File m_Stopwords = new File(System.getProperty("user.dir"));

  /**
   * Returns an enumeration describing the available options.
   *
   * @return an enumeration of all the available options.
   */
  @Override
  public Enumeration listOptions() {
    Vector result = new Vector();

    Enumeration enm = super.listOptions();
    while (enm.hasMoreElements())
      result.add(enm.nextElement());

    result.addElement(new Option(
      "\t" + stopwordsTipText() + "\n"
      + "\t(default: .)",
      "stopwords", 1, "-stopwords "));

    return result.elements();
  }

  /**
   * Parses a given list of options.
   *
   * @param options the list of options as an array of strings
   * @throws Exception if an option is not supported
   */
  @Override
  public void setOptions(String[] options) throws Exception {
    String	tmpStr;

    tmpStr = Utils.getOption("stopwords", options);
    if (tmpStr.isEmpty())
      setStopwords(new File("."));
    else
      setStopwords(new File(tmpStr));

    super.setOptions(options);
  }

  /**
   * Gets the current settings of the Classifier.
   *
   * @return an array of strings suitable for passing to setOptions
   */
  @Override
  public String[] getOptions() {
    List options = new ArrayList(Arrays.asList(super.getOptions()));

    options.add("-stopwords");
    options.add(getStopwords().toString());

    return options.toArray(new String[options.size()]);
  }

  /**
   * Sets the file containing the stopwords, null or a directory unset the
   * stopwords.
   *
   * @param value 	the file containing the stopwords
   */
  public void setStopwords(File value) {
    if (value == null) {
      value = new File(System.getProperty("user.dir"));
    }

    m_Stopwords = value;
    reset();
  }

  /**
   * returns the file used for obtaining the stopwords, if the file represents a
   * directory then the default ones are used.
   *
   * @return the file containing the stopwords
   */
  public File getStopwords() {
    return m_Stopwords;
  }

  /**
   * Returns the tip text for this property.
   *
   * @return tip text for this property suitable for displaying in the
   *         explorer/experimenter gui
   */
  public abstract String stopwordsTipText();

  /**
   * Reads in the stopwords file, line by line (trimmed).
   * Returns an empty list if not existing or a directory.
   *
   * @return		the content of the file
   */
  protected List read() {
    List	result;
    String		line;
    BufferedReader	reader;

    result = new ArrayList();

    if (m_Stopwords.exists() && !m_Stopwords.isDirectory()) {
      reader = null;
      try {
	reader = new BufferedReader(new FileReader(m_Stopwords));
	while ((line = reader.readLine()) != null)
	  result.add(line.trim());
      }
      catch (Exception e) {
	error("Failed to read stopwords file '" + m_Stopwords + "'!");
	e.printStackTrace();
      }
      finally {
	if (reader != null) {
	  try {
	    reader.close();
	  }
	  catch (Exception ex) {
	    // ignored
	  }
	}
      }
    }

    return result;
  }
}