net.simplace.pipe.functionality.FWAbstractFunctionality

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.


public abstract class FWAbstractFunctionality extends java.lang.Thread {
// Protected Constructors
protected FWAbstractFunctionality();

// Public Instance Methods
public FWObservable runFunctionality() throws Exception;

abstract method which has to be implemented in implementation - always executed in Framework while this class is used
returns FWObservable
public void run(); // Overrides java.lang.Thread

abstract method which has to be implemented in implementation - allways executed in Framework while this class is used
public String getID();


returns Identifier of this Functionality
public String getSystemID();


returns Identifier of this Functionality
public String getOID();


returns Objectidentifierer of this Functionaliy - allways unique!
public String getUserGroup();


returns usergroup which is allowed to use this function
public String getStringParameterValue(String aKey);


returns one parameter value for given key - null if key was not set
public Object getParameter(String aKey);


returns parameter specified by aKey
public FWMainFrame getMainFrame();


returns MainFrame of application
public Component getMainComponent();


returns selected tab panel of TabView
public FWObservable getObservable();


returns the output parameter map != input parameter map
public String getNextFunction();

evaluating the expression for nextFunction and returning it
returns the next Function ID String
public String getPreviousFunction();

evaluating the expression for previousFunction and returning it
returns the previous Function ID String
public boolean shouldFunctionBeRun() throws PipeLineException;


returns if this function should be run
public void setOutputParameter(String aKey, Object aValue);

public void setObservable(FWObservable aOservable);

public boolean stopThread();

stopping current Thread if it is still running
returns true, if the Thread was running and it is stopped, false if it was already stopped
public boolean hasInfoElements();


returns true, if InfoElements are contained
public Collection getInfoElements();


returns collection of InfoElements
public JPanel getCenterPanel();


returns center Panel
public void setCenterPanel(JPanel aCenterPanel);

public Thread getCurrentThread();


returns the current Thread
public Element toXML();


returns the generated XML as description of this funtionality

// Protected Instance Methods
protected void initialize(Map aParameterMap);

method initializes the Functionality implementation with jdom Element
protected void initialize(FWFunctionalityModel aFunctionModel);

method initializes the Functionality implementation with jdom Element
protected abstract void startFunctionality() throws Exception;

abstract method which has to be implemented in implementation - allways executed in Framework while this class is used
protected Element getFunctionElement();


returns returns the Functionelement saved in this Functionality
protected String getLocaleValue(String aKey);

This method limits the coding for reading values from the locale.
returns LocaleValue specified by aKey
protected void setCurrentThread(Thread aCurrentThread);


}



Hierarchy: java.lang.Object - java.lang.Thread (java.lang.Runnable) - FWAbstractFunctionality



Extended by: net.simplace.pipe.functionalities.BrowserFunctionality, net.simplace.pipe.functionalities.ConsoleOutFunctionality, net.simplace.pipe.functionalities.DatabaseAccessFunctionality, net.simplace.client.pipe.functionalities.EditXMLFunctionality, net.simplace.pipe.functionalities.FormFunctionality, net.simplace.pipe.functionalities.PDFViewerFunctionality, net.simplace.pipe.functionalities.PipeLineFunctionality, net.simplace.pipe.functionalities.ShowImageFunctionality, net.simplace.client.sim.functionalities.SimEnvGraphFunctionality



Passed to: net.simplace.core.FWClientController.back(), net.simplace.core.FWClientController.cancel(), net.simplace.ui.panel.FWBrowserPanel(), net.simplace.ui.panel.FWBrowserPanel(), net.simplace.ui.panel.FWChartPanel(), net.simplace.ui.panel.FWDatabaseAccessFunctionalityPanel(), net.simplace.ui.panel.FWDatabaseAccessFunctionalityPanel(), net.simplace.ui.panel.FWDefaultPanel(), net.simplace.ui.panel.FWDefaultPanel(), net.simplace.ui.panel.FWImagePanel(), net.simplace.ui.panel.FWImagePanel(), net.simplace.ui.panel.FWInternalBrowserPanel(), net.simplace.ui.panel.FWInternalBrowserPanel(), net.simplace.core.FWObservable(), net.simplace.ui.panel.FWPDFPanel(), net.simplace.ui.panel.FWPDFPanel(), net.simplace.pipe.progress.FWProgressViewController(), net.simplace.pipe.progress.FWProgressViewPanel(), net.simplace.core.FWClientController.go(), net.simplace.core.FWClientController.go(), net.simplace.client.sim.graphpanel.SimEnvGraphPanel()



Returned by: net.simplace.core.FWClientController.getCurrentFunctionality(), net.simplace.core.FWObservable.getFunctionality(), net.simplace.ui.panel.FWDefaultPanel.getFunctionality(), FWFunctionalityFactory.getFunctionality(), FWFunctionalityFactory.getFunctionality()



Type of: net.simplace.ui.panel.FWDefaultPanel.iFunctionality