Package adams.data.conversion

Class WekaPredictionContainerToEvaluationContainer

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<adams.data.conversion.AbstractConversion>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.data.conversion.Conversion, Serializable
    public class WekaPredictionContainerToEvaluationContainer
extends adams.data.conversion.AbstractConversion
    Turns a adams.flow.container.WekaPredictionContainer into a knir.flow.container.EvaluationContainer. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -id <java.lang.String> (property: ID)
    The (optional) ID for the evaluation (to be used instead of component).
    default:
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected String m_Component
      the optional component to store.
      protected String m_ID
      the optional ID to store.
      protected String m_Version
      the optional version to store.

      • Fields inherited from class adams.data.conversion.AbstractConversion

        m_Input, m_Output, m_Owner, m_Stopped

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Class accepts()
      Returns the class that is accepted as input.
      String componentTipText()
      Returns the tip text for this property.
      void defineOptions()
      Adds options to the internal list of options.
      protected Object doConvert()
      Performs the actual conversion.
      Class generates()
      Returns the class that is generated as output.
      String getComponent()
      Returns the component to use for the evaluation.
      String getID()
      Returns the ID to use for the evaluation (to be used instead of component).
      String getQuickInfo()
      Returns a quick info about the object, which can be displayed in the GUI.
      String getVersion()
      Returns the version to use for the evaluation.
      String globalInfo()
      Returns a string describing the object.
      String IDTipText()
      Returns the tip text for this property.
      void setComponent​(String value)
      Sets the component to use for the evaluation.
      void setID​(String value)
      Sets the ID to use for the evaluation (to be used instead of component).
      void setVersion​(String value)
      Sets the version to use for the evaluation.
      String versionTipText()
      Returns the tip text for this property.

      • Methods inherited from class adams.data.conversion.AbstractConversion

        checkData, cleanUp, convert, getAdditionalInformation, getInput, getInput, getOutput, getOutput, getOwner, reset, setInput, setOwner, shallowCopy, shallowCopy, stopExecution

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

      • Methods inherited from class adams.core.logging.LoggingObject

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel

    • Field Detail

      • m_Component

        protected String m_Component
        the optional component to store.

      • m_Version

        protected String m_Version
        the optional version to store.

      • m_ID

        protected String m_ID
        the optional ID to store.

    • Constructor Detail

      • WekaPredictionContainerToEvaluationContainer

        public WekaPredictionContainerToEvaluationContainer()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui

      • defineOptions

        public void defineOptions()
        Adds options to the internal list of options.
        Specified by:
        defineOptions in interface adams.core.option.OptionHandler
        Overrides:
        defineOptions in class adams.core.option.AbstractOptionHandler

      • setComponent

        public void setComponent​(String value)
        Sets the component to use for the evaluation.
        Parameters:
        value - the component

      • getComponent

        public String getComponent()
        Returns the component to use for the evaluation.
        Returns:
        the component

      • componentTipText

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

      • setVersion

        public void setVersion​(String value)
        Sets the version to use for the evaluation.
        Parameters:
        value - the version

      • getVersion

        public String getVersion()
        Returns the version to use for the evaluation.
        Returns:
        the version

      • versionTipText

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

      • setID

        public void setID​(String value)
        Sets the ID to use for the evaluation (to be used instead of component).
        Parameters:
        value - the ID

      • getID

        public String getID()
        Returns the ID to use for the evaluation (to be used instead of component).
        Returns:
        the ID

      • IDTipText

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

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the object, which can be displayed in the GUI.
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class adams.data.conversion.AbstractConversion
        Returns:
        null if no info available, otherwise short string

      • accepts

        public Class accepts()
        Returns the class that is accepted as input.
        Specified by:
        accepts in interface adams.data.conversion.Conversion
        Specified by:
        accepts in class adams.data.conversion.AbstractConversion
        Returns:
        the class

      • generates

        public Class generates()
        Returns the class that is generated as output.
        Specified by:
        generates in interface adams.data.conversion.Conversion
        Specified by:
        generates in class adams.data.conversion.AbstractConversion
        Returns:
        the class

      • doConvert

        protected Object doConvert()
                    throws Exception
        Performs the actual conversion.
        Specified by:
        doConvert in class adams.data.conversion.AbstractConversion
        Returns:
        the converted data
        Throws:
        Exception - if something goes wrong with the conversion