Package adams.flow.transformer.wekapackagemanageraction

Class InstallOfficial

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.SizeOfHandler, adams.flow.core.FlowContextHandler, Serializable
    public class InstallOfficial
extends AbstractWekaPackageManagerAction
    Action that installs official packages via their name and (optional) version.
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.data.spreadsheet.SpreadSheetColumnIndex m_ColName
      the column with the name.
      protected adams.data.spreadsheet.SpreadSheetColumnIndex m_ColVersion
      the column with the version.

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

        m_OptionManager

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

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Constructor Summary

      Constructors 
      Constructor Description
      InstallOfficial()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Class[] accepts()
      The types of data the action accepts.
      String colNameTipText()
      Returns the tip text for this property.
      String colVersionTipText()
      Returns the tip text for this property.
      void defineOptions()
      Adds options to the internal list of options.
      Object doExecute​(Object input, adams.core.MessageCollection errors)
      Executes the action.
      Class[] generates()
      The types of data the action generates.
      adams.data.spreadsheet.SpreadSheetColumnIndex getColName()
      Returns the spreadsheet column with the name.
      adams.data.spreadsheet.SpreadSheetColumnIndex getColVersion()
      Returns the (optional) spreadsheet column with the version.
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      String globalInfo()
      Returns a string describing the object.
      void setColName​(adams.data.spreadsheet.SpreadSheetColumnIndex value)
      Sets the spreadsheet column with the name.
      void setColVersion​(adams.data.spreadsheet.SpreadSheetColumnIndex value)
      Sets the (optional) spreadsheet column with the version.

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

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, 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_ColName

        protected adams.data.spreadsheet.SpreadSheetColumnIndex m_ColName
        the column with the name.

      • m_ColVersion

        protected adams.data.spreadsheet.SpreadSheetColumnIndex m_ColVersion
        the column with the version.

    • Constructor Detail

      • InstallOfficial

        public InstallOfficial()

    • 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

      • setColName

        public void setColName​(adams.data.spreadsheet.SpreadSheetColumnIndex value)
        Sets the spreadsheet column with the name.
        Parameters:
        value - the column

      • getColName

        public adams.data.spreadsheet.SpreadSheetColumnIndex getColName()
        Returns the spreadsheet column with the name.
        Returns:
        the column

      • colNameTipText

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

      • setColVersion

        public void setColVersion​(adams.data.spreadsheet.SpreadSheetColumnIndex value)
        Sets the (optional) spreadsheet column with the version.
        Parameters:
        value - the column

      • getColVersion

        public adams.data.spreadsheet.SpreadSheetColumnIndex getColVersion()
        Returns the (optional) spreadsheet column with the version.
        Returns:
        the column

      • colVersionTipText

        public String colVersionTipText()
        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 actor, which will be displayed in the GUI.
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class AbstractWekaPackageManagerAction
        Returns:
        null if no info available, otherwise short string

      • doExecute

        public Object doExecute​(Object input,
                        adams.core.MessageCollection errors)
        Executes the action.
        Specified by:
        doExecute in class AbstractWekaPackageManagerAction
        Parameters:
        input - the input to process
        errors - for collecting errors
        Returns:
        the generated output, null if failed to generated