org.severe.jripples.modules.interfaces
Interface JRipplesICModuleInterface

All Superinterfaces:
JRipplesModuleInterface

public interface JRipplesICModuleInterface
extends JRipplesModuleInterface

Interface of JRipples modules that provide and execute Incremental Change (IC) propagation rules for JRipplesEIG nodes.

Author:
Maksym Petrenko
See Also:
JRipplesEIG, JRipplesEIGNode

Field Summary
 
Fields inherited from interface org.severe.jripples.modules.interfaces.JRipplesModuleInterface
CONTROLLER_TYPE_ECLIPSE, CONTROLLER_TYPE_IMPORTEXPORT, CONTROLLER_TYPE_MODULEPROXY, CONTROLLER_TYPE_SELF, CONTROLLER_TYPE_START, CONTROLLER_TYPE_UNKNOWN, CONTROLLER_TYPE_USER
 
Method Summary
 void ApplyRuleAtNode(java.lang.String rule, JRipplesEIGNode node, int granularity)
          Applies the selected propagation rule at the selected node.
 void ApplyRuleAtNode(java.lang.String rule, JRipplesEIGNode nodeFrom, JRipplesEIGNode nodeTo)
          Applies the selected propagation rule at the selected node using the particular dependency instead of the whole dependency graph.
 java.util.Set<java.lang.String> getAllMarks()
          Returns a set of all marks (names of propagation rules), used by an Incremental Change stage that is supported in this module.
 java.util.Set<java.lang.String> GetAvailableRulesForMark(java.lang.String mark)
          Returns a set of marks (names of propagation rules), available for a node with the supplied current mark.
 org.eclipse.swt.graphics.Color getColorForMark(java.lang.String mark)
          Returns color that is used to decorate rows of the tables in a GUI.
 org.eclipse.jface.resource.ImageDescriptor getImageDescriptorForMark(java.lang.String mark)
          Returns image descriptor that is used to display the supplied mark in a GUI.
 void InitializeStage()
          Called to initialize Incremental Change stage that this module supports.
 
Methods inherited from interface org.severe.jripples.modules.interfaces.JRipplesModuleInterface
loadUp, shutDown
 

Method Detail

InitializeStage

void InitializeStage()
Called to initialize Incremental Change stage that this module supports. Typically is called either on EIG initialization or upon switching to the next stage of Incremental Change.


GetAvailableRulesForMark

java.util.Set<java.lang.String> GetAvailableRulesForMark(java.lang.String mark)
Returns a set of marks (names of propagation rules), available for a node with the supplied current mark. This is called to determine which propagation rules can still be applied to a particular node and display this rules in GUI.

Parameters:
mark - current mark of a node
Returns:
a set of marks (of type String)

ApplyRuleAtNode

void ApplyRuleAtNode(java.lang.String rule,
                     JRipplesEIGNode node,
                     int granularity)
Applies the selected propagation rule at the selected node.

Parameters:
rule - rule to apply
node - node to apply the rule at
granularity - granularity at which the rule is applied

ApplyRuleAtNode

void ApplyRuleAtNode(java.lang.String rule,
                     JRipplesEIGNode nodeFrom,
                     JRipplesEIGNode nodeTo)
Applies the selected propagation rule at the selected node using the particular dependency instead of the whole dependency graph.

Parameters:
rule - rule to apply
nodeFrom - node to apply the rule at
nodeTo - node, to which the rule propagates

getAllMarks

java.util.Set<java.lang.String> getAllMarks()
Returns a set of all marks (names of propagation rules), used by an Incremental Change stage that is supported in this module.

Returns:
a set of marks (of type String)

getImageDescriptorForMark

org.eclipse.jface.resource.ImageDescriptor getImageDescriptorForMark(java.lang.String mark)
Returns image descriptor that is used to display the supplied mark in a GUI.

Parameters:
mark - mark, for which image descriptor is needed
Returns:
image descriptor if any,
null otherwise

getColorForMark

org.eclipse.swt.graphics.Color getColorForMark(java.lang.String mark)
Returns color that is used to decorate rows of the tables in a GUI.

Parameters:
mark - mark, for which color is needed
Returns:
Color if any,
null otherwise