Package tethys.deployment

Class DeploymentHandler

java.lang.Object

tethys.CollectionHandler

tethys.deployment.DeploymentHandler

All Implemented Interfaces:

DeploymentTableObserver, TethysStateObserver

public class DeploymentHandler
extends CollectionHandler
implements TethysStateObserver, DeploymentTableObserver

Functions to gather data for the deployment document from all around PAMGuard. There should be just one of these, available from TethysControl and it will try to sensible handle when and how it updates it's list of PAMGuard and Tethys information
Any part of PAMGuard wanting information on Deployments should come here.

Author:

dg50

Field Summary

Fields

Modifier and Type	Field	Description
static final String	helpPoint

Fields inherited from class tethys.CollectionHandler

tethysControl

Constructor Summary

Constructors

Constructor	Description
DeploymentHandler(TethysControl tethysControl)

Method Summary

Modifier and Type	Method	Description
void	batchExport(nilus.Deployment outlineDeployment)	Called from the offline task (which will probably only be available in batch mode) to export all deployments.
String	canExportDeployments(boolean fullChecks)	Test to see if it's possible to export Deployment documents.
nilus.Deployment	createDeploymentDocument(int i, RecordingPeriod recordingPeriod, String deploymentId)	Create deployment document.
void	createPamguardOverview()
void	exportDeployments()	Export button pressed on GUI.
void	exportDeployments(ArrayList<RecordingPeriod> selected)	Export deployments docs.
String	getBinaryDataURI()
PInstrument	getCurrentArrayInstrument()	Get the Instrument info for the current array.
String	getDatabaseURI()
DeploymentExportOpts	getDeploymentExportOptions()
long	getDeploymentOverlap(PDeployment aDeployment, RecordingPeriod aPeriod)	Get the overlap in mills between a nilus Deployment and a PAMGuard recording period
DeploymentOverview	getDeploymentOverview()
DutyCycleInfo	getDutyCycle()	Get the automatic duty cycle information.
int	getFirstFreeDeploymentId()	Get the first free deploymendId.
String	getHelpPoint()
ArrayList<PDeployment>	getMatchedDeployments()	Get a list of Tethys Deployment docs that match the current PAMGuard data.
ArrayList<PDeployment>	getProjectDeployments()	Get a list of Tethys deployment docs.
ArrayList<PInstrument>	getProjectInstruments()	Get a list of instruments from the current project deployments.
String	getRawDataURI()
TrackInformation	getTrackInformation()	Gather up all track information both from the GPS module (if it exists) and the type of hydrophone array (or many!)
void	selectionChanged()
void	setDeploymentExportOptions(DeploymentExportOpts deploymentExportOptions)
void	showOptions(Window parent)
boolean	updateProjectDeployments()	Update the list of Tethys deployments
void	updateState(TethysState tethysState)	Receive state updates when Tethys has done something (made a connection, moved some data, etc.) Note that this is for RECEIVING state updates, not for sending them.

Methods inherited from class tethys.CollectionHandler

collectionName, getCollection, getDetectorEffort, getMethodString, getSoftwareString, getSupportSoftware, getSupportSoftwareVersion, getTethysControl, getVersionString

Methods inherited from class java.lang.Object

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

Field Details

helpPoint

public static final String helpPoint

See Also:

• Constant Field Values

Constructor Details

DeploymentHandler

public DeploymentHandler(TethysControl tethysControl)

Method Details

getTrackInformation

public TrackInformation getTrackInformation()

Gather up all track information both from the GPS module (if it exists) and the type of hydrophone array (or many!)

Returns:

updateState

public void updateState(TethysState tethysState)

Description copied from interface: TethysStateObserver

Receive state updates when Tethys has done something (made a connection, moved some data, etc.)
Note that this is for RECEIVING state updates, not for sending them. To avoid infinite notifications loops, use tethysControl.sendStateUpdate(TethysState) to send out state notifications.

