AbstractDataPluginWithGOE (adams-pom 24.5.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.gui.tools.spreadsheetviewer.AbstractDataPlugin
      - adams.gui.tools.spreadsheetviewer.AbstractDataPluginWithGOE

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<AbstractDataPlugin>, SizeOfHandler, Serializable
```
public abstract class AbstractDataPluginWithGOE
extends AbstractDataPlugin
```
Ancestor for plugins that present a GOE dialog.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary
- Fields inherited from class adams.gui.tools.spreadsheetviewer.AbstractDataPlugin
  m_CanceledByUser, m_CurrentPanel, m_LastSetup
- 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

AbstractDataPluginWithGOE()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected SpreadSheet`	`doProcess(SpreadSheet sheet)`	Performs the user interaction.
`protected boolean`	`getCanChangeClassInDialog()`	Returns whether the class can be changed in the GOE.
`protected abstract Object`	`getDefaultValue()`	Returns the default object to use in the GOE if no last setup is yet available.
`protected abstract Class`	`getEditorType()`	Returns the class to use as type (= superclass) in the GOE.
`protected abstract SpreadSheet`	`processData(SpreadSheet sheet)`	Performs the actual processing of the spreadsheet.

Methods inherited from class adams.gui.tools.spreadsheetviewer.AbstractDataPlugin
canProcess, check, getCanceledByUser, getCurrentPanel, getLastSetup, getMenuIcon, getMenuText, getPlugins, hasLastSetup, isInPlace, process, setCurrentPanel, setLastSetup, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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

- Constructor Detail
  - AbstractDataPluginWithGOE
```
public AbstractDataPluginWithGOE()
```
- Method Detail
  - getEditorType
```
protected abstract Class getEditorType()
```
    Returns the class to use as type (= superclass) in the GOE.
    
    Returns:
    
    the class
  - getDefaultValue
```
protected abstract Object getDefaultValue()
```
    Returns the default object to use in the GOE if no last setup is yet available.
    
    Returns:
    
    the object
  - getCanChangeClassInDialog
```
protected boolean getCanChangeClassInDialog()
```
    Returns whether the class can be changed in the GOE.
    
    Returns:
    
    true if class can be changed by the user
  - processData
```
protected abstract SpreadSheet processData(SpreadSheet sheet)
```
    Performs the actual processing of the spreadsheet.
    
    Parameters:
    
    sheet - the sheet to process
    
    Returns:
    
    the processed sheet
  - doProcess
```
protected SpreadSheet doProcess(SpreadSheet sheet)
```
    Performs the user interaction.
    
    Specified by:
    
    doProcess in class AbstractDataPlugin
    
    Parameters:
    
    sheet - the sheet to process
    
    Returns:
    
    the processed sheet, null if not processed