Package loggerForms

Class FormsControl

java.lang.Object
PamController.PamControlledUnit
loggerForms.FormsControl
All Implemented Interfaces:
PamSettings, SettingsNameProvider
public class FormsControl extends PamControlledUnit implements PamSettings
Author:
Graham Weatherup controls the logger forms module

  • Field Details

  • Constructor Details

    • FormsControl

      public FormsControl(String unitName)

  • Method Details

    • notifyModelChanged

      public void notifyModelChanged(int changeType)
      Description copied from class: PamControlledUnit
      General notification when the PAMGAURD model changes.
      Overrides:
      notifyModelChanged in class PamControlledUnit
      Parameters:
      changeType - type of change

    • getNumFormDescriptions

      public int getNumFormDescriptions()

    • getFormDescription

      public FormDescription getFormDescription(int iForm)
      Get the form description for a specific index.
      Parameters:
      iForm - form index
      Returns:
      for description

    • getFormIndex

      public int getFormIndex(FormDescription formDescription)
      Get a form index from a form description
      Parameters:
      formDescription - Form Descriptions
      Returns:
      form index or -1 if not found

    • findFormByOrder

      public FormDescription findFormByOrder(int order)
      Find a form which has a particular order value.
      Parameters:
      order - order (starts from 1 generally)
      Returns:
      a form, or null if none have that order.

    • findFormDescription

      public FormDescription findFormDescription(String formName)
      Find a form description with a given name.
      Parameters:
      formName -
      Returns:
      form description or null.

    • getOutputTableNameCounterSuffix

      public Character getOutputTableNameCounterSuffix(FormDescription thisFormDescription)

    • readUDFTables

      public void readUDFTables()
      Generates a list of tables beginning with UDF_ and reads their contents into a FormDescription

    • addFormDescription

      public void addFormDescription(String newFormName)

    • getFormsTabPanel

      public FormsTabPanel getFormsTabPanel()
      Get the correct type of reference to the forms tab panel.
      Returns:
      reference to the forms tab panel.

    • getTabPanel

      public PamTabPanel getTabPanel()
      Description copied from class: PamControlledUnit
      Gets a reference to a panel to be added to a view
      Overrides:
      getTabPanel in class PamControlledUnit
      Returns:
      reference to a PamTabPanel object
      See Also:

    • getSidePanel

      public PamSidePanel getSidePanel()
      Description copied from class: PamControlledUnit
      Gets a reference to a small panel to be displayed along the left hand edge of the main tab panel. Side panels should be small since they are always visible and any space they take will be taken from the main tab panel.

      It is possible for a PamControlled unit to have a side panel without having a pamTabPanel.

      Overrides:
      getSidePanel in class PamControlledUnit
      Returns:
      a pamSidePanel object.
      See Also:

    • getFormsProcess

      public FormsProcess getFormsProcess()
      Returns:
      the formsProcess

    • createDetectionMenu

      public JMenuItem createDetectionMenu(Frame parentFrame)
      Description copied from class: PamControlledUnit
      Create a JMenu object containing MenuItems associated with PamProcesses
      Overrides:
      createDetectionMenu in class PamControlledUnit
      Parameters:
      parentFrame - The owner frame of the menu
      Returns:
      reference to a JMenu which can be added to an existing menu or menu bar

      Note that if multiple views are to use the same menu, then they should each create a new menu (by setting Create to true) the first time they call this method.

    • newLoggerform

      public String newLoggerform(Frame parentFrame)
      Create a new logger form
      Parameters:
      parentFrame - parent frame
      Returns:
      selected name for new form, or null if nothing created.

    • regenerateForms

      public void regenerateForms(Window parentFrame)
      Delete and recreate all forms / form data, etc.
      Parameters:
      parentFrame -

    • createDisplayMenu

      public JMenuItem createDisplayMenu(Frame parentFrame)
      Description copied from class: PamControlledUnit
      Create a JMenu object containing MenuItems associated with the view
      Overrides:
      createDisplayMenu in class PamControlledUnit
      Returns:
      reference to a JMenu which can be added to an existing menu or menu bar

      Note that if multiple views are to use the same menu, then they should each create a new menu (by setting Create to true) the first time they call this method.

    • displayOptions

      public void displayOptions(Frame parentFrame)

    • canClose

      public boolean canClose()
      Description copied from class: PamControlledUnit
      Called before Pamguard shuts down. Rather than returning false, this function can be used as a final oportunity to save settings, write to the database, etc.
      Overrides:
      canClose in class PamControlledUnit
      Returns:
      true if OK for Pamguard to shut down, false otherwise.

    • rewriteChangedUDFTables

      public void rewriteChangedUDFTables()
      Rewrite all UDF tables in forms which have been altered.

    • getFormsMonitor

      public FormsMonitorMaster getFormsMonitor()
      Returns:
      the formsMonitor

    • getModuleStatus

      public ModuleStatus getModuleStatus()
      Description copied from class: PamControlledUnit
      Quick convenient way of getting the module status.
      Overrides:
      getModuleStatus in class PamControlledUnit
      Returns:
      Module Status or null if no status manager present.

    • checkBadBoolean

      public static Boolean checkBadBoolean(Object value)
      Some things that are meant to be boolean are coming out as int or string so need to do some type checking.
      Parameters:
      value -
      Returns:

    • getSettingsReference

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

    • getSettingsVersion

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

    • restoreSettings

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

    • getFormsParameters

      public FormsParameters getFormsParameters()
      Returns:
      the formsParameters