Package adams.data.areaoverlap

Class AbstractAreaOverlap

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.areaoverlap.AbstractAreaOverlap

All Implemented Interfaces:

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

Direct Known Subclasses:

BoundingBoxBased, PolygonBased

public abstract class AbstractAreaOverlap
extends AbstractOptionHandler
implements AreaOverlap

Ancestor for area overlap computation schemes.

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

Method Summary

Modifier and Type	Method	Description
LocatedObjects	calculate(Map<LocatedObject,Map<LocatedObject,Double>> matches, MessageCollection errors)	Computes the overlapping areas between the matches.
protected String	check(Map<LocatedObject,Map<LocatedObject,Double>> matches)	Hook method for checks before calculating the areas.
protected abstract LocatedObjects	doCalculate(Map<LocatedObject,Map<LocatedObject,Double>> matches, MessageCollection errors)	Computes the overlapping areas between the matches.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.core.QuickInfoSupporter

getQuickInfo

Constructor Detail

AbstractAreaOverlap

public AbstractAreaOverlap()

Method Detail

check

protected String check(Map<LocatedObject,Map<LocatedObject,Double>> matches)

Hook method for checks before calculating the areas.

Parameters:

matches - the matches to check

Returns:

null if checks passed, otherwise error message

doCalculate

protected abstract LocatedObjects doCalculate(Map<LocatedObject,Map<LocatedObject,Double>> matches,
                                              MessageCollection errors)

Computes the overlapping areas between the matches.

Parameters:

matches - the computed matches

errors - for collecting errors

Returns:

the overlapping areas, null in case of error

calculate

public LocatedObjects calculate(Map<LocatedObject,Map<LocatedObject,Double>> matches,
                                MessageCollection errors)

Computes the overlapping areas between the matches.

Specified by:

calculate in interface AreaOverlap

Parameters:

matches - the computed matches

errors - for collecting errors

Returns:

the overlapping areas, null in case of error