Package net.simplace.pipe.functionality

Klasse FWAbstractFunctionality

java.lang.Object
java.lang.Thread
net.simplace.pipe.functionality.FWAbstractFunctionality
Alle implementierten Schnittstellen:
Runnable
Bekannte direkte Unterklassen:
BrowserFunctionality, ConsoleOutFunctionality, DatabaseAccessFunctionality, EditXMLFunctionality, FormFunctionality, PDFViewerFunctionality, PipeLineFunctionality, ShowImageFunctionality, SimEnvGraphFunctionality
public abstract class FWAbstractFunctionality extends Thread
Functionality is used to start functions in Framework by class for name instatiation. Method startFunctionaltiy is allways called when functionality starts. Abstract implemented parts: Parameters are handled by AbstractFuncitonality. You have access to Mainframe and the MainTab in TabViewModule. Additionally you can create new Tab for started Functionaliatimplementation. For instantiation use FunctionalityFactory with specific FunctionModel.
Autor:
Andreas Enders

  • Konstruktordetails

    • FWAbstractFunctionality

      protected FWAbstractFunctionality()
      Default constructor is protected for beeing overwritte by implementation - used for ClassForName implementation

  • Methodendetails

    • initialize

      protected void initialize(Map<String,Object> aParameterMap)
      method initializes the Functionality implementation with jdom Element
      Parameter:
      aParameterMap -

    • initialize

      protected void initialize(FWFunctionalityModel aFunctionModel)
      method initializes the Functionality implementation with jdom Element
      Parameter:
      aFunctionModel -

    • startFunctionality

      protected abstract void startFunctionality() throws Exception
      abstract method which has to be implemented in implementation - allways executed in Framework while this class is used
      Löst aus:
      Exception

    • getFunctionElement

      protected org.jdom2.Element getFunctionElement()
      Gibt zurück:
      returns the Functionelement saved in this Functionality

    • runFunctionality

      public FWObservable runFunctionality() throws Exception
      abstract method which has to be implemented in implementation - always executed in Framework while this class is used
      Gibt zurück:
      FWObservable
      Löst aus:
      Exception

    • run

      public void run()
      abstract method which has to be implemented in implementation - allways executed in Framework while this class is used
      Angegeben von:
      run in Schnittstelle Runnable
      Setzt außer Kraft:
      run in Klasse Thread

    • getID

      public String getID()
      Gibt zurück:
      Identifier of this Functionality

    • getSystemID

      public String getSystemID()
      Gibt zurück:
      Identifier of this Functionality

    • getOID

      public String getOID()
      Gibt zurück:
      Objectidentifierer of this Functionaliy - allways unique!

    • getUserGroup

      public String getUserGroup()
      Gibt zurück:
      usergroup which is allowed to use this function

    • getStringParameterValue

      public String getStringParameterValue(String aKey)
      Parameter:
      aKey -
      Gibt zurück:
      one parameter value for given key - null if key was not set

    • getParameter

      public Object getParameter(String aKey)
      Parameter:
      aKey -
      Gibt zurück:
      parameter specified by aKey

    • getMainFrame

      public FWMainFrame getMainFrame()
      Gibt zurück:
      MainFrame of application

    • getMainComponent

      public Component getMainComponent()
      Gibt zurück:
      selected tab panel of TabView

    • getObservable

      public FWObservable getObservable()
      Gibt zurück:
      the output parameter map != input parameter map

    • getNextFunction

      public String getNextFunction()
      evaluating the expression for nextFunction and returning it
      Gibt zurück:
      the next Function ID String

    • getPreviousFunction

      public String getPreviousFunction()
      evaluating the expression for previousFunction and returning it
      Gibt zurück:
      the previous Function ID String

    • shouldFunctionBeRun

      public boolean shouldFunctionBeRun() throws PipeLineException
      Gibt zurück:
      if this function should be run
      Löst aus:
      PipeLineException

    • setOutputParameter

      public void setOutputParameter(String aKey, Object aValue)
      Parameter:
      aKey -
      aValue -

    • setObservable

      public void setObservable(FWObservable aOservable)
      Parameter:
      aOservable -

    • getLocaleValue

      protected String getLocaleValue(String aKey)
      This method limits the coding for reading values from the locale.
      Parameter:
      aKey -
      Gibt zurück:
      LocaleValue specified by aKey

    • stopThread

      public boolean stopThread()
      stopping current Thread if it is still running
      Gibt zurück:
      true, if the Thread was running and it is stopped, false if it was already stopped

    • setCurrentThread

      protected void setCurrentThread(Thread aCurrentThread)
      Parameter:
      aCurrentThread - the currentThread to set

    • hasInfoElements

      public boolean hasInfoElements()
      Gibt zurück:
      true, if InfoElements are contained

    • getInfoElements

      public Collection<org.jdom2.Element> getInfoElements()
      Gibt zurück:
      collection of InfoElements

    • getCenterPanel

      public JPanel getCenterPanel()
      Gibt zurück:
      center Panel

    • setCenterPanel

      public void setCenterPanel(JPanel aCenterPanel)
      Parameter:
      aCenterPanel -

    • getCurrentThread

      public Thread getCurrentThread()
      Gibt zurück:
      the current Thread

    • toXML

      public org.jdom2.Element toXML()
      Gibt zurück:
      the generated XML as description of this functionality