Specified by:

updateState in interface TethysStateObserver

Parameters:

tethysState -

updateProjectDeployments

public boolean updateProjectDeployments()

Update the list of Tethys deployments

Returns:

true if OK

getProjectDeployments

public ArrayList<PDeployment> getProjectDeployments()

Get a list of Tethys deployment docs. Note that this doesn't update the list, but uses the one currently in memory so call updateTethysDeployments() first if necessary.

Returns:

list of (wrapped) nilus Deployment objects.

showOptions

public void showOptions(Window parent)

createPamguardOverview

public void createPamguardOverview()

exportDeployments

public void exportDeployments()

Export button pressed on GUI. Run wizard....

exportDeployments

public void exportDeployments(ArrayList<RecordingPeriod> selected)

Export deployments docs. Playing with a couple of different ways of doing this.

Parameters:

selected -

getDeploymentOverview

public DeploymentOverview getDeploymentOverview()

getDeploymentOverlap

public long getDeploymentOverlap(PDeployment aDeployment,
 RecordingPeriod aPeriod)

Get the overlap in mills between a nilus Deployment and a PAMGuard recording period

Parameters:

aDeployment - nilus Deployment from Tethys

aPeriod - PAMGuard recording period

Returns:

overlap in milliseconds

getMatchedDeployments

public ArrayList<PDeployment> getMatchedDeployments()

Get a list of Tethys Deployment docs that match the current PAMGuard data. Watch for repeats if a single deployment doc covers many perdiods.

Returns:

getProjectInstruments

public ArrayList<PInstrument> getProjectInstruments()

Get a list of instruments from the current project deployments. This may be a shorter list than the list of deployments.

Returns:

getFirstFreeDeploymentId

public int getFirstFreeDeploymentId()

Get the first free deploymendId. This will get appended to the ProjectName to make and id for each Deployment document

Returns:

createDeploymentDocument

public nilus.Deployment createDeploymentDocument(int i,
 RecordingPeriod recordingPeriod,
 String deploymentId)

Create deployment document. May be better off passing in the Metadata.

Parameters:

i -

recordingPeriod -

deploymentId -

Returns:

getBinaryDataURI

public String getBinaryDataURI()

getDatabaseURI

public String getDatabaseURI()

getRawDataURI

public String getRawDataURI()

canExportDeployments

public String canExportDeployments(boolean fullChecks)

Test to see if it's possible to export Deployment documents. This is basically a test of various metadata fields that are required, such as instrument id's.
In main Tethys, this is called before the Export button is pressed, so doesn't check information that's filled in in the Wizard. When called from the task though it has to do a more complete set of checks.

Parameters:

fullChecks - do a more complete set of checks of EVERYTHING that's needed prior to export. If false only do some checks that are needed prior to running the Wizard.

Returns:

null if OK, or a string describing the first encountered error

getCurrentArrayInstrument

public PInstrument getCurrentArrayInstrument()

Get the Instrument info for the current array.

Returns:

getDutyCycle

public DutyCycleInfo getDutyCycle()

Get the automatic duty cycle information.

Returns:

selectionChanged

public void selectionChanged()

Specified by:

selectionChanged in interface DeploymentTableObserver

getDeploymentExportOptions

public DeploymentExportOpts getDeploymentExportOptions()

Returns:

the deploymentExportOptions

setDeploymentExportOptions

public void setDeploymentExportOptions(DeploymentExportOpts deploymentExportOptions)

Parameters:

deploymentExportOptions - the deploymentExportOptions to set

getHelpPoint

public String getHelpPoint()

Specified by:

getHelpPoint in class CollectionHandler

batchExport

public void batchExport(nilus.Deployment outlineDeployment)

Called from the offline task (which will probably only be available in batch mode) to export all deployments.
Can see various enhancements such as allowing overwriting to include in batch process parameters. Won't ever overwrite.

Parameters:

outlineDeployment -