clickDetector.offlineFuncs

Class OfflineEventDataBlock

java.lang.Object

PamguardMVC.PamObservable

PamguardMVC.PamDataBlock<OfflineEventDataUnit>

clickDetector.offlineFuncs.OfflineEventDataBlock

All Implemented Interfaces:

PanelOverlayDraw, StaticLocaliserProvider, TargetMotionLocaliserProvider

public class OfflineEventDataBlock
extends PamDataBlock<OfflineEventDataUnit>
implements StaticLocaliserProvider, TargetMotionLocaliserProvider

PamDataBlock for offline events.

As with RainbowClick, this will (probably) hold all offline events from the database so that the operator can navigate through them with ease. However, only clicks associated with the currently loaded period will be loaded into memory and associated with the OfflineEventDataUnits.

Author:

Doug

Field Summary

Fields inherited from class PamguardMVC.PamDataBlock

ITERATOR_END, MATCH_AFTER, MATCH_BEFORE, MATCH_EXACT, MIX_DONOTHING, MIX_INTODATABASE, MIX_OUTOFDATABASE, NOTIFY_NEW_DATA, NOTIFY_UPDATE_DATA, OFFLINE_DATA_CANCEL, OFFLINE_DATA_INTERRUPT, OFFLINE_DATA_WAIT, orderLock, POSITION_AFTER, POSITION_BEFORE, REFERENCE_ABSOLUTE, REFERENCE_CURRENT, REQUEST_DATA_LOADED, REQUEST_DATA_PARTIAL_LOAD, REQUEST_EXCEPTION, REQUEST_INTERRUPTED, REQUEST_NO_DATA, REQUEST_SAME_REQUEST

Constructor Summary

Constructors

Constructor and Description
OfflineEventDataBlock(java.lang.String dataName, ClickDetector parentProcess, int channelMap)

Method Summary

Methods

Modifier and Type	Method and Description
void	addPamData(OfflineEventDataUnit pamDataUnit) Adds a new PamDataUnit to the PamDataBlock.
void	clearAll() This is generally only called from loadViwerData and since LoadviewerData only ever operates once, it should never get called !
int	getChannelMap()
boolean	getShouldLog(PamDataUnit pamDataUnit) Should log the data unit to the database ?
AbstractLocaliserControl	getSLControlDialog(StaticLocaliserControl staticLocaliserControl) Any datablock can provide a localiser control panel for the static localiser, however it must be tailored to the specific type of detection.
AbstractControlPanel	getTMControlPanel(TargetMotionControl targetMotionControl) Any datablock can provide a localiser control panel for the static localiser, however it must be tailored to the specific type of detection.
TargetMotionInformation	getTMInfo(java.util.ArrayList<PamDetection> detections) Each data block may have a unique way of calculating targetmotion information.
boolean	loadViewerData(long dataStart, long dataEnd, ViewLoadObserver loadObserver) LoadViewerData works very differently for offline events since all events for the entire data set are always held in memory.
boolean	remove(OfflineEventDataUnit aDataUnit)
boolean	saveViewerData() Saves data in this data block in offline viewer mode.

Methods inherited from class PamguardMVC.PamDataBlock

addDataAnnotationType, addLocalisationContents, addObserver, addObserver, addOfflineDataMap, autoSetDataBlockMixMode, cancelDataOrder, clearChannelIterators, clearDeletedList, createProcessAnnotations, createProcessAnnotations, dumpBlockContents, findAnnotation, findAnnotation, findByDatabaseIndex, findDataUnit, findDataUnit, findUnitsinInterval, getBinaryDataSource, getCanLog, getChannelIterator, getChannelIteratorCount, getClosestUnitMillis, getClosestUnitMillis, getCurrentViewDataEnd, getCurrentViewDataStart, getDataAnnotationType, getDataGain, getDatagrammedMap, getDatagramProvider, getDataName, getDataSelectCreator, getDataSelector, getDataUnit, getFirstUnit, getFirstUnit, getFirstUnitAfter, getLastUnit, getLastUnit, getListIterator, getListIterator, getListIteratorFromEnd, getListIteratorFromStart, getLocalisationContents, getLogging, getLoggingName, getLongDataName, getMixedDirection, getNaturalLifetime, getNaturalLifetimeMillis, getNextDataStart, getNextUnit, getNextUnit, getNumDataAnnotationTypes, getNumOfflineDataMaps, getNumRequiredBeforeLoadTime, getOfflineData, getOfflineDataMap, getOfflineDataMap, getOrderStatus, getParentProcess, getPreceedingUnit, getPreceedingUnit, getPreceedingUnit, getPreceedingUnit, getPrevDataEnd, getPrimaryDataMap, getProcessAnnotations, getQuickId, getRawSourceDataBlock, getRawSourceDataBlock2, getRecycledUnit, getRecyclingStoreLength, getRemovedItems, getReverseChannelIterator, getSampleRate, getSaveRequirements, getShouldBinary, getSourceDataBlock, getSourceProcess, getUnitClass, getUnitIndex, getUnitsCount, getUnitsCountFromTime, isCanClipGenerate, isClearAtStart, isLinkGpsData, isRecycling, masterClockUpdate, noteNewSettings, notifyModelChanged, orderOfflineData, orderOfflineData, remove, removeOfflineDataMap, reset, setBinaryDataSource, setCanClipGenerate, setChannelMap, setClearAtStart, setDatagramProvider, setDataName, setLinkGpsData, setLocalisationContents, SetLogging, setMixedDirection, setNaturalLifetime, setNaturalLifetimeMillis, setRecordingTrigger, setRecycling, setRecyclingStoreLength, setSampleRate, setShouldBinary, setShouldLog, shouldNotify, sortData, toString, updatePamData

