adams.data.conversion
Class AbstractInPlaceSpreadSheetConversion

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.data.conversion.AbstractConversion
              adams.data.conversion.AbstractSpreadSheetConversion
                  adams.data.conversion.AbstractInPlaceSpreadSheetConversion

All Implemented Interfaces:

CleanUpHandler, Debuggable, Destroyable, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractConversion>, SizeOfHandler, Conversion, InPlaceProcessing, Serializable

Direct Known Subclasses:

AbstractSpreadSheetColumnConverter, RenameSpreadSheetColumn, SpreadSheetAddSumColumn, SpreadSheetAddSumRow, SpreadSheetUniqueColumnNames

public abstract class AbstractInPlaceSpreadSheetConversion
extends AbstractSpreadSheetConversion
implements InPlaceProcessing

Ancestor for spreadsheet conversion that allow working on the incoming data rather than on a copy (to conserve memory).

Version:

$Revision: 6291 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected boolean

m_NoCopy whether to skip creating a copy of the spreadsheet.

Fields inherited from class adams.data.conversion.AbstractConversion

m_Input, m_Output, m_Owner

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

AbstractInPlaceSpreadSheetConversion()

Method Summary

void	defineOptions() Adds options to the internal list of options.
boolean	getNoCopy() Returns whether to skip creating a copy of the spreadsheet before processing it.
String	noCopyTipText() Returns the tip text for this property.
void	setNoCopy(boolean value) Sets whether to skip creating a copy of the spreadsheet before processing it.

Methods inherited from class adams.data.conversion.AbstractSpreadSheetConversion

accepts, convert, doConvert, generates

Methods inherited from class adams.data.conversion.AbstractConversion

checkData, cleanUp, convert, getInput, getOutput, getOwner, getQuickInfo, reset, setInput, setOwner, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debug, debugLevelTipText, destroy, finishInit, getDebugLevel, getOptionManager, globalInfo, initialize, isDebugOn, newOptionManager, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut, sizeOf

Methods inherited from class java.lang.Object

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

Field Detail

m_NoCopy

protected boolean m_NoCopy

whether to skip creating a copy of the spreadsheet.

Constructor Detail

AbstractInPlaceSpreadSheetConversion

public AbstractInPlaceSpreadSheetConversion()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setNoCopy

public void setNoCopy(boolean value)

Sets whether to skip creating a copy of the spreadsheet before processing it.

Specified by:

setNoCopy in interface InPlaceProcessing

Parameters:

value - true if to skip creating copy

getNoCopy

public boolean getNoCopy()

Returns whether to skip creating a copy of the spreadsheet before processing it.

Specified by:

getNoCopy in interface InPlaceProcessing

Returns:

true if copying is skipped

noCopyTipText

public String noCopyTipText()

Returns the tip text for this property.

Specified by:

noCopyTipText in interface InPlaceProcessing

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.