Package quickAnnotation

Class QuickAnnotationModule

java.lang.Object

PamController.PamControlledUnit

annotationMark.MarkModule

annotationMark.spectrogram.SpectrogramAnnotationModule

quickAnnotation.QuickAnnotationModule

All Implemented Interfaces:

PamSettings, SettingsNameProvider

public class QuickAnnotationModule
extends SpectrogramAnnotationModule
implements PamSettings

Nested Class Summary

Nested classes/interfaces inherited from class annotationMark.spectrogram.SpectrogramAnnotationModule

SpectrogramAnnotationModule.DisplayObserver

Field Summary

Fields inherited from class annotationMark.spectrogram.SpectrogramAnnotationModule

annotationHandler, displayObserver, labelAnnotationType, snrAnnotationType, splAnnotationType, stringAnnotationType

Fields inherited from class annotationMark.MarkModule

unitType

Fields inherited from class PamController.PamControlledUnit

isMixed, isViewer

Constructor Summary

Constructors

Constructor	Description
QuickAnnotationModule(String unitName)

Method Summary

Modifier and Type	Method	Description
JMenuItem	createDetectionMenu(Frame parentFrame)	Create a JMenu object containing MenuItems associated with PamProcesses
StringAnnotationType	getLabelAnnotationType()
String	getMarkType()
QuickAnnotationParameters	getQuickAnnotationParameters()
String	getSelectedAnnotationCode()
LookupItem	getSelectedAnnotationItem()
Serializable	getSettingsReference()
long	getSettingsVersion()
SNRAnnotationType	getSnrAnnotationType()
SPLAnnotationType	getSPLAnnotationType()
StringAnnotationType	getStringAnnotationType()
WavAnnotationType	getWavAnnotationType()
boolean	importMenu(Frame parentFrame)
protected boolean	manualAnnotate(MarkDataUnit adu, Point locOnScreen)	Here we need to handle all of the annotations that cannot autoAnnotate.
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
boolean	settingMenu(Frame parentFrame)
void	updateSidePanel()

Methods inherited from class annotationMark.spectrogram.SpectrogramAnnotationModule

findAnnotationUnit, getAnnotationChoices, getAnnotationHandler, removeUnit, showSettingsMenu, sortSQLLogging, subscribeMarkObserver

Methods inherited from class annotationMark.MarkModule

addAnnotationType, getAnnotationDataBlock, getAnnotationProcess

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, getUnitTaskManager, getUnitTaskManager, getUnitType, getVerboseLevel, gotoTab, isInMainConfiguration, isNetRx, isViewer, notifyModelChanged, pamClose, pamHasStopped, pamToStart, playViewerSound, removePamProcess, rename, saveViewerData, setFrameNumber, setModuleStatusManager, setPamConfiguration, setPamController, setPamModuleInfo, setPamView, setSidePanel, setTabPanel, setToolbarComponent, setUnitTaskManager, setupControlledUnit, stopViewerSound, tellModule, terminalPrint, terminalPrintln, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface PamController.PamSettings

getUnitType

Methods inherited from interface PamController.SettingsNameProvider

getUnitName

Constructor Details

QuickAnnotationModule

public QuickAnnotationModule(String unitName)

Method Details

getSnrAnnotationType

public SNRAnnotationType getSnrAnnotationType()

getSPLAnnotationType

public SPLAnnotationType getSPLAnnotationType()

getWavAnnotationType

public WavAnnotationType getWavAnnotationType()

getSettingsReference

public Serializable getSettingsReference()

Specified by:

getSettingsReference in interface PamSettings

Overrides:

getSettingsReference in class SpectrogramAnnotationModule

Returns:

The serialisable object that will be stored

getSettingsVersion

public long getSettingsVersion()

Specified by:

getSettingsVersion in interface PamSettings

Overrides:

getSettingsVersion in class SpectrogramAnnotationModule

Returns:

An integer version number for the settings

restoreSettings

public boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Specified by:

restoreSettings in interface PamSettings

Overrides:

restoreSettings in class SpectrogramAnnotationModule

Parameters:

pamControlledUnitSettings -

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

getQuickAnnotationParameters

public QuickAnnotationParameters getQuickAnnotationParameters()

createDetectionMenu

public JMenuItem createDetectionMenu(Frame parentFrame)

Description copied from class: PamControlledUnit

Create a JMenu object containing MenuItems associated with PamProcesses

Overrides:

createDetectionMenu in class SpectrogramAnnotationModule

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.

settingMenu

public boolean settingMenu(Frame parentFrame)

importMenu

public boolean importMenu(Frame parentFrame)

updateSidePanel

public void updateSidePanel()

manualAnnotate

protected boolean manualAnnotate(MarkDataUnit adu,
 Point locOnScreen)

Here we need to handle all of the annotations that cannot autoAnnotate.

Overrides:

manualAnnotate in class SpectrogramAnnotationModule

getStringAnnotationType

public StringAnnotationType getStringAnnotationType()

getLabelAnnotationType

public StringAnnotationType getLabelAnnotationType()

getSelectedAnnotationItem

public LookupItem getSelectedAnnotationItem()

getSelectedAnnotationCode

public String getSelectedAnnotationCode()

getMarkType

public String getMarkType()

Overrides:

getMarkType in class SpectrogramAnnotationModule