Package export

Interface PamDataUnitExporter

All Known Implementing Classes:
CSVExportManager, MLDetectionsManager, RExportManager, WavDetExportManager
public interface PamDataUnitExporter
Manages the exporting of data units to a particular type of file e.g. CSV, MATLAB, R, WAV files

  • Method Details

    • hasCompatibleUnits

      boolean hasCompatibleUnits(Class dataUnitType)
      Check whether a particular data unit class is compatible
      Parameters:
      dataUnitType - - the data unit type to test.
      Returns:
      true if it can be exported.

    • exportData

      boolean exportData(File fileName, List<PamDataUnit> dataUnits, boolean append)
      Export the data to a folder.
      Parameters:
      fileName - - the file to export to
      dataUnits - - the data units to export.
      prefix - - file prefix for filenames.
      true - to append the data to the current file - otherwise a new file is written.
      Returns:
      true if exported successfully.

    • getFileExtension

      String getFileExtension()
      Get the extension for the output file type
      Returns:
      the extension for the file type e.g. "mat"

    • getIconString

      String getIconString()
      Get the ikonli icon string for the exporter.
      Returns:
      the ikon string.

    • getName

      String getName()
      Get the name of the exporter.
      Returns:
      the name of the exporter.

    • close

      void close()
      Close the exporter.

    • isNeedsNewFile

      boolean isNeedsNewFile()
      Check whether and exporter needs a new file
      Returns:
      true if we need a new file.

    • getOptionsPanel

      Component getOptionsPanel()
      An optional panel that displays additional options for the user.
      Returns:
      additional options panel - can be null.

    • getOptionsPane

      javafx.scene.layout.Pane getOptionsPane()
      An optional JavaFX pane that displays additional options for the user.
      Returns:
      pane with additonal options - can be null.

    • prepareExport

      void prepareExport()
      Called whenever a new export run is prepared.