3 * Copyright (C) 2007 EDIT
4 * European Distributed Institute of Taxonomy
5 * http://www.e-taxonomy.eu
7 * The contents of this file are subject to the Mozilla Public License Version 1.1
8 * See LICENSE.TXT at the top of this package for the full license terms.
14 package eu
.etaxonomy
.taxeditor
.datasource
;
17 import java
.io
.FileNotFoundException
;
18 import java
.util
.ArrayList
;
19 import java
.util
.List
;
21 import org
.eclipse
.core
.runtime
.IPath
;
22 import org
.eclipse
.ui
.IMemento
;
23 import org
.eclipse
.ui
.XMLMemento
;
25 import eu
.etaxonomy
.cdm
.config
.CdmPersistentSourceUtils
;
26 import eu
.etaxonomy
.cdm
.config
.ICdmPersistentSource
;
27 import eu
.etaxonomy
.cdm
.config
.ICdmSource
;
28 import eu
.etaxonomy
.cdm
.database
.CdmDataSource
;
29 import eu
.etaxonomy
.cdm
.database
.CdmPersistentDataSource
;
30 import eu
.etaxonomy
.cdm
.database
.DataSourceNotFoundException
;
31 import eu
.etaxonomy
.cdm
.database
.ICdmDataSource
;
32 import eu
.etaxonomy
.cdm
.model
.name
.NomenclaturalCode
;
34 import eu
.etaxonomy
.taxeditor
.model
.MementoHelper
;
35 import eu
.etaxonomy
.taxeditor
.model
.MessagingUtils
;
36 import eu
.etaxonomy
.taxeditor
.preference
.PreferencesUtil
;
37 import eu
.etaxonomy
.taxeditor
.remoting
.source
.CdmPersistentRemoteSource
;
38 import eu
.etaxonomy
.taxeditor
.remoting
.source
.CdmRemoteSourceException
;
39 import eu
.etaxonomy
.taxeditor
.remoting
.source
.ICdmRemoteSource
;
40 import eu
.etaxonomy
.taxeditor
.store
.CdmStore
;
41 import eu
.etaxonomy
.taxeditor
.store
.internal
.TaxeditorStorePlugin
;
42 public class CdmDataSourceRepository
{
44 /** Constant <code>TAG_DATASOURCE="tagDataSource"</code> */
45 public static final String TAG_DATASOURCE
= "tagDataSource";
46 private static final String CURRENT_DATASOURCE
= "currentDataSource";
47 private static final String CURRENT_DATASOURCE_POSTFIX
= "currentDataSourcePostFix";
48 private static final String DEFAULT_DATASOURCE_STATE_FILENAME
= "datasource.xml";
50 private static final String DEFAULT_DATASOURCE_NAME
= "cdm";
51 private static final String DEFAULT_DATASOURCE_POSTFIX
= CdmPersistentDataSource
.DATASOURCE_BEAN_POSTFIX
;
53 private static ICdmSource currentCdmSource
;
54 private static IMemento memento
;
56 private static String lastUsedCdmSourceName
;
57 private static String lastUsedCdmSourcePostFix
;
62 * <p>Getter for the field <code>lastUsedDataSourceName</code>.</p>
64 * @return a {@link java.lang.String} object.
66 public static void updateLastUsedDataSource(){
67 if(lastUsedCdmSourceName
== null){
68 memento
= readMemento();
69 lastUsedCdmSourceName
= memento
!= null ? memento
.getString(CURRENT_DATASOURCE
) : DEFAULT_DATASOURCE_NAME
;
70 lastUsedCdmSourcePostFix
= memento
!= null ? memento
.getString(CURRENT_DATASOURCE_POSTFIX
) : DEFAULT_DATASOURCE_POSTFIX
;
79 * @param dataSource a {@link eu.etaxonomy.cdm.database.CdmPersistentDataSource} object.
82 public static boolean delete(ICdmPersistentSource cdmPersistentSource
) {
83 CdmPersistentSourceUtils
.delete(cdmPersistentSource
);
91 * @return a {@link java.util.List} object.
93 public static List
<ICdmSource
> getAll() {
94 List
<ICdmSource
> remoteSources
= new ArrayList
<ICdmSource
>();
96 for(ICdmDataSource dataSource
: CdmPersistentDataSource
.getAllDataSources()){
98 remoteSources
.add(CdmPersistentDataSource
.NewInstance(dataSource
.getName()));
99 } catch (DataSourceNotFoundException e
) {
100 MessagingUtils
.error(CdmDataSourceRepository
.class, "Could not find dataSource", e
);
105 for(ICdmRemoteSource remoteSource
: CdmPersistentRemoteSource
.getAllRemoteSources()){
106 remoteSources
.add(remoteSource
);
108 } catch (CdmRemoteSourceException e
) {
109 MessagingUtils
.error(CdmDataSourceRepository
.class, "Error retrieving remote sources", e
);
112 // TODO sort by database name
114 return remoteSources
;
118 * <p>getDataSource</p>
120 * @param name a {@link java.lang.String} object.
121 * @return a {@link eu.etaxonomy.cdm.database.ICdmDataSource} object.
123 public static ICdmDataSource
getDataSource(String name
){
125 for(ICdmDataSource dataSource
: CdmPersistentDataSource
.getAllDataSources()){
127 if(dataSource
.getName().equals(name
)){
128 return CdmPersistentDataSource
.NewInstance(dataSource
.getName());
130 } catch (DataSourceNotFoundException e
) {
131 MessagingUtils
.error(CdmDataSourceRepository
.class, "Could not find dataSource", e
);
140 * <p>Getter for the field <code>currentDataSource</code>.</p>
142 * @return a {@link eu.etaxonomy.cdm.database.ICdmDataSource} object.
143 * @throws CdmRemoteSourceException
145 public static ICdmSource
getCurrentCdmSource() throws CdmRemoteSourceException
{
147 if (currentCdmSource
== null) {
148 updateLastUsedDataSource();
150 if(lastUsedCdmSourceName
== null) {
153 // for post fix = null , source is by default a data source
154 if(lastUsedCdmSourcePostFix
== null || lastUsedCdmSourcePostFix
.equals(CdmPersistentDataSource
.DATASOURCE_BEAN_POSTFIX
)) {
156 currentCdmSource
= CdmPersistentDataSource
.NewInstance(lastUsedCdmSourceName
);
157 } catch (DataSourceNotFoundException e
) {
158 // fallback creates a new default
159 setCurrentCdmSource(createDefaultH2DataSource());
161 } else if (lastUsedCdmSourcePostFix
.equals(CdmPersistentRemoteSource
.REMOTESOURCE_BEAN_POSTFIX
)) {
162 currentCdmSource
= CdmPersistentRemoteSource
.NewInstance(lastUsedCdmSourceName
);
164 throw new CdmRemoteSourceException("Unkown Cdm Source Type");
167 return currentCdmSource
;
171 * Creates a default H2 CDM Data Source
173 * @return the newly created data source
175 public static ICdmDataSource
createDefaultH2DataSource() {
176 ICdmDataSource h2DataSource
= CdmDataSource
.NewH2EmbeddedInstance(
177 DEFAULT_DATASOURCE_NAME
, "sa", "", PreferencesUtil
.getPreferredNomenclaturalCode());
178 save(h2DataSource
.getName(), h2DataSource
);
183 * <p>Setter for the field <code>currentDataSource</code>.</p>
185 * @param dataSource a {@link eu.etaxonomy.cdm.database.ICdmDataSource} object.
188 public static boolean setCurrentCdmSource(ICdmSource cdmSource
) {
189 currentCdmSource
= cdmSource
;
190 NomenclaturalCode dataSourceNomenclaturalCode
= cdmSource
.getNomenclaturalCode();
191 NomenclaturalCode applicationNomenclaturalCode
= PreferencesUtil
.getPreferredNomenclaturalCode();
193 if( dataSourceNomenclaturalCode
!= null && ! dataSourceNomenclaturalCode
.equals(applicationNomenclaturalCode
)){
194 PreferencesUtil
.setPreferredNomenclaturalCode(dataSourceNomenclaturalCode
);
195 MessagingUtils
.informationDialog("Nomenclatural Code Change", "The Datasource that was just " +
196 "loaded has a different nomenclatural code than the one stored in Preferences. " +
197 "The nomenclatural code was changed in the application.");
203 * <p>changeDataSource</p>
205 * @param dataSource a {@link eu.etaxonomy.cdm.database.ICdmDataSource} object.
208 public static boolean changeDataSource(final ICdmSource cdmSource
) {
209 saveAsCurrentDatabaseToMemento(cdmSource
);
210 CdmStore
.connect(cdmSource
);
218 * @param dataSource a {@link eu.etaxonomy.cdm.database.ICdmDataSource} object.
219 * @param strDataSourceName a {@link java.lang.String} object.
220 * @return a {@link eu.etaxonomy.cdm.database.CdmPersistentDataSource} object.
221 * @throws CdmRemoteSourceException
223 public static ICdmPersistentSource
save(String strCdmSourceName
, ICdmRemoteSource cdmSource
) throws CdmRemoteSourceException
{
224 return CdmPersistentRemoteSource
.save(strCdmSourceName
, cdmSource
);
230 * @param dataSource a {@link eu.etaxonomy.cdm.database.ICdmDataSource} object.
231 * @param strDataSourceName a {@link java.lang.String} object.
232 * @return a {@link eu.etaxonomy.cdm.database.CdmPersistentDataSource} object.
233 * @throws CdmRemoteSourceException
235 public static ICdmPersistentSource
save(String strCdmSourceName
, ICdmDataSource cdmSource
) {
236 return CdmPersistentDataSource
.save(strCdmSourceName
, cdmSource
);
242 * @param strDataSourceName a {@link java.lang.String} object.
243 * @param dataSource a {@link eu.etaxonomy.cdm.database.ICdmDataSource} object.
244 * @return a {@link eu.etaxonomy.cdm.database.CdmPersistentDataSource} object.
246 public static ICdmPersistentSource
update(String strCdmSourceName
, ICdmDataSource cdmSource
){
248 return CdmPersistentDataSource
.update(strCdmSourceName
, cdmSource
);
249 } catch (Exception e
) {
250 MessagingUtils
.error(CdmDataSourceRepository
.class, "Error updating CDM Source", e
);
255 public static ICdmPersistentSource
replace(String strCdmSourceName
, ICdmDataSource cdmSource
){
257 return CdmPersistentDataSource
.replace(strCdmSourceName
, cdmSource
);
258 } catch (Exception e
) {
259 MessagingUtils
.error(CdmDataSourceRepository
.class, "Error updating CDM Source", e
);
267 * @param strDataSourceName a {@link java.lang.String} object.
268 * @param dataSource a {@link eu.etaxonomy.cdm.database.ICdmDataSource} object.
269 * @return a {@link eu.etaxonomy.cdm.database.CdmPersistentDataSource} object.
271 public static ICdmPersistentSource
update(String strCdmSourceName
, ICdmRemoteSource cdmSource
){
273 return CdmPersistentRemoteSource
.update(strCdmSourceName
, cdmSource
);
274 } catch (Exception e
) {
275 MessagingUtils
.error(CdmDataSourceRepository
.class, "Error updating CDM Source", e
);
281 /*********************************************************
283 *********************************************************/
285 private static void saveAsCurrentDatabaseToMemento(ICdmSource cdmSource
){
286 if(memento
== null) {
287 memento
= readMemento();
289 memento
.putString(CURRENT_DATASOURCE
, cdmSource
.getName());
291 // Set postfix to distinguish between data and remote sources
292 if(cdmSource
instanceof CdmPersistentRemoteSource
) {
293 memento
.putString(CURRENT_DATASOURCE_POSTFIX
, CdmPersistentRemoteSource
.REMOTESOURCE_BEAN_POSTFIX
);
295 memento
.putString(CURRENT_DATASOURCE_POSTFIX
, CdmPersistentDataSource
.DATASOURCE_BEAN_POSTFIX
);
299 saveMementoToFile(memento
);
303 * Answer the workbench state file.
305 private static File
getCdmSourceStateFile() {
306 IPath path
= TaxeditorStorePlugin
.getDefault().getStateLocation();
310 path
= path
.append(DEFAULT_DATASOURCE_STATE_FILENAME
);
311 return path
.toFile();
314 private static IMemento
readMemento(){
316 return MementoHelper
.readMementoFromFile(getCdmSourceStateFile());
317 } catch (FileNotFoundException e
) {
318 return initializeMemento();
323 private static IMemento
initializeMemento() {
325 XMLMemento memento
= XMLMemento
.createWriteRoot(TAG_DATASOURCE
);
326 memento
.putString(CURRENT_DATASOURCE
, DEFAULT_DATASOURCE_NAME
);
327 saveMementoToFile(memento
);
329 return readMemento();
333 * Save the workbench UI in a persistence file.
335 private static IMemento
saveMementoToFile(IMemento memento
) {
336 return MementoHelper
.saveMementoToFile(memento
, getCdmSourceStateFile());