Package dataMap
Class DataMapControl
java.lang.Object
PamController.PamControlledUnit
dataMap.DataMapControl
- All Implemented Interfaces:
 PamSettings,SettingsNameProvider
The data map appears only during PAMGUARD viewer mode and is the root of
 a navigation system allowing the operator to scroll easily through large
 amounts of data. 
 
The primary role of the map is to show a time line of data rate for each module, which may extend from minutes to years, and to relate that map to the positions of the various scroll bars used to navigate through the data.
Data may be loaded from the database and the binary storage system. Data in each will have been mapped into either hour units or units representing the individual files in the binary store.
- Author:
 - Doug Gillespie
 - See Also:
 
- 
Field Summary
FieldsFields inherited from class PamController.PamControlledUnit
isMixed, isViewer - 
Constructor Summary
Constructors - 
Method Summary
Modifier and TypeMethodDescriptionvoidcentreDataAt(PamDataBlock dataBlock, long menuMouseTime) Centre the data in all data streams at the given timevoidlong[]getDataExtent(OfflineDataStore dataSource) Get the start and end times for all data associated with a particular data sourcestatic DataMapControllonggetGUI(int flag) Get the GUI for the PAMControlled unit.longlongGets a reference to a panel to be added to a viewvoidnotifyModelChanged(int changeType) General notification when the PAMGAURD model changes.booleanrestoreSettings(PamControlledUnitSettings pamControlledUnitSettings) voidscrollToData(PamDataBlock dataBlock) voidsetFirstTime(long firstTime) voidsetLastTime(long lastTime) voidsetPamView(PamView pamView) Called whenever the frme of a PamControlledunit changes (including at program startup).voidstartDataAt(PamDataBlock dataBlock, long menuMouseTime) Start the data in all data streams at the given timevoidupdateSingleDataMap(OfflineDataMap<?> singleDataMap) Update a single data map.Methods inherited from class PamController.PamControlledUnit
addOfflineTaskGroup, addOtherRelatedMenuItems, addPamProcess, addPamProcess, addRelatedMenuItems, canClose, canPlayViewerSound, createDetectionMenu, createDisplayMenu, createFileMenu, createHelpMenu, flushDataBlockBuffers, getBackupInformation, getFrameNumber, getGuiFrame, getInstanceIndex, getModuleStatus, getModuleStatusManager, getModuleSummary, getModuleSummary, getNumOfflineTaskGroups, getNumPamProcesses, getOfflineState, getOfflineTaskGroup, getPamConfiguration, getPamController, getPamModuleInfo, getPamProcess, getPamView, getPlugin, getShortUnitType, getSidePanel, getTabClipCopier, getTabSpecificMenuBar, getToolbarComponent, getUnitName, getUnitTaskManager, getUnitTaskManager, getUnitType, getVerboseLevel, gotoTab, isInMainConfiguration, isNetRx, isViewer, pamClose, pamHasStopped, pamToStart, playViewerSound, removePamProcess, removeUnit, rename, saveViewerData, setFrameNumber, setModuleStatusManager, setPamConfiguration, setPamController, setPamModuleInfo, setSidePanel, setTabPanel, setToolbarComponent, setUnitTaskManager, setupControlledUnit, stopViewerSound, tellModule, terminalPrint, terminalPrintln, toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface PamController.PamSettings
getUnitTypeMethods inherited from interface PamController.SettingsNameProvider
getUnitName 
- 
Field Details
- 
dataMapParameters
 
 - 
 - 
Constructor Details
- 
DataMapControl
 
 - 
 - 
Method Details
- 
setFirstTime
public void setFirstTime(long firstTime) - Parameters:
 firstTime- the firstTime to set
 - 
setLastTime
public void setLastTime(long lastTime) - Parameters:
 lastTime- the lastTime to set
 - 
getDataMapControl
 - 
setPamView
Description copied from class:PamControlledUnitCalled whenever the frme of a PamControlledunit changes (including at program startup).- Overrides:
 setPamViewin classPamControlledUnit- Parameters:
 pamView-
 - 
frameResized
public void frameResized() - 
getTabPanel
Description copied from class:PamControlledUnitGets a reference to a panel to be added to a view- Overrides:
 getTabPanelin classPamControlledUnit- Returns:
 - reference to a PamTabPanel object
 - See Also:
 
 - 
notifyModelChanged
public void notifyModelChanged(int changeType) Description copied from class:PamControlledUnitGeneral notification when the PAMGAURD model changes.- Overrides:
 notifyModelChangedin classPamControlledUnit- Parameters:
 changeType- type of change
 - 
getMappedDataBlocks
 - 
updateSingleDataMap
Update a single data map. Useful when bringing in data from 'non standard' sources. Check overall time limits and redraw, but no total map creation.- Parameters:
 singleDataMap-
 - 
getFirstTime
public long getFirstTime()- Returns:
 - the firstTime for any data in any data block
 
 - 
getLastTime
public long getLastTime()- Returns:
 - the lastTime for any data in any data block
 
 - 
getDataExtent
Get the start and end times for all data associated with a particular data source- Parameters:
 dataSource- datasource- Returns:
 - start and end times in milliseconds.
 
 - 
getSettingsReference
- Specified by:
 getSettingsReferencein interfacePamSettings- Returns:
 - The serialisable object that will be stored
 
 - 
getSettingsVersion
public long getSettingsVersion()- Specified by:
 getSettingsVersionin interfacePamSettings- Returns:
 - An integer version number for the settings
 
 - 
restoreSettings
- Specified by:
 restoreSettingsin interfacePamSettings- 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
 
 - 
centreDataAt
Centre the data in all data streams at the given time- Parameters:
 dataBlock- data block graph sending the commandmenuMouseTime- time in milliseconds.
 - 
startDataAt
Start the data in all data streams at the given time- Parameters:
 dataBlock- data block graph sending the commandmenuMouseTime- time in milliseconds.
 - 
scrollToData
 - 
getDataMapGUI
 - 
getGUI
Get the GUI for the PAMControlled unit. This has multiple GUI options which are instantiated depending on the view type.- Overrides:
 getGUIin classPamControlledUnit- Parameters:
 flag- . The GUI type flag defined in PAMGuiManager.- Returns:
 - the GUI for the PamControlledUnit unit.
 
 
 -