IndependentModeler/src/cz/cvut/promod/gui/dialogs/configurationChangeDialog/ConfigurationDiffDialog.java

   1 package cz.cvut.promod.gui.dialogs.configurationChangeDialog;
   2
   3 import cz.cvut.promod.services.ModelerSession;
   4 import cz.cvut.promod.services.projectService.results.ConfigurationDifference;
   5 import cz.cvut.promod.plugin.notationSpecificPlugIn.notation.Notation;
   6
   7 import java.util.List;
   8 import java.awt.event.ActionListener;
   9 import java.awt.event.ActionEvent;
  10 import java.awt.event.KeyEvent;
  11
  12 import org.apache.log4j.Logger;
  13
  14 import javax.swing.*;
  15
  16 /**
  17  * ProMod, master thesis project
  18  * User: Petr Zverina, petr.zverina@gmail.com
  19  * Date: 17:55:32, 12.12.2009
  20  *
  21  * Dialog displaying differences between actual ProMod configuration and the ProMod configuration that
  22  * was actual at the time, when the project, that is now being loaded, was saved.
  23  */
  24 public class ConfigurationDiffDialog extends ConfigurationDiffDialogView{
  25
  26     private static final Logger LOG = Logger.getLogger(ConfigurationDiffDialog.class);
  27
  28     private static final String TITLE_LABEL =
  29             ModelerSession.getCommonResourceBundle().getString("modeler.configuration.title");
  30     private static final String MISSING_NOTATION_LABEL =
  31             ModelerSession.getCommonResourceBundle().getString("modeler.configuration.missing.notation");
  32     private static final String LOADED_VALUE_LABEL =
  33             ModelerSession.getCommonResourceBundle().getString("modeler.configuration.loaded.value");
  34     private static final String ACTUAL_VALUE_LABEL =
  35             ModelerSession.getCommonResourceBundle().getString("modeler.configuration.actual.value");
  36     private static final String MISSING_MODULE_LABEL =
  37             ModelerSession.getCommonResourceBundle().getString("modeler.configuration.missing.module");
  38     private static final String RELATED_IDENTIFIER_LABEL =
  39             ModelerSession.getCommonResourceBundle().getString("modeler.configuration.related.notation");
  40     private static final String MISSING_EXTENSION_LABEL =
  41             ModelerSession.getCommonResourceBundle().getString("modeler.configuration.missing.extension");
  42     private static final String DIFF_EXTENSION_LABEL =
  43             ModelerSession.getCommonResourceBundle().getString("modeler.configuration.different.extension");
  44     private static final String DIFF_ABBREVIATION_LABEL =
  45             ModelerSession.getCommonResourceBundle().getString("modeler.configuration.different.abbreviation");
  46     private static final String DIFF_NAME_LABEL =
  47             ModelerSession.getCommonResourceBundle().getString("modeler.configuration.different.name");
  48
  49     public final String NEW_LINE = "\n";
  50
  51
  52     /**
  53      * Constructs a new ConfigurationDiffDialog class.
  54      *
  55      * @param differences is the list containing all configuration differences
  56      */
  57     public ConfigurationDiffDialog(final List<ConfigurationDifference> differences){
  58         setTitle(TITLE_LABEL);
  59
  60         initEventHandling();
  61
  62         initReport(differences);
  63
  64         setModal(true);
  65
  66         getRootPane().setDefaultButton(hideButton);
  67
  68         setVisible(true);
  69     }
  70
  71     /**
  72      * Initialize event handling.
  73      */
  74     private void initEventHandling() {
  75         hideButton.addActionListener(new ActionListener(){
  76             public void actionPerformed(ActionEvent e) {
  77                 disposeDialog();
  78             }
  79         });
  80
  81         getRootPane().registerKeyboardAction(new ActionListener(){
  82                     public void actionPerformed(ActionEvent actionEvent) {
  83                         disposeDialog();
  84                     }
  85                 },
  86                 KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0),
  87                 JComponent.WHEN_IN_FOCUSED_WINDOW);
  88     }
  89
  90     /**
  91      * Hides the dialog.
  92      */
  93     private void disposeDialog(){
  94         setVisible(false);
  95         dispose();
  96     }
  97
  98     /**
  99      * Initialize messages about configuration differences.
 100      *
 101      * @param differences all configuration differences
 102      */
 103     private void initReport(final List<ConfigurationDifference> differences) {
 104         for(final ConfigurationDifference difference : differences){
 105             switch (difference.getChangeType()){
 106                 case MISSING_NOTATION:
 107                     publishMissingNotationDiff(difference);
 108                     break;
 109                 case MISSING_MODULE:
 110                     publishMissingModuleDiff(difference);
 111                     break;
 112                 case MISSING_EXTENSION:
 113                     publishMissingExtensionDiff(difference);
 114                     break;
 115                 case DIFFERENT_FULL_NAME:
 116                     publishDiffName(difference);
 117                     break;
 118                 case DIFFERENT_ABBREVIATION:
 119                     publishDiffAbbreviation(difference);
 120                     break;
 121                 case DIFFERENT_EXTENSION:
 122                     publishDiffExtension(difference);
 123                     break;
 124                 default:
 125                     LOG.error("No such a configuration change option.");
 126             }
 127
 128             diffTextArea.append(NEW_LINE);
 129             diffTextArea.append(NEW_LINE);
 130         }
 131     }
 132
 133     /**
 134      * Publishes different full name.
 135      *
 136      * @param difference is the difference detail
 137      */
 138     private void publishDiffName(final ConfigurationDifference difference) {
 139         diffTextArea.append(DIFF_NAME_LABEL);
 140         diffTextArea.append(NEW_LINE);
 141         diffTextArea.append(LOADED_VALUE_LABEL + " " + difference.getMessage());
 142         diffTextArea.append(NEW_LINE);
 143         diffTextArea.append(ACTUAL_VALUE_LABEL + " " + ModelerSession.getNotationService().getNotation(difference.getIdentifier()).getFullName());
 144     }
 145
 146     /**
 147      * Publishes different abbreviation.
 148      *
 149      * @param difference is the difference detail
 150      */
 151     private void publishDiffAbbreviation(final ConfigurationDifference difference) {
 152         diffTextArea.append(DIFF_ABBREVIATION_LABEL);
 153         diffTextArea.append(NEW_LINE);
 154         diffTextArea.append(LOADED_VALUE_LABEL + " " + difference.getMessage());
 155         diffTextArea.append(NEW_LINE);
 156         diffTextArea.append(ACTUAL_VALUE_LABEL + " " + ModelerSession.getNotationService().getNotation(difference.getIdentifier()).getAbbreviation());
 157     }
 158
 159     /**
 160      * Publishes different extension.
 161      *
 162      * @param difference is the difference detail
 163      */
 164     private void publishDiffExtension(final ConfigurationDifference difference) {
 165         diffTextArea.append(DIFF_EXTENSION_LABEL);
 166         diffTextArea.append(NEW_LINE);
 167         diffTextArea.append(LOADED_VALUE_LABEL +" " + difference.getMessage());
 168         diffTextArea.append(NEW_LINE);
 169         diffTextArea.append(
 170                 ACTUAL_VALUE_LABEL + " " + ModelerSession.getNotationService().getNotation(
 171                         difference.getIdentifier()
 172                 ).getLocalIOController().getNotationFileExtension());
 173     }
 174
 175     /**
 176      * Publishes missing extension difference.
 177      *
 178      * @param difference is the difference detail
 179      */
 180     private void publishMissingExtensionDiff(final ConfigurationDifference difference) {
 181         diffTextArea.append(MISSING_EXTENSION_LABEL);
 182         diffTextArea.append(NEW_LINE);
 183         diffTextArea.append(LOADED_VALUE_LABEL + " " + difference.getMessage());
 184     }
 185
 186     /**
 187      * Publishes missing module difference.
 188      *
 189      * @param difference is the difference detail
 190      */
 191     private void publishMissingModuleDiff(final ConfigurationDifference difference) {
 192         diffTextArea.append(MISSING_MODULE_LABEL);
 193         diffTextArea.append(NEW_LINE);
 194
 195         final Notation notation = ModelerSession.getNotationService().getNotation(difference.getIdentifier());
 196         if(notation != null){
 197             diffTextArea.append(RELATED_IDENTIFIER_LABEL + "" + notation.getFullName() + " (" + notation.getIdentifier() + ").");
 198             diffTextArea.append(NEW_LINE);
 199         } else {
 200             LOG.error("Unavailable notation for given identifier: " + difference.getIdentifier());
 201         }
 202
 203         diffTextArea.append(LOADED_VALUE_LABEL + " " + difference.getMessage());
 204     }
 205
 206     /**
 207      * Publishes missing notation difference.
 208      *
 209      * @param difference is the difference detail
 210      */
 211     private void publishMissingNotationDiff(final ConfigurationDifference difference) {
 212         diffTextArea.append(MISSING_NOTATION_LABEL);
 213         diffTextArea.append(NEW_LINE);
 214         diffTextArea.append(LOADED_VALUE_LABEL + " " + difference.getMessage());
 215     }
 216
 217 }