Package adams.flow.transformer.multimapoperation

Class CommonKeys

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.multimapoperation.AbstractMultiMapOperation<Object[]>

adams.flow.transformer.multimapoperation.CommonKeys

All Implemented Interfaces:

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

public class CommonKeys
extends AbstractMultiMapOperation<Object[]>

Outputs the common keys among the maps.

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

Method Summary

Modifier and Type	Method	Description
protected Object[]	doProcess(Map[] maps, MessageCollection errors)	Performs the actual processing of the maps.
Class	generates()	The type of data that is generated.
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.

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

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

CommonKeys

public CommonKeys()

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

minNumMapsRequired

public int minNumMapsRequired()

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

Specified by:

minNumMapsRequired in class AbstractMultiMapOperation<Object[]>

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<Object[]>

Returns:

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

generates

public Class generates()

The type of data that is generated.

Specified by:

generates in class AbstractMultiMapOperation<Object[]>

Returns:

the class

doProcess

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

Performs the actual processing of the maps.

Specified by:

doProcess in class AbstractMultiMapOperation<Object[]>

Parameters:

maps - the containers to process

errors - for collecting errors

Returns:

the generated data