Package adams.flow.transformer.wekapackagemanageraction

Class InstallOfficial

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.wekapackagemanageraction.AbstractWekaPackageManagerAction

adams.flow.transformer.wekapackagemanageraction.InstallOfficial

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, 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 SpreadSheetColumnIndex	m_ColName	the column with the name.
protected SpreadSheetColumnIndex	m_ColVersion	the column with the version.

Fields inherited from class adams.flow.transformer.wekapackagemanageraction.AbstractWekaPackageManagerAction

m_FlowContext

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

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, MessageCollection errors)	Executes the action.
Class[]	generates()	The types of data the action generates.
SpreadSheetColumnIndex	getColName()	Returns the spreadsheet column with the name.
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(SpreadSheetColumnIndex value)	Sets the spreadsheet column with the name.
void	setColVersion(SpreadSheetColumnIndex value)	Sets the (optional) spreadsheet column with the version.

Methods inherited from class adams.flow.transformer.wekapackagemanageraction.AbstractWekaPackageManagerAction

check, execute, getFlowContext, setFlowContext, unhandledInputType

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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_ColName

protected SpreadSheetColumnIndex m_ColName

the column with the name.

m_ColVersion

protected 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 GlobalInfoSupporter

Specified by:

globalInfo in class 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 OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setColName

public void setColName(SpreadSheetColumnIndex value)

Sets the spreadsheet column with the name.

Parameters:

value - the column

getColName

public 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(SpreadSheetColumnIndex value)

Sets the (optional) spreadsheet column with the version.

Parameters:

value - the column

getColVersion

public 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 QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractWekaPackageManagerAction

Returns:

null if no info available, otherwise short string

accepts

public Class[] accepts()

The types of data the action accepts.

Specified by:

accepts in class AbstractWekaPackageManagerAction

Returns:

the input types

generates

public Class[] generates()

The types of data the action generates.

Specified by:

generates in class AbstractWekaPackageManagerAction

Returns:

the output types

doExecute

public Object doExecute(Object input,
                        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