weka.knowledgeflow.steps.KFStep Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of weka-stable Show documentation

The Waikato Environment for Knowledge Analysis (WEKA), a machine learning workbench. This is the stable version. Apart from bugfixes, this version does not receive any other updates.

There is a newer version: 3.8.6

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

/*
 *    KFStep.java
 *    Copyright (C) 2015 University of Waikato, Hamilton, New Zealand
 *
 */

package weka.knowledgeflow.steps;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * KFStep class annotation
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface KFStep {

  /**
   * The name of this step
   * 
   * @return the name of the step
   */
  String name();

  /**
   * The top-level folder in the JTree that this step should appear in
   * 
   * @return the name of the top-level folder that this step should appear in
   */
  String category();

  /**
   * Mouse-over tool tip for this step (appears when the mouse hovers over the
   * entry in the JTree)
   * 
   * @return the tool tip text for this step
   */
  String toolTipText();

  /**
   * Path (as a resource on the classpath) to the icon for this step
   * 
   * @return the path to the icon for this step
   */
  String iconPath();

  /**
   * True if this processing step is resource intensive (cpu or memory).
   * BaseExecution environment will use the limited number of worker thread
   * executor service to execute this step in this case.
   *
   * @return true if this step is CPU-intensive
   */
  boolean resourceIntensive() default false;
}