org.severe.jripples.modules.interfaces
Interface JRipplesModuleInterface

All Known Subinterfaces:
JRipplesAnalysisModuleInterface, JRipplesDependencyGraphModuleInterface, JRipplesICModuleInterface, JRipplesPresentationModuleInterface

public interface JRipplesModuleInterface

This class is a common interface for all JRipples modules. It provides methods that notify a module when it is loaded or shut down. It also tells a module what was a role of a controller, which triggered activation or deactivation of this module, to process load and shut down events more appropriately.

Author:
Maksym Petrenko

Field Summary
static int CONTROLLER_TYPE_ECLIPSE
          Constant indicating an event was triggered by some Eclipse event;
typically means that a GUI module was disposed or activated through Eclipse controls.
static int CONTROLLER_TYPE_IMPORTEXPORT
          Constant indicating an event was triggered by loading one of the previously saved JRipples states;
typically means that no data processing should be done as everything is already loaded from disk.
static int CONTROLLER_TYPE_MODULEPROXY
          Constant indicating an event was triggered by ModuleProxy class.
static int CONTROLLER_TYPE_SELF
          Constant indicating an event was triggered by some module itself;
typically means that some module monitored Eclipse environment and avter a certain event decided that it is the most appropriate module for the user at that moment of time.
static int CONTROLLER_TYPE_START
          Constant indicating an event was triggered by JRipples Start Analysis wizard;
typically means that user just started an analysis session and thus the selected project should be analyzed from scratch.
static int CONTROLLER_TYPE_UNKNOWN
          Constant indicating general type of unknown controller.
static int CONTROLLER_TYPE_USER
          Constant indicating an event was triggered by user through a configuration menu;
typically means that one module was replaced by another module in order to obtain different perspective on the JRipples EIG data.
 
Method Summary
 void loadUp(int controllerType)
          The method is called when the module implementing this interface is activated through ModuleProxy class.
 void shutDown(int controllerType)
          The method is called when the module implementing this interface is deactivated up through ModuleProxy class.
 

Field Detail

CONTROLLER_TYPE_MODULEPROXY

static final int CONTROLLER_TYPE_MODULEPROXY
Constant indicating an event was triggered by ModuleProxy class.

See Also:
Constant Field Values

CONTROLLER_TYPE_START

static final int CONTROLLER_TYPE_START
Constant indicating an event was triggered by JRipples Start Analysis wizard;
typically means that user just started an analysis session and thus the selected project should be analyzed from scratch.

See Also:
Constant Field Values

CONTROLLER_TYPE_IMPORTEXPORT

static final int CONTROLLER_TYPE_IMPORTEXPORT
Constant indicating an event was triggered by loading one of the previously saved JRipples states;
typically means that no data processing should be done as everything is already loaded from disk.

See Also:
Constant Field Values

CONTROLLER_TYPE_USER

static final int CONTROLLER_TYPE_USER
Constant indicating an event was triggered by user through a configuration menu;
typically means that one module was replaced by another module in order to obtain different perspective on the JRipples EIG data.

See Also:
Constant Field Values

CONTROLLER_TYPE_ECLIPSE

static final int CONTROLLER_TYPE_ECLIPSE
Constant indicating an event was triggered by some Eclipse event;
typically means that a GUI module was disposed or activated through Eclipse controls.

See Also:
Constant Field Values

CONTROLLER_TYPE_UNKNOWN

static final int CONTROLLER_TYPE_UNKNOWN
Constant indicating general type of unknown controller.

See Also:
Constant Field Values

CONTROLLER_TYPE_SELF

static final int CONTROLLER_TYPE_SELF
Constant indicating an event was triggered by some module itself;
typically means that some module monitored Eclipse environment and avter a certain event decided that it is the most appropriate module for the user at that moment of time.

See Also:
Constant Field Values
Method Detail

loadUp

void loadUp(int controllerType)
The method is called when the module implementing this interface is activated through ModuleProxy class.
The controllerType parameter is supplied to indicate a role of a component that triggered deactivation of this module, to process load and shut down events more appropriately;
type is one of the constants, defined in this JRipplesModuleInterface interface.

Parameters:
controllerType - type of controller that triggered activation of this module; type is one of the constants, defined in JRipplesModuleInterface class

shutDown

void shutDown(int controllerType)
The method is called when the module implementing this interface is deactivated up through ModuleProxy class.
The controllerType parameter is supplied to indicate a role of a component that triggered deactivation of this module, to process load and shut down events more appropriately;
type is one of the constants, defined in this JRipplesModuleInterface interface.

Parameters:
controllerType - type of controller that triggered deactivation of this module