Package adams.flow.transformer.multimapoperation

Class Merge

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.multimapoperation.AbstractMultiMapOperation<Map>

adams.flow.transformer.multimapoperation.Merge

All Implemented Interfaces:

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

public class Merge
extends AbstractMultiMapOperation<Map>
implements InPlaceProcessing

Merges the maps.

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 map.
protected boolean	m_Overwrite	whether to overwrite existing keys.

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 Map	doProcess(Map[] maps, MessageCollection errors)	Performs the actual processing of the maps.
Class	generates()	The type of data that is generated.
boolean	getNoCopy()	Returns whether to skip creating a copy of the map before merging.
boolean	getOverwrite()	Returns whether to overwrite existing keys.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
int	maxNumMapsRequired()	Returns the maximum number of maps that are required for the operation.
int	minNumMapsRequired()	Returns the minimum number of maps that are required for the operation.
String	noCopyTipText()	Returns the tip text for this property.
String	overwriteTipText()	Returns the tip text for this property.
void	setNoCopy(boolean value)	Sets whether to skip creating a copy of the map before merging.
void	setOverwrite(boolean value)	Sets whether to overwrite existing keys.

Methods inherited from class adams.flow.transformer.multimapoperation.AbstractMultiMapOperation

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_Overwrite

protected boolean m_Overwrite

whether to overwrite existing keys.

m_NoCopy

protected boolean m_NoCopy

whether to skip creating a copy of the map.

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

setOverwrite

public void setOverwrite(boolean value)

Sets whether to overwrite existing keys.

Parameters:

value - true if to overwrite

getOverwrite

public boolean getOverwrite()

Returns whether to overwrite existing keys.

Returns:

true if to overwrite

overwriteTipText

public String overwriteTipText()

Returns the tip text for this property.

Returns:

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

setNoCopy

public void setNoCopy(boolean value)

Sets whether to skip creating a copy of the map before merging.

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 map before merging.

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.

minNumMapsRequired

public int minNumMapsRequired()

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

Specified by:

minNumMapsRequired in class AbstractMultiMapOperation<Map>

Returns:

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

maxNumMapsRequired

public int maxNumMapsRequired()

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

Specified by:

maxNumMapsRequired in class AbstractMultiMapOperation<Map>

Returns:

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

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractMultiMapOperation<Map>

Returns:

null if no info available, otherwise short string

generates

public Class generates()

The type of data that is generated.

Specified by:

generates in class AbstractMultiMapOperation<Map>

Returns:

the class

doProcess

protected Map doProcess(Map[] maps,
                        MessageCollection errors)

Performs the actual processing of the maps.

Specified by:

doProcess in class AbstractMultiMapOperation<Map>

Parameters:

maps - the containers to process

errors - for collecting errors

Returns:

the generated data