• Home
• nz.ac.waikato.cms.weka
• weka-stable
• 3.8.0
• source code
• CheckGOE.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.CheckGOE 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 .
 */

/*
 *    CheckGOE.java
 *    Copyright (C) 2007-2012 University of Waikato, Hamilton, New Zealand
 *
 */

package weka.core;

import weka.gui.ProgrammaticProperty;

import java.beans.BeanInfo;
import java.beans.Introspector;
import java.beans.PropertyDescriptor;
import java.util.Collections;
import java.util.Enumeration;
import java.util.HashSet;
import java.util.Vector;

/**
 * Simple command line checking of classes that are editable in the GOE.
 * 

 * 
 * Usage:
 * 

 * 
 *     CheckGOE -W classname -- test options
 * 
 * 

 * 
 *  Valid options are:
 * 

 * 
 * 
 * -D
 *  Turn on debugging output.
 * 
 * 
 * 
 * -S
 *  Silent mode - prints nothing to stdout.
 * 
 * 
 * 
 * -ignored <comma-separated list of properties>
 *  Skipped properties.
 *  (default: capabilities,options)
 * 
 * 
 * 
 * -W
 *  Full name of the class analysed.
 *  eg: weka.classifiers.rules.ZeroR
 *  (default weka.classifiers.rules.ZeroR)
 * 
 * 
 * 
 * 
 * @author FracPete (fracpete at waikato dot ac dot nz)
 * @version $Revision: 11726 $
 */
public class CheckGOE extends Check {

  /** the object to test */
  protected Object m_Object = new weka.classifiers.rules.ZeroR();

  /** whether the tests were successful */
  protected boolean m_Success;

  /**
   * properties that are skipped in the checkToolTips method
   * 
   * @see #checkToolTips()
   */
  protected HashSet m_IgnoredProperties = new HashSet();

  /**
   * default constructor
   */
  public CheckGOE() {
    super();

    // set default options
    try {
      setOptions(new String[0]);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }

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

    result.addAll(Collections.list(super.listOptions()));

    result.addElement(new Option("\tSkipped properties.\n"
      + "\t(default: capabilities,options)", "ignored", 1,
      "-ignored "));

    result.addElement(new Option("\tFull name of the class analysed.\n"
      + "\teg: weka.classifiers.rules.ZeroR\n"
      + "\t(default weka.classifiers.rules.ZeroR)", "W", 1, "-W"));

    return result.elements();
  }

