Package adams.flow.transformer.multispreadsheetoperation

Class Merge

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.Merge

All Implemented Interfaces:

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

public class Merge
extends AbstractMultiSpreadSheetOperation<SpreadSheet>

Merges 2 or more spreadsheets into a single spreadsheet, using a selectable merge method.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-method <adams.flow.transformer.spreadsheetmethodmerge.AbstractMerge> (property: mergeMethod)
    The method that should be used to perform the merge.
    default: adams.flow.transformer.spreadsheetmethodmerge.Simple -class-finder adams.data.spreadsheet.columnfinder.NullFinder
 

Author:

Corey Sterling (csterlin at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractMerge	m_MergeMethod	The method to use to perform the merge.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected SpreadSheet	doProcess(SpreadSheet[] sheets, MessageCollection errors)	Performs the actual processing of the sheets.
Class	generates()	Returns the class of objects that it generates.
AbstractMerge	getMergeMethod()	Gets the currently-set merge method.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
int	maxNumSheetsRequired()	Returns the maximum number of sheets that are required for the operation.
String	mergeMethodTipText()	Gets the tip-text for the merge method option.
int	minNumSheetsRequired()	Returns the minimum number of sheets that are required for the operation.
void	setMergeMethod(AbstractMerge mergeMethod)	Sets the merge method to use to perform the merge.

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

check, process

Methods inherited from class adams.core.option.AbstractOptionHandler

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

Field Detail

m_MergeMethod

protected AbstractMerge m_MergeMethod

The method to use to perform the merge.

Constructor Detail

Merge

public Merge()

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

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

getMergeMethod

public AbstractMerge getMergeMethod()

Gets the currently-set merge method.

Returns:

The merge method being used currently.

setMergeMethod

public void setMergeMethod(AbstractMerge mergeMethod)

Sets the merge method to use to perform the merge.

Parameters:

mergeMethod - The merge method to use.

mergeMethodTipText

public String mergeMethodTipText()

Gets the tip-text for the merge method option.

Returns:

The tip-text as a String.

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractMultiSpreadSheetOperation<SpreadSheet>

Returns:

null if no info available, otherwise short string

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

generates

public Class generates()

Returns the class of objects that it generates.

Specified by:

generates in class AbstractMultiSpreadSheetOperation<SpreadSheet>

Returns:

the Class of the generated tokens

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