Package adams.flow.transformer

Class DetermineOverlappingAreas

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractActor

adams.flow.transformer.AbstractTransformer

adams.flow.transformer.DetermineOverlappingAreas

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable

public class DetermineOverlappingAreas
extends AbstractTransformer

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AreaOverlap	m_AreaAlgorithm	the area calculation to use.
protected boolean	m_CompareWithItself	whether to compare with itself.
protected ObjectFinder	m_Finder	the object finder to use.
protected ObjectOverlap	m_OverlapAlgorithm	the object overlap calculation to use.
protected StorageName	m_StorageName	the storage item.

Fields inherited from class adams.flow.transformer.AbstractTransformer

BACKUP_INPUT, BACKUP_OUTPUT, m_InputToken, m_OutputToken

Fields inherited from class adams.flow.core.AbstractActor

m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Constructor Summary

Constructors

Constructor	Description
DetermineOverlappingAreas()

Method Summary

Modifier and Type	Method	Description
Class[]	accepts()	Returns the class that the consumer accepts.
String	areaAlgorithmTipText()	Returns the tip text for this property.
String	compareWithItselfTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected String	doExecute()	Executes the flow item.
String	finderTipText()	Returns the tip text for this property.
Class[]	generates()	Returns the class of objects that it generates.
AreaOverlap	getAreaAlgorithm()	Returns the algorithm for determining the overlapping objects.
boolean	getCompareWithItself()	Returns whether to compare the report with itself rather than the one from storage.
ObjectFinder	getFinder()	Returns object finder for locating the objects.
ObjectOverlap	getOverlapAlgorithm()	Returns the algorithm for determining the overlapping objects.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
StorageName	getStorageName()	Returns the name of the storage item to merge with (Report or ReportHandler).
String	globalInfo()	Returns a string describing the object.
String	overlapAlgorithmTipText()	Returns the tip text for this property.
void	setAreaAlgorithm(AreaOverlap value)	Sets the algorithm for determining the overlapping objects.
void	setCompareWithItself(boolean value)	Sets whether to compare the report with itself rather than the one from storage.
void	setFinder(ObjectFinder value)	Sets the object finder for locating the objects.
void	setOverlapAlgorithm(ObjectOverlap value)	Sets the algorithm for determining the overlapping objects.
void	setStorageName(StorageName value)	Sets the name of the storage item to merge with (Report or ReportHandler).
String	storageNameTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.transformer.AbstractTransformer

backupState, currentInput, execute, hasInput, hasPendingOutput, input, output, postExecute, restoreState, wrapUp

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, finalUpdateVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, preExecute, pruneBackup, pruneBackup, reset, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.flow.core.Actor

cleanUp, compareTo, destroy, equals, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel, setLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter

getLogger, isLoggingEnabled

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager

Methods inherited from interface adams.core.VariablesInspectionHandler

canInspectOptions

Field Detail

m_StorageName

protected StorageName m_StorageName

the storage item.

m_CompareWithItself

protected boolean m_CompareWithItself

whether to compare with itself.

m_Finder

protected ObjectFinder m_Finder

the object finder to use.

m_OverlapAlgorithm

protected ObjectOverlap m_OverlapAlgorithm

the object overlap calculation to use.

m_AreaAlgorithm

protected AreaOverlap m_AreaAlgorithm

the area calculation to use.

Constructor Detail

DetermineOverlappingAreas

public DetermineOverlappingAreas()

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 AbstractActor

setStorageName

public void setStorageName(StorageName value)

Sets the name of the storage item to merge with (Report or ReportHandler).

Parameters:

value - the name

getStorageName

public StorageName getStorageName()

Returns the name of the storage item to merge with (Report or ReportHandler).

Returns:

the name

storageNameTipText

public String storageNameTipText()

Returns the tip text for this property.

Returns:

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

setCompareWithItself

public void setCompareWithItself(boolean value)

Sets whether to compare the report with itself rather than the one from storage.

Parameters:

value - true if to compare with itself

getCompareWithItself

public boolean getCompareWithItself()

Returns whether to compare the report with itself rather than the one from storage.

Returns:

true if to compare with itself

compareWithItselfTipText

public String compareWithItselfTipText()

Returns the tip text for this property.

Returns:

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

setFinder

public void setFinder(ObjectFinder value)

Sets the object finder for locating the objects.

Parameters:

value - the finder

getFinder

public ObjectFinder getFinder()

Returns object finder for locating the objects.

Returns:

the finder

finderTipText

public String finderTipText()

Returns the tip text for this property.

Returns:

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

setOverlapAlgorithm

public void setOverlapAlgorithm(ObjectOverlap value)

Sets the algorithm for determining the overlapping objects.

Parameters:

value - the algorithm

getOverlapAlgorithm

public ObjectOverlap getOverlapAlgorithm()

Returns the algorithm for determining the overlapping objects.

Returns:

the algorithm

overlapAlgorithmTipText

public String overlapAlgorithmTipText()

Returns the tip text for this property.

Returns:

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

setAreaAlgorithm

public void setAreaAlgorithm(AreaOverlap value)

Sets the algorithm for determining the overlapping objects.

Parameters:

value - the algorithm

getAreaAlgorithm

public AreaOverlap getAreaAlgorithm()

Returns the algorithm for determining the overlapping objects.

Returns:

the algorithm

areaAlgorithmTipText

public String areaAlgorithmTipText()

Returns the tip text for this property.

Returns:

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

getQuickInfo

public String getQuickInfo()

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

Specified by:

getQuickInfo in interface Actor

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractActor

Returns:

null if no info available, otherwise short string

accepts

public Class[] accepts()

Returns the class that the consumer accepts.

Returns:

the Class of objects that can be processed

generates

public Class[] generates()

Returns the class of objects that it generates.

Returns:

the Class of the generated tokens

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message