Annotation Type KFStep


  • @Documented
    @Retention(RUNTIME)
    @Target(TYPE)
    public @interface KFStep
    Optional annotation for plugin beans in the Knowledge Flow. The main purpose is to provide info on which top-level folder (category) the plugin should appear under in the GUI. Note that learning algorithms automatically appear in the Knowledge Flow under the correct category as long as they are in the classpath or are provided in packages. This annotation mechanism is useful for plugin components that are not standard Weka classifiers, clusterers, associators, loaders etc.
    Version:
    $Revision: 8034 $
    Author:
    Mark Hall (mhall{[at]}pentaho{[dot]}com)
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String category
      The top-level folder in the JTree that this plugin bean should appear in
      java.lang.String toolTipText
      Mouse-over tool tip for this plugin component (appears when the mouse hovers over the entry in the JTree)
    • Element Detail

      • category

        java.lang.String category
        The top-level folder in the JTree that this plugin bean should appear in
        Returns:
        the name of the top-level folder that this plugin bean should appear in
      • toolTipText

        java.lang.String toolTipText
        Mouse-over tool tip for this plugin component (appears when the mouse hovers over the entry in the JTree)
        Returns:
        the tool tip text for this plugin bean