dataMap

Class DataMapControl

java.lang.Object

PamController.PamControlledUnit

dataMap.DataMapControl

All Implemented Interfaces:

PamSettings

public class DataMapControl
extends PamControlledUnit
implements PamSettings

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:

DBControlUnit, BinaryStore, OfflineDataMap, OfflineDataMapPoint

Constructor Summary

Constructors

Constructor and Description
DataMapControl(java.lang.String unitName)

Method Summary

Methods

Modifier and Type	Method and Description
void	centreDataAt(PamDataBlock dataBlock, long menuMouseTime) Centre the data in all data streams at the given time
void	frameResized()
long[]	getDataExtent(OfflineDataStore dataSource) Get the start and end times for all data associated with a particular data source
static DataMapControl	getDataMapControl()
long	getFirstTime()
long	getLastTime()
java.util.ArrayList<PamDataBlock>	getMappedDataBlocks()
java.io.Serializable	getSettingsReference()
long	getSettingsVersion()
PamTabPanel	getTabPanel() Gets a reference to a panel to be added to a view
void	notifyModelChanged(int changeType) General notification when the PAMGAURD model changes.
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
void	scrollToData(PamDataBlock dataBlock)
void	setPamView(PamView pamView) Called whenever the frme of a PamControlledunit changes (including at program startup).
void	startDataAt(PamDataBlock dataBlock, long menuMouseTime) Start the data in all data streams at the given time

Methods inherited from class PamController.PamControlledUnit

addOfflineTaskGroup, addOtherRelatedMenuItems, addPamProcess, addRelatedMenuItems, addXMLParameter, addXMLParameter, addXMLParameter, addXMLParameter, canClose, canPlayViewerSound, createDetectionMenu, createDisplayMenu, createFileMenu, createHelpMenu, fillXMLElement, flushDataBlockBuffers, getFrameNumber, getGuiFrame, getModuleSummary, getNumOfflineTaskGroups, getNumPamProcesses, getOfflineTaskGroup, getPamController, getPamModuleInfo, getPamProcess, getPamView, getShortUnitType, getSidePanel, getTabClipCopier, getTabSpecificMenuBar, getToolbarComponent, getUnitName, getUnitType, getVerboseLevel, gotoTab, isViewer, pamClose, pamHasStopped, pamToStart, playViewerSound, removePamProcess, removeUnit, rename, saveViewerData, setFrameNumber, setPamController, setPamModuleInfo, setSidePanel, setTabPanel, setupControlledUnit, stopViewerSound, terminalPrint, terminalPrintln, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface PamController.PamSettings

getUnitName, getUnitType

Constructor Detail

DataMapControl

public DataMapControl(java.lang.String unitName)

Method Detail

getDataMapControl

public static DataMapControl getDataMapControl()

setPamView

public void setPamView(PamView pamView)

Description copied from class: PamControlledUnit

Called whenever the frme of a PamControlledunit changes (including at program startup).

Overrides:

setPamView in class PamControlledUnit

frameResized

public void frameResized()

getTabPanel

public PamTabPanel getTabPanel()

Description copied from class: PamControlledUnit

Gets a reference to a panel to be added to a view

Overrides:

getTabPanel in class PamControlledUnit

Returns:

reference to a PamTabPanel object

See Also:

PamTabPanel, PamSidePanel

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

getMappedDataBlocks

public java.util.ArrayList<PamDataBlock> getMappedDataBlocks()

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

public long[] getDataExtent(OfflineDataStore dataSource)

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

public java.io.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

centreDataAt

public void centreDataAt(PamDataBlock dataBlock,
                long menuMouseTime)

Centre the data in all data streams at the given time

Parameters:

dataBlock - data block graph sending the command

menuMouseTime - time in milliseconds.

startDataAt

public void startDataAt(PamDataBlock dataBlock,
               long menuMouseTime)

Start the data in all data streams at the given time

Parameters:

dataBlock - data block graph sending the command

menuMouseTime - time in milliseconds.

scrollToData

public void scrollToData(PamDataBlock dataBlock)