  /**
   * Parses a given list of options.
   * 

   * 
   *  Valid options are:
   * 

   * 
   * 
   * -D
   *  Turn on debugging output.
   * 
   * 
   * 
   * -S
   *  Silent mode - prints nothing to stdout.
   * 
   * 
   * 
   * -ignored <comma-separated list of properties>
   *  Skipped properties.
   *  (default: capabilities,options)
   * 
   * 
   * 
   * -W
   *  Full name of the class analysed.
   *  eg: weka.classifiers.rules.ZeroR
   *  (default weka.classifiers.rules.ZeroR)
   * 
   * 
   * 
   * 
   * @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;

    super.setOptions(options);

    tmpStr = Utils.getOption('W', options);
    if (tmpStr.length() == 0) {
      tmpStr = weka.classifiers.rules.ZeroR.class.getName();
    }
    setObject(Utils.forName(Object.class, tmpStr, null));

    tmpStr = Utils.getOption("ignored", options);
    if (tmpStr.length() == 0) {
      tmpStr = "capabilities,options";
    }
    setIgnoredProperties(tmpStr);
  }

  /**
   * Gets the current settings of the object.
   * 
   * @return an array of strings suitable for passing to setOptions
   */
  @Override
  public String[] getOptions() {
    Vector result = new Vector();

    Collections.addAll(result, super.getOptions());

    result.add("-ignored");
    result.add(getIgnoredProperties());

    if (getObject() != null) {
      result.add("-W");
      result.add(getObject().getClass().getName());
    }

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

  /**
   * Set the object to work on..
   * 
   * @param value the object to use.
   */
  public void setObject(Object value) {
    m_Object = value;
  }

  /**
   * Get the object used in the tests.
   * 
   * @return the object used in the tests.
   */
  public Object getObject() {
    return m_Object;
  }

  /**
   * Sets the properties to ignore in checkToolTips(). Comma-separated list.
   * 
   * @param value the list of properties
   * @see #checkToolTips()
   */
  public void setIgnoredProperties(String value) {
    String[] props;
    int i;

    m_IgnoredProperties.clear();
    props = value.split(",");
    for (i = 0; i < props.length; i++) {
      m_IgnoredProperties.add(props[i]);
    }
  }

  /**
   * Get the ignored properties used in checkToolTips() as comma-separated list
   * (sorted).
   * 
   * @return the ignored properties
   * @see #checkToolTips()
   */
  public String getIgnoredProperties() {
    String result;
    Vector list;
    int i;

    list = new Vector();
    list.addAll(m_IgnoredProperties);

    // sort
    if (list.size() > 1) {
      Collections.sort(list);
    }

    result = "";
    for (i = 0; i < list.size(); i++) {
      if (i > 0) {
        result += ",";
      }
      result += list.get(i);
    }

    return result;
  }

  /**
   * returns the success of the tests
   * 
   * @return true if the tests were successful
   */
  public boolean getSuccess() {
    return m_Success;
  }

  /**
   * checks whether the object declares a globalInfo method.
   * 
   * @return true if the test was passed
   */
  public boolean checkGlobalInfo() {
    boolean result;
    Class cls;

    print("Global info...");

    result = true;
    cls = getObject().getClass();

    // test for globalInfo method
    try {
      cls.getMethod("globalInfo", (Class[]) null);
    } catch (Exception e) {
      result = false;
    }

    if (result) {
      println("yes");
    } else {
      println("no");
    }

    return result;
  }

  /**
   * checks whether the object declares tip text method for all its properties.
   * 
   * @return true if the test was passed
   */
  public boolean checkToolTips() {
    boolean result;
    Class cls;
    BeanInfo info;
    PropertyDescriptor[] desc;
    int i;
    Vector missing;
    String suffix;

    print("Tool tips...");

    result = true;
    suffix = "TipText";
    cls = getObject().getClass();

    // get properties
    try {
      info = Introspector.getBeanInfo(cls, Object.class);
      desc = info.getPropertyDescriptors();
    } catch (Exception e) {
      e.printStackTrace();
      desc = null;
    }

    // test for TipText methods
    if (desc != null) {
      missing = new Vector();

      for (i = 0; i < desc.length; i++) {
        // skip property?
        if (m_IgnoredProperties.contains(desc[i].getName())) {
          continue;
        }
        if ((desc[i].getReadMethod() == null)
          || (desc[i].getWriteMethod() == null)) {
          continue;
        }

        OptionMetadata m = desc[i].getReadMethod().getAnnotation(OptionMetadata.class);
        if (m == null) {
          m = desc[i].getWriteMethod().getAnnotation(OptionMetadata.class);
        }
        if (m != null) {
          continue;
        }

        // programatic properties don't need tip texts
        ProgrammaticProperty p = desc[i].getReadMethod().getAnnotation(ProgrammaticProperty.class);
        if (p == null) {
          p = desc[i].getWriteMethod().getAnnotation(ProgrammaticProperty.class);
        }
        if (p != null) {
          continue;
        }

        try {
          cls.getMethod(desc[i].getName() + suffix, (Class[]) null);
        } catch (Exception e) {
          result = false;
          missing.add(desc[i].getName() + suffix);
        }
      }

      if (result) {
        println("yes");
      } else {
        println("no (missing: " + missing + ")");
      }

    } else {
      println("maybe");
    }

    return result;
  }

  /**
   * Runs some diagnostic tests on the object. Output is printed to System.out
   * (if not silent).
   */
  @Override
  public void doTests() {
    println("Object: " + m_Object.getClass().getName() + "\n");

    println("--> Tests");

    m_Success = checkGlobalInfo();

    if (m_Success) {
      m_Success = checkToolTips();
    }
  }

  /**
   * Returns the revision string.
   * 
   * @return the revision
   */
  @Override
  public String getRevision() {
    return RevisionUtils.extract("$Revision: 11726 $");
  }

  /**
   * Main method for using the CheckGOE.
   * 
   * @param args the options to the CheckGOE
   */
  public static void main(String[] args) {
    CheckGOE check = new CheckGOE();
    runCheck(check, args);
    if (check.getSuccess()) {
      System.exit(0);
    } else {
      System.exit(1);
    }
  }
}