Package annotation.userforms.datasel

Class UserFormDataSelector

java.lang.Object

PamguardMVC.dataSelector.DataSelector

annotation.dataselect.AnnotationDataSelector

annotation.userforms.datasel.UserFormDataSelector

public class UserFormDataSelector
extends AnnotationDataSelector

This is a wrapper around a standard forms data selector. Needed because annotations hold data in a different way to a normal FormsDataUnit, so mustn't call the standard scoreData fundtion in the formsDataSelector.

Author:

Dougl

Constructor Summary

Constructors

Constructor	Description
UserFormDataSelector(DataAnnotationType annotationType, PamDataBlock pamDataBlock, String selectorName, boolean allowScores, FormDataSelector formsDataSelector)

Method Summary

Modifier and Type	Method	Description
DynamicSettingsPane<Boolean>	getDialogPaneFX()
PamDialogPanel	getDialogPanel()
DataSelectParams	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.
protected double	scoreData(PamDataUnit pamDataUnit, DataAnnotation annotation)	Score the data based on the annotaiton.
void	setParams(DataSelectParams dataSelectParams)	Set selection parameters from centralised storage.

Methods inherited from class annotation.dataselect.AnnotationDataSelector

getAnnotationType, getLongSelectorName, scoreData

Methods inherited from class PamguardMVC.dataSelector.DataSelector

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

Methods inherited from class java.lang.Object

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

Constructor Details

UserFormDataSelector

public UserFormDataSelector(DataAnnotationType annotationType,
 PamDataBlock pamDataBlock,
 String selectorName,
 boolean allowScores,
 FormDataSelector formsDataSelector)

Method Details

scoreData

protected double scoreData(PamDataUnit pamDataUnit,
 DataAnnotation annotation)

Description copied from class: AnnotationDataSelector

Score the data based on the annotaiton.

Specified by:

scoreData in class AnnotationDataSelector

Parameters:

pamDataUnit -

annotation - might be null

Returns:

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

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.