2 * Copyright (C) 2007 EDIT
3 * European Distributed Institute of Taxonomy
4 * http://www.e-taxonomy.eu
6 * The contents of this file are subject to the Mozilla Public License Version 1.1
7 * See LICENSE.TXT at the top of this package for the full license terms.
10 package eu
.etaxonomy
.taxeditor
.preference
;
13 import java
.io
.FileInputStream
;
14 import java
.io
.FileOutputStream
;
15 import java
.io
.IOException
;
17 import java
.net
.URISyntaxException
;
18 import java
.util
.ArrayList
;
19 import java
.util
.Arrays
;
20 import java
.util
.Collections
;
21 import java
.util
.HashMap
;
22 import java
.util
.List
;
24 import java
.util
.Properties
;
25 import java
.util
.StringTokenizer
;
26 import java
.util
.UUID
;
28 import org
.apache
.commons
.lang
.StringUtils
;
29 import org
.apache
.log4j
.Logger
;
30 import org
.eclipse
.core
.runtime
.preferences
.ConfigurationScope
;
31 import org
.eclipse
.core
.runtime
.preferences
.IEclipsePreferences
;
32 import org
.eclipse
.equinox
.internal
.p2
.ui
.model
.MetadataRepositoryElement
;
33 import org
.eclipse
.jface
.preference
.IPreferenceStore
;
34 import org
.eclipse
.jface
.window
.Window
;
35 import org
.eclipse
.swt
.widgets
.Composite
;
36 import org
.eclipse
.swt
.widgets
.Control
;
37 import org
.eclipse
.swt
.widgets
.Shell
;
38 import org
.eclipse
.ui
.PlatformUI
;
39 import org
.osgi
.service
.prefs
.BackingStoreException
;
40 import org
.osgi
.service
.prefs
.Preferences
;
42 import eu
.etaxonomy
.cdm
.api
.application
.ICdmRepository
;
43 import eu
.etaxonomy
.cdm
.api
.facade
.DerivedUnitFacadeConfigurator
;
44 import eu
.etaxonomy
.cdm
.api
.service
.IFeatureTreeService
;
45 import eu
.etaxonomy
.cdm
.api
.service
.ITermService
;
46 import eu
.etaxonomy
.cdm
.api
.service
.config
.FindTaxaAndNamesConfiguratorImpl
;
47 import eu
.etaxonomy
.cdm
.api
.service
.config
.IFindTaxaAndNamesConfigurator
;
48 import eu
.etaxonomy
.cdm
.common
.CdmUtils
;
49 import eu
.etaxonomy
.cdm
.hibernate
.HibernateProxyHelper
;
50 import eu
.etaxonomy
.cdm
.io
.specimen
.abcd206
.in
.Abcd206ImportConfigurator
;
51 import eu
.etaxonomy
.cdm
.model
.common
.ICdmBase
;
52 import eu
.etaxonomy
.cdm
.model
.common
.Language
;
53 import eu
.etaxonomy
.cdm
.model
.common
.MarkerType
;
54 import eu
.etaxonomy
.cdm
.model
.metadata
.CdmPreference
;
55 import eu
.etaxonomy
.cdm
.model
.metadata
.CdmPreference
.PrefKey
;
56 import eu
.etaxonomy
.cdm
.model
.metadata
.IPreferencePredicate
;
57 import eu
.etaxonomy
.cdm
.model
.metadata
.PreferencePredicate
;
58 import eu
.etaxonomy
.cdm
.model
.metadata
.PreferenceSubject
;
59 import eu
.etaxonomy
.cdm
.model
.metadata
.TermDisplayEnum
;
60 import eu
.etaxonomy
.cdm
.model
.name
.NomenclaturalCode
;
61 import eu
.etaxonomy
.cdm
.model
.term
.FeatureTree
;
62 import eu
.etaxonomy
.cdm
.model
.term
.IDefinedTerm
;
63 import eu
.etaxonomy
.cdm
.model
.term
.ISimpleTerm
;
64 import eu
.etaxonomy
.cdm
.model
.term
.TermBase
;
65 import eu
.etaxonomy
.cdm
.strategy
.match
.DefaultMatchStrategy
;
66 import eu
.etaxonomy
.cdm
.strategy
.match
.FieldMatcher
;
67 import eu
.etaxonomy
.cdm
.strategy
.match
.IMatchStrategy
;
68 import eu
.etaxonomy
.cdm
.strategy
.match
.MatchException
;
69 import eu
.etaxonomy
.cdm
.strategy
.match
.MatchMode
;
70 import eu
.etaxonomy
.taxeditor
.model
.AbstractUtility
;
71 import eu
.etaxonomy
.taxeditor
.model
.MessagingUtils
;
72 import eu
.etaxonomy
.taxeditor
.model
.NomenclaturalCodeHelper
;
73 import eu
.etaxonomy
.taxeditor
.remoting
.source
.CdmRemoteSource
;
74 import eu
.etaxonomy
.taxeditor
.store
.CdmStore
;
75 import eu
.etaxonomy
.taxeditor
.store
.internal
.TaxeditorStorePlugin
;
76 import eu
.etaxonomy
.taxeditor
.ui
.dialog
.DefaultLanguageDialog
;
80 * PreferencesUtil class.
87 public class PreferencesUtil
implements IPreferenceKeys
{
88 private final static String EDITOR_PREFERENCES_NODE
= "eu.etaxonomy.taxeditor";
90 public static final String PREFERRED_TERMS_CHANGE
= "preferred_terms";
92 public static final String P2_REPOSITORIES_DELIM
= ",";
93 public static final String P2_REPOSITORY_FIELDS_DELIM
= ";";
94 public static final String SUBJECT_DELIM
= "/";
95 private final static Logger logger
= Logger
.getLogger(PreferencesUtil
.class);
97 public static IPreferenceStore
getPreferenceStore() {
98 return TaxeditorStorePlugin
.getDefault().getPreferenceStore();
101 public static String
[] extractSubjectParts(String subject
){
102 String
[] result
= subject
.split("/");
106 public static IEclipsePreferences
getEditorPreferences(){
107 return ConfigurationScope
.INSTANCE
.getNode(EDITOR_PREFERENCES_NODE
);
110 public static String
getPreferenceValue(PrefKey prefKey
){
112 if(getEditorPreferences().nodeExists(prefKey
.getPredicate())){
113 Preferences predicateNode
= getEditorPreferences().node(prefKey
.getPredicate());
114 String
[] splittedSubject
= extractSubjectParts(prefKey
.getSubject());
115 String value
= predicateNode
.get(splittedSubject
[splittedSubject
.length
-1], PreferencePredicate
.getByKey(prefKey
.getPredicate()).getDefaultValue() != null? PreferencePredicate
.getByKey(prefKey
.getPredicate()).getDefaultValue().toString(): "");
116 int index
= splittedSubject
.length
-2;
117 while (value
!= null && index
>= 0){
118 value
= predicateNode
.get(splittedSubject
[index
], prefKey
.getPredicate());
124 } catch (BackingStoreException e
) {
125 // TODO Auto-generated catch block
131 public static List
<CdmPreference
> getPreference(PreferencePredicate prefPredicate
){
133 List
<CdmPreference
> prefs
= new ArrayList();
135 PreferenceSubject subject
;
136 if(getEditorPreferences().nodeExists(prefPredicate
.getKey())){
137 Preferences predicateNode
= getEditorPreferences().node(prefPredicate
.getKey());
138 for (String childName
: predicateNode
.childrenNames()){
139 Preferences child
= predicateNode
.node(childName
);
140 String subjectString
= "";
141 subjectString
= createSubjectStringForChildNodes(childName
, child
);
142 String value
= child
.get(subjectString
, "");
143 subject
= PreferenceSubject
.NewInstance(subjectString
);
144 pref
= CdmPreference
.NewInstance(subject
, prefPredicate
, value
);
150 } catch (BackingStoreException e
) {
151 // TODO Auto-generated catch block
161 private static String
createSubjectStringForChildNodes(String subject
, Preferences parent
) {
163 for (String childName
: parent
.childrenNames()){
164 subject
= childName
+SUBJECT_DELIM
+subject
;
165 Preferences child
= parent
.node(childName
);
166 createSubjectStringForChildNodes(subject
, child
);
168 } catch (BackingStoreException e
) {
169 // TODO Auto-generated catch block
176 private static String
prefKey(String name
) {
177 return name
+ "_"+ ((CdmRemoteSource
)CdmStore
.getActiveCdmSource()).toString();
180 public static String
prefOverrideKey(String name
) {
181 return name
+ "_OVERRIDE_";
184 public static void setStringValue(String name
, String value
) {
186 getPreferenceStore().setValue(prefKey(name
), value
);
188 getPreferenceStore().setToDefault(name
);
192 public static void setIntValue(String name
, int value
) {
193 getPreferenceStore().setValue(prefKey(name
), value
);
196 public static void setBooleanValue(String name
, boolean value
) {
197 getPreferenceStore().setValue(prefKey(name
), value
);
200 public static void setDoubleValue(String name
, double value
) {
201 getPreferenceStore().setValue(prefKey(name
), value
);
204 public static void setFloatValue(String name
, float value
) {
205 getPreferenceStore().setValue(prefKey(name
), value
);
208 public static void setLongValue(String name
, long value
) {
209 getPreferenceStore().setValue(prefKey(name
), value
);
212 public static String
getStringValue(String name
, boolean local
) {
214 CdmPreference pref
= getDBPreferenceValue(name
);
215 String prefValue
= null;
216 String overrideKey
= createPreferenceString(createOverridePreferenceString(name
));
217 boolean override
= getPreferenceStore().getBoolean(overrideKey
);
219 if (local
|| pref
== null || (pref
!= null && pref
.isAllowOverride() && override
)){
220 String dbSpecific
= prefKey(name
);
221 if (getPreferenceStore().contains(dbSpecific
)){
222 prefValue
= getPreferenceStore().getString(dbSpecific
);
224 prefValue
= getPreferenceStore().
227 }else if (pref
!= null){
228 prefValue
= pref
.getValue();
234 public static String
getStringValue(String name
){
235 return getStringValue(name
, false);
238 private static CdmPreference
getDBPreferenceValue(String name
) {
239 CdmPreferenceCache cache
= CdmPreferenceCache
.instance();
240 CdmPreference pref
= null;
242 pref
= cache
.get(name
);
244 //get default value for Predicate
245 IPreferencePredicate pred
= PreferencePredicate
.getByKey(name
);
247 if (pred
.getDefaultValue() != null){
248 pref
= CdmPreference
.NewTaxEditorInstance(pred
, pred
.getDefaultValue().toString());
250 pref
= CdmPreference
.NewTaxEditorInstance(pred
, null);
252 pref
.setAllowOverride(true);
258 public static int getIntValue(String name
, boolean local
) {
259 CdmPreference pref
= getDBPreferenceValue(name
);
260 String prefValue
= null;
262 prefValue
= pref
.getValue();
264 Integer result
= null;
266 result
= Integer
.parseInt(prefValue
);
267 }catch(NumberFormatException e
){
268 logger
.debug("Preference value of " + name
+ " is not a number");
271 String overrideKey
= createPreferenceString(createOverridePreferenceString(name
));
272 boolean override
= true;
273 if (getPreferenceStore().contains(overrideKey
)){
274 override
= getPreferenceStore().getBoolean(overrideKey
);
276 if (local
|| pref
== null || (pref
!= null && pref
.isAllowOverride() && override
)){
277 String dbSpecific
= prefKey(name
);
278 if (getPreferenceStore().contains(dbSpecific
)){
279 result
= getPreferenceStore().getInt(dbSpecific
);
281 result
= getPreferenceStore().
289 public static boolean getBooleanValue(String name
) {
290 return getBooleanValue(name
, false);
293 public static boolean getBooleanValue(String name
, boolean local
) {
294 if (CdmStore
.isActive()){
295 CdmPreference pref
= getDBPreferenceValue(name
);
297 String overrideKey
= createPreferenceString(createOverridePreferenceString(name
));
298 boolean override
= getPreferenceStore().getBoolean(overrideKey
);
300 if (local
|| pref
== null || (pref
!= null && pref
.isAllowOverride() && override
)){
301 String dbSpecific
= prefKey(name
);
302 return getPreferenceStore().getBoolean(dbSpecific
);
304 return Boolean
.valueOf(pref
.getValue());
308 return getPreferenceStore().getBoolean(name
);
313 public static double getDoubleValue(String name
) {
314 CdmPreference pref
= getDBPreferenceValue(name
);
315 String prefValue
= null;
317 prefValue
= pref
.getValue();
319 Double result
= null;
321 result
= Double
.parseDouble(prefValue
);
322 }catch(NumberFormatException e
){
323 logger
.debug("Preference value of " + name
+ " is not a number");
326 String dbSpecific
= prefKey(name
);
327 if (getPreferenceStore().contains(dbSpecific
)){
328 result
= getPreferenceStore().getDouble(dbSpecific
);
330 result
= getPreferenceStore().
338 public static float getFloatValue(String name
, boolean local
) {
339 CdmPreference pref
= getDBPreferenceValue(name
);
340 String prefValue
= null;
342 prefValue
= pref
.getValue();
346 result
= Float
.parseFloat(prefValue
);
347 }catch(NumberFormatException e
){
348 logger
.debug("Preference value of " + name
+ " is not a number");
350 String overrideKey
= createPreferenceString(createOverridePreferenceString(name
));
351 boolean override
= true;
352 if (getPreferenceStore().contains(overrideKey
)){
353 override
= getPreferenceStore().getBoolean(overrideKey
);
355 if (local
|| pref
== null || (pref
!= null && pref
.isAllowOverride() && override
)){
356 String dbSpecific
= prefKey(name
);
357 if (getPreferenceStore().contains(dbSpecific
)){
358 result
= getPreferenceStore().getFloat(dbSpecific
);
360 result
= getPreferenceStore().
368 public static long getLongValue(String name
) {
369 CdmPreference pref
= getDBPreferenceValue(name
);
370 String prefValue
= null;
372 prefValue
= pref
.getValue();
376 result
= Long
.parseLong(prefValue
);
377 }catch(NumberFormatException e
){
378 logger
.debug("Preference value of " + name
+ " is not a number");
381 String dbSpecific
= prefKey(name
);
382 if (getPreferenceStore().contains(dbSpecific
)){
383 result
= getPreferenceStore().getLong(dbSpecific
);
385 result
= getPreferenceStore().
392 public static CdmPreference
setPreferredNomenclaturalCode(
393 String preferenceValue
, boolean local
) {
395 setStringValue(PREFERRED_NOMENCLATURAL_CODE_KEY
,
399 ICdmRepository controller
;
400 controller
= CdmStore
.getCurrentApplicationConfiguration();
401 if (controller
== null){
406 key
= CdmPreference
.NewKey(PreferenceSubject
.NewDatabaseInstance(), PreferencePredicate
.NomenclaturalCode
);
407 }catch (Exception e
){
408 System
.out
.println(e
.getStackTrace());
410 CdmPreference preference
= null;
412 if (preferenceValue
== null){
413 preference
= controller
.getPreferenceService().find(key
);
414 if (preference
== null){
417 setStringValue(PREFERRED_NOMENCLATURAL_CODE_KEY
,
418 preference
.getValue());
423 preference
= CdmPreference
.NewInstance(PreferenceSubject
.NewDatabaseInstance(), PreferencePredicate
.NomenclaturalCode
, preferenceValue
);
424 controller
.getPreferenceService().set(preference
);
434 public static void setPreferredNomenclaturalCode(
435 CdmPreference preference
) {
437 ICdmRepository controller
;
438 controller
= CdmStore
.getCurrentApplicationConfiguration();
439 if (controller
== null){
444 key
= CdmPreference
.NewKey(PreferenceSubject
.NewDatabaseInstance(), PreferencePredicate
.NomenclaturalCode
);
445 }catch (Exception e
){
446 System
.out
.println(e
.getStackTrace());
449 controller
.getPreferenceService().set(preference
);
453 public static NomenclaturalCode
getPreferredNomenclaturalCode() {
455 CdmPreference pref
= getPreferenceFromDB(PreferencePredicate
.NomenclaturalCode
);
458 String preferredCode
;
459 if(pref
== null || (pref
.isAllowOverride() && getBooleanValue(prefOverrideKey(PreferencePredicate
.NomenclaturalCode
.getKey())))){
460 preferredCode
= getStringValue(
461 PreferencePredicate
.NomenclaturalCode
.getKey(), true);
464 preferredCode
= pref
.getValue();
466 if (StringUtils
.isBlank(preferredCode
)){
467 preferredCode
= getPreferenceKey((NomenclaturalCode
)PreferencePredicate
.NomenclaturalCode
.getDefaultValue());
470 return getPreferredNomenclaturalCode(preferredCode
);
474 public static NomenclaturalCode
getPreferredNomenclaturalCode(String preferenceKeyNomenclaturalCode
) {
476 for (NomenclaturalCode code
: NomenclaturalCodeHelper
.getAllCodes()) {
477 if (getPreferenceKey(code
).equals(preferenceKeyNomenclaturalCode
)) {
484 public static boolean isShowTaxonAssociations(){
485 boolean result
= getBooleanValue(PreferencePredicate
.ShowTaxonAssociations
.getKey());
489 public static boolean isShowLifeForm(){
490 boolean result
= getBooleanValue(PreferencePredicate
.ShowLifeForm
.getKey());
494 public static boolean isDeterminationOnlyForFieldUnits(){
495 boolean result
= getBooleanValue(PreferencePredicate
.DeterminationOnlyForFieldUnits
.getKey());
499 public static boolean isCollectingAreaInGeneralSection(){
500 boolean result
= getBooleanValue(PreferencePredicate
.ShowCollectingAreasInGeneralSection
.getKey());
504 public static CdmPreference
getPreferenceFromDB(IPreferencePredicate predicate
){
505 ICdmRepository controller
;
506 CdmPreference pref
= null;
509 if(CdmStore
.isActive()){
510 controller
= CdmStore
.getCurrentApplicationConfiguration();
511 PrefKey key
= CdmPreference
.NewKey(PreferenceSubject
.NewTaxEditorInstance(), predicate
);
512 pref
= controller
.getPreferenceService().find(key
);
522 public static List
<CdmPreference
> getPreferencesFromDB(IPreferencePredicate predicate
){
523 ICdmRepository controller
;
524 List
<CdmPreference
> prefs
= null;
527 if(CdmStore
.isActive()){
528 controller
= CdmStore
.getCurrentApplicationConfiguration();
529 PrefKey key
= CdmPreference
.NewKey(PreferenceSubject
.NewTaxEditorInstance(), predicate
);
530 prefs
= controller
.getPreferenceService().list(predicate
);
540 public static void setPreferencesToDB(CdmPreference preference
, boolean setDefault
){
541 ICdmRepository controller
;
545 if(CdmStore
.isActive()){
546 controller
= CdmStore
.getCurrentApplicationConfiguration();
549 controller
.getPreferenceService().remove(preference
.getKey());
551 controller
.getPreferenceService().set(preference
);
562 public static CdmPreference
getPreferenceFromDB(PrefKey key
){
563 ICdmRepository controller
;
564 CdmPreference pref
= null;
567 if(CdmStore
.isActive()){
568 controller
= CdmStore
.getCurrentApplicationConfiguration();
569 pref
= controller
.getPreferenceService().find(key
);
579 public static void setPreferenceToDB(CdmPreference preference
){
580 ICdmRepository controller
;
582 if(CdmStore
.isActive()){
583 controller
= CdmStore
.getCurrentApplicationConfiguration();
584 controller
.getPreferenceService().set(preference
);
585 CdmPreferenceCache
.instance().put(preference
);
593 public static String
getPreferredDefaultLangugae(){
594 String preferredLanguage
= getStringValue(DEFAULT_LANGUAGE_EDITOR
);
595 if(StringUtils
.isNotEmpty(preferredLanguage
) && StringUtils
.isNotBlank(preferredLanguage
)){
596 return preferredLanguage
;
601 public static boolean isShowMediaPreview(){
602 boolean isShowMediaPreview
= getBooleanValue(SHOW_MEDIA_PREVIEW
);
603 return isShowMediaPreview
;
607 * Get the match strategy for the given class that was stored in preferences
608 * or the default strategy if it was not stored in preferences
611 * a {@link java.lang.Class} object.
612 * @return a {@link eu.etaxonomy.cdm.strategy.match.IMatchStrategy} object.
614 public static IMatchStrategy
getMatchStrategy(Class
<?
> clazz
) {
615 String className
= clazz
.getName();
616 if (getBooleanValue(MATCH_STRATEGY_PREFIX
+ className
)) {
617 IMatchStrategy matchStrategy
= getDefaultMatchStrategy(clazz
);
619 //TODO CacheMatchers (or multiple field matchers in future) are missing here
620 for (FieldMatcher fieldMatcher
: matchStrategy
.getMatching().getFieldMatchers(false)) {
621 String fieldName
= fieldMatcher
.getPropertyName();
622 String matchModeName
= getStringValue(
623 getMatchStrategyFieldName(className
, fieldName
));
624 MatchMode matchMode
= MatchMode
.valueOf(matchModeName
);
626 matchStrategy
.setMatchMode(fieldName
, matchMode
);
627 } catch (MatchException e
) {
628 MessagingUtils
.error(PreferencesUtil
.class, e
);
629 throw new RuntimeException(e
);
633 return matchStrategy
;
635 return getDefaultMatchStrategy(clazz
);
639 * Stores a matchStrategy into the preference store.
641 * @param matchStrategy
642 * a {@link eu.etaxonomy.cdm.strategy.match.IMatchStrategy}
645 public static void setMatchStrategy(IMatchStrategy matchStrategy
) {
646 String className
= "ANY class"; //FIXME was: matchStrategy.getMatchClass().getName(); seems currently not in use
647 setBooleanValue(MATCH_STRATEGY_PREFIX
+ className
, true);
649 List
<FieldMatcher
> fieldMatchers
= matchStrategy
.getMatching().getFieldMatchers(false);
651 for (FieldMatcher fieldMatcher
: fieldMatchers
) {
652 String fieldName
= fieldMatcher
.getPropertyName();
654 getMatchStrategyFieldName(className
, fieldName
),
655 fieldMatcher
.getMatchMode().name());
660 * Helper method to create the preference property for a match field.
666 private static String
getMatchStrategyFieldName(String className
,
668 return MATCH_STRATEGY_PREFIX
+ className
+ "." + fieldName
;
672 * Returns the default match strategy for a given class.
675 * a {@link java.lang.Class} object.
676 * @return a {@link eu.etaxonomy.cdm.strategy.match.IMatchStrategy} object.
678 public static IMatchStrategy
getDefaultMatchStrategy(Class clazz
) {
679 return DefaultMatchStrategy
.NewInstance(clazz
);
682 public static String
getDateFormatPattern() {
683 // TODO make this configurable in properties
684 String pattern
= "Y-M-d H:m";
688 public static <T
extends TermBase
> void addTermToPreferredTerms(T term
) {
690 // VocabularyEnum vocabulary =
691 // VocabularyEnum.getVocabularyEnum(term.getClass());
693 // getPreferenceStore().setValue(getPreferenceKey(term),
694 // VocabularyStore.getTermVocabulary(vocabulary).getTerms().contains(term));
696 // firePreferencesChanged(term.getClass());
700 * Construct a unique key using the CdmBase object's uuid
705 private static String
getPreferenceKey(ICdmBase cdmBase
) {
706 cdmBase
= HibernateProxyHelper
.deproxy(cdmBase
);
708 String key
= cdmBase
.getClass().getName().concat(".")
709 .concat(cdmBase
.getUuid().toString());
710 if (key
.contains("javassist")) {
711 MessagingUtils
.info("proxy");
717 * Construct a unique key using the CdmBase object's uuid
722 public static String
getPreferenceKey(ISimpleTerm simpleTerm
) {
723 simpleTerm
= HibernateProxyHelper
.deproxy(simpleTerm
);
724 String key
= simpleTerm
.getClass().getName().concat(".")
725 .concat(simpleTerm
.getUuid().toString());
726 if (key
.contains("javassist")) {
727 MessagingUtils
.warn(PreferencesUtil
.class,
728 "Trying to persist a preference based on a proxy class.");
736 * Construct a unique key using the CdmBase object's uuid
741 public static String
getPreferenceKey(IDefinedTerm definedTerm
) {
742 definedTerm
= HibernateProxyHelper
.deproxy(definedTerm
);
743 String key
= definedTerm
.getClass().getName().concat(".")
744 .concat(definedTerm
.getUuid().toString());
745 if (key
.contains("javassist")) {
746 MessagingUtils
.warn(PreferencesUtil
.class,
747 "Trying to persist a preference based on a proxy class.");
753 * Retrieves search preferences from the preference store
755 * @return an {@link ITaxonServiceConfigurator} to pass to search methods
757 public static IFindTaxaAndNamesConfigurator
getSearchConfigurator() {
758 IFindTaxaAndNamesConfigurator configurator
= initializeSearchConfigurator();
760 configurator
.setDoTaxa(getBooleanValue(
761 TAXON_SERVICE_CONFIGURATOR_TAXA
));
762 configurator
.setDoSynonyms(getBooleanValue(
763 TAXON_SERVICE_CONFIGURATOR_SYNONYMS
));
764 configurator
.setDoNamesWithoutTaxa(getBooleanValue(
765 TAXON_SERVICE_CONFIGURATOR_NAMES
));
766 configurator
.setDoTaxaByCommonNames(getBooleanValue(
767 TAXON_SERVICE_CONFIGURATOR_COMMON_NAMES
));
768 //configurator.setMatchMode(eu.etaxonomy.cdm.persistence.query.MatchMode.valueOf(getStringValue(TAXON_SERVICE_CONFIGURATOR_MATCH_MODE)));
774 * create new preferences, setting all search options to true
777 * {@link eu.etaxonomy.cdm.api.service.config.ITaxonServiceConfigurator}
780 public static IFindTaxaAndNamesConfigurator
initializeSearchConfigurator() {
781 IFindTaxaAndNamesConfigurator configurator
= FindTaxaAndNamesConfiguratorImpl
.NewInstance();
783 configurator
.setDoTaxa(true);
784 configurator
.setDoSynonyms(true);
785 configurator
.setDoNamesWithoutTaxa(true);
786 configurator
.setDoTaxaByCommonNames(true);
788 configurator
.setTaxonPropertyPath(Arrays
.asList("$", "titleCache",
789 "name", "name.$", "relationsFromThisTaxon.$"));
791 configurator
.setSynonymPropertyPath(Arrays
.asList("$", "titleCache",
792 "name", "name.$", "synonyms.relatedTo.*"));
795 // match mode is a simple like, actually all other match modes are kind
798 .setMatchMode(eu
.etaxonomy
.cdm
.persistence
.query
.MatchMode
.ANYWHERE
);
799 // we set page number and size here as this should always be unlimited
800 configurator
.setPageNumber(0);
801 // TODO currently limit results to 10000
802 configurator
.setPageSize(10000);
803 //setSearchConfigurator(configurator) ;
808 * Store search preferences
810 * @param configurator
812 * {@link eu.etaxonomy.cdm.api.service.config.ITaxonServiceConfigurator}
815 public static void setSearchConfigurator(
816 IFindTaxaAndNamesConfigurator configurator
) {
817 getPreferenceStore().setValue(TAXON_SERVICE_CONFIGURATOR_TAXA
,
818 configurator
.isDoTaxa());
819 getPreferenceStore().setValue(TAXON_SERVICE_CONFIGURATOR_SYNONYMS
,
820 configurator
.isDoSynonyms());
821 getPreferenceStore().setValue(TAXON_SERVICE_CONFIGURATOR_NAMES
,
822 configurator
.isDoNamesWithoutTaxa());
823 getPreferenceStore().setValue(TAXON_SERVICE_CONFIGURATOR_COMMON_NAMES
,
824 configurator
.isDoTaxaByCommonNames());
827 public static void firePreferencesChanged(Class clazz
) {
828 getPreferenceStore().firePropertyChangeEvent(PREFERRED_TERMS_CHANGE
,
832 public static String
createPreferenceString(String property
){
833 return prefKey(property
);
836 public static String
createOverridePreferenceString(String property
){
837 return prefOverrideKey(property
);
842 * Set default values for preferences
844 public static void setDefaults() {
845 getPreferenceStore().setDefault(TAXON_SERVICE_CONFIGURATOR_TAXA
, true);
846 getPreferenceStore().setDefault(TAXON_SERVICE_CONFIGURATOR_SYNONYMS
,
848 getPreferenceStore().setDefault(createPreferenceString(EDIT_MAP_SERVICE_ACCES_POINT
),
849 "http://edit.africamuseum.be/edit_wp5/v1.2/rest_gen.php");
850 //FIXME : changed default for SHOULD_CONNECT_AT_STARTUP to false (ticket 3828) until resolution
851 getPreferenceStore().setDefault(createPreferenceString(SHOULD_CONNECT_AT_STARTUP
), false);
852 getPreferenceStore().setDefault(createPreferenceString(OPENURL_ACCESS_POINT
),
853 "http://www.biodiversitylibrary.org/openurl");
854 getPreferenceStore().setDefault(createPreferenceString(OPENURL_IMAGE_MAX_WIDTH
), "1000");
855 getPreferenceStore().setDefault(createPreferenceString(OPENURL_IMAGE_MAX_HEIGHT
), "1000");
856 getPreferenceStore().setDefault(TAXON_SERVICE_CONFIGURATOR_TAXA
, true);
857 getPreferenceStore().setDefault(TAXON_SERVICE_CONFIGURATOR_SYNONYMS
, true);
858 getPreferenceStore().setDefault(TAXON_SERVICE_CONFIGURATOR_NAMES
, true);
859 getPreferenceStore().setDefault(TAXON_SERVICE_CONFIGURATOR_COMMON_NAMES
, true);
861 //Distribution Editor:
862 // getPreferenceStore().setDefault(createPreferenceString(PreferencePredicate.DistributionEditorActivated.getKey()), Boolean.valueOf(PreferencePredicate.DistributionEditorActivated.getDefaultValue().toString()));
863 // getPreferenceStore().setDefault(createPreferenceString(PreferencePredicate.DisplayOfAreasInDistributionEditor.getKey()), PreferencePredicate.DisplayOfAreasInDistributionEditor.getDefaultValue().toString());
864 // getPreferenceStore().setDefault(createPreferenceString(PreferencePredicate.DisplayOfStatus.getKey()), PreferencePredicate.DisplayOfStatus.getDefaultValue().toString());
868 getPreferenceStore().setDefault(createPreferenceString(PreferencePredicate
.NameDetailsView
.getKey()), new NameDetailsConfigurator(false).toString());
870 //Navigator preferences
871 getPreferenceStore().setDefault(createPreferenceString(PreferencePredicate
.TaxonNodeOrder
.getKey()), NavigatorOrderEnum
.RankAndNameOrder
.getKey());
873 //getPreferenceStore().setDefault(createPreferenceString(Prefe), true);
875 getPreferenceStore().setDefault(createPreferenceString(SHOW_ADVANCED_MEDIA_SECTION
), false);
877 getPreferenceStore().setDefault(createPreferenceString(SHOW_MEDIA_PREVIEW
), false);
878 //override db preferences
879 getPreferenceStore().setDefault(createPreferenceString(prefOverrideKey(PreferencePredicate
.AbcdImportConfig
.getKey())), false);
880 getPreferenceStore().setDefault(createPreferenceString(prefOverrideKey(PreferencePredicate
.ShowSpecimen
.getKey())), true);
881 getPreferenceStore().setDefault(createPreferenceString(prefOverrideKey(PreferencePredicate
.NameDetailsView
.getKey())), false);
882 getPreferenceStore().setDefault(createPreferenceString(prefOverrideKey(PreferencePredicate
.DistributionEditorActivated
.getKey())), true);
883 getPreferenceStore().setDefault(createPreferenceString(prefOverrideKey(PreferencePredicate
.AvailableDistributionStatus
.getKey())), true);
884 getPreferenceStore().setDefault(createPreferenceString(prefOverrideKey(PreferencePredicate
.AvailableDistributionAreaTerms
.getKey())), true);
885 getPreferenceStore().setDefault(createPreferenceString(prefOverrideKey(PreferencePredicate
.AvailableDistributionAreaVocabularies
.getKey())), true);
886 getPreferenceStore().setDefault(createPreferenceString(prefOverrideKey(PreferencePredicate
.CommonNameAreaVocabularies
.getKey())), false);
887 getPreferenceStore().setDefault(createPreferenceString(FILTER_COMMON_NAME_REFERENCES
), false);
888 getPreferenceStore().setDefault(createPreferenceString(PreferencePredicate
.ShowTaxonNodeWizard
.getKey()), Boolean
.valueOf(PreferencePredicate
.ShowTaxonNodeWizard
.getDefaultValue().toString()));
889 getPreferenceStore().setDefault(createPreferenceString(PreferencePredicate
.ShowNamespaceInSource
.getKey()), Boolean
.valueOf(PreferencePredicate
.ShowNamespaceInSource
.getDefaultValue().toString()));
890 getPreferenceStore().setDefault(createPreferenceString(PreferencePredicate
.ShowIdInSource
.getKey()), Boolean
.valueOf(PreferencePredicate
.ShowIdInSource
.getDefaultValue().toString()));
891 getPreferenceStore().setDefault(createPreferenceString(PreferencePredicate
.DisableMultiClassification
.getKey()), Boolean
.valueOf(PreferencePredicate
.DisableMultiClassification
.getDefaultValue().toString()));
892 getPreferenceStore().setDefault(createPreferenceString(PreferencePredicate
.ShowImportExportMenu
.getKey()), Boolean
.valueOf(PreferencePredicate
.ShowImportExportMenu
.getDefaultValue().toString()));
893 getPreferenceStore().setDefault(createPreferenceString(PreferencePredicate
.ShowSpecimen
.getKey()), Boolean
.valueOf(PreferencePredicate
.ShowSpecimen
.getDefaultValue().toString()));
897 public static void checkNomenclaturalCode() {
898 // First time Editor is opened, no nomenclatural code has been set
899 if (PreferencesUtil
.getPreferredNomenclaturalCode() == null) {
900 PreferencesUtil
.setPreferredNomenclaturalCode(getPreferenceKey(NomenclaturalCode
.ICNAFP
), true);
906 public static void setNomenclaturalCodePreferences(){
907 ICdmRepository controller
;
908 controller
= CdmStore
.getCurrentApplicationConfiguration();
909 PrefKey key
= CdmPreference
.NewKey(PreferenceSubject
.NewDatabaseInstance(), PreferencePredicate
.NomenclaturalCode
);
910 CdmPreference preference
= null;
911 if (controller
== null){
914 preference
= controller
.getPreferenceService().find(key
);
915 if (preference
== null){
918 // setBooleanValue(ALLOW_OVERRIDE_NOMENCLATURAL_CODE_KEY, preference.isAllowOverride());
920 int index
= StringUtils
.lastIndexOf(preference
.getValue(), ".");
921 UUID uuid
= UUID
.fromString(preference
.getValue().substring(index
+1, preference
.getValue().length()));
922 NomenclaturalCode preferredCode
= NomenclaturalCode
.getByUuid(uuid
);
924 setStringValue(PREFERRED_NOMENCLATURAL_CODE_KEY
,
925 getPreferenceKey(preferredCode
));
929 public static void checkDefaultLanguage(){
930 if(PreferencesUtil
.getPreferredDefaultLangugae() == null){
931 Shell shell
= AbstractUtility
.getShell();
932 int open
= new DefaultLanguageDialog(shell
).open();
933 if(open
== Window
.OK
){
934 PlatformUI
.getWorkbench().restart();
937 //TODO:In case of a reinstall, the config.ini will be overwritten
938 // here you create config.ini with the stored key from preferences
942 public static String
getMapServiceAccessPoint() {
943 return getStringValue(EDIT_MAP_SERVICE_ACCES_POINT
);
946 public static boolean shouldConnectAtStartUp() {
947 //FIXME : force SHOULD_CONNECT_AT_STARTUP to false (ticket 3828) until resolution
948 //return getBooleanValue(SHOULD_CONNECT_AT_STARTUP);
952 public static FeatureTree
getDefaultFeatureTreeForTextualDescription() {
953 String uuidString
= getStringValue(
954 FEATURE_TREE_DEFAULT_TEXT
);
955 if (StringUtils
.isBlank(uuidString
)) {
958 FeatureTree tree
= CdmStore
.getService(
959 IFeatureTreeService
.class).load(UUID
.fromString(uuidString
));
960 if (tree
.getId() == 0) {
966 public static FeatureTree
getDefaultFeatureTreeForStructuredDescription() {
967 String uuidString
= getStringValue(
968 FEATURE_TREE_DEFAULT_STRUCTURE
);
969 return CdmUtils
.isEmpty(uuidString
) ?
null : CdmStore
.getService(
970 IFeatureTreeService
.class).load(UUID
.fromString(uuidString
));
973 public static void setSortRanksHierarchichally(boolean selection
) {
974 setBooleanValue(SORT_RANKS_HIERARCHICHALLY
, selection
);
977 public static boolean getSortRanksHierarchichally() {
978 return getBooleanValue(SORT_RANKS_HIERARCHICHALLY
);
981 public static boolean isMultilanguageTextEditingCapability() {
982 return getBooleanValue(
983 MULTILANGUAGE_TEXT_EDITING_CAPABILITY
);
986 public static Language
getGlobalLanguage() {
989 String languageUuidString
= getStringValue(
990 GLOBAL_LANGUAGE_UUID
);
992 if(!CdmStore
.isActive()) {
993 MessagingUtils
.noDataSourceWarningDialog(languageUuidString
);
997 if (CdmUtils
.isBlank(languageUuidString
)) {
998 return Language
.getDefaultLanguage();
1001 UUID languageUuid
= UUID
.fromString(languageUuidString
);
1002 return (Language
) CdmStore
.getService(ITermService
.class).load(
1006 public static void setGlobalLanguage(Language language
) {
1007 if(language
!= null) {
1008 setStringValue(GLOBAL_LANGUAGE_UUID
,language
.getUuid().toString());
1009 CdmStore
.setDefaultLanguage(language
);
1014 public static Map
<MarkerType
, Boolean
> getEditMarkerTypePreferences() {
1015 List
<MarkerType
> markerTypes
= CdmStore
.getTermManager()
1016 .getPreferredTerms(MarkerType
.class);
1018 Map
<MarkerType
, Boolean
> result
= new HashMap
<MarkerType
, Boolean
>();
1020 for (MarkerType markerType
: markerTypes
) {
1021 String name
= getMarkerTypeEditingPreferenceKey(markerType
);
1022 Boolean value
= getBooleanValue(name
);
1024 result
.put(markerType
, value
);
1030 public static void setEditMarkerTypePreferences(
1031 Map
<MarkerType
, Boolean
> markerTypeEditingMap
) {
1032 for (MarkerType markerType
: markerTypeEditingMap
.keySet()) {
1033 String name
= getMarkerTypeEditingPreferenceKey(markerType
);
1034 setBooleanValue(name
,
1035 markerTypeEditingMap
.get(markerType
));
1040 private static String
getMarkerTypeEditingPreferenceKey(
1041 MarkerType markerType
) {
1042 markerType
= HibernateProxyHelper
.deproxy(markerType
);
1043 return markerType
.getClass().getName() + EDIT_MARKER_TYPE_PREFIX
;
1046 public static void setEditMarkerTypePreference(MarkerType markerType
,
1049 getMarkerTypeEditingPreferenceKey(markerType
), edit
);
1052 public static DerivedUnitFacadeConfigurator
getDerivedUnitConfigurator() {
1053 DerivedUnitFacadeConfigurator configurator
= DerivedUnitFacadeConfigurator
1055 configurator
.setMoveDerivedUnitMediaToGallery(true);
1056 configurator
.setMoveFieldObjectMediaToGallery(true);
1057 return configurator
;
1061 * This method will write language properties to the config.ini located in the configuration folder
1062 * of the Taxonomic Ediitor. <b>This method is only used to set the default language for Taxonomic Editor.</b>
1064 * @param setLanguage 0 is for german and 1 for english.
1065 * @throws IOException
1067 public void writePropertyToConfigFile(int setLanguage
) throws IOException
{
1068 File file
= org
.eclipse
.core
.runtime
.preferences
.ConfigurationScope
.INSTANCE
.getLocation().toFile();
1069 //give warning to user if the directory has no write access
1071 throw new IOException();
1073 Properties properties
= load(file
.getAbsolutePath()+"/config.ini");
1074 switch(setLanguage
){
1076 properties
.setProperty("osgi.nl", "de");
1077 setStringValue(IPreferenceKeys
.DEFAULT_LANGUAGE_EDITOR
, "de");
1080 properties
.setProperty("osgi.nl", "en");
1081 setStringValue(IPreferenceKeys
.DEFAULT_LANGUAGE_EDITOR
, "en");
1086 save(file
+"/config.ini", properties
);
1090 * This method loads a property from a given file and returns it.
1094 * @throws IOException
1096 private Properties
load(String filename
) throws IOException
{
1097 FileInputStream in
= new FileInputStream(filename
);
1098 Properties prop
= new Properties();
1105 * This method saves a property to the specified file.
1109 * @throws IOException
1111 private void save(String filename
, Properties properties
) throws IOException
{
1112 FileOutputStream fos
= new FileOutputStream(filename
);
1113 properties
.store(fos
, "");
1118 * Saves a list of P2 Metadata Repositories as string with specified delimiters
1122 public static void setP2Repositories(List
<MetadataRepositoryElement
> p2Repos
) {
1123 StringBuilder sb
= new StringBuilder();
1124 for(MetadataRepositoryElement p2Repo
: p2Repos
) {
1125 sb
.append(P2_REPOSITORIES_DELIM
);
1126 if(p2Repo
.getName() == null || p2Repo
.getName().isEmpty()) {
1129 sb
.append(p2Repo
.getName());
1131 sb
.append(P2_REPOSITORY_FIELDS_DELIM
);
1132 sb
.append(p2Repo
.getLocation().toString());
1133 sb
.append(P2_REPOSITORY_FIELDS_DELIM
);
1134 sb
.append(String
.valueOf(p2Repo
.isEnabled()));
1136 getPreferenceStore().setValue(P2_REPOSITORY_LIST
, sb
.toString());
1141 * Retrieves a list of previously saved P2 repositories
1145 public static List
<MetadataRepositoryElement
> getP2Repositories() {
1146 List
<MetadataRepositoryElement
> p2Repos
= new ArrayList
<MetadataRepositoryElement
>();
1147 String p2ReposPref
= getStringValue(P2_REPOSITORY_LIST
);
1148 if(p2ReposPref
!= null && !p2ReposPref
.isEmpty()) {
1149 StringTokenizer p2ReposPrefST
= new StringTokenizer(p2ReposPref
,P2_REPOSITORIES_DELIM
);
1151 while(p2ReposPrefST
.hasMoreTokens()) {
1152 String p2RepoStr
= p2ReposPrefST
.nextToken();
1153 StringTokenizer p2ReposStrST
= new StringTokenizer(p2RepoStr
,P2_REPOSITORY_FIELDS_DELIM
);
1154 if(p2ReposStrST
.countTokens()==3) {
1155 String nickname
= p2ReposStrST
.nextToken();
1158 uri
= new URI(p2ReposStrST
.nextToken());
1159 } catch (URISyntaxException e
) {
1162 boolean enabled
= Boolean
.parseBoolean(p2ReposStrST
.nextToken());
1163 MetadataRepositoryElement mre
= new MetadataRepositoryElement(null, uri
, true);
1164 mre
.setNickname(nickname
);
1165 mre
.setEnabled(enabled
);
1175 * enables/disables nested composite. <br>
1177 * @param ctrl - Composite to be en-/disabeld
1178 * @param enabled - boolean
1180 public static void recursiveSetEnabled(Control ctrl
, boolean enabled
) {
1181 if (ctrl
instanceof Composite
) {
1182 Composite comp
= (Composite
) ctrl
;
1183 for (Control c
: comp
.getChildren()) {
1184 recursiveSetEnabled(c
, enabled
);
1187 ctrl
.setEnabled(enabled
);
1191 public static void setSortNodes(NavigatorOrderEnum nodesOrder
) {
1192 setStringValue(PreferencePredicate
.TaxonNodeOrder
.getKey(), nodesOrder
.key
);
1196 public static NavigatorOrderEnum
getSortNodes() {
1197 return NavigatorOrderEnum
.valueOf(getStringValue(PreferencePredicate
.TaxonNodeOrder
.getKey()));
1201 public static boolean isNodesSortedNaturally() {
1202 NavigatorOrderEnum value
= NavigatorOrderEnum
.valueOf(getStringValue(PreferencePredicate
.TaxonNodeOrder
.getKey()));
1203 return value
.equals(NavigatorOrderEnum
.NaturalOrder
);
1207 public static boolean isNodesSortedByName() {
1208 NavigatorOrderEnum value
= NavigatorOrderEnum
.valueOf(getStringValue(PreferencePredicate
.TaxonNodeOrder
.getKey()));
1209 return value
.equals(NavigatorOrderEnum
.AlphabeticalOrder
);
1213 public static boolean isNodesSortedByNameAndRank() {
1214 NavigatorOrderEnum value
= NavigatorOrderEnum
.valueOf(getStringValue(PreferencePredicate
.TaxonNodeOrder
.getKey()));
1215 return value
.equals(NavigatorOrderEnum
.RankAndNameOrder
);
1219 public static boolean isStoreNavigatorState() {
1220 return getBooleanValue(RESTORE_NAVIGATOR_STATE
);
1224 public static void setStoreNavigatorState(boolean selection
) {
1225 setBooleanValue(RESTORE_NAVIGATOR_STATE
, selection
);
1229 public static boolean isShowUpWidgetIsDisposedMessages() {
1230 return getBooleanValue(IS_SHOW_UP_WIDGET_IS_DISPOSED
);
1232 public static void setShowUpWidgetIsDisposedMessages(boolean selection
) {
1233 setBooleanValue(IS_SHOW_UP_WIDGET_IS_DISPOSED
, selection
);
1236 public static boolean isShowIdInVocabularyInChecklistEditor() {
1237 String area_display
= getStringValue(PreferencePredicate
.DisplayOfAreasInDistributionEditor
.getKey());
1238 if (area_display
.equals(TermDisplayEnum
.IdInVocabulary
.getKey())) {
1244 public static boolean isShowSymbol1InChecklistEditor() {
1245 String area_display
= getStringValue(PreferencePredicate
.DisplayOfAreasInDistributionEditor
.getKey());
1246 if (area_display
.equals(TermDisplayEnum
.Symbol1
.getKey())) {
1252 public static boolean isShowSymbol2InChecklistEditor() {
1253 String area_display
= getStringValue(PreferencePredicate
.DisplayOfAreasInDistributionEditor
.getKey());
1254 if (area_display
.equals(TermDisplayEnum
.Symbol2
.getKey())) {
1260 public static void setAreaDisplayInChecklistEditor(String selection
) {
1261 setStringValue(PreferencePredicate
.DisplayOfAreasInDistributionEditor
.getKey(), selection
);
1264 public static void setOwnDescriptionForChecklistEditor(boolean selection
) {
1265 setBooleanValue(PreferencePredicate
.OwnDescriptionForDistributionEditor
.getKey(), selection
);
1268 public static boolean isOwnDescriptionForChecklistEditor() {
1269 return getBooleanValue(PreferencePredicate
.OwnDescriptionForDistributionEditor
.getKey());
1272 public static String
displayAreaInChecklistEditor() {
1273 String result
= getStringValue(PreferencePredicate
.DisplayOfAreasInDistributionEditor
.getKey());
1274 if (StringUtils
.isBlank(result
)){
1275 return ((TermDisplayEnum
) PreferencePredicate
.DisplayOfAreasInDistributionEditor
.getDefaultValue()).getKey();
1280 public static String
displayStatusInChecklistEditor() {
1281 String result
= getStringValue(PreferencePredicate
.DisplayOfStatus
.getKey());
1282 if (StringUtils
.isBlank(result
)){
1283 return((TermDisplayEnum
) PreferencePredicate
.DisplayOfStatus
.getDefaultValue()).getKey();
1287 public static void setDisplayStatusInChecklistEditor(String selection
) {
1288 setStringValue(PreferencePredicate
.DisplayOfStatus
.getKey(), selection
);
1292 public static boolean isShowRankInChecklistEditor() {
1293 return getBooleanValue(PreferencePredicate
.ShowRankInDistributionEditor
.getKey());
1295 public static void setShowRankInChecklistEditor(boolean selection
) {
1296 setBooleanValue(PreferencePredicate
.ShowRankInDistributionEditor
.getKey(), selection
);
1299 public static NameDetailsConfigurator
getPreferredNameDetailsConfiguration( boolean local
) {
1300 NameDetailsConfigurator config
= new NameDetailsConfigurator(true);
1301 CdmPreferenceCache cache
= CdmPreferenceCache
.instance();
1302 CdmPreference preference
= null;
1305 PrefKey key
= CdmPreference
.NewKey(PreferenceSubject
.NewTaxEditorInstance(), PreferencePredicate
.NameDetailsView
);
1306 preference
= cache
.findBestMatching(key
);
1307 if (preference
== null){
1311 // setBooleanValue(ALLOW_OVERRIDE_NAME_DETAILS, preference.isAllowOverride());
1312 value
= preference
.getValue();
1313 config
.setAllowOverride(preference
.isAllowOverride());
1314 //the preference value is build like this:
1315 //<section1>:true;<section2>:false....
1317 value
= getStringValue(PreferencePredicate
.NameDetailsView
.getKey(), local
);
1320 String
[] sections
= value
.split(";");
1321 Map
<String
, Boolean
> sectionMap
= new HashMap
<String
, Boolean
>();
1322 String
[] sectionValues
;
1323 for (String sectionValue
: sections
){
1324 sectionValues
= sectionValue
.split(":");
1325 sectionMap
.put(sectionValues
[0], Boolean
.valueOf(sectionValues
[1]));
1327 config
.setSimpleDetailsViewActivated(getValue(sectionMap
, "simpleViewActivated"));
1328 config
.setTaxonSectionActivated(getValue(sectionMap
, "taxon"));
1329 config
.setSecDetailsActivated(getValue(sectionMap
, "taxon.SecDetails"));
1330 config
.setSecEnabled(getValue(sectionMap
, "taxon.SecEnabled"));
1331 config
.setLSIDActivated(getValue(sectionMap
, "lsid"));
1332 config
.setNomenclaturalCodeActived(getValue(sectionMap
, "nc"));
1333 config
.setAppendedPhraseActivated(getValue(sectionMap
, "ap"));
1334 config
.setRankActivated(getValue(sectionMap
, "rank"));
1335 config
.setAtomisedEpithetsActivated(getValue(sectionMap
, "atomisedEpithets"));
1336 config
.setAuthorshipSectionActivated(getValue(sectionMap
,"author"));
1337 config
.setNomenclaturalReferenceSectionActivated(sectionMap
.get("nomRef"));
1338 config
.setNomenclaturalStatusSectionActivated(getValue(sectionMap
, "nomStat"));
1339 config
.setProtologueActivated(getValue(sectionMap
,"protologue"));
1340 config
.setTypeDesignationSectionActivated(getValue(sectionMap
,"typeDes"));
1341 config
.setNameRelationsSectionActivated(getValue(sectionMap
,"nameRelation"));
1342 config
.setHybridActivated(getValue(sectionMap
,"hybrid"));
1347 public static NameDetailsConfigurator
getPreferredNameDetailsConfiguration() {
1348 NameDetailsConfigurator config
= new NameDetailsConfigurator(true);
1352 value
= getStringValue(PreferencePredicate
.NameDetailsView
.getKey(), false);
1354 String
[] sections
= value
.split(";");
1355 Map
<String
, Boolean
> sectionMap
= new HashMap
<String
, Boolean
>();
1356 String
[] sectionValues
;
1357 for (String sectionValue
: sections
){
1358 sectionValues
= sectionValue
.split(":");
1359 sectionMap
.put(sectionValues
[0], Boolean
.valueOf(sectionValues
[1]));
1362 config
.setSimpleDetailsViewActivated(getValue(sectionMap
, "simpleViewActivated"));
1364 config
.setTaxonSectionActivated(getValue(sectionMap
, "taxon"));
1366 config
.setSecDetailsActivated(getValue(sectionMap
, "taxon.SecDetails"));
1367 config
.setSecEnabled(getValue(sectionMap
, "taxon.SecEnabled"));
1369 config
.setLSIDActivated(getValue(sectionMap
, "lsid"));
1371 config
.setNomenclaturalCodeActived(getValue(sectionMap
, "nc"));
1373 config
.setAppendedPhraseActivated(getValue(sectionMap
, "ap"));
1375 config
.setRankActivated(getValue(sectionMap
, "rank"));
1377 config
.setAtomisedEpithetsActivated(getValue(sectionMap
, "atomisedEpithets"));
1379 config
.setAuthorshipSectionActivated(getValue(sectionMap
,"author"));
1381 config
.setNomenclaturalReferenceSectionActivated(sectionMap
.get("nomRef"));
1383 config
.setNomenclaturalStatusSectionActivated(getValue(sectionMap
, "nomStat"));
1385 config
.setProtologueActivated(getValue(sectionMap
,"protologue"));
1387 config
.setTypeDesignationSectionActivated(getValue(sectionMap
,"typeDes"));
1389 config
.setNameRelationsSectionActivated(getValue(sectionMap
,"nameRelation"));
1391 config
.setHybridActivated(getValue(sectionMap
,"hybrid"));
1396 public static void setPreferredNameDetailsConfiguration(NameDetailsConfigurator config
, boolean local
) {
1397 CdmPreference preference
= null;
1400 preference
= CdmPreference
.NewInstance(PreferenceSubject
.NewTaxEditorInstance(), PreferencePredicate
.NameDetailsView
, config
.toString());
1402 setPreferenceToDB(preference
);
1405 setStringValue(PreferencePredicate
.NameDetailsView
.getKey(), config
.toString());
1411 private static Boolean
getValue(Map
<String
, Boolean
> sectionMap
, String string
) {
1412 if (sectionMap
.containsKey(string
)){
1413 return sectionMap
.get(string
);
1420 public static Abcd206ImportConfigurator
getDBAbcdImportConfigurationPreference() {
1422 Abcd206ImportConfigurator config
= Abcd206ImportConfigurator
.NewInstance(null,null);
1423 ICdmRepository controller
;
1424 controller
= CdmStore
.getCurrentApplicationConfiguration();
1425 PrefKey key
= CdmPreference
.NewKey(PreferenceSubject
.NewTaxEditorInstance(), PreferencePredicate
.AbcdImportConfig
);
1426 CdmPreference preference
= null;
1427 if (controller
== null){
1430 preference
= controller
.getPreferenceService().find(key
);
1431 if (preference
== null){
1434 String configString
= preference
.getValue();
1435 String
[] configArray
= configString
.split(";");
1437 for (String configItem
: configArray
){
1438 String
[] keyValue
= configItem
.split(":");
1439 String keyString
= keyValue
[0];
1440 String valueString
= null;
1441 if (keyValue
.length
>1){
1442 valueString
= keyValue
[1];
1444 if (keyString
.equals("ignoreImportOfExistingSpecimen")){
1445 config
.setIgnoreImportOfExistingSpecimen(Boolean
.valueOf(valueString
));
1446 }else if (keyString
.equals("addIndividualsAssociationsSuchAsSpecimenAndObservations")){
1447 config
.setAddIndividualsAssociationsSuchAsSpecimenAndObservations(Boolean
.valueOf(valueString
));
1448 }else if (keyString
.equals("reuseExistingTaxaWhenPossible")){
1449 config
.setReuseExistingTaxaWhenPossible(Boolean
.valueOf(valueString
));
1450 }else if (keyString
.equals("ignoreAuthorship")){
1451 config
.setIgnoreAuthorship(Boolean
.valueOf(valueString
));
1452 }else if (keyString
.equals("addMediaAsMediaSpecimen")){
1453 config
.setAddMediaAsMediaSpecimen(Boolean
.valueOf(valueString
));
1454 }else if (keyString
.equals("reuseExistingMetaData")){
1455 config
.setReuseExistingMetaData(Boolean
.valueOf(valueString
));
1456 }else if (keyString
.equals("reuseExistingDescriptiveGroups")){
1457 config
.setReuseExistingDescriptiveGroups(Boolean
.valueOf(valueString
));
1458 }else if (keyString
.equals("allowReuseOtherClassifications")){
1459 config
.setAllowReuseOtherClassifications(Boolean
.valueOf(valueString
));
1460 }else if (keyString
.equals("deduplicateReferences")){
1461 config
.setDeduplicateReferences(Boolean
.valueOf(valueString
));
1462 }else if (keyString
.equals("deduplicateClassifications")){
1463 config
.setDeduplicateClassifications(Boolean
.valueOf(valueString
));
1464 }else if (keyString
.equals("moveNewTaxaToDefaultClassification")){
1465 config
.setMoveNewTaxaToDefaultClassification(Boolean
.valueOf(valueString
));
1466 }else if (keyString
.equals("mapUnitIdToCatalogNumber")){
1467 config
.setMapUnitIdToCatalogNumber(Boolean
.valueOf(valueString
));
1468 }else if (keyString
.equals("mapUnitIdToAccessionNumber")){
1469 config
.setMapUnitIdToAccessionNumber(Boolean
.valueOf(valueString
));
1470 }else if (keyString
.equals("mapUnitIdToBarcode")){
1471 config
.setMapUnitIdToBarcode(Boolean
.valueOf(valueString
));
1472 }else if (keyString
.equals("overwriteExistingSpecimens")){
1473 config
.setOverwriteExistingSpecimens(Boolean
.valueOf(valueString
));
1474 }else if (keyString
.equals("nomenclaturalCode")){
1475 config
.setNomenclaturalCode(NomenclaturalCode
.fromString(valueString
));
1477 logger
.debug("This key of the abcd configurator needs to be added to the transformer: " + keyString
);
1485 public static Abcd206ImportConfigurator
getLocalAbcdImportConfigurator(){
1486 Abcd206ImportConfigurator config
= Abcd206ImportConfigurator
.NewInstance(null,null);
1488 config
.setAddIndividualsAssociationsSuchAsSpecimenAndObservations(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_ADD_INDIVIDUALS_ASSOCIATIONS_SUCH_AS_SPECIMEN_AND_OBSERVATIONS
));
1490 config
.setAddMediaAsMediaSpecimen(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_ADD_MEDIA_AS_MEDIASPECIMEN
));
1492 config
.setAllowReuseOtherClassifications(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_ALLOW_REUSE_OTHER_CLASSIFICATIONS
));
1493 config
.setDeduplicateClassifications(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_DEDUPLICATE_CLASSIFICATIONS
));
1494 config
.setDeduplicateReferences(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_DEDUPLICATE_REFERENCES
));
1495 config
.setRemoveCountryFromLocalityText(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_REMOVE_COUNTRY_FROM_LOCALITY_TEXT
));
1496 config
.setGetSiblings(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_DO_SIBLINGS
));
1497 config
.setIgnoreAuthorship(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_IGNORE_AUTHORSHIP
));
1498 config
.setIgnoreImportOfExistingSpecimen(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_IGNORE_IMPORT_OF_EXISTING_SPECIMEN
));
1499 config
.setMapUnitIdToAccessionNumber(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_MAP_UNIT_ID_TO_ACCESSION_NUMBER
));
1500 config
.setMapUnitIdToBarcode(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_MAP_UNIT_ID_TO_BARCODE
));
1501 config
.setMapUnitIdToCatalogNumber(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_MAP_UNIT_ID_TOCATALOG_NUMBER
));
1502 config
.setMoveNewTaxaToDefaultClassification(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_MOVE_NEW_TAXA_TO_DEFAULT_CLASSIFICATION
));
1503 config
.setOverwriteExistingSpecimens(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_OVERWRITE_EXISTING_SPECIMEN
));
1504 config
.setReuseExistingDescriptiveGroups(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_REUSE_EXISTING_DESCRIPTIVE_GROUPS
));
1505 config
.setReuseExistingMetaData(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_REUSE_EXISTING_META_DATA
));
1506 config
.setReuseExistingTaxaWhenPossible(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_REUSE_EXISTING_TAXA_WHEN_POSSIBLE
));
1507 config
.setNomenclaturalCode(NomenclaturalCode
.getByKey(getStringValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_NOMENCLATURAL_CODE
)));
1513 public static void updateAbcdImportConfigurationPreference() {
1514 CdmPreferenceCache cache
= CdmPreferenceCache
.instance();
1516 CdmPreference pref
= cache
.findBestMatching(CdmPreference
.NewKey(PreferenceSubject
.NewTaxEditorInstance(), PreferencePredicate
.AbcdImportConfig
));
1518 if (!getBooleanValue(prefOverrideKey(PreferencePredicate
.AbcdImportConfig
.getKey())) || !pref
.isAllowOverride()){
1519 resetToDBPreferenceAbcdCOnfigurator();
1524 public static void resetToDBPreferenceAbcdCOnfigurator(){
1525 Abcd206ImportConfigurator config
= getDBAbcdImportConfigurationPreference();
1526 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_ADD_INDIVIDUALS_ASSOCIATIONS_SUCH_AS_SPECIMEN_AND_OBSERVATIONS
, config
.isAddIndividualsAssociationsSuchAsSpecimenAndObservations());
1527 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_ADD_MEDIA_AS_MEDIASPECIMEN
, config
.isAddMediaAsMediaSpecimen());
1529 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_ALLOW_REUSE_OTHER_CLASSIFICATIONS
, config
.isAllowReuseOtherClassifications());
1530 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_DEDUPLICATE_CLASSIFICATIONS
, config
.isDeduplicateClassifications());
1531 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_DEDUPLICATE_REFERENCES
, config
.isDeduplicateReferences());
1533 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_DO_SIBLINGS
, config
.isGetSiblings());
1534 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_IGNORE_AUTHORSHIP
, config
.isIgnoreAuthorship());
1535 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_IGNORE_IMPORT_OF_EXISTING_SPECIMEN
, config
.isIgnoreImportOfExistingSpecimen());
1536 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_MAP_UNIT_ID_TO_ACCESSION_NUMBER
, config
.isMapUnitIdToAccessionNumber());
1537 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_MAP_UNIT_ID_TO_BARCODE
, config
.isMapUnitIdToBarcode());
1538 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_MAP_UNIT_ID_TOCATALOG_NUMBER
, config
.isMapUnitIdToCatalogNumber());
1539 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_MOVE_NEW_TAXA_TO_DEFAULT_CLASSIFICATION
, config
.isMoveNewTaxaToDefaultClassification());
1540 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_OVERWRITE_EXISTING_SPECIMEN
, config
.isOverwriteExistingSpecimens());
1541 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_REUSE_EXISTING_DESCRIPTIVE_GROUPS
, config
.isReuseExistingDescriptiveGroups());
1542 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_REUSE_EXISTING_META_DATA
, config
.isReuseExistingMetaData());
1543 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_REUSE_EXISTING_TAXA_WHEN_POSSIBLE
, config
.isReuseExistingTaxaWhenPossible());
1544 if (config
.getNomenclaturalCode() != null){
1545 setStringValue(ABCD_IMPORT_CONFIGURATOR_NOMENCLATURAL_CODE
, config
.getNomenclaturalCode().getKey());
1549 public static boolean isSortTaxaByRankAndName() {
1551 return getBooleanValue(IPreferenceKeys
.SORT_TAXA_BY_RANK_AND_NAME
);
1554 public static String
getSortNamedAreasInDistributionEditor() {
1556 return getStringValue(PreferencePredicate
.AreasSortedInDistributionEditor
.getKey());
1559 public static void setSortNamedAreasInDistributionEditor(String isSortByVocabularyOrder
) {
1560 setStringValue(PreferencePredicate
.AreasSortedInDistributionEditor
.getKey(), isSortByVocabularyOrder
);
1564 public static void setLastSelectedReference(
1565 List
<String
> lastSelectedReferences
) {
1567 setStringValue(PreferencesUtil
.LAST_SELECTED_REFERENCES
, lastSelectedReferences
.toString());
1570 public static List
<String
> getLastSelectedReferences() {
1572 //IPreferenceStore preferenceStore = PreferencesUtil.getPreferenceStore();
1573 String lastSelected
= getStringValue(PreferencesUtil
.LAST_SELECTED_REFERENCES
);
1574 List
<String
> result
= new ArrayList
<>();
1575 if (!StringUtils
.isBlank(lastSelected
)){
1576 Collections
.addAll(result
, lastSelected
.substring(1,lastSelected
.length()-1).split(", "));
1581 public static void setPreferredNamedAreasForDistributionEditor(
1582 String saveCheckedElements
, String saveGrayedElements
, boolean local
) {
1584 setStringValue(PreferencePredicate
.AvailableDistributionAreaTerms
.getKey(), saveCheckedElements
);
1588 CdmPreference preference
= null;
1590 if (saveCheckedElements
== null){
1591 preference
= getPreferenceFromDB(PreferencePredicate
.AvailableDistributionAreaTerms
);
1593 if (preference
== null){
1596 setStringValue(PreferencePredicate
.AvailableDistributionAreaTerms
.getKey(),
1597 saveCheckedElements
);
1598 preference
= CdmPreference
.NewInstance(PreferenceSubject
.NewTaxEditorInstance(), PreferencePredicate
.AvailableDistributionAreaTerms
, saveCheckedElements
);
1599 setPreferenceToDB(preference
);
1603 preference
= CdmPreference
.NewInstance(PreferenceSubject
.NewTaxEditorInstance(), PreferencePredicate
.AvailableDistributionAreaTerms
, saveCheckedElements
);
1604 setPreferenceToDB(preference
);
1605 setStringValue(PreferencePredicate
.AvailableDistributionAreaTerms
.getKey(),
1606 saveCheckedElements
);
1613 public static void setPreferredVocabulariesForDistributionEditor(String saveCheckedElements
,
1614 boolean local
, boolean isOverride
) {
1616 setStringValue(PreferencePredicate
.AvailableDistributionAreaVocabularies
.getKey(), saveCheckedElements
);
1617 setBooleanValue(prefOverrideKey(PreferencePredicate
.AvailableDistributionAreaVocabularies
.getKey()), isOverride
);
1620 ICdmRepository controller
;
1621 CdmPreference preference
= null;
1623 if (saveCheckedElements
== null){
1624 preference
= getPreferenceFromDB(PreferencePredicate
.AvailableDistributionAreaVocabularies
);
1626 if (preference
== null){
1629 setStringValue(PreferencePredicate
.AvailableDistributionAreaVocabularies
.getKey(),
1630 saveCheckedElements
);
1631 preference
= CdmPreference
.NewInstance(PreferenceSubject
.NewTaxEditorInstance(), PreferencePredicate
.AvailableDistributionAreaVocabularies
, saveCheckedElements
);
1632 preference
.setAllowOverride(isOverride
);
1633 setPreferenceToDB(preference
);
1636 preference
= CdmPreference
.NewInstance(PreferenceSubject
.NewTaxEditorInstance(), PreferencePredicate
.AvailableDistributionAreaVocabularies
, saveCheckedElements
);
1637 preference
.setAllowOverride(isOverride
);
1638 setPreferenceToDB(preference
);
1639 setStringValue(PreferencePredicate
.AvailableDistributionAreaVocabularies
.getKey(),
1640 saveCheckedElements
);
1646 public static String
getPreferredVocabulariesForDistributionEditor(boolean local
) {
1649 String pref
= getStringValue(PreferencePredicate
.AvailableDistributionAreaVocabularies
.getKey(), local
);
1653 CdmPreference preference
= null;
1654 preference
= getPreferenceFromDB(PreferencePredicate
.AvailableDistributionAreaVocabularies
);
1655 if (preference
== null){
1658 return preference
.getValue();
1664 public static List
<UUID
> createUUIDListFromStringPref(String prefKey
) {
1665 String prefValue
= PreferencesUtil
.getStringValue(prefKey
);
1666 String
[] stringArray
= prefValue
.split(";");
1667 List
<UUID
> uuidList
= new ArrayList();
1668 for (String uuid
: stringArray
){
1669 if (!StringUtils
.isBlank(uuid
)){
1670 uuidList
.add(UUID
.fromString(uuid
));
1676 public static boolean getFilterCommonNameReferences(){
1677 return getBooleanValue(PreferencesUtil
.FILTER_COMMON_NAME_REFERENCES
);
1680 public static void updateDBPreferences() {
1683 CdmPreferenceCache cache
= CdmPreferenceCache
.instance();
1684 cache
.getAllTaxEditorDBPreferences();
1688 updateAbcdImportConfigurationPreference();
1691 NameDetailsConfigurator config
= getPreferredNameDetailsConfiguration(false);
1692 // if (config != null ){
1693 // if (!getBooleanValue(OVERRIDE_NAME_DETAILS) || !getBooleanValue(ALLOW_OVERRIDE_NAME_DETAILS)){
1694 // setPreferredNameDetailsConfiguration(config, false);
1700 public static void setPreferencesToDB(List
<CdmPreference
> preferences
) {
1702 ICdmRepository controller
;
1704 if(CdmStore
.isActive()){
1705 controller
= CdmStore
.getCurrentApplicationConfiguration();
1706 for (CdmPreference preference
: preferences
){
1707 controller
.getPreferenceService().set(preference
);
1708 CdmPreferenceCache
.instance().put(preference
);
1711 }catch(Exception e
){
1712 e
.printStackTrace();
1717 * Returns whether the named preference is known.
1718 * @param prefKey the key of the preference
1719 * @return <code>true</code> if the preference is known, <code>false</code> otherwise
1721 public static boolean contains(String prefKey
){
1722 return getPreferenceStore().contains(prefKey(prefKey
));