Package PamguardMVC.dataSelector

Class CompoundDataSelector

java.lang.Object

PamguardMVC.dataSelector.DataSelector

PamguardMVC.dataSelector.CompoundDataSelector

public class CompoundDataSelector
extends DataSelector

Constructor Summary

Constructors

Constructor	Description
CompoundDataSelector(PamDataBlock pamDataBlock, ArrayList<DataSelector> allSelectors, String selectorName, boolean allowScores, String selectorType)

Method Summary

Modifier and Type	Method	Description
DataSelector	findDataSelector(Class selectorClass)	Find a data selector within a data selector.
DynamicSettingsPane<Boolean>	getDialogPaneFX()
PamDialogPanel	getDialogPanel()
DataSelectParams	getParams()	Get selection parameters for more organised centralised storage.
ArrayList<DataSelector>	getSelectorList()
double	scoreData(PamDataUnit pamDataUnit)	Score a PAMDataUnit.
void	setParams(DataSelectParams dataSelectParams)	Set selection parameters from centralised storage.

Methods inherited from class PamguardMVC.dataSelector.DataSelector

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

Methods inherited from class java.lang.Object

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

Constructor Details

CompoundDataSelector

public CompoundDataSelector(PamDataBlock pamDataBlock,
 ArrayList<DataSelector> allSelectors,
 String selectorName,
 boolean allowScores,
 String selectorType)

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

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.

getSelectorList

public ArrayList<DataSelector> getSelectorList()

Returns:

the selectorList

findDataSelector

public DataSelector findDataSelector(Class selectorClass)

Description copied from class: DataSelector

Find a data selector within a data selector. This is primarily for use with ComoundDataSelector objects which may encapsulate multiple other selectors, particularly when annotations are in use. but it's needed here so that it can be called on any DataSelector object.

Overrides:

findDataSelector in class DataSelector

Parameters:

selectorClass - class to data selector to find.

Returns:

DataSelector or null if that class of data selector doesn't exist.