Class WekaExtractArray

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable

    public class WekaExtractArray
    extends AbstractTransformer
    Extracts a column or row of data from a weka.core.Instances or SpreadSheet object.
    Only numeric columns can be returned. In case of row-retrieval, the value of the internal format of the weka.core.Instance object is returned; for SpreadSheet object it is attempted to convert the cell content to double (null values might get returned!).

    Input/output:
    - accepts:
       weka.core.Instances
       adams.core.io.SpreadSheet
    - generates:
       java.lang.Double[]


    Valid options are:

    -D <int> (property: debugLevel)
        The greater the number the more additional info the scheme may output to
        the console (0 = off).
        default: 0
        minimum: 0
     
    -name <java.lang.String> (property: name)
        The name of the actor.
        default: ExtractArray
     
    -annotation <adams.core.base.BaseText> (property: annotations)
        The annotations to attach to this actor.
        default:
     
    -skip (property: skip)
        If set to true, transformation is skipped and the input token is just forwarded
        as it is.
     
    -stop-flow-on-error (property: stopFlowOnError)
        If set to true, the flow gets stopped in case this actor encounters an error;
         useful for critical actors.
     
    -type <COLUMN|ROW> (property: type)
        The type of extraction to perform, row or column.
        default: COLUMN
     
    -index <java.lang.String> (property: index)
        The index of the row/column to extract.
        default: first
     
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Constructor Detail

      • WekaExtractArray

        public WekaExtractArray()
    • Method Detail

      • initialize

        protected void initialize()
        Initializes the member variables.
        Overrides:
        initialize in class AbstractActor
      • typeTipText

        public String typeTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setIndex

        public void setIndex​(Index value)
        Sets the type of extraction to perform.
        Parameters:
        value - the type
      • getIndex

        public Index getIndex()
        Returns the type of extraction to perform.
        Returns:
        the type
      • indexTipText

        public String indexTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Returns:
        weka.core.Instances.class, adams.core.io.SpreadSheet.class
      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        java.lang.Double[].class
      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message