Package loggerForms.dataselect

Class FormDataSelector

java.lang.Object

PamguardMVC.dataSelector.DataSelector

loggerForms.dataselect.FormDataSelector

public class FormDataSelector
extends DataSelector

Constructor Summary

Constructors

Constructor	Description
FormDataSelector(PamDataBlock pamDataBlock, FormDescription fromDescription, String selectorName, boolean allowScores)

Method Summary

Modifier and Type	Method	Description
DynamicSettingsPane<Boolean>	getDialogPaneFX()
PamDialogPanel	getDialogPanel()
FormDescription	getFromDescription()
FormDataSelParams	getParams()	Get selection parameters for more organised centralised storage.
String	getSelectorTitle()	This is a title for the data selector which can be used in dialogs.
double	scoreData(PamDataUnit pamDataUnit)	Score a PAMDataUnit.
double	scoreData(PamDataUnit dataUnit, Object[] formData)
void	setParams(DataSelectParams dataSelectParams)	Set selection parameters from centralised storage.

Methods inherited from class PamguardMVC.dataSelector.DataSelector

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

Methods inherited from class java.lang.Object

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

Constructor Details

FormDataSelector

public FormDataSelector(PamDataBlock pamDataBlock,
 FormDescription fromDescription,
 String selectorName,
 boolean allowScores)

Method Details

setParams

public void setParams(DataSelectParams dataSelectParams)

Description copied from class: DataSelector

Set selection parameters from centralised storage.

Specified by:

setParams in class DataSelector

getParams

public FormDataSelParams 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

scoreData

public double scoreData(PamDataUnit pamDataUnit)

Description copied from class: DataSelector

Score a PAMDataUnit. this is used in preference to a boolean select function so that the user can add different return flags. Generally 0 indicates false.

Specified by:

scoreData in class DataSelector

Parameters:

pamDataUnit - - the input data unit.

Returns:

score of data out. 0 usually indicates false.

scoreData

public double scoreData(PamDataUnit dataUnit,
 Object[] formData)

getFromDescription

public FormDescription getFromDescription()

Returns:

the fromDescription

getSelectorTitle

public String getSelectorTitle()

Description copied from class: DataSelector

This is a title for the data selector which can be used in dialogs. This can be different to the name, since the name is generally the display, which we know anyway. Particularly with complicated compound data selectors, it's useful to have a more informative name for various sub-components.

Overrides:

getSelectorTitle in class DataSelector

Returns:

title to use in dialog components.