Package adams.gui.scripting

Class RemoveData

java.lang.Object

adams.core.logging.LoggingObject

adams.gui.scripting.AbstractScriptlet

adams.gui.scripting.AbstractUndoScriptlet

adams.gui.scripting.AbstractDataContainerPanelScriptlet

adams.gui.scripting.RemoveData

All Implemented Interfaces:

LoggingSupporter, SizeOfHandler, Stoppable, StoppableWithFeedback, UndoHandler, Serializable, Comparable

public class RemoveData
extends AbstractDataContainerPanelScriptlet

Action parameters:

   remove-data <comma-separated list of 1-based indices>

Description:

   Removes the data containers with the specified indices.
    NB: index is based on the order the data containers have beeen loaded into
    the system, includes all data containers, not just visible ones.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	ACTION	the action to execute.

Fields inherited from class adams.gui.scripting.AbstractScriptlet

m_DataProvider, m_Owner, m_Parameters, m_Stopped

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
RemoveData()

Method Summary

Modifier and Type	Method	Description
protected String	doProcess(String options)	Processes the options.
String	getAction()	Returns the action string used in the command processor.
String	getDescription()	Returns the full description of the action.
protected String	getOptionsDescription()	Returns a one-line listing of the options of the action.

Methods inherited from class adams.gui.scripting.AbstractDataContainerPanelScriptlet

getDataContainerPanel, getRequirements

Methods inherited from class adams.gui.scripting.AbstractUndoScriptlet

addUndoPoint, getUndo, isUndoSupported, setUndo

Methods inherited from class adams.gui.scripting.AbstractScriptlet

compareTo, equals, forName, getBasePanel, getDataProvider, getOwner, getParameter, getParameterDescription, getScriptlets, hashCode, hasOwner, hasParameter, initialize, isStopped, process, setDataProvider, setOwner, setParameter, showStatus, stopExecution, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ACTION

public static final String ACTION

the action to execute.

See Also:

Constant Field Values

Constructor Detail

RemoveData

public RemoveData()

Method Detail

getAction

public String getAction()

Returns the action string used in the command processor.

Specified by:

getAction in class AbstractScriptlet

Returns:

the action string

getOptionsDescription

protected String getOptionsDescription()

Returns a one-line listing of the options of the action.

Overrides:

getOptionsDescription in class AbstractScriptlet

Returns:

the options or null if none

getDescription

public String getDescription()

Returns the full description of the action.

Specified by:

getDescription in class AbstractScriptlet

Returns:

the full description

doProcess

protected String doProcess(String options)
                    throws Exception

Processes the options.

Specified by:

doProcess in class AbstractScriptlet

Parameters:

options - additional/optional options for the action

Returns:

null if no error, otherwise error message

Throws:

Exception - if something goes wrong