Methods inherited from class PamguardMVC.PamObservable

canDraw, clearchanged, countObservers, createKeyItem, deleteObserver, deleteObservers, drawDataUnit, findThreadedObserver, getCPUPercent, getCPUPercent, getHoverText, getLongestObserver, getPamObservers, getRequiredHistory, hasOptionsDialog, notifyObservers, notifyObservers, setChanged, setOverlayDraw, showOptions, waitForThreadedObservers

Methods inherited from class java.lang.Object

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

Constructor Detail

OfflineEventDataBlock

public OfflineEventDataBlock(java.lang.String dataName,
                     ClickDetector parentProcess,
                     int channelMap)

Method Detail

getChannelMap

public int getChannelMap()

Overrides:

getChannelMap in class PamDataBlock<OfflineEventDataUnit>

addPamData

public void addPamData(OfflineEventDataUnit pamDataUnit)

Description copied from class: PamDataBlock

Adds a new PamDataUnit to the PamDataBlock. When the data unit is added, PamObservers that have subscribed to the block will be notified.

Overrides:

addPamData in class PamDataBlock<OfflineEventDataUnit>

Parameters:

pamDataUnit - Reference to a PamDataUnit

getShouldLog

public boolean getShouldLog(PamDataUnit pamDataUnit)

Description copied from class: PamDataBlock

Should log the data unit to the database ?

Overrides:

getShouldLog in class PamDataBlock<OfflineEventDataUnit>

Parameters:

pamDataUnit - dataunit to consider

Returns:

true if data should be logged.

loadViewerData

public boolean loadViewerData(long dataStart,
                     long dataEnd,
                     ViewLoadObserver loadObserver)

LoadViewerData works very differently for offline events since all events for the entire data set are always held in memory.

Therefore, they only need be loaded once at the start of analysis and should never be deleted. They should however be saved as often as is reasonably possible.

Overrides:

loadViewerData in class PamDataBlock<OfflineEventDataUnit>

Parameters:

dataStart - data start time in millis

dataEnd - data end time in millis.

clearAll

public void clearAll()

This is generally only called from loadViwerData and since LoadviewerData only ever operates once, it should never get called !

Overrides:

clearAll in class PamDataBlock<OfflineEventDataUnit>

saveViewerData

public boolean saveViewerData()

Description copied from class: PamDataBlock

Saves data in this data block in offline viewer mode.

Overrides:

saveViewerData in class PamDataBlock<OfflineEventDataUnit>

Returns:

true if data found and saved.

remove

public boolean remove(OfflineEventDataUnit aDataUnit)

Overrides:

remove in class PamDataBlock<OfflineEventDataUnit>

getSLControlDialog

public AbstractLocaliserControl getSLControlDialog(StaticLocaliserControl staticLocaliserControl)

Description copied from interface: StaticLocaliserProvider

Any datablock can provide a localiser control panel for the static localiser, however it must be tailored to the specific type of detection. For example clicks would require a control panel which can sort out events, classified clicks etc. Whistles on the other hand may require a spectrogram, or perhaps a generic amplitude time display, with a contour preview box.

Specified by:

getSLControlDialog in interface StaticLocaliserProvider

Returns:

getTMControlPanel

public AbstractControlPanel getTMControlPanel(TargetMotionControl targetMotionControl)

Description copied from interface: TargetMotionLocaliserProvider

Any datablock can provide a localiser control panel for the static localiser, however it must be tailored to the specific type of detection. For example clicks would require a control panel which can sort out events, classified clicks etc.

Specified by:

getTMControlPanel in interface TargetMotionLocaliserProvider

Returns:

getTMInfo

public TargetMotionInformation getTMInfo(java.util.ArrayList<PamDetection> detections)

Description copied from interface: TargetMotionLocaliserProvider

Each data block may have a unique way of calculating targetmotion information.

Specified by:

getTMInfo in interface TargetMotionLocaliserProvider

Returns:

any class which implements TargetMotionInformation