Module io.github.tonywasher.joceanus.prometheus.core
Package io.github.tonywasher.joceanus.prometheus.views

Class PrometheusDataControl

java.lang.Object
io.github.tonywasher.joceanus.prometheus.views.PrometheusDataControl
All Implemented Interfaces:
OceanusEventRegistrar.OceanusEventProvider<PrometheusDataEvent>
public abstract class PrometheusDataControl extends Object implements OceanusEventRegistrar.OceanusEventProvider<PrometheusDataEvent>
Provides top-level control of data.

  • Constructor Details

    • PrometheusDataControl

      protected PrometheusDataControl(PrometheusToolkit pToolkit)
      Constructor for default control.
      Parameters:
      pToolkit - the toolkit

  • Method Details

    • getEventRegistrar

      public OceanusEventRegistrar<PrometheusDataEvent> getEventRegistrar()
      Description copied from interface: OceanusEventRegistrar.OceanusEventProvider
      Obtain registration object for listeners.
      Specified by:
      getEventRegistrar in interface OceanusEventRegistrar.OceanusEventProvider<PrometheusDataEvent>
      Returns:
      the registrar

    • setValidatorFactory

      public void setValidatorFactory(PrometheusDataValidator.PrometheusDataValidatorFactory pFactory)
      Set the validator factory.
      Parameters:
      pFactory - the validator factory

    • getValidatorFactory

      public PrometheusDataValidator.PrometheusDataValidatorFactory getValidatorFactory()
      Obtain the validator factory.
      Returns:
      the validator factory

    • setData

      public void setData(PrometheusDataSet pData)
      Record new DataSet.
      Parameters:
      pData - the new DataSet

    • incrementVersion

      public void incrementVersion()
      Increment data version.

    • getData

      public PrometheusDataSet getData()
      Obtain current DataSet.
      Returns:
      the current DataSet

    • deriveUpdates

      public void deriveUpdates() throws OceanusException
      Derive update list.
      Throws:
      OceanusException - on error

    • getUpdates

      public PrometheusDataSet getUpdates()
      Obtain current Updates.
      Returns:
      the current Updates

    • addError

      public void addError(OceanusException pError)
      Add new Error.
      Parameters:
      pError - the new Error

    • clearErrors

      protected void clearErrors()
      Clear error list.

    • getErrors

      public MetisViewerErrorList getErrors()
      Obtain current error.
      Returns:
      the current Error

    • getToolkit

      public PrometheusToolkit getToolkit()
      Obtain toolkit.
      Returns:
      the toolkit

    • getDataFormatter

      public OceanusDataFormatter getDataFormatter()
      Obtain DataFormatter.
      Returns:
      the DataFormatter

    • getPasswordManager

      public PrometheusSecurityPasswordManager getPasswordManager()
      Obtain SecurityManager.
      Returns:
      the SecurityManager

    • getPreferenceManager

      public PrometheusPreferenceManager getPreferenceManager()
      Obtain PreferenceManager.
      Returns:
      the PreferenceManager

    • getViewerManager

      public MetisViewerManager getViewerManager()
      Obtain ViewerManager.
      Returns:
      the ViewerManager

    • getGuiFactory

      public TethysUIFactory<?> getGuiFactory()
      Obtain GuiFactory.
      Returns:
      the GuiFactory

    • getViewerEntry

      public final MetisViewerEntry getViewerEntry(PrometheusViewerEntryId pId)
      Get viewer Entry.
      Parameters:
      pId - the id of the entry
      Returns:
      the Viewer Entry

    • getSpreadSheet

      public abstract PrometheusSpreadSheet getSpreadSheet()
      Obtain SpreadSheet object.
      Returns:
      SpreadSheet object

    • getDatabaseName

      public abstract String getDatabaseName()
      Obtain the database name.
      Returns:
      the name

    • getDatabase

      public abstract PrometheusDataStore getDatabase() throws OceanusException
      Obtain Database object.
      Returns:
      database object
      Throws:
      OceanusException - on error

    • getNullDatabase

      public abstract PrometheusDataStore getNullDatabase() throws OceanusException
      Obtain Null Database object.
      Returns:
      database object
      Throws:
      OceanusException - on error

    • getNewData

      public abstract PrometheusDataSet getNewData()
      Obtain DataSet object.
      Returns:
      dataSet object

    • analyseData

      protected abstract boolean analyseData(boolean bPreserve)
      Analyse the data in the view.
      Parameters:
      bPreserve - preserve any error
      Returns:
      success true/false

    • refreshViews

      final void refreshViews()
      refresh the data view.

    • undoLastChange

      public void undoLastChange()
      Undo changes in a viewSet.

    • resetChanges

      public void resetChanges()
      Reset changes in a viewSet.

    • getNewProfile

      public OceanusProfile getNewProfile(String pTask)
      Create new profile.
      Parameters:
      pTask - the name of the task
      Returns:
      the new profile

    • getActiveProfile

      public OceanusProfile getActiveProfile()
      Obtain the active profile.
      Returns:
      the active profile

    • getActiveTask

      public OceanusProfile getActiveTask()
      Obtain the active task.
      Returns:
      the active task