Package detectiongrouplocaliser

Class DetectionGroupControl

java.lang.Object

PamController.PamControlledUnit

detectiongrouplocaliser.DetectionGroupControl

All Implemented Interfaces:

PamSettings, SettingsNameProvider

public class DetectionGroupControl
extends PamControlledUnit
implements PamSettings

Class for grouping any type of data together. Not really a localiser, but does include some localisation options.
Will attempt to offer a variety of localisation options and will store data for each group in a pair of database tables.

Author:

dg50

Field Summary

Fields

Modifier and Type	Field	Description
static final String	unitType

Constructor Summary

Constructors

Constructor	Description
DetectionGroupControl(String unitName)

Method Summary

Modifier and Type	Method	Description
void	addGroupObserver(DetectionGroupObserver groupObserver)	Add an observer of group structure or data changes.
JMenuItem	createDetectionMenu(Frame parentFrame)	Create a JMenu object containing MenuItems associated with PamProcesses
DetectionGroupProcess	getDetectionGroupProcess()
DetectionGroupSettings	getDetectionGroupSettings()
DisplayOptionsHandler	getDisplayOptionsHandler()
Serializable	getSettingsReference()
long	getSettingsVersion()
SymbolData	getSymbolforMenuItems(PamDataUnit dgdu)
void	notifyGroupDataChanged()	Notify any observers that data have changed.
void	notifyGroupModelChanged()	Notify any observers that the group model has changed (effectively this means a change in annotations).
void	notifyModelChanged(int changeType)	General notification when the PAMGAURD model changes.
void	removeGroupObserveR(DetectionGroupObserver groupObserver)	Remove an observer of group changes
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Methods inherited from class PamController.PamControlledUnit

addOfflineTaskGroup, addOtherRelatedMenuItems, addPamProcess, addPamProcess, addRelatedMenuItems, canClose, canPlayViewerSound, createDisplayMenu, createFileMenu, createHelpMenu, flushDataBlockBuffers, getBackupInformation, getFrameNumber, getGUI, getGuiFrame, getInstanceIndex, getModuleStatus, getModuleStatusManager, getModuleSummary, getModuleSummary, getNumOfflineTaskGroups, getNumPamProcesses, getOfflineState, getOfflineTaskGroup, getPamConfiguration, getPamController, getPamModuleInfo, getPamProcess, getPamView, getPlugin, getShortUnitType, getSidePanel, getTabClipCopier, getTabPanel, getTabSpecificMenuBar, getToolbarComponent, getUnitName, getUnitType, getVerboseLevel, gotoTab, isInMainConfiguration, isNetRx, isViewer, pamClose, pamHasStopped, pamToStart, playViewerSound, removePamProcess, removeUnit, rename, saveViewerData, setFrameNumber, setModuleStatusManager, setPamConfiguration, setPamController, setPamModuleInfo, setPamView, setSidePanel, setTabPanel, setToolbarComponent, setupControlledUnit, stopViewerSound, tellModule, terminalPrint, terminalPrintln, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface PamController.PamSettings

getUnitType

Methods inherited from interface PamController.SettingsNameProvider

getUnitName

Field Details

unitType

public static final String unitType

See Also:

• Constant Field Values

Constructor Details

DetectionGroupControl

public DetectionGroupControl(String unitName)

Method Details

getSettingsReference

public Serializable getSettingsReference()

Specified by:

getSettingsReference in interface PamSettings

Returns:

The serialisable object that will be stored

getSettingsVersion

public long getSettingsVersion()

Specified by:

getSettingsVersion in interface PamSettings

Returns:

An integer version number for the settings

restoreSettings

public boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Specified by:

restoreSettings in interface PamSettings

Returns:

true if successful The object performs final checks (if needed) and then casts the settings data pamcontrolledunitSettings.settings into the correct type and uses as required

getDetectionGroupSettings

public DetectionGroupSettings getDetectionGroupSettings()

Returns:

the detectionGroupSettings

createDetectionMenu

public JMenuItem createDetectionMenu(Frame parentFrame)

Description copied from class: PamControlledUnit

Create a JMenu object containing MenuItems associated with PamProcesses

Overrides:

createDetectionMenu in class PamControlledUnit

Parameters:

parentFrame - The owner frame of the menu

Returns:

reference to a JMenu which can be added to an existing menu or menu bar

Note that if multiple views are to use the same menu, then they should each create a new menu (by setting Create to true) the first time they call this method.

getDetectionGroupProcess

public DetectionGroupProcess getDetectionGroupProcess()

Returns:

the detectionGroupProcess

addGroupObserver

public void addGroupObserver(DetectionGroupObserver groupObserver)

Add an observer of group structure or data changes.

Parameters:

groupObserver -

removeGroupObserveR

public void removeGroupObserveR(DetectionGroupObserver groupObserver)

Remove an observer of group changes

Parameters:

groupObserver -

notifyGroupDataChanged

public void notifyGroupDataChanged()

Notify any observers that data have changed.

notifyGroupModelChanged

public void notifyGroupModelChanged()

Notify any observers that the group model has changed (effectively this means a change in annotations).

getSymbolforMenuItems

public SymbolData getSymbolforMenuItems(PamDataUnit dgdu)

notifyModelChanged

public void notifyModelChanged(int changeType)

Description copied from class: PamControlledUnit

General notification when the PAMGAURD model changes.

Overrides:

notifyModelChanged in class PamControlledUnit

Parameters:

changeType - type of change

getDisplayOptionsHandler

public DisplayOptionsHandler getDisplayOptionsHandler()

Returns:

the displayOptionsHandler