Package export.wavExport

Class WavDetExportManager

java.lang.Object

export.wavExport.WavDetExportManager

All Implemented Interfaces:

PamDataUnitExporter

public class WavDetExportManager
extends Object
implements PamDataUnitExporter

Writes data units and/or ordered raw data to a wav file. Has functions to handle .wav file writing based on overlay marks and detection groups with functions to make decisions based on what type of data unit is selected and whether raw data is available.

There are two primary use cases;
1) Order raw data from an overlay mark and save as a wav file
2) Save a list of data units to wav files - either a single file with zero pads, a concatenated file or separate files.

Author:

Jamie Macaulay

Constructor Summary

Constructors

Constructor	Description
WavDetExportManager()

Method Summary

Modifier and Type	Method	Description
void	close()	Close the exporter.
boolean	exportData(File fileName, List<PamDataUnit> dataUnits, boolean append)	Export the data to a folder.
String	getFileExtension()	Get the extension for the output file type
String	getIconString()	Get the ikonli icon string for the exporter.
String	getName()	Get the name of the exporter.
javafx.scene.layout.Pane	getOptionsPane()	An optional JavaFX pane that displays additional options for the user.
Component	getOptionsPanel()	An optional panel that displays additional options for the user.
boolean	hasCompatibleUnits(Class dataUnitType)	Check whether a particular data unit class is compatible
boolean	isNeedsNewFile()	Check whether and exporter needs a new file
void	prepareExport()	Called whenever a new export run is prepared.

Methods inherited from class java.lang.Object

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

Constructor Details

WavDetExportManager

public WavDetExportManager()

Method Details

hasCompatibleUnits

public boolean hasCompatibleUnits(Class dataUnitType)

Description copied from interface: PamDataUnitExporter

Check whether a particular data unit class is compatible

Specified by:

hasCompatibleUnits in interface PamDataUnitExporter

Parameters:

dataUnitType - - the data unit type to test.

Returns:

true if it can be exported.

exportData

public boolean exportData(File fileName,
 List<PamDataUnit> dataUnits,
 boolean append)

Description copied from interface: PamDataUnitExporter

Export the data to a folder.

Specified by:

exportData in interface PamDataUnitExporter

Parameters:

fileName - - the file to export to

dataUnits - - the data units to export.

Returns:

true if exported successfully.

getFileExtension

public String getFileExtension()

Description copied from interface: PamDataUnitExporter

Get the extension for the output file type

Specified by:

getFileExtension in interface PamDataUnitExporter

Returns:

the extension for the file type e.g. "mat"

getIconString

public String getIconString()

Description copied from interface: PamDataUnitExporter

Get the ikonli icon string for the exporter.

Specified by:

getIconString in interface PamDataUnitExporter

Returns:

the ikon string.

getName

public String getName()

Description copied from interface: PamDataUnitExporter

Get the name of the exporter.

Specified by:

getName in interface PamDataUnitExporter

Returns:

the name of the exporter.

close

public void close()

Description copied from interface: PamDataUnitExporter

Close the exporter.

Specified by:

close in interface PamDataUnitExporter

isNeedsNewFile

public boolean isNeedsNewFile()

Description copied from interface: PamDataUnitExporter

Check whether and exporter needs a new file

Specified by:

isNeedsNewFile in interface PamDataUnitExporter

Returns:

true if we need a new file.

getOptionsPanel

public Component getOptionsPanel()

Description copied from interface: PamDataUnitExporter

An optional panel that displays additional options for the user.

Specified by:

getOptionsPanel in interface PamDataUnitExporter

Returns:

additional options panel - can be null.

getOptionsPane

public javafx.scene.layout.Pane getOptionsPane()

Description copied from interface: PamDataUnitExporter

An optional JavaFX pane that displays additional options for the user.

Specified by:

getOptionsPane in interface PamDataUnitExporter

Returns:

pane with additonal options - can be null.

prepareExport

public void prepareExport()

Description copied from interface: PamDataUnitExporter

Called whenever a new export run is prepared.

Specified by:

prepareExport in interface PamDataUnitExporter