Package adams.flow.transformer.multispreadsheetoperation

Class Overlay

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.multispreadsheetoperation.AbstractMultiSpreadSheetOperation<SpreadSheet>

adams.flow.transformer.multispreadsheetoperation.Overlay

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, Serializable

public class Overlay
extends AbstractMultiSpreadSheetOperation<SpreadSheet>

Combines non-empty cells from the spreadsheets into one by overlaying them.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

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

Method Summary

Modifier and Type	Method	Description
protected void	check(SpreadSheet[] sheets)	Checks the sheets.
protected SpreadSheet	doProcess(SpreadSheet[] sheets, MessageCollection errors)	Performs the actual processing of the sheets.
Class	generates()	The type of data that is generated.
String	globalInfo()	Returns a string describing the object.
int	maxNumSheetsRequired()	Returns the maximum number of sheets that are required for the operation.
int	minNumSheetsRequired()	Returns the minimum number of sheets that are required for the operation.

Methods inherited from class adams.flow.transformer.multispreadsheetoperation.AbstractMultiSpreadSheetOperation

getQuickInfo, process

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, 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

Constructor Detail

Overlay

public Overlay()

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

minNumSheetsRequired

public int minNumSheetsRequired()

Returns the minimum number of sheets that are required for the operation.

Specified by:

minNumSheetsRequired in class AbstractMultiSpreadSheetOperation<SpreadSheet>

Returns:

the number of sheets that are required, <= 0 means no lower limit

maxNumSheetsRequired

public int maxNumSheetsRequired()

Returns the maximum number of sheets that are required for the operation.

Specified by:

maxNumSheetsRequired in class AbstractMultiSpreadSheetOperation<SpreadSheet>

Returns:

the number of sheets that are required, <= 0 means no upper limit

check

protected void check(SpreadSheet[] sheets)

Checks the sheets.

Overrides:

check in class AbstractMultiSpreadSheetOperation<SpreadSheet>

Parameters:

sheets - the sheets to check

generates

public Class generates()

The type of data that is generated.

Specified by:

generates in class AbstractMultiSpreadSheetOperation<SpreadSheet>

Returns:

the class

doProcess

protected SpreadSheet doProcess(SpreadSheet[] sheets,
                                MessageCollection errors)

Performs the actual processing of the sheets.

Specified by:

doProcess in class AbstractMultiSpreadSheetOperation<SpreadSheet>

Parameters:

sheets - the containers to process

errors - for collecting errors

Returns:

the generated data