Package adams.data.outlier

Class TargetRequired

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.outlier.AbstractOutlierDetector

adams.data.outlier.TargetRequired

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter, SizeOfHandler, OutlierDetector, Serializable, Comparable

public class TargetRequired
extends AbstractOutlierDetector

Checks whether the specified target field is available in the report.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 

-field <adams.data.report.Field> (property: field)
    The field to use (ie, the class).
    default: benzene\\tConc
 

-conc <double> (property: minConcentration)
    The minimum concentration that the target value must have.
    default: 0.0
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class adams.data.outlier.AbstractOutlierDetector

AbstractOutlierDetector.DetectorJob<T extends DataContainer>

Field Summary

Fields

Modifier and Type	Field	Description
protected Field	m_Field	the name of the reference compound.
protected double	m_MinConcentration	the minimum concentration.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
String	fieldTipText()	Returns the tip text for this property.
Field	getField()	Returns the current reference (i.e., class).
double	getMinConcentration()	Get minimum concentration.
String	globalInfo()	Returns a string describing the object.
String	minConcentrationTipText()	Returns the tip text for this property.
protected List<String>	processData(DataContainer data)	Performs the actual detection.
void	setField(Field value)	Sets the reference, i.e., the class.
void	setMinConcentration(double value)	Set minimum concentration.

Methods inherited from class adams.data.outlier.AbstractOutlierDetector

checkData, cleanUp, compareTo, destroy, detect, equals, forCommandLine, forName, getOutlierDetectors, getQuickInfo, reset, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_Field

protected Field m_Field

the name of the reference compound.

m_MinConcentration

protected double m_MinConcentration

the minimum concentration.

Constructor Detail

TargetRequired

public TargetRequired()

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

setField

public void setField(Field value)

Sets the reference, i.e., the class.

Parameters:

value - the reference

getField

public Field getField()

Returns the current reference (i.e., class).

Returns:

the reference

fieldTipText

public String fieldTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setMinConcentration

public void setMinConcentration(double value)

Set minimum concentration.

Parameters:

value - the minimum concentration

getMinConcentration

public double getMinConcentration()

Get minimum concentration.

Returns:

the minimum concentration

minConcentrationTipText

public String minConcentrationTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

processData

protected List<String> processData(DataContainer data)

Performs the actual detection.

Specified by:

processData in class AbstractOutlierDetector

Parameters:

data - the data to process

Returns:

the detections