Package annotation.userforms.species

Class FormsAnnotationSpeciesManager

java.lang.Object
tethys.species.DataBlockSpeciesManager
annotation.userforms.species.FormsAnnotationSpeciesManager
All Implemented Interfaces:
PamSettings, SettingsNameProvider
public class FormsAnnotationSpeciesManager extends DataBlockSpeciesManager implements PamSettings

  • Constructor Details Link icon

  • Method Details Link icon

    • getSpeciesCodes Link icon

      public DataBlockSpeciesCodes getSpeciesCodes()
      Description copied from class: DataBlockSpeciesManager
      Object that contains a list of species codes. This may be fluid between configurations and may change during a session, e.g. through the addition of a new click type or changes to the whistle classifier settings.
      Specified by:
      getSpeciesCodes in class DataBlockSpeciesManager
      Returns:
      object containing a list of species types.

    • getSpeciesCode Link icon

      public String getSpeciesCode(PamDataUnit dataUnit)
      Description copied from class: DataBlockSpeciesManager
      Gets a species string for a specific data unit, This is abstracted since different detectors store this in non standard ways. The result of this should be within the set provided by getSpeciesCodes() which can then be used in the DataBlockSpeciesMap to look up an itis code.
      Specified by:
      getSpeciesCode in class DataBlockSpeciesManager
      Parameters:
      dataUnit -
      Returns:
      A species code for a specific data unit. May be null (e.g. for an unclassified click)

    • getDialogPanel Link icon

      public PamDialogPanel getDialogPanel(SpeciesManagerObserver speciesManagerObserver)
      Description copied from class: DataBlockSpeciesManager
      Return a (preferably) small dialog panel that can contain options for the species manager.
      Overrides:
      getDialogPanel in class DataBlockSpeciesManager
      Returns:

    • getUnitName Link icon

      public String getUnitName()
      Specified by:
      getUnitName in interface SettingsNameProvider
      Returns:
      A Name specific to this instance of the particular class, e.g. Sperm whale detector, Beaked whale detector, etc.

    • getUnitType Link icon

      public String getUnitType()
      Specified by:
      getUnitType in interface PamSettings
      Returns:
      A Name specific to the type, e.g. Click detector

    • getSettingsReference Link icon

      public Serializable getSettingsReference()
      Specified by:
      getSettingsReference in interface PamSettings
      Returns:
      The serialisable object that will be stored

    • getSettingsVersion Link icon

      public long getSettingsVersion()
      Specified by:
      getSettingsVersion in interface PamSettings
      Returns:
      An integer version number for the settings

    • restoreSettings Link icon

      public boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
      Specified by:
      restoreSettings in interface PamSettings
      Parameters:
      pamControlledUnitSettings -
      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

    • getUserFormAnnotationType Link icon

      public UserFormAnnotationType getUserFormAnnotationType()
      Returns:
      the userFormAnnotationType

    • getSpeciesSettings Link icon

      public FormsSpeciesSettings getSpeciesSettings()
      Returns:
      the speciesSettings