Class WekaExperimentExecution

  • 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 WekaExperimentExecution
    extends AbstractTransformer
    Executes an experiment. The jobrunner of the experiment can be overriden.

    - accepts:
    - generates:

    Container information:
    - adams.flow.container.WekaExperimentContainer: Experiment, Instances, Spreadsheet

    -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: WekaExperimentExecution
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
        The annotations to attach to this actor.
    -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 
        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
    -override-jobrunner <boolean> (property: overrideJobRunner)
        If enabled, the jobrunner of the experiments gets replaced with the one 
        specified here.
        default: false
    -jobrunner <adams.multiprocess.JobRunner> (property: jobRunner)
        The JobRunner to use for processing the jobs.
        default: adams.multiprocess.LocalJobRunner
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Detail

      • m_OverrideJobRunner

        protected boolean m_OverrideJobRunner
        whether to override the jobrunner in the experiment.
      • m_JobRunner

        protected JobRunner m_JobRunner
        the JobRunner template.
      • m_Experiment

        protected transient AbstractExperiment m_Experiment
        the current experiment.
    • Constructor Detail

      • WekaExperimentExecution

        public WekaExperimentExecution()
    • Method Detail

      • setOverrideJobRunner

        public void setOverrideJobRunner​(boolean value)
        Sets whether to override the jobrunner of the experiment.
        value - true if to override
      • getOverrideJobRunner

        public boolean getOverrideJobRunner()
        Returns whether to override the jobrunner of the experiment.
        true if to override
      • overrideJobRunnerTipText

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

        public void setJobRunner​(JobRunner value)
        Sets the jobrunner for the experiment.
        value - the jobrunner
      • getJobRunner

        public JobRunner getJobRunner()
        Returns the jobrunner for the experiment.
        the jobrunner
      • jobRunnerTipText

        public String jobRunnerTipText()
        Returns the tip text for this property.
        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.
        the Class of objects that can be processed
      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        the Class of the generated tokens
      • doExecute

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