Package adams.data.conversion

Class AbstractInPlaceSpreadSheetConversion

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.conversion.AbstractConversion

adams.data.conversion.AbstractSpreadSheetConversion

adams.data.conversion.AbstractInPlaceSpreadSheetConversion

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractConversion>, SizeOfHandler, Stoppable, Conversion, InPlaceProcessing, Serializable

Direct Known Subclasses:

AbstractSpreadSheetColumnConverter, RenameSpreadSheet, RenameSpreadSheetColumn, SpreadSheetAddFormulaColumn, SpreadSheetAddFormulaRow, SpreadSheetAddRowID, SpreadSheetAddSumColumn, SpreadSheetAddSumRow, SpreadSheetMaterializeFormulas, SpreadSheetUniqueColumnNames, SpreadSheetUseRowAsHeader

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$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
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, m_Stopped

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
AbstractInPlaceSpreadSheetConversion()

Method Summary

Modifier and Type	Method	Description
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, getAdditionalInformation, getInput, getInput, getOutput, getOutput, getOwner, getQuickInfo, reset, setInput, setOwner, shallowCopy, shallowCopy, stopExecution

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, 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_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.