IndependentModeler/src/cz/cvut/promod/services/pluginLoaderService/utils/NotationSpecificPlugins.java

   1 package cz.cvut.promod.services.pluginLoaderService.utils;
   2
   3 import cz.cvut.promod.plugin.notationSpecificPlugIn.notation.Notation;
   4 import cz.cvut.promod.plugin.notationSpecificPlugIn.module.Module;
   5 import cz.cvut.promod.plugin.notationSpecificPlugIn.DockableFrameData;
   6
   7 import java.util.*;
   8
   9 /**
  10  * ProMod, master thesis project
  11  * User: Petr Zverina, petr.zverina@gmail.com
  12  * Date: 22:34:23, 12.10.2009
  13  */
  14
  15 /**
  16  * NotationSpecificPlugins is holder for notation and it's related modules.
  17  *
  18  * It is not possible to change the list holding modules.
  19  */
  20 public final class NotationSpecificPlugins {
  21
  22     private final Notation notation;
  23
  24     private final List<Module> modules;
  25
  26
  27     /**
  28      * Constructs new NotationSpecificPlugins for the specified notation.
  29      *
  30      * @param notation is the notation
  31      * @param modules unchangeable list of plugins
  32      */
  33     public NotationSpecificPlugins(final Notation notation, final List<Module> modules){
  34         this.notation = notation;
  35
  36         this.modules = modules;
  37     }
  38
  39     /**
  40      * Returns notation object.
  41      *
  42      * @return notation object
  43      */
  44     public Notation getNotation() {
  45         return notation;
  46     }
  47
  48     /**
  49      * Returns list of notation in the same order as they were specified in plugin configuration file and have been
  50      * instantiated.
  51      *
  52      * @return list of modules
  53      */
  54     public List<Module> getModules() {
  55         return modules;
  56     }
  57
  58     /**
  59      * Returns already stored module according to it's identifier.
  60      *
  61      * @param moduleIdentifier is the identifier of required module
  62      * @return module, if any with given identifier is found, null otherwise
  63      */
  64     public Module getModule(final String moduleIdentifier){
  65         for(final Module module : modules){
  66             if(module.getIdentifier().equals(moduleIdentifier)){
  67                 return module;
  68             }
  69         }
  70
  71         return null;
  72     }
  73
  74     /**
  75      * Checks whether a module with given identifier has been already loaded and stored.
  76      *
  77      * @param moduleIdentifier is the required module's identifier
  78      * @return true, if such a module has already been loaded and stored, false otherwise
  79      */
  80     public boolean existModule(final String moduleIdentifier){
  81         return getModule(moduleIdentifier) != null;
  82
  83     }
  84
  85     /**
  86      * Returns dockable frame data defined by the notation and all it's related modules.
  87      *
  88      * @return dockable frame data defined by the notation and all it's related modules
  89      */
  90     public Collection<DockableFrameData> getDockableFramesData(){
  91         final Collection<DockableFrameData> dockableFrameData = new HashSet<DockableFrameData>();
  92
  93         final Set<DockableFrameData> notationFrameData = getNotation().getDockableFrames();
  94
  95         if(notationFrameData != null){
  96             dockableFrameData.addAll(notationFrameData);
  97         }
  98
  99         for(final Module module : getModules()){
 100             final Set<DockableFrameData> moduleFrameData = module.getDockableFrames();
 101
 102             if(moduleFrameData != null){
 103                 dockableFrameData.addAll(module.getDockableFrames());
 104             }
 105         }
 106
 107         return dockableFrameData;
 108     }
 109 }