Class WekaClusterEvaluationSummary

  • 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 WekaClusterEvaluationSummary
    extends AbstractTransformer
    Generates a summary string of the weka.clusterers.ClusterEvaluation objects that it receives.

    - accepts:
    - generates:

    Container information:
    - adams.flow.container.WekaClusterEvaluationContainer: Evaluation, Model, Log-likelohood

    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: WekaClusterEvaluationSummary
    -annotation <adams.core.base.BaseText> (property: annotations)
        The annotations to attach to this actor.
    -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.
    -comment <adams.core.base.BaseText> (property: comment)
        An optional comment to output in the summary.
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Detail

      • m_Comment

        protected BaseText m_Comment
        an optional comment to output.
    • Constructor Detail

      • WekaClusterEvaluationSummary

        public WekaClusterEvaluationSummary()
    • Method Detail

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        weka.clusterers.ClusterEvaluation.class, adams.flow.container.WekaClusterEvaluationContainer.class
      • generates

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

        public void setComment​(BaseText value)
        Sets the comment to output in the summary.
        value - the comment
      • getComment

        public BaseText getComment()
        Returns the comment to output in the summary.
        the comment
      • commentTipText

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

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