Package adams.flow.sink

Class WekaExperimentFileWriter

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, FileWriter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, Serializable, Comparable
    public class WekaExperimentFileWriter
extends AbstractFileWriter
    Saves an experiment file.

    Input/output:
    - accepts:
       adams.gui.tools.wekamultiexperimenter.experiment.AbstractExperiment


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: WekaExperimentFileWriter
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default: 
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow execution at this level gets stopped in case this 
    actor encounters an error; the error gets propagated; useful for critical 
    actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing 
    actor handler must have this enabled as well.
    default: false
 
    -output <adams.core.io.PlaceholderFile> (property: outputFile)
    The file to write the experiment to.
    default: ${CWD}
 
    -handler <adams.gui.tools.wekamultiexperimenter.io.AbstractExperimentIO> (property: handler)
    The I/O handler to use.
    default: adams.gui.tools.wekamultiexperimenter.io.DefaultAdamsExperimentIO
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Constructor Detail

      • WekaExperimentFileWriter

        public WekaExperimentFileWriter()

    • Method Detail

      • getDefaultHandler

        protected AbstractExperimentIO getDefaultHandler()
        Returns the default IO handler.
        Returns:
        the handler

      • setHandler

        public void setHandler​(AbstractExperimentIO value)
        Sets the IO handler.
        Parameters:
        value - the handler

      • getHandler

        public AbstractExperimentIO getHandler()
        Returns the IO handler.
        Returns:
        the handler

      • handlerTipText

        public String handlerTipText()
        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:
        the Class of objects that can be processed

      • doExecute

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