Package annotation.dataselect

Class ScalarDataSelector<TDataAnnotation extends DataAnnotation<?>>

java.lang.Object

PamguardMVC.dataSelector.DataSelector

annotation.dataselect.AnnotationDataSelector<TDataAnnotation>

annotation.dataselect.ScalarDataSelector<TDataAnnotation>

Direct Known Subclasses:

ClassifierDataSelector, SNRDataSelector

public abstract class ScalarDataSelector<TDataAnnotation extends DataAnnotation<?>>
extends AnnotationDataSelector<TDataAnnotation>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	USE_MAXIMUM
static final int	USE_MINIMUM

Constructor Summary

Constructors

Constructor	Description
ScalarDataSelector(DataAnnotationType<TDataAnnotation> annotationType, PamDataBlock pamDataBlock, String selectorName, boolean allowScores, int useMinMax)

Method Summary

Modifier and Type	Method	Description
DynamicSettingsPane<Boolean>	getDialogPaneFX()
PamDialogPanel	getDialogPanel()
DataSelectParams	getParams()	Get selection parameters for more organised centralised storage.
ScalarDataParams	getScalarDataParams()
abstract double	getScalarValue(TDataAnnotation annotation)
int	getUseMinMax()
protected double	scoreData(PamDataUnit pamDataUnit, TDataAnnotation annotation)	Score the data based on the annotaiton.
void	setParams(DataSelectParams dataSelectParams)	Set selection parameters from centralised storage.
void	setScalarDataParams(ScalarDataParams scalarDataParams)

Methods inherited from class annotation.dataselect.AnnotationDataSelector

getAnnotationType, getLongSelectorName, scoreData

Methods inherited from class PamguardMVC.dataSelector.DataSelector

findDataSelector, getDescription, getDialogButton, getDialogButton, getMenuItem, getPamDataBlock, getSelectorName, getSelectorTitle, getSQLSelectClause, isAllowScores, setSelectorTitle, showSelectDialog

Methods inherited from class java.lang.Object

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

Field Details

USE_MINIMUM

public static final int USE_MINIMUM

See Also:

• Constant Field Values

USE_MAXIMUM

public static final int USE_MAXIMUM

See Also:

• Constant Field Values

Constructor Details

ScalarDataSelector

public ScalarDataSelector(DataAnnotationType<TDataAnnotation> annotationType,
 PamDataBlock pamDataBlock,
 String selectorName,
 boolean allowScores,
 int useMinMax)

Method Details

getScalarDataParams

public ScalarDataParams getScalarDataParams()

Returns:

the scalarDataParams

setScalarDataParams

public void setScalarDataParams(ScalarDataParams scalarDataParams)

Parameters:

scalarDataParams - the scalarDataParams to set

getUseMinMax

public int getUseMinMax()

Returns:

the useMinMax

scoreData

protected double scoreData(PamDataUnit pamDataUnit,
 TDataAnnotation annotation)

Description copied from class: AnnotationDataSelector

Score the data based on the annotaiton.

Specified by:

scoreData in class AnnotationDataSelector<TDataAnnotation extends DataAnnotation<?>>

Parameters:

pamDataUnit -

annotation - might be null

Returns:

getScalarValue

public abstract double getScalarValue(TDataAnnotation annotation)

setParams

public void setParams(DataSelectParams dataSelectParams)

Description copied from class: DataSelector

Set selection parameters from centralised storage.

Specified by:

setParams in class DataSelector

Parameters:

dataSelectParams -

getParams

public DataSelectParams getParams()

Description copied from class: DataSelector

Get selection parameters for more organised centralised storage. This must never be null since all selectors have an enable / disable options added to them automatically in their dialogs.

Specified by:

getParams in class DataSelector

Returns:

getDialogPanel

public PamDialogPanel getDialogPanel()

Specified by:

getDialogPanel in class DataSelector

Returns:

a dialog panel which can be used in a wider dialog

getDialogPaneFX

public DynamicSettingsPane<Boolean> getDialogPaneFX()

Specified by:

getDialogPaneFX in class DataSelector

Returns:

a FX pane which can be used in a wider dialog