View Javadoc

1   /**
2    * - Digitalis Internal Framework v2.0 - (C) 2007, Digitalis Informatica. Distribuicao e Gestao de Informatica, Lda.
3    * Estrada de Paco de Arcos num.9 - Piso -1 2780-666 Paco de Arcos Telefone: (351) 21 4408990 Fax: (351) 21 4408999
4    * http://www.digitalis.pt
5    */
6   package pt.digitalis.dif.codegen.templates;
7   
8   import java.util.Map;
9   
10  import pt.digitalis.dif.codegen.CGAncillaries;
11  import pt.digitalis.dif.dem.interfaces.IApplication;
12  import pt.digitalis.dif.dem.interfaces.IProvider;
13  import pt.digitalis.dif.dem.objects.LicenseEditionType;
14  import pt.digitalis.dif.exception.manager.RegistrationManagerException;
15  import pt.digitalis.dif.startup.DIFGeneralConfigurationParameters;
16  import pt.digitalis.dif.utils.logging.DIFLogger;
17  
18  /**
19   * This class is a template for the IProvider interface method implementations. The CodeGen will copy these methods to
20   * the class implementing the interface IProvider. Some methods will be copied "as is", other will be tweaked.
21   * 
22   * @author Rodrigo Gonçalves <a href="mailto:rgoncalves@digitalis.pt">rgoncalves@digitalis.pt</a>
23   * @created 2007/06/01
24   */
25  public class ProviderCGTemplate implements IProvider {
26  
27      /**
28       * @see pt.digitalis.dif.dem.interfaces.IProvider#getApplications()
29       */
30      public Map<String, IApplication> getApplications()
31      {
32          return TemplateResources.getDEMManager().getApplications(this);
33      }
34  
35      /**
36       * @see pt.digitalis.dif.dem.interfaces.IRegistrable#getLicenseEdition()
37       */
38      public LicenseEditionType getLicenseEdition()
39      {
40          return TemplateResources.getRegistrationManager().getProviderEdition(this.getID());
41      }
42  
43      /**
44       * @see pt.digitalis.dif.dem.interfaces.IEntity#getID()
45       */
46      public String getID()
47      {
48          return CGAncillaries.CG_TO_BE_IMPLEMENTED_MESSAGE;
49      }
50  
51      /**
52       * @see pt.digitalis.dif.dem.interfaces.IMessage#getMessage(java.lang.String)
53       */
54      public String getMessage(String messageID)
55      {
56          return getMessages().get(messageID);
57      }
58  
59      /**
60       * @see pt.digitalis.dif.dem.interfaces.IMessage#getMessages()
61       */
62      public Map<String, String> getMessages()
63      {
64          return TemplateResources.getMessageManager().getMessages(this,
65                  DIFGeneralConfigurationParameters.getInstance().getDefaultLanguage());
66      }
67  
68      /**
69       * @see pt.digitalis.dif.dem.interfaces.IEntity#getName()
70       */
71      public String getName()
72      {
73          return CGAncillaries.CG_TO_BE_IMPLEMENTED_MESSAGE;
74      }
75  
76      /**
77       * @see pt.digitalis.dif.dem.interfaces.IEntity#getOriginalClassName()
78       */
79      public String getOriginalClassName()
80      {
81          return CGAncillaries.CG_TO_BE_IMPLEMENTED_MESSAGE;
82      }
83  
84      /**
85       * @return an instance of template resources
86       */
87      protected TemplateResources getTemplateResources()
88      {
89          return TemplateResources.getInstance();
90      }
91  
92      /**
93       * @see pt.digitalis.dif.dem.interfaces.IEntity#getUID()
94       */
95      public String getUID()
96      {
97          return "PROVIDER:" + this.getID();
98      }
99  
100     /**
101      * @see pt.digitalis.dif.dem.interfaces.IRegistrable#isRegistered()
102      */
103     public boolean isRegistered()
104     {
105         boolean result = true;
106 
107         if (isRegistrable())
108             result = TemplateResources.getRegistrationManager().isProviderRegistered(getID());
109 
110         return result;
111     }
112 
113     /**
114      * @see pt.digitalis.dif.dem.interfaces.IRegistrable#isRegistrable()
115      */
116     public boolean isRegistrable()
117     {
118         return TemplateResources.getRegistrationManager().isProviderRegistrable(getID());
119     }
120 
121     /**
122      * @see pt.digitalis.dif.dem.interfaces.IRegistrable#register(java.lang.String, java.lang.String)
123      */
124     public boolean register(String name, String key)
125     {
126         try
127         {
128             return TemplateResources.getRegistrationManager().registerProvider(getID(), name, key);
129         }
130         catch (RegistrationManagerException e)
131         {
132             DIFLogger.getLogger().debug(e);
133             return false;
134 
135         }
136     }
137 
138     /**
139      * @see pt.digitalis.dif.dem.interfaces.IRegistrable#unregister()
140      */
141     public void unregister()
142     {
143         TemplateResources.getRegistrationManager().unregisterProvider(getID());
144     }
145 }