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
.equinox
.internal
.p2
.ui
.model
.MetadataRepositoryElement
;
31 import org
.eclipse
.jface
.preference
.IPreferenceStore
;
32 import org
.eclipse
.jface
.window
.Window
;
33 import org
.eclipse
.swt
.widgets
.Composite
;
34 import org
.eclipse
.swt
.widgets
.Control
;
35 import org
.eclipse
.swt
.widgets
.Shell
;
36 import org
.eclipse
.ui
.PlatformUI
;
38 import eu
.etaxonomy
.cdm
.api
.application
.ICdmRepository
;
39 import eu
.etaxonomy
.cdm
.api
.facade
.DerivedUnitFacadeConfigurator
;
40 import eu
.etaxonomy
.cdm
.api
.service
.IFeatureTreeService
;
41 import eu
.etaxonomy
.cdm
.api
.service
.ITermService
;
42 import eu
.etaxonomy
.cdm
.api
.service
.config
.FindTaxaAndNamesConfiguratorImpl
;
43 import eu
.etaxonomy
.cdm
.api
.service
.config
.IFindTaxaAndNamesConfigurator
;
44 import eu
.etaxonomy
.cdm
.common
.CdmUtils
;
45 import eu
.etaxonomy
.cdm
.hibernate
.HibernateProxyHelper
;
46 import eu
.etaxonomy
.cdm
.io
.specimen
.abcd206
.in
.Abcd206ImportConfigurator
;
47 import eu
.etaxonomy
.cdm
.model
.common
.ICdmBase
;
48 import eu
.etaxonomy
.cdm
.model
.common
.Language
;
49 import eu
.etaxonomy
.cdm
.model
.common
.MarkerType
;
50 import eu
.etaxonomy
.cdm
.model
.metadata
.CdmPreference
;
51 import eu
.etaxonomy
.cdm
.model
.metadata
.CdmPreference
.PrefKey
;
52 import eu
.etaxonomy
.cdm
.model
.metadata
.IPreferencePredicate
;
53 import eu
.etaxonomy
.cdm
.model
.metadata
.PreferencePredicate
;
54 import eu
.etaxonomy
.cdm
.model
.metadata
.PreferenceSubject
;
55 import eu
.etaxonomy
.cdm
.model
.metadata
.TermDisplayEnum
;
56 import eu
.etaxonomy
.cdm
.model
.name
.NomenclaturalCode
;
57 import eu
.etaxonomy
.cdm
.model
.term
.FeatureTree
;
58 import eu
.etaxonomy
.cdm
.model
.term
.IDefinedTerm
;
59 import eu
.etaxonomy
.cdm
.model
.term
.ISimpleTerm
;
60 import eu
.etaxonomy
.cdm
.model
.term
.TermBase
;
61 import eu
.etaxonomy
.cdm
.strategy
.match
.DefaultMatchStrategy
;
62 import eu
.etaxonomy
.cdm
.strategy
.match
.FieldMatcher
;
63 import eu
.etaxonomy
.cdm
.strategy
.match
.IMatchStrategy
;
64 import eu
.etaxonomy
.cdm
.strategy
.match
.MatchException
;
65 import eu
.etaxonomy
.cdm
.strategy
.match
.MatchMode
;
66 import eu
.etaxonomy
.taxeditor
.model
.AbstractUtility
;
67 import eu
.etaxonomy
.taxeditor
.model
.MessagingUtils
;
68 import eu
.etaxonomy
.taxeditor
.model
.NomenclaturalCodeHelper
;
69 import eu
.etaxonomy
.taxeditor
.remoting
.source
.CdmRemoteSource
;
70 import eu
.etaxonomy
.taxeditor
.store
.CdmStore
;
71 import eu
.etaxonomy
.taxeditor
.store
.internal
.TaxeditorStorePlugin
;
72 import eu
.etaxonomy
.taxeditor
.ui
.dialog
.DefaultLanguageDialog
;
76 * PreferencesUtil class.
83 public class PreferencesUtil
implements IPreferenceKeys
{
88 public static final String PREFERRED_TERMS_CHANGE
= "preferred_terms";
90 public static final String P2_REPOSITORIES_DELIM
= ",";
91 public static final String P2_REPOSITORY_FIELDS_DELIM
= ";";
93 private final static Logger logger
= Logger
.getLogger(PreferencesUtil
.class);
104 * @return a {@link org.eclipse.jface.preference.IPreferenceStore} object.
106 public static IPreferenceStore
getPreferenceStore() {
107 return TaxeditorStorePlugin
.getDefault().getPreferenceStore();
110 static String
prefKey(String name
) {
111 return name
+ "_"+ ((CdmRemoteSource
)CdmStore
.getActiveCdmSource()).toString();
114 public static String
prefOverrideKey(String name
) {
115 return name
+ "_OVERRIDE_";
125 public static void setStringValue(String name
, String value
) {
127 getPreferenceStore().setValue(prefKey(name
), value
);
129 getPreferenceStore().setToDefault(name
);
140 public static void setIntValue(String name
, int value
) {
141 getPreferenceStore().setValue(prefKey(name
), value
);
151 public static void setBooleanValue(String name
, boolean value
) {
152 getPreferenceStore().setValue(prefKey(name
), value
);
162 public static void setDoubleValue(String name
, double value
) {
163 getPreferenceStore().setValue(prefKey(name
), value
);
173 public static void setFloatValue(String name
, float value
) {
174 getPreferenceStore().setValue(prefKey(name
), value
);
184 public static void setLongValue(String name
, long value
) {
185 getPreferenceStore().setValue(prefKey(name
), value
);
195 public static String
getStringValue(String name
, boolean local
) {
197 CdmPreference pref
= getDBPreferenceValue(name
);
198 String prefValue
= null;
199 String overrideKey
= createPreferenceString(createOverridePreferenceString(name
));
200 boolean override
= true;
201 if (getPreferenceStore().contains(overrideKey
)){
202 override
= getPreferenceStore().getBoolean(overrideKey
);
204 if (local
|| pref
== null || (pref
!= null && pref
.isAllowOverride() && override
)){
205 String dbSpecific
= prefKey(name
);
206 if (getPreferenceStore().contains(dbSpecific
)){
207 prefValue
= getPreferenceStore().getString(dbSpecific
);
209 prefValue
= getPreferenceStore().
212 }else if (pref
!= null){
213 prefValue
= pref
.getValue();
219 public static String
getStringValue(String name
){
220 return getStringValue(name
, false);
223 private static CdmPreference
getDBPreferenceValue(String name
) {
224 CdmPreferenceCache cache
= CdmPreferenceCache
.instance();
225 CdmPreference pref
= null;
227 pref
= cache
.get(name
);
229 //get default value for Predicate
230 IPreferencePredicate pred
= PreferencePredicate
.getByKey(name
);
232 if (pred
.getDefaultValue() != null){
233 pref
= CdmPreference
.NewTaxEditorInstance(pred
, pred
.getDefaultValue().toString());
235 pref
= CdmPreference
.NewTaxEditorInstance(pred
, null);
237 pref
.setAllowOverride(true);
250 public static int getIntValue(String name
) {
251 CdmPreference pref
= getDBPreferenceValue(name
);
252 String prefValue
= null;
254 prefValue
= pref
.getValue();
256 Integer result
= null;
258 result
= Integer
.parseInt(prefValue
);
259 }catch(NumberFormatException e
){
260 logger
.debug("Preference value of " + name
+ " is not a number");
263 String dbSpecific
= prefKey(name
);
264 if (getPreferenceStore().contains(dbSpecific
)){
265 result
= getPreferenceStore().getInt(dbSpecific
);
267 result
= getPreferenceStore().
276 public static boolean getBooleanValue(String name
) {
277 return getBooleanValue(name
, false);
287 public static boolean getBooleanValue(String name
, boolean local
) {
288 if (CdmStore
.isActive()){
289 CdmPreference pref
= getDBPreferenceValue(name
);
290 String prefValue
= null;
291 if (pref
== null || local
){
292 String dbSpecific
= prefKey(name
);
293 if (getPreferenceStore().contains(dbSpecific
)){
294 return getPreferenceStore().getBoolean(dbSpecific
);
296 return getPreferenceStore().
300 return Boolean
.valueOf(pref
.getValue());
304 return getPreferenceStore().getBoolean(name
);
316 public static double getDoubleValue(String name
) {
317 CdmPreference pref
= getDBPreferenceValue(name
);
318 String prefValue
= null;
320 prefValue
= pref
.getValue();
322 Double result
= null;
324 result
= Double
.parseDouble(prefValue
);
325 }catch(NumberFormatException e
){
326 logger
.debug("Preference value of " + name
+ " is not a number");
329 String dbSpecific
= prefKey(name
);
330 if (getPreferenceStore().contains(dbSpecific
)){
331 result
= getPreferenceStore().getDouble(dbSpecific
);
333 result
= getPreferenceStore().
348 public static float getFloatValue(String name
) {
349 CdmPreference pref
= getDBPreferenceValue(name
);
350 String prefValue
= null;
352 prefValue
= pref
.getValue();
356 result
= Float
.parseFloat(prefValue
);
357 }catch(NumberFormatException e
){
358 logger
.debug("Preference value of " + name
+ " is not a number");
361 String dbSpecific
= prefKey(name
);
362 if (getPreferenceStore().contains(dbSpecific
)){
363 result
= getPreferenceStore().getFloat(dbSpecific
);
365 result
= getPreferenceStore().
380 public static long getLongValue(String name
) {
381 CdmPreference pref
= getDBPreferenceValue(name
);
382 String prefValue
= null;
384 prefValue
= pref
.getValue();
388 result
= Long
.parseLong(prefValue
);
389 }catch(NumberFormatException e
){
390 logger
.debug("Preference value of " + name
+ " is not a number");
393 String dbSpecific
= prefKey(name
);
394 if (getPreferenceStore().contains(dbSpecific
)){
395 result
= getPreferenceStore().getLong(dbSpecific
);
397 result
= getPreferenceStore().
407 * setPreferredNomenclaturalCode
410 * @param preferredCode
411 * a {@link eu.etaxonomy.cdm.model.name.NomenclaturalCode}
414 public static CdmPreference
setPreferredNomenclaturalCode(
415 String preferenceValue
, boolean local
) {
417 setStringValue(PREFERRED_NOMENCLATURAL_CODE_KEY
,
421 ICdmRepository controller
;
422 controller
= CdmStore
.getCurrentApplicationConfiguration();
423 if (controller
== null){
428 key
= CdmPreference
.NewKey(PreferenceSubject
.NewDatabaseInstance(), PreferencePredicate
.NomenclaturalCode
);
429 }catch (Exception e
){
430 System
.out
.println(e
.getStackTrace());
432 CdmPreference preference
= null;
434 if (preferenceValue
== null){
435 preference
= controller
.getPreferenceService().find(key
);
436 if (preference
== null){
439 setStringValue(PREFERRED_NOMENCLATURAL_CODE_KEY
,
440 preference
.getValue());
445 preference
= CdmPreference
.NewInstance(PreferenceSubject
.NewDatabaseInstance(), PreferencePredicate
.NomenclaturalCode
, preferenceValue
);
446 controller
.getPreferenceService().set(preference
);
458 * setPreferredNomenclaturalCode
461 * @param preferredCode
462 * a {@link eu.etaxonomy.cdm.model.name.NomenclaturalCode}
465 public static void setPreferredNomenclaturalCode(
466 CdmPreference preference
) {
468 ICdmRepository controller
;
469 controller
= CdmStore
.getCurrentApplicationConfiguration();
470 if (controller
== null){
475 key
= CdmPreference
.NewKey(PreferenceSubject
.NewDatabaseInstance(), PreferencePredicate
.NomenclaturalCode
);
476 }catch (Exception e
){
477 System
.out
.println(e
.getStackTrace());
480 controller
.getPreferenceService().set(preference
);
489 * getPreferredNomenclaturalCode
492 * @return a {@link eu.etaxonomy.cdm.model.name.NomenclaturalCode} object.
494 public static NomenclaturalCode
getPreferredNomenclaturalCode() {
496 CdmPreference pref
= getPreferenceFromDB(PreferencePredicate
.NomenclaturalCode
);
499 String preferredCode
;
500 if(pref
== null || (pref
.isAllowOverride() && getBooleanValue(prefOverrideKey(PreferencePredicate
.NomenclaturalCode
.getKey())))){
501 preferredCode
= getStringValue(
502 PreferencePredicate
.NomenclaturalCode
.getKey(), true);
505 preferredCode
= pref
.getValue();
507 if (StringUtils
.isBlank(preferredCode
)){
508 preferredCode
= getPreferenceKey((NomenclaturalCode
)PreferencePredicate
.NomenclaturalCode
.getDefaultValue());
511 return getPreferredNomenclaturalCode(preferredCode
);
517 * getPreferredNomenclaturalCode
520 * @return a {@link eu.etaxonomy.cdm.model.name.NomenclaturalCode} object.
522 public static NomenclaturalCode
getPreferredNomenclaturalCode(String preferenceKeyNomenclaturalCode
) {
524 for (NomenclaturalCode code
: NomenclaturalCodeHelper
.getAllCodes()) {
525 if (getPreferenceKey(code
).equals(preferenceKeyNomenclaturalCode
)) {
532 public static boolean isShowTaxonAssociations(){
533 boolean result
= getBooleanValue(PreferencePredicate
.ShowTaxonAssociations
.getKey());
537 public static boolean isShowLifeForm(){
538 boolean result
= getBooleanValue(PreferencePredicate
.ShowLifeForm
.getKey());
542 public static boolean isDeterminationOnlyForFieldUnits(){
543 boolean result
= getBooleanValue(PreferencePredicate
.DeterminationOnlyForFieldUnits
.getKey());
547 public static boolean isCollectingAreaInGeneralSection(){
548 boolean result
= getBooleanValue(PreferencePredicate
.ShowCollectingAreasInGeneralSection
.getKey());
552 public static CdmPreference
getPreferenceFromDB(IPreferencePredicate predicate
){
553 ICdmRepository controller
;
554 CdmPreference pref
= null;
557 if(CdmStore
.isActive()){
558 controller
= CdmStore
.getCurrentApplicationConfiguration();
559 PrefKey key
= CdmPreference
.NewKey(PreferenceSubject
.NewTaxEditorInstance(), predicate
);
560 pref
= controller
.getPreferenceService().find(key
);
570 public static List
<CdmPreference
> getPreferencesFromDB(IPreferencePredicate predicate
){
571 ICdmRepository controller
;
572 List
<CdmPreference
> prefs
= null;
575 if(CdmStore
.isActive()){
576 controller
= CdmStore
.getCurrentApplicationConfiguration();
577 PrefKey key
= CdmPreference
.NewKey(PreferenceSubject
.NewTaxEditorInstance(), predicate
);
578 prefs
= controller
.getPreferenceService().list(predicate
);
588 public static CdmPreference
getPreferenceFromDB(PrefKey key
){
589 ICdmRepository controller
;
590 CdmPreference pref
= null;
593 if(CdmStore
.isActive()){
594 controller
= CdmStore
.getCurrentApplicationConfiguration();
595 pref
= controller
.getPreferenceService().find(key
);
607 public static void setPreferenceToDB(CdmPreference preference
){
608 ICdmRepository controller
;
610 if(CdmStore
.isActive()){
611 controller
= CdmStore
.getCurrentApplicationConfiguration();
612 controller
.getPreferenceService().set(preference
);
613 CdmPreferenceCache
.instance().put(preference
);
623 public static String
getPreferredDefaultLangugae(){
624 String preferredLanguage
= getStringValue(DEFAULT_LANGUAGE_EDITOR
);
625 if(StringUtils
.isNotEmpty(preferredLanguage
) && StringUtils
.isNotBlank(preferredLanguage
)){
626 return preferredLanguage
;
631 public static boolean isShowMediaPreview(){
632 boolean isShowMediaPreview
= getBooleanValue(SHOW_MEDIA_PREVIEW
);
633 return isShowMediaPreview
;
637 * Get the match strategy for the given class that was stored in preferences
638 * or the default strategy if it was not stored in preferences
641 * a {@link java.lang.Class} object.
642 * @return a {@link eu.etaxonomy.cdm.strategy.match.IMatchStrategy} object.
644 public static IMatchStrategy
getMatchStrategy(Class
<?
> clazz
) {
645 String className
= clazz
.getName();
646 if (getBooleanValue(MATCH_STRATEGY_PREFIX
+ className
)) {
647 IMatchStrategy matchStrategy
= getDefaultMatchStrategy(clazz
);
649 //TODO CacheMatchers (or multiple field matchers in future) are missing here
650 for (FieldMatcher fieldMatcher
: matchStrategy
.getMatching().getFieldMatchers(false)) {
651 String fieldName
= fieldMatcher
.getPropertyName();
652 String matchModeName
= getStringValue(
653 getMatchStrategyFieldName(className
, fieldName
));
654 MatchMode matchMode
= MatchMode
.valueOf(matchModeName
);
656 matchStrategy
.setMatchMode(fieldName
, matchMode
);
657 } catch (MatchException e
) {
658 MessagingUtils
.error(PreferencesUtil
.class, e
);
659 throw new RuntimeException(e
);
663 return matchStrategy
;
665 return getDefaultMatchStrategy(clazz
);
669 * Stores a matchStrategy into the preference store.
671 * @param matchStrategy
672 * a {@link eu.etaxonomy.cdm.strategy.match.IMatchStrategy}
675 public static void setMatchStrategy(IMatchStrategy matchStrategy
) {
676 String className
= "ANY class"; //FIXME was: matchStrategy.getMatchClass().getName(); seems currently not in use
677 setBooleanValue(MATCH_STRATEGY_PREFIX
+ className
, true);
679 List
<FieldMatcher
> fieldMatchers
= matchStrategy
.getMatching().getFieldMatchers(false);
681 for (FieldMatcher fieldMatcher
: fieldMatchers
) {
682 String fieldName
= fieldMatcher
.getPropertyName();
684 getMatchStrategyFieldName(className
, fieldName
),
685 fieldMatcher
.getMatchMode().name());
690 * Helper method to create the preference property for a match field.
696 private static String
getMatchStrategyFieldName(String className
,
698 return MATCH_STRATEGY_PREFIX
+ className
+ "." + fieldName
;
702 * Returns the default match strategy for a given class.
705 * a {@link java.lang.Class} object.
706 * @return a {@link eu.etaxonomy.cdm.strategy.match.IMatchStrategy} object.
708 public static IMatchStrategy
getDefaultMatchStrategy(Class clazz
) {
709 return DefaultMatchStrategy
.NewInstance(clazz
);
714 * getDateFormatPattern
717 * @return a {@link java.lang.String} object.
719 public static String
getDateFormatPattern() {
720 // TODO make this configurable in properties
721 String pattern
= "Y-M-d H:m";
727 * addTermToPreferredTerms
735 public static <T
extends TermBase
> void addTermToPreferredTerms(T term
) {
737 // VocabularyEnum vocabulary =
738 // VocabularyEnum.getVocabularyEnum(term.getClass());
740 // getPreferenceStore().setValue(getPreferenceKey(term),
741 // VocabularyStore.getTermVocabulary(vocabulary).getTerms().contains(term));
743 // firePreferencesChanged(term.getClass());
747 * Construct a unique key using the CdmBase object's uuid
752 private static String
getPreferenceKey(ICdmBase cdmBase
) {
753 cdmBase
= HibernateProxyHelper
.deproxy(cdmBase
);
755 String key
= cdmBase
.getClass().getName().concat(".")
756 .concat(cdmBase
.getUuid().toString());
757 if (key
.contains("javassist")) {
758 MessagingUtils
.info("proxy");
764 * Construct a unique key using the CdmBase object's uuid
769 public static String
getPreferenceKey(ISimpleTerm simpleTerm
) {
770 simpleTerm
= HibernateProxyHelper
.deproxy(simpleTerm
);
771 String key
= simpleTerm
.getClass().getName().concat(".")
772 .concat(simpleTerm
.getUuid().toString());
773 if (key
.contains("javassist")) {
774 MessagingUtils
.warn(PreferencesUtil
.class,
775 "Trying to persist a preference based on a proxy class.");
783 * Construct a unique key using the CdmBase object's uuid
788 public static String
getPreferenceKey(IDefinedTerm definedTerm
) {
789 definedTerm
= HibernateProxyHelper
.deproxy(definedTerm
);
790 String key
= definedTerm
.getClass().getName().concat(".")
791 .concat(definedTerm
.getUuid().toString());
792 if (key
.contains("javassist")) {
793 MessagingUtils
.warn(PreferencesUtil
.class,
794 "Trying to persist a preference based on a proxy class.");
800 * Retrieves search preferences from the preference store
802 * @return an {@link ITaxonServiceConfigurator} to pass to search methods
804 public static IFindTaxaAndNamesConfigurator
getSearchConfigurator() {
805 IFindTaxaAndNamesConfigurator configurator
= initializeSearchConfigurator();
807 configurator
.setDoTaxa(getBooleanValue(
808 TAXON_SERVICE_CONFIGURATOR_TAXA
));
809 configurator
.setDoSynonyms(getBooleanValue(
810 TAXON_SERVICE_CONFIGURATOR_SYNONYMS
));
811 configurator
.setDoNamesWithoutTaxa(getBooleanValue(
812 TAXON_SERVICE_CONFIGURATOR_NAMES
));
813 configurator
.setDoTaxaByCommonNames(getBooleanValue(
814 TAXON_SERVICE_CONFIGURATOR_COMMON_NAMES
));
815 //configurator.setMatchMode(eu.etaxonomy.cdm.persistence.query.MatchMode.valueOf(getStringValue(TAXON_SERVICE_CONFIGURATOR_MATCH_MODE)));
821 * create new preferences, setting all search options to true
824 * {@link eu.etaxonomy.cdm.api.service.config.ITaxonServiceConfigurator}
827 public static IFindTaxaAndNamesConfigurator
initializeSearchConfigurator() {
828 IFindTaxaAndNamesConfigurator configurator
= FindTaxaAndNamesConfiguratorImpl
.NewInstance();
830 configurator
.setDoTaxa(true);
831 configurator
.setDoSynonyms(true);
832 configurator
.setDoNamesWithoutTaxa(true);
833 configurator
.setDoTaxaByCommonNames(true);
835 configurator
.setTaxonPropertyPath(Arrays
.asList("$", "titleCache",
836 "name", "name.$", "relationsFromThisTaxon.$"));
838 configurator
.setSynonymPropertyPath(Arrays
.asList("$", "titleCache",
839 "name", "name.$", "synonyms.relatedTo.*"));
842 // match mode is a simple like, actually all other match modes are kind
845 .setMatchMode(eu
.etaxonomy
.cdm
.persistence
.query
.MatchMode
.ANYWHERE
);
846 // we set page number and size here as this should always be unlimited
847 configurator
.setPageNumber(0);
848 // TODO currently limit results to 10000
849 configurator
.setPageSize(10000);
850 setSearchConfigurator(configurator
) ;
855 * Store search preferences
857 * @param configurator
859 * {@link eu.etaxonomy.cdm.api.service.config.ITaxonServiceConfigurator}
862 public static void setSearchConfigurator(
863 IFindTaxaAndNamesConfigurator configurator
) {
864 getPreferenceStore().setValue(TAXON_SERVICE_CONFIGURATOR_TAXA
,
865 configurator
.isDoTaxa());
866 getPreferenceStore().setValue(TAXON_SERVICE_CONFIGURATOR_SYNONYMS
,
867 configurator
.isDoSynonyms());
868 getPreferenceStore().setValue(TAXON_SERVICE_CONFIGURATOR_NAMES
,
869 configurator
.isDoNamesWithoutTaxa());
870 getPreferenceStore().setValue(TAXON_SERVICE_CONFIGURATOR_COMMON_NAMES
,
871 configurator
.isDoTaxaByCommonNames());
876 * firePreferencesChanged
880 * a {@link java.lang.Class} object.
882 public static void firePreferencesChanged(Class clazz
) {
883 getPreferenceStore().firePropertyChangeEvent(PREFERRED_TERMS_CHANGE
,
887 public static String
createPreferenceString(String property
){
888 return prefKey(property
);
891 public static String
createOverridePreferenceString(String property
){
892 return prefOverrideKey(property
);
897 * Set default values for preferences
899 public static void setDefaults() {
900 getPreferenceStore().setDefault(TAXON_SERVICE_CONFIGURATOR_TAXA
, true);
901 getPreferenceStore().setDefault(TAXON_SERVICE_CONFIGURATOR_SYNONYMS
,
903 getPreferenceStore().setDefault(createPreferenceString(EDIT_MAP_SERVICE_ACCES_POINT
),
904 "http://edit.africamuseum.be/edit_wp5/v1.2/rest_gen.php");
905 //FIXME : changed default for SHOULD_CONNECT_AT_STARTUP to false (ticket 3828) until resolution
906 getPreferenceStore().setDefault(createPreferenceString(SHOULD_CONNECT_AT_STARTUP
), false);
907 getPreferenceStore().setDefault(createPreferenceString(OPENURL_ACCESS_POINT
),
908 "http://www.biodiversitylibrary.org/openurl");
909 getPreferenceStore().setDefault(createPreferenceString(OPENURL_IMAGE_MAX_WIDTH
), "1000");
910 getPreferenceStore().setDefault(createPreferenceString(OPENURL_IMAGE_MAX_HEIGHT
), "1000");
911 //Distribution Editor:
912 getPreferenceStore().setDefault(createPreferenceString(PreferencePredicate
.DistributionEditorActivated
.getKey()), Boolean
.valueOf(PreferencePredicate
.DistributionEditorActivated
.getDefaultValue().toString()));
913 // getPreferenceStore().setDefault(createPreferenceString(PreferencePredicate.DisplayOfAreasInDistributionEditor.getKey()), PreferencePredicate.DisplayOfAreasInDistributionEditor.getDefaultValue().toString());
914 // getPreferenceStore().setDefault(createPreferenceString(PreferencePredicate.DisplayOfStatus.getKey()), PreferencePredicate.DisplayOfStatus.getDefaultValue().toString());
918 getPreferenceStore().setDefault(createPreferenceString(PreferencePredicate
.NameDetailsView
.getKey()), new NameDetailsConfigurator(false).toString());
920 //Navigator preferences
921 getPreferenceStore().setDefault(createPreferenceString(PreferencePredicate
.TaxonNodeOrder
.getKey()), NavigatorOrderEnum
.RankAndNameOrder
.getKey());
923 getPreferenceStore().setDefault(createPreferenceString(SORT_TAXA_BY_RANK_AND_NAME
), true);
925 getPreferenceStore().setDefault(createPreferenceString(SHOW_ADVANCED_MEDIA_SECTION
), false);
927 getPreferenceStore().setDefault(createPreferenceString(SHOW_MEDIA_PREVIEW
), false);
928 //override db preferences
929 getPreferenceStore().setDefault(createPreferenceString(prefOverrideKey(PreferencePredicate
.AbcdImportConfig
.getKey())), false);
930 getPreferenceStore().setDefault(createPreferenceString(prefOverrideKey(PreferencePredicate
.ShowSpecimen
.getKey())), true);
931 getPreferenceStore().setDefault(createPreferenceString(prefOverrideKey(PreferencePredicate
.NameDetailsView
.getKey())), false);
932 getPreferenceStore().setDefault(createPreferenceString(prefOverrideKey(PreferencePredicate
.DistributionEditorActivated
.getKey())), true);
933 getPreferenceStore().setDefault(createPreferenceString(prefOverrideKey(PreferencePredicate
.AvailableDistributionStatus
.getKey())), true);
934 getPreferenceStore().setDefault(createPreferenceString(prefOverrideKey(PreferencePredicate
.AvailableDistributionAreaTerms
.getKey())), true);
935 getPreferenceStore().setDefault(createPreferenceString(prefOverrideKey(PreferencePredicate
.AvailableDistributionAreaVocabularies
.getKey())), true);
936 getPreferenceStore().setDefault(createPreferenceString(prefOverrideKey(PreferencePredicate
.CommonNameAreaVocabularies
.getKey())), false);
937 getPreferenceStore().setDefault(createPreferenceString(FILTER_COMMON_NAME_REFERENCES
), false);
938 getPreferenceStore().setDefault(createPreferenceString(PreferencePredicate
.ShowTaxonNodeWizard
.getKey()), Boolean
.valueOf(PreferencePredicate
.ShowTaxonNodeWizard
.getDefaultValue().toString()));
939 getPreferenceStore().setDefault(createPreferenceString(PreferencePredicate
.ShowNamespaceInSource
.getKey()), Boolean
.valueOf(PreferencePredicate
.ShowNamespaceInSource
.getDefaultValue().toString()));
940 getPreferenceStore().setDefault(createPreferenceString(PreferencePredicate
.ShowIdInSource
.getKey()), Boolean
.valueOf(PreferencePredicate
.ShowIdInSource
.getDefaultValue().toString()));
941 getPreferenceStore().setDefault(createPreferenceString(PreferencePredicate
.DisableMultiClassification
.getKey()), Boolean
.valueOf(PreferencePredicate
.DisableMultiClassification
.getDefaultValue().toString()));
942 getPreferenceStore().setDefault(createPreferenceString(PreferencePredicate
.ShowImportExportMenu
.getKey()), Boolean
.valueOf(PreferencePredicate
.ShowImportExportMenu
.getDefaultValue().toString()));
948 * checkNomenclaturalCode
951 public static void checkNomenclaturalCode() {
952 // First time Editor is opened, no nomenclatural code has been set
953 if (PreferencesUtil
.getPreferredNomenclaturalCode() == null) {
954 PreferencesUtil
.setPreferredNomenclaturalCode(getPreferenceKey(NomenclaturalCode
.ICNAFP
), true);
960 public static void setNomenclaturalCodePreferences(){
961 ICdmRepository controller
;
962 controller
= CdmStore
.getCurrentApplicationConfiguration();
963 PrefKey key
= CdmPreference
.NewKey(PreferenceSubject
.NewDatabaseInstance(), PreferencePredicate
.NomenclaturalCode
);
964 CdmPreference preference
= null;
965 if (controller
== null){
968 preference
= controller
.getPreferenceService().find(key
);
969 if (preference
== null){
972 // setBooleanValue(ALLOW_OVERRIDE_NOMENCLATURAL_CODE_KEY, preference.isAllowOverride());
974 int index
= StringUtils
.lastIndexOf(preference
.getValue(), ".");
975 UUID uuid
= UUID
.fromString(preference
.getValue().substring(index
+1, preference
.getValue().length()));
976 NomenclaturalCode preferredCode
= NomenclaturalCode
.getByUuid(uuid
);
978 setStringValue(PREFERRED_NOMENCLATURAL_CODE_KEY
,
979 getPreferenceKey(preferredCode
));
983 public static void checkDefaultLanguage(){
984 if(PreferencesUtil
.getPreferredDefaultLangugae() == null){
985 Shell shell
= AbstractUtility
.getShell();
986 int open
= new DefaultLanguageDialog(shell
).open();
987 if(open
== Window
.OK
){
988 PlatformUI
.getWorkbench().restart();
991 //TODO:In case of a reinstall, the config.ini will be overwritten
992 // here you create config.ini with the stored key from preferences
998 * getMapServiceAccessPoint
1001 * @return a {@link java.lang.String} object.
1003 public static String
getMapServiceAccessPoint() {
1004 return getStringValue(EDIT_MAP_SERVICE_ACCES_POINT
);
1009 * shouldConnectAtStartUp
1012 * @return a boolean.
1014 public static boolean shouldConnectAtStartUp() {
1015 //FIXME : force SHOULD_CONNECT_AT_STARTUP to false (ticket 3828) until resolution
1016 //return getBooleanValue(SHOULD_CONNECT_AT_STARTUP);
1022 * getDefaultFeatureTreeForTextualDescription
1025 * @return a {@link eu.etaxonomy.cdm.model.term.FeatureTree} object.
1027 public static FeatureTree
getDefaultFeatureTreeForTextualDescription() {
1028 String uuidString
= getStringValue(
1029 FEATURE_TREE_DEFAULT_TEXT
);
1030 if (StringUtils
.isBlank(uuidString
)) {
1033 FeatureTree tree
= CdmStore
.getService(
1034 IFeatureTreeService
.class).load(UUID
.fromString(uuidString
));
1035 if (tree
.getId() == 0) {
1043 * getDefaultFeatureTreeForStructuredDescription
1046 * @return a {@link eu.etaxonomy.cdm.model.term.FeatureTree} object.
1048 public static FeatureTree
getDefaultFeatureTreeForStructuredDescription() {
1049 String uuidString
= getStringValue(
1050 FEATURE_TREE_DEFAULT_STRUCTURE
);
1051 return CdmUtils
.isEmpty(uuidString
) ?
null : CdmStore
.getService(
1052 IFeatureTreeService
.class).load(UUID
.fromString(uuidString
));
1057 * setSortRanksHierarchichally
1063 public static void setSortRanksHierarchichally(boolean selection
) {
1064 setBooleanValue(SORT_RANKS_HIERARCHICHALLY
, selection
);
1069 * getSortRanksHierarchichally
1072 * @return a boolean.
1074 public static boolean getSortRanksHierarchichally() {
1075 return getBooleanValue(SORT_RANKS_HIERARCHICHALLY
);
1078 public static boolean isMultilanguageTextEditingCapability() {
1079 return getBooleanValue(
1080 MULTILANGUAGE_TEXT_EDITING_CAPABILITY
);
1083 public static Language
getGlobalLanguage() {
1086 String languageUuidString
= getStringValue(
1087 GLOBAL_LANGUAGE_UUID
);
1089 if(!CdmStore
.isActive()) {
1090 MessagingUtils
.noDataSourceWarningDialog(languageUuidString
);
1094 if (CdmUtils
.isBlank(languageUuidString
)) {
1095 return Language
.getDefaultLanguage();
1098 UUID languageUuid
= UUID
.fromString(languageUuidString
);
1099 return (Language
) CdmStore
.getService(ITermService
.class).load(
1103 public static void setGlobalLanguage(Language language
) {
1104 if(language
!= null) {
1105 setStringValue(GLOBAL_LANGUAGE_UUID
,language
.getUuid().toString());
1106 CdmStore
.setDefaultLanguage(language
);
1114 public static Map
<MarkerType
, Boolean
> getEditMarkerTypePreferences() {
1115 List
<MarkerType
> markerTypes
= CdmStore
.getTermManager()
1116 .getPreferredTerms(MarkerType
.class);
1118 Map
<MarkerType
, Boolean
> result
= new HashMap
<MarkerType
, Boolean
>();
1120 for (MarkerType markerType
: markerTypes
) {
1121 String name
= getMarkerTypeEditingPreferenceKey(markerType
);
1122 Boolean value
= getBooleanValue(name
);
1124 result
.put(markerType
, value
);
1131 * @param markerTypeEditingMap
1133 public static void setEditMarkerTypePreferences(
1134 Map
<MarkerType
, Boolean
> markerTypeEditingMap
) {
1135 for (MarkerType markerType
: markerTypeEditingMap
.keySet()) {
1136 String name
= getMarkerTypeEditingPreferenceKey(markerType
);
1137 setBooleanValue(name
,
1138 markerTypeEditingMap
.get(markerType
));
1143 private static String
getMarkerTypeEditingPreferenceKey(
1144 MarkerType markerType
) {
1145 markerType
= HibernateProxyHelper
.deproxy(markerType
);
1146 return markerType
.getClass().getName() + EDIT_MARKER_TYPE_PREFIX
;
1151 * setEditMarkerTypePreference
1155 * a {@link org.eclipse.ui.IEditorInput} object.
1157 * a {@link eu.etaxonomy.cdm.model.common.MarkerType} object.
1161 public static void setEditMarkerTypePreference(MarkerType markerType
,
1164 getMarkerTypeEditingPreferenceKey(markerType
), edit
);
1170 public static DerivedUnitFacadeConfigurator
getDerivedUnitConfigurator() {
1171 DerivedUnitFacadeConfigurator configurator
= DerivedUnitFacadeConfigurator
1173 configurator
.setMoveDerivedUnitMediaToGallery(true);
1174 configurator
.setMoveFieldObjectMediaToGallery(true);
1175 return configurator
;
1179 * This method will write language properties to the config.ini located in the configuration folder
1180 * of the Taxonomic Ediitor. <b>This method is only used to set the default language for Taxonomic Editor.</b>
1182 * @param setLanguage 0 is for german and 1 for english.
1183 * @throws IOException
1185 public void writePropertyToConfigFile(int setLanguage
) throws IOException
{
1186 File file
= org
.eclipse
.core
.runtime
.preferences
.ConfigurationScope
.INSTANCE
.getLocation().toFile();
1187 //give warning to user if the directory has no write access
1189 throw new IOException();
1191 Properties properties
= load(file
.getAbsolutePath()+"/config.ini");
1192 switch(setLanguage
){
1194 properties
.setProperty("osgi.nl", "de");
1195 setStringValue(IPreferenceKeys
.DEFAULT_LANGUAGE_EDITOR
, "de");
1198 properties
.setProperty("osgi.nl", "en");
1199 setStringValue(IPreferenceKeys
.DEFAULT_LANGUAGE_EDITOR
, "en");
1204 save(file
+"/config.ini", properties
);
1208 * This method loads a property from a given file and returns it.
1212 * @throws IOException
1214 private Properties
load(String filename
) throws IOException
{
1215 FileInputStream in
= new FileInputStream(filename
);
1216 Properties prop
= new Properties();
1223 * This method saves a property to the specified file.
1227 * @throws IOException
1229 private void save(String filename
, Properties properties
) throws IOException
{
1230 FileOutputStream fos
= new FileOutputStream(filename
);
1231 properties
.store(fos
, "");
1236 * Saves a list of P2 Metadata Repositories as string with specified delimiters
1240 public static void setP2Repositories(List
<MetadataRepositoryElement
> p2Repos
) {
1241 StringBuilder sb
= new StringBuilder();
1242 for(MetadataRepositoryElement p2Repo
: p2Repos
) {
1243 sb
.append(P2_REPOSITORIES_DELIM
);
1244 if(p2Repo
.getName() == null || p2Repo
.getName().isEmpty()) {
1247 sb
.append(p2Repo
.getName());
1249 sb
.append(P2_REPOSITORY_FIELDS_DELIM
);
1250 sb
.append(p2Repo
.getLocation().toString());
1251 sb
.append(P2_REPOSITORY_FIELDS_DELIM
);
1252 sb
.append(String
.valueOf(p2Repo
.isEnabled()));
1254 getPreferenceStore().setValue(P2_REPOSITORY_LIST
, sb
.toString());
1259 * Retrieves a list of previously saved P2 repositories
1263 public static List
<MetadataRepositoryElement
> getP2Repositories() {
1264 List
<MetadataRepositoryElement
> p2Repos
= new ArrayList
<MetadataRepositoryElement
>();
1265 String p2ReposPref
= getStringValue(P2_REPOSITORY_LIST
);
1266 if(p2ReposPref
!= null && !p2ReposPref
.isEmpty()) {
1267 StringTokenizer p2ReposPrefST
= new StringTokenizer(p2ReposPref
,P2_REPOSITORIES_DELIM
);
1269 while(p2ReposPrefST
.hasMoreTokens()) {
1270 String p2RepoStr
= p2ReposPrefST
.nextToken();
1271 StringTokenizer p2ReposStrST
= new StringTokenizer(p2RepoStr
,P2_REPOSITORY_FIELDS_DELIM
);
1272 if(p2ReposStrST
.countTokens()==3) {
1273 String nickname
= p2ReposStrST
.nextToken();
1276 uri
= new URI(p2ReposStrST
.nextToken());
1277 } catch (URISyntaxException e
) {
1280 boolean enabled
= Boolean
.parseBoolean(p2ReposStrST
.nextToken());
1281 MetadataRepositoryElement mre
= new MetadataRepositoryElement(null, uri
, true);
1282 mre
.setNickname(nickname
);
1283 mre
.setEnabled(enabled
);
1293 * enables/disables nested composite. <br>
1295 * @param ctrl - Composite to be en-/disabeld
1296 * @param enabled - boolean
1298 public static void recursiveSetEnabled(Control ctrl
, boolean enabled
) {
1299 if (ctrl
instanceof Composite
) {
1300 Composite comp
= (Composite
) ctrl
;
1301 for (Control c
: comp
.getChildren()) {
1302 recursiveSetEnabled(c
, enabled
);
1305 ctrl
.setEnabled(enabled
);
1313 * @param orderActivated
1315 public static void setSortNodes(NavigatorOrderEnum nodesOrder
) {
1316 setStringValue(PreferencePredicate
.TaxonNodeOrder
.getKey(), nodesOrder
.key
);
1321 * @param orderActivated
1323 public static NavigatorOrderEnum
getSortNodes() {
1324 return NavigatorOrderEnum
.valueOf(getStringValue(PreferencePredicate
.TaxonNodeOrder
.getKey()));
1329 * @param orderActivated
1331 public static boolean isNodesSortedNaturally() {
1332 NavigatorOrderEnum value
= NavigatorOrderEnum
.valueOf(getStringValue(PreferencePredicate
.TaxonNodeOrder
.getKey()));
1333 return value
.equals(NavigatorOrderEnum
.NaturalOrder
);
1338 * @param orderActivated
1340 public static boolean isNodesSortedByName() {
1341 NavigatorOrderEnum value
= NavigatorOrderEnum
.valueOf(getStringValue(PreferencePredicate
.TaxonNodeOrder
.getKey()));
1342 return value
.equals(NavigatorOrderEnum
.AlphabeticalOrder
);
1347 * @param orderActivated
1349 public static boolean isNodesSortedByNameAndRank() {
1350 NavigatorOrderEnum value
= NavigatorOrderEnum
.valueOf(getStringValue(PreferencePredicate
.TaxonNodeOrder
.getKey()));
1351 return value
.equals(NavigatorOrderEnum
.RankAndNameOrder
);
1356 * setStoreNavigatorState
1362 public static boolean isStoreNavigatorState() {
1363 return getBooleanValue(RESTORE_NAVIGATOR_STATE
);
1369 * setStoreNavigatorState
1375 public static void setStoreNavigatorState(boolean selection
) {
1376 setBooleanValue(RESTORE_NAVIGATOR_STATE
, selection
);
1383 public static boolean isShowUpWidgetIsDisposedMessages() {
1384 return getBooleanValue(IS_SHOW_UP_WIDGET_IS_DISPOSED
);
1386 public static void setShowUpWidgetIsDisposedMessages(boolean selection
) {
1387 setBooleanValue(IS_SHOW_UP_WIDGET_IS_DISPOSED
, selection
);
1393 public static boolean isShowIdInVocabularyInChecklistEditor() {
1394 String area_display
= getStringValue(PreferencePredicate
.DisplayOfAreasInDistributionEditor
.getKey());
1395 if (area_display
.equals(TermDisplayEnum
.IdInVocabulary
.getKey())) {
1401 public static boolean isShowSymbol1InChecklistEditor() {
1402 String area_display
= getStringValue(PreferencePredicate
.DisplayOfAreasInDistributionEditor
.getKey());
1403 if (area_display
.equals(TermDisplayEnum
.Symbol1
.getKey())) {
1409 public static boolean isShowSymbol2InChecklistEditor() {
1410 String area_display
= getStringValue(PreferencePredicate
.DisplayOfAreasInDistributionEditor
.getKey());
1411 if (area_display
.equals(TermDisplayEnum
.Symbol2
.getKey())) {
1417 public static void setAreaDisplayInChecklistEditor(String selection
) {
1418 setStringValue(PreferencePredicate
.DisplayOfAreasInDistributionEditor
.getKey(), selection
);
1421 public static void setOwnDescriptionForChecklistEditor(boolean selection
) {
1422 setBooleanValue(PreferencePredicate
.OwnDescriptionForDistributionEditor
.getKey(), selection
);
1425 public static boolean isOwnDescriptionForChecklistEditor() {
1426 return getBooleanValue(PreferencePredicate
.OwnDescriptionForDistributionEditor
.getKey());
1432 public static String
displayAreaInChecklistEditor() {
1433 String result
= getStringValue(PreferencePredicate
.DisplayOfAreasInDistributionEditor
.getKey());
1434 if (StringUtils
.isBlank(result
)){
1435 return ((TermDisplayEnum
) PreferencePredicate
.DisplayOfAreasInDistributionEditor
.getDefaultValue()).getKey();
1443 public static String
displayStatusInChecklistEditor() {
1444 String result
= getStringValue(PreferencePredicate
.DisplayOfStatus
.getKey());
1445 if (StringUtils
.isBlank(result
)){
1446 return((TermDisplayEnum
) PreferencePredicate
.DisplayOfStatus
.getDefaultValue()).getKey();
1450 public static void setDisplayStatusInChecklistEditor(String selection
) {
1451 setStringValue(PreferencePredicate
.DisplayOfStatus
.getKey(), selection
);
1458 public static boolean isShowRankInChecklistEditor() {
1459 return getBooleanValue(PreferencePredicate
.ShowRankInDistributionEditor
.getKey());
1461 public static void setShowRankInChecklistEditor(boolean selection
) {
1462 setBooleanValue(PreferencePredicate
.ShowRankInDistributionEditor
.getKey(), selection
);
1470 public static NameDetailsConfigurator
getPreferredNameDetailsConfiguration( boolean local
) {
1471 NameDetailsConfigurator config
= new NameDetailsConfigurator(true);
1472 CdmPreferenceCache cache
= CdmPreferenceCache
.instance();
1473 CdmPreference preference
= null;
1476 PrefKey key
= CdmPreference
.NewKey(PreferenceSubject
.NewTaxEditorInstance(), PreferencePredicate
.NameDetailsView
);
1477 preference
= cache
.findBestMatching(key
);
1478 if (preference
== null){
1482 // setBooleanValue(ALLOW_OVERRIDE_NAME_DETAILS, preference.isAllowOverride());
1483 value
= preference
.getValue();
1484 config
.setAllowOverride(preference
.isAllowOverride());
1485 //the preference value is build like this:
1486 //<section1>:true;<section2>:false....
1488 value
= getStringValue(PreferencePredicate
.NameDetailsView
.getKey(), local
);
1490 String
[] sections
= value
.split(";");
1491 Map
<String
, Boolean
> sectionMap
= new HashMap
<String
, Boolean
>();
1492 String
[] sectionValues
;
1493 for (String sectionValue
: sections
){
1494 sectionValues
= sectionValue
.split(":");
1495 sectionMap
.put(sectionValues
[0], Boolean
.valueOf(sectionValues
[1]));
1498 config
.setSimpleDetailsViewActivated(getValue(sectionMap
, "simpleViewActivated"));
1500 config
.setTaxonSectionActivated(getValue(sectionMap
, "taxon"));
1502 config
.setSecDetailsActivated(getValue(sectionMap
, "taxon.SecDetails"));
1503 config
.setSecEnabled(getValue(sectionMap
, "taxon.SecEnabled"));
1505 config
.setLSIDActivated(getValue(sectionMap
, "lsid"));
1507 config
.setNomenclaturalCodeActived(getValue(sectionMap
, "nc"));
1509 config
.setAppendedPhraseActivated(getValue(sectionMap
, "ap"));
1511 config
.setRankActivated(getValue(sectionMap
, "rank"));
1513 config
.setAtomisedEpithetsActivated(getValue(sectionMap
, "atomisedEpithets"));
1515 config
.setAuthorshipSectionActivated(getValue(sectionMap
,"author"));
1517 config
.setNomenclaturalReferenceSectionActivated(sectionMap
.get("nomRef"));
1519 config
.setNomenclaturalStatusSectionActivated(getValue(sectionMap
, "nomStat"));
1521 config
.setProtologueActivated(getValue(sectionMap
,"protologue"));
1523 config
.setTypeDesignationSectionActivated(getValue(sectionMap
,"typeDes"));
1525 config
.setNameRelationsSectionActivated(getValue(sectionMap
,"nameRelation"));
1527 config
.setHybridActivated(getValue(sectionMap
,"hybrid"));
1532 public static NameDetailsConfigurator
getPreferredNameDetailsConfiguration() {
1533 NameDetailsConfigurator config
= new NameDetailsConfigurator(true);
1537 value
= getStringValue(PreferencePredicate
.NameDetailsView
.getKey(), false);
1539 String
[] sections
= value
.split(";");
1540 Map
<String
, Boolean
> sectionMap
= new HashMap
<String
, Boolean
>();
1541 String
[] sectionValues
;
1542 for (String sectionValue
: sections
){
1543 sectionValues
= sectionValue
.split(":");
1544 sectionMap
.put(sectionValues
[0], Boolean
.valueOf(sectionValues
[1]));
1547 config
.setSimpleDetailsViewActivated(getValue(sectionMap
, "simpleViewActivated"));
1549 config
.setTaxonSectionActivated(getValue(sectionMap
, "taxon"));
1551 config
.setSecDetailsActivated(getValue(sectionMap
, "taxon.SecDetails"));
1552 config
.setSecEnabled(getValue(sectionMap
, "taxon.SecEnabled"));
1554 config
.setLSIDActivated(getValue(sectionMap
, "lsid"));
1556 config
.setNomenclaturalCodeActived(getValue(sectionMap
, "nc"));
1558 config
.setAppendedPhraseActivated(getValue(sectionMap
, "ap"));
1560 config
.setRankActivated(getValue(sectionMap
, "rank"));
1562 config
.setAtomisedEpithetsActivated(getValue(sectionMap
, "atomisedEpithets"));
1564 config
.setAuthorshipSectionActivated(getValue(sectionMap
,"author"));
1566 config
.setNomenclaturalReferenceSectionActivated(sectionMap
.get("nomRef"));
1568 config
.setNomenclaturalStatusSectionActivated(getValue(sectionMap
, "nomStat"));
1570 config
.setProtologueActivated(getValue(sectionMap
,"protologue"));
1572 config
.setTypeDesignationSectionActivated(getValue(sectionMap
,"typeDes"));
1574 config
.setNameRelationsSectionActivated(getValue(sectionMap
,"nameRelation"));
1576 config
.setHybridActivated(getValue(sectionMap
,"hybrid"));
1587 public static void setPreferredNameDetailsConfiguration(NameDetailsConfigurator config
, boolean local
) {
1588 CdmPreference preference
= null;
1591 preference
= CdmPreference
.NewInstance(PreferenceSubject
.NewTaxEditorInstance(), PreferencePredicate
.NameDetailsView
, config
.toString());
1593 setPreferenceToDB(preference
);
1596 setStringValue(PreferencePredicate
.NameDetailsView
.getKey(), config
.toString());
1602 private static Boolean
getValue(Map
<String
, Boolean
> sectionMap
, String string
) {
1603 if (sectionMap
.containsKey(string
)){
1604 return sectionMap
.get(string
);
1615 * setAbcdConfigurator
1618 * @param preferredConfiguration
1619 * a {@link eu.etaxonomy.cdm.io.specimen.abcd206.in.Abcd206ImportConfigurator}
1622 public static Abcd206ImportConfigurator
getDBAbcdImportConfigurationPreference() {
1624 Abcd206ImportConfigurator config
= Abcd206ImportConfigurator
.NewInstance(null,null);
1625 ICdmRepository controller
;
1626 controller
= CdmStore
.getCurrentApplicationConfiguration();
1627 PrefKey key
= CdmPreference
.NewKey(PreferenceSubject
.NewTaxEditorInstance(), PreferencePredicate
.AbcdImportConfig
);
1628 CdmPreference preference
= null;
1629 if (controller
== null){
1632 preference
= controller
.getPreferenceService().find(key
);
1633 if (preference
== null){
1636 String configString
= preference
.getValue();
1637 String
[] configArray
= configString
.split(";");
1639 for (String configItem
: configArray
){
1640 String
[] keyValue
= configItem
.split(":");
1641 String keyString
= keyValue
[0];
1642 String valueString
= null;
1643 if (keyValue
.length
>1){
1644 valueString
= keyValue
[1];
1646 if (keyString
.equals("ignoreImportOfExistingSpecimen")){
1647 config
.setIgnoreImportOfExistingSpecimen(Boolean
.valueOf(valueString
));
1648 }else if (keyString
.equals("addIndividualsAssociationsSuchAsSpecimenAndObservations")){
1649 config
.setAddIndividualsAssociationsSuchAsSpecimenAndObservations(Boolean
.valueOf(valueString
));
1650 }else if (keyString
.equals("reuseExistingTaxaWhenPossible")){
1651 config
.setReuseExistingTaxaWhenPossible(Boolean
.valueOf(valueString
));
1652 }else if (keyString
.equals("ignoreAuthorship")){
1653 config
.setIgnoreAuthorship(Boolean
.valueOf(valueString
));
1654 }else if (keyString
.equals("addMediaAsMediaSpecimen")){
1655 config
.setAddMediaAsMediaSpecimen(Boolean
.valueOf(valueString
));
1656 }else if (keyString
.equals("reuseExistingMetaData")){
1657 config
.setReuseExistingMetaData(Boolean
.valueOf(valueString
));
1658 }else if (keyString
.equals("reuseExistingDescriptiveGroups")){
1659 config
.setReuseExistingDescriptiveGroups(Boolean
.valueOf(valueString
));
1660 }else if (keyString
.equals("allowReuseOtherClassifications")){
1661 config
.setAllowReuseOtherClassifications(Boolean
.valueOf(valueString
));
1662 }else if (keyString
.equals("deduplicateReferences")){
1663 config
.setDeduplicateReferences(Boolean
.valueOf(valueString
));
1664 }else if (keyString
.equals("deduplicateClassifications")){
1665 config
.setDeduplicateClassifications(Boolean
.valueOf(valueString
));
1666 }else if (keyString
.equals("moveNewTaxaToDefaultClassification")){
1667 config
.setMoveNewTaxaToDefaultClassification(Boolean
.valueOf(valueString
));
1668 }else if (keyString
.equals("mapUnitIdToCatalogNumber")){
1669 config
.setMapUnitIdToCatalogNumber(Boolean
.valueOf(valueString
));
1670 }else if (keyString
.equals("mapUnitIdToAccessionNumber")){
1671 config
.setMapUnitIdToAccessionNumber(Boolean
.valueOf(valueString
));
1672 }else if (keyString
.equals("mapUnitIdToBarcode")){
1673 config
.setMapUnitIdToBarcode(Boolean
.valueOf(valueString
));
1674 }else if (keyString
.equals("overwriteExistingSpecimens")){
1675 config
.setOverwriteExistingSpecimens(Boolean
.valueOf(valueString
));
1676 }else if (keyString
.equals("nomenclaturalCode")){
1677 config
.setNomenclaturalCode(NomenclaturalCode
.fromString(valueString
));
1679 logger
.debug("This key of the abcd configurator needs to be added to the transformer: " + keyString
);
1687 public static Abcd206ImportConfigurator
getLocalAbcdImportConfigurator(){
1688 Abcd206ImportConfigurator config
= Abcd206ImportConfigurator
.NewInstance(null,null);
1690 config
.setAddIndividualsAssociationsSuchAsSpecimenAndObservations(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_ADD_INDIVIDUALS_ASSOCIATIONS_SUCH_AS_SPECIMEN_AND_OBSERVATIONS
));
1692 config
.setAddMediaAsMediaSpecimen(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_ADD_MEDIA_AS_MEDIASPECIMEN
));
1694 config
.setAllowReuseOtherClassifications(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_ALLOW_REUSE_OTHER_CLASSIFICATIONS
));
1695 config
.setDeduplicateClassifications(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_DEDUPLICATE_CLASSIFICATIONS
));
1696 config
.setDeduplicateReferences(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_DEDUPLICATE_REFERENCES
));
1697 config
.setRemoveCountryFromLocalityText(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_REMOVE_COUNTRY_FROM_LOCALITY_TEXT
));
1698 config
.setGetSiblings(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_DO_SIBLINGS
));
1699 config
.setIgnoreAuthorship(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_IGNORE_AUTHORSHIP
));
1700 config
.setIgnoreImportOfExistingSpecimen(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_IGNORE_IMPORT_OF_EXISTING_SPECIMEN
));
1701 config
.setMapUnitIdToAccessionNumber(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_MAP_UNIT_ID_TO_ACCESSION_NUMBER
));
1702 config
.setMapUnitIdToBarcode(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_MAP_UNIT_ID_TO_BARCODE
));
1703 config
.setMapUnitIdToCatalogNumber(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_MAP_UNIT_ID_TOCATALOG_NUMBER
));
1704 config
.setMoveNewTaxaToDefaultClassification(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_MOVE_NEW_TAXA_TO_DEFAULT_CLASSIFICATION
));
1705 config
.setOverwriteExistingSpecimens(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_OVERWRITE_EXISTING_SPECIMEN
));
1706 config
.setReuseExistingDescriptiveGroups(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_REUSE_EXISTING_DESCRIPTIVE_GROUPS
));
1707 config
.setReuseExistingMetaData(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_REUSE_EXISTING_META_DATA
));
1708 config
.setReuseExistingTaxaWhenPossible(getBooleanValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_REUSE_EXISTING_TAXA_WHEN_POSSIBLE
));
1709 config
.setNomenclaturalCode(NomenclaturalCode
.getByKey(getStringValue(IPreferenceKeys
.ABCD_IMPORT_CONFIGURATOR_NOMENCLATURAL_CODE
)));
1716 public static void updateAbcdImportConfigurationPreference() {
1717 CdmPreferenceCache cache
= CdmPreferenceCache
.instance();
1719 CdmPreference pref
= cache
.findBestMatching(CdmPreference
.NewKey(PreferenceSubject
.NewTaxEditorInstance(), PreferencePredicate
.AbcdImportConfig
));
1721 if (!getBooleanValue(prefOverrideKey(PreferencePredicate
.AbcdImportConfig
.getKey())) || !pref
.isAllowOverride()){
1722 resetToDBPreferenceAbcdCOnfigurator();
1727 public static void resetToDBPreferenceAbcdCOnfigurator(){
1728 Abcd206ImportConfigurator config
= getDBAbcdImportConfigurationPreference();
1729 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_ADD_INDIVIDUALS_ASSOCIATIONS_SUCH_AS_SPECIMEN_AND_OBSERVATIONS
, config
.isAddIndividualsAssociationsSuchAsSpecimenAndObservations());
1730 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_ADD_MEDIA_AS_MEDIASPECIMEN
, config
.isAddMediaAsMediaSpecimen());
1732 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_ALLOW_REUSE_OTHER_CLASSIFICATIONS
, config
.isAllowReuseOtherClassifications());
1733 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_DEDUPLICATE_CLASSIFICATIONS
, config
.isDeduplicateClassifications());
1734 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_DEDUPLICATE_REFERENCES
, config
.isDeduplicateReferences());
1736 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_DO_SIBLINGS
, config
.isGetSiblings());
1737 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_IGNORE_AUTHORSHIP
, config
.isIgnoreAuthorship());
1738 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_IGNORE_IMPORT_OF_EXISTING_SPECIMEN
, config
.isIgnoreImportOfExistingSpecimen());
1739 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_MAP_UNIT_ID_TO_ACCESSION_NUMBER
, config
.isMapUnitIdToAccessionNumber());
1740 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_MAP_UNIT_ID_TO_BARCODE
, config
.isMapUnitIdToBarcode());
1741 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_MAP_UNIT_ID_TOCATALOG_NUMBER
, config
.isMapUnitIdToCatalogNumber());
1742 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_MOVE_NEW_TAXA_TO_DEFAULT_CLASSIFICATION
, config
.isMoveNewTaxaToDefaultClassification());
1743 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_OVERWRITE_EXISTING_SPECIMEN
, config
.isOverwriteExistingSpecimens());
1744 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_REUSE_EXISTING_DESCRIPTIVE_GROUPS
, config
.isReuseExistingDescriptiveGroups());
1745 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_REUSE_EXISTING_META_DATA
, config
.isReuseExistingMetaData());
1746 setBooleanValue(ABCD_IMPORT_CONFIGURATOR_REUSE_EXISTING_TAXA_WHEN_POSSIBLE
, config
.isReuseExistingTaxaWhenPossible());
1747 if (config
.getNomenclaturalCode() != null){
1748 setStringValue(ABCD_IMPORT_CONFIGURATOR_NOMENCLATURAL_CODE
, config
.getNomenclaturalCode().getKey());
1761 public static boolean isSortTaxaByRankAndName() {
1763 return getBooleanValue(IPreferenceKeys
.SORT_TAXA_BY_RANK_AND_NAME
);
1769 public static String
getSortNamedAreasInDistributionEditor() {
1771 return getStringValue(PreferencePredicate
.AreasSortedInDistributionEditor
.getKey());
1774 public static void setSortNamedAreasInDistributionEditor(String isSortByVocabularyOrder
) {
1775 setStringValue(PreferencePredicate
.AreasSortedInDistributionEditor
.getKey(), isSortByVocabularyOrder
);
1781 * setPreferredNamedAreasForDistributionEditor
1784 * @param saveCheckedElements
1785 * @param saveGrayedElements
1787 public static void setLastSelectedReference(
1788 List
<String
> lastSelectedReferences
) {
1790 setStringValue(PreferencesUtil
.LAST_SELECTED_REFERENCES
, lastSelectedReferences
.toString());
1795 * setPreferredNamedAreasForDistributionEditor
1798 * @param saveCheckedElements
1799 * @param saveGrayedElements
1801 public static List
<String
> getLastSelectedReferences() {
1803 //IPreferenceStore preferenceStore = PreferencesUtil.getPreferenceStore();
1804 String lastSelected
= getStringValue(PreferencesUtil
.LAST_SELECTED_REFERENCES
);
1805 List
<String
> result
= new ArrayList
<>();
1806 if (!StringUtils
.isBlank(lastSelected
)){
1807 Collections
.addAll(result
, lastSelected
.substring(1,lastSelected
.length()-1).split(", "));
1815 * setPreferredNamedAreasForDistributionEditor
1818 * @param saveCheckedElements
1819 * @param saveGrayedElements
1821 public static void setPreferredNamedAreasForDistributionEditor(
1822 String saveCheckedElements
, String saveGrayedElements
, boolean local
) {
1824 setStringValue(PreferencePredicate
.AvailableDistributionAreaTerms
.getKey(), saveCheckedElements
);
1828 CdmPreference preference
= null;
1830 if (saveCheckedElements
== null){
1831 preference
= getPreferenceFromDB(PreferencePredicate
.AvailableDistributionAreaTerms
);
1833 if (preference
== null){
1836 setStringValue(PreferencePredicate
.AvailableDistributionAreaTerms
.getKey(),
1837 saveCheckedElements
);
1838 preference
= CdmPreference
.NewInstance(PreferenceSubject
.NewTaxEditorInstance(), PreferencePredicate
.AvailableDistributionAreaTerms
, saveCheckedElements
);
1839 setPreferenceToDB(preference
);
1843 preference
= CdmPreference
.NewInstance(PreferenceSubject
.NewTaxEditorInstance(), PreferencePredicate
.AvailableDistributionAreaTerms
, saveCheckedElements
);
1844 setPreferenceToDB(preference
);
1845 setStringValue(PreferencePredicate
.AvailableDistributionAreaTerms
.getKey(),
1846 saveCheckedElements
);
1854 * @param saveCheckedElements
1855 * @param saveCheckedElements2
1858 public static void setPreferredVocabulariesForDistributionEditor(String saveCheckedElements
,
1859 boolean local
, boolean isOverride
) {
1861 setStringValue(PreferencePredicate
.AvailableDistributionAreaVocabularies
.getKey(), saveCheckedElements
);
1862 setBooleanValue(prefOverrideKey(PreferencePredicate
.AvailableDistributionAreaVocabularies
.getKey()), isOverride
);
1865 ICdmRepository controller
;
1866 CdmPreference preference
= null;
1868 if (saveCheckedElements
== null){
1869 preference
= getPreferenceFromDB(PreferencePredicate
.AvailableDistributionAreaVocabularies
);
1871 if (preference
== null){
1874 setStringValue(PreferencePredicate
.AvailableDistributionAreaVocabularies
.getKey(),
1875 saveCheckedElements
);
1876 preference
= CdmPreference
.NewInstance(PreferenceSubject
.NewTaxEditorInstance(), PreferencePredicate
.AvailableDistributionAreaVocabularies
, saveCheckedElements
);
1877 preference
.setAllowOverride(isOverride
);
1878 setPreferenceToDB(preference
);
1881 preference
= CdmPreference
.NewInstance(PreferenceSubject
.NewTaxEditorInstance(), PreferencePredicate
.AvailableDistributionAreaVocabularies
, saveCheckedElements
);
1882 preference
.setAllowOverride(isOverride
);
1883 setPreferenceToDB(preference
);
1884 setStringValue(PreferencePredicate
.AvailableDistributionAreaVocabularies
.getKey(),
1885 saveCheckedElements
);
1893 * @param saveCheckedElements
1894 * @param saveCheckedElements2
1897 public static String
getPreferredVocabulariesForDistributionEditor(boolean local
) {
1900 String pref
= getStringValue(PreferencePredicate
.AvailableDistributionAreaVocabularies
.getKey(), local
);
1904 CdmPreference preference
= null;
1905 preference
= getPreferenceFromDB(PreferencePredicate
.AvailableDistributionAreaVocabularies
);
1906 if (preference
== null){
1909 return preference
.getValue();
1915 public static List
<UUID
> createUUIDListFromStringPref(String prefKey
) {
1916 String prefValue
= PreferencesUtil
.getStringValue(prefKey
);
1917 String
[] stringArray
= prefValue
.split(";");
1918 List
<UUID
> uuidList
= new ArrayList();
1919 for (String uuid
: stringArray
){
1920 if (!StringUtils
.isBlank(uuid
)){
1921 uuidList
.add(UUID
.fromString(uuid
));
1927 public static boolean getFilterCommonNameReferences(){
1928 return getBooleanValue(PreferencesUtil
.FILTER_COMMON_NAME_REFERENCES
);
1934 public static void updateDBPreferences() {
1935 CdmPreference preference
= null;
1936 CdmPreferenceCache cache
= CdmPreferenceCache
.instance();
1937 cache
.getAllTaxEditorDBPreferences();
1941 updateAbcdImportConfigurationPreference();
1944 NameDetailsConfigurator config
= getPreferredNameDetailsConfiguration(false);
1945 // if (config != null ){
1946 // if (!getBooleanValue(OVERRIDE_NAME_DETAILS) || !getBooleanValue(ALLOW_OVERRIDE_NAME_DETAILS)){
1947 // setPreferredNameDetailsConfiguration(config, false);
1962 * @param saveCheckedElements
1964 public static void setPreferencesToDB(List
<CdmPreference
> preferences
) {
1966 ICdmRepository controller
;
1968 if(CdmStore
.isActive()){
1969 controller
= CdmStore
.getCurrentApplicationConfiguration();
1970 for (CdmPreference preference
: preferences
){
1972 controller
.getPreferenceService().set(preference
);
1974 CdmPreferenceCache
.instance().put(preference
);
1977 }catch(Exception e
){
1978 e
.printStackTrace();