AT: Updating the class's Javadoc description to mak it more accurate
[taxeditor.git] / eu.etaxonomy.taxeditor.editor / src / main / java / eu / etaxonomy / taxeditor / editor / UseObjectManager.java
index 0f45bc921d1477f77dc41e03be0054def6cf734f..3d3c1e69b9e0b9c40661f8d16c4346a269456828 100644 (file)
@@ -1,24 +1,41 @@
+/**\r
+* Copyright (C) 2011 EDIT\r
+* European Distributed Institute of Taxonomy \r
+* http://www.e-taxonomy.eu\r
+* \r
+* The contents of this file are subject to the Mozilla Public License Version 1.1\r
+* See LICENSE.TXT at the top of this package for the full license terms.\r
+*/\r
 package eu.etaxonomy.taxeditor.editor;\r
 \r
 import java.net.URI;\r
 import java.net.URISyntaxException;\r
-import java.util.UUID;\r
 \r
 import org.eclipse.core.runtime.IProgressMonitor;\r
 import org.eclipse.ui.IMemento;\r
 \r
 import eu.etaxonomy.cdm.api.conversation.ConversationHolder;\r
+import eu.etaxonomy.cdm.api.service.IFeatureTreeService;\r
 import eu.etaxonomy.cdm.api.service.ITermService;\r
 import eu.etaxonomy.cdm.api.service.IVocabularyService;\r
 import eu.etaxonomy.cdm.model.common.MarkerType;\r
 import eu.etaxonomy.cdm.model.common.TermVocabulary;\r
 import eu.etaxonomy.cdm.model.description.Feature;\r
+import eu.etaxonomy.cdm.model.description.FeatureNode;\r
+import eu.etaxonomy.cdm.model.description.FeatureTree;\r
 import eu.etaxonomy.cdm.model.description.Modifier;\r
 import eu.etaxonomy.cdm.model.description.State;\r
 import eu.etaxonomy.taxeditor.model.ContextListenerAdapter;\r
 import eu.etaxonomy.taxeditor.store.CdmStore;\r
 import eu.etaxonomy.taxeditor.store.StoreUtil;\r
 \r
+/**\r
+ * The context listener will call this class when the uses view is being loaded.\r
+ * It checks if the uses view's necessary objects are present in the database and it will persist the objects that aren't using the CDMLib's services classes. \r
+ * @author a.theys     \r
+ * @created mar 13, 2012\r
+ * @version 1.0\r
+ */\r
 public class UseObjectManager extends ContextListenerAdapter{\r
        @Override\r
        public void contextRefresh(IProgressMonitor monitor) {\r
@@ -36,17 +53,19 @@ public class UseObjectManager extends ContextListenerAdapter{
        }\r
        \r
        private void setupNecessaryItems(IProgressMonitor monitor) {\r
-               MarkerType existingMarkertype = (MarkerType) CdmStore.getService(ITermService.class).find(UUID.fromString("2e6e42d9-e92a-41f4-899b-03c0ac64f039"));\r
-               TermVocabulary<State> stateVocabulary =  (TermVocabulary<State>) CdmStore.getService(IVocabularyService.class).find(UUID.fromString("67430d7c-fd43-4e9d-af5e-d0dca3f74931"));\r
-               Feature featureUseRecord = (Feature) CdmStore.getService(ITermService.class).find(UUID.fromString("8125a59d-b4d5-4485-89ea-67306297b599"));\r
-               TermVocabulary<Modifier> countryVocabulary =  (TermVocabulary<Modifier>) CdmStore.getService(IVocabularyService.class).find(UUID.fromString("116c51f1-e63a-46f7-a258-e1149a42868b"));\r
-               TermVocabulary<Modifier> plantPartVocabulary =  (TermVocabulary<Modifier>) CdmStore.getService(IVocabularyService.class).find(UUID.fromString("369914fe-d54b-4063-99ce-abc81d30ad35"));\r
-               TermVocabulary<Modifier> humanGroupVocabulary =  (TermVocabulary<Modifier>) CdmStore.getService(IVocabularyService.class).find(UUID.fromString("ca46cea5-bdf7-438d-9cd8-e2793d2178dc"));\r
+               MarkerType existingMarkertype = (MarkerType) CdmStore.getService(ITermService.class).find(UsageTermCollection.uuidUseMarkerType);\r
+               TermVocabulary<State> stateVocabulary =  (TermVocabulary<State>) CdmStore.getService(IVocabularyService.class).find(UsageTermCollection.uuidUseCategoryVocabulary);\r
+               Feature featureUseRecord = (Feature) CdmStore.getService(ITermService.class).find(UsageTermCollection.uuidUseRecordFeature);\r
+               Feature featureUseSummary = (Feature) CdmStore.getService(ITermService.class).find(UsageTermCollection.uuidUseSummaryFeature);\r
+               TermVocabulary<Modifier> countryVocabulary =  (TermVocabulary<Modifier>) CdmStore.getService(IVocabularyService.class).find(UsageTermCollection.uuidCountryVocabulary);\r
+               TermVocabulary<Modifier> plantPartVocabulary =  (TermVocabulary<Modifier>) CdmStore.getService(IVocabularyService.class).find(UsageTermCollection.uuidPlantPartVocabulary);\r
+               TermVocabulary<Modifier> humanGroupVocabulary =  (TermVocabulary<Modifier>) CdmStore.getService(IVocabularyService.class).find(UsageTermCollection.uuidHumanGroupVocabulary);\r
+               \r
                ConversationHolder conversation = CdmStore.createConversation();\r
                if (existingMarkertype == null) {\r
-                       existingMarkertype = MarkerType.NewInstance("use", "use", null);\r
-                       existingMarkertype.setUuid( UUID.fromString("2e6e42d9-e92a-41f4-899b-03c0ac64f039"));\r
-                       TermVocabulary<MarkerType> markerTypeVocabulary = (TermVocabulary<MarkerType>)CdmStore.getService(IVocabularyService.class).find((UUID.fromString("19dffff7-e142-429c-a420-5d28e4ebe305")));\r
+                       existingMarkertype = MarkerType.NewInstance(UsageTermCollection.useMakerLabel, UsageTermCollection.useMakerLabel, null);\r
+                       existingMarkertype.setUuid( UsageTermCollection.uuidUseMarkerType);\r
+                       TermVocabulary<MarkerType> markerTypeVocabulary = (TermVocabulary<MarkerType>)CdmStore.getService(IVocabularyService.class).find((UsageTermCollection.uuidMarkersVocabulary));\r
                        markerTypeVocabulary.addTerm(existingMarkertype);\r
                        CdmStore.getService(IVocabularyService.class).saveOrUpdate(markerTypeVocabulary);\r
                        conversation.commit(true);\r
@@ -59,10 +78,12 @@ public class UseObjectManager extends ContextListenerAdapter{
                        } catch (URISyntaxException e) {\r
                                e.printStackTrace();\r
                        }\r
-                       stateVocabulary = TermVocabulary.NewInstance("Use Category", "Use Category", null, termSourceUri);\r
-                       stateVocabulary.setUuid(UUID.fromString("67430d7c-fd43-4e9d-af5e-d0dca3f74931"));\r
-                       State newDummyState = State.NewInstance("Dummy Use Cat", "Dummy Use Cat", null);\r
-                       State newDummySubCat = State.NewInstance("Dummy Use Sub Cat", "Dummy Use Sub Cat", null);\r
+                       stateVocabulary = TermVocabulary.NewInstance(UsageTermCollection.useCategoryVocabularyLabel, UsageTermCollection.useCategoryVocabularyLabel, null, termSourceUri);\r
+                       stateVocabulary.setUuid(UsageTermCollection.uuidUseCategoryVocabulary);\r
+                       State newDummyState = State.NewInstance(UsageTermCollection.notAvailableLabel, UsageTermCollection.notAvailableLabel, null);\r
+                       newDummyState.setUuid(UsageTermCollection.uuidUseCategoryDummy);\r
+                       State newDummySubCat = State.NewInstance(UsageTermCollection.notAvailableLabel, UsageTermCollection.notAvailableLabel, null);\r
+                       newDummySubCat.setUuid(UsageTermCollection.uuidUseSubCategoryDummy);\r
                        newDummyState.addIncludes(newDummySubCat);\r
                        stateVocabulary.addTerm(newDummyState);\r
                        CdmStore.getService(IVocabularyService.class).saveOrUpdate(stateVocabulary);\r
@@ -76,10 +97,10 @@ public class UseObjectManager extends ContextListenerAdapter{
                        } catch (URISyntaxException e) {\r
                                e.printStackTrace();\r
                        }\r
-                       countryVocabulary = TermVocabulary.NewInstance("Country", "Country", null, termSourceUri);\r
-                       countryVocabulary.setUuid(UUID.fromString("116c51f1-e63a-46f7-a258-e1149a42868b"));\r
-                       \r
-                       Modifier newDummyModifier = Modifier.NewInstance("Dummy Country", "Dummy Country", null);\r
+                       countryVocabulary = TermVocabulary.NewInstance(UsageTermCollection.countryLabel, UsageTermCollection.countryLabel, null, termSourceUri);\r
+                       countryVocabulary.setUuid(UsageTermCollection.uuidCountryVocabulary);\r
+                       Modifier newDummyModifier = Modifier.NewInstance(UsageTermCollection.notAvailableLabel, UsageTermCollection.notAvailableLabel, null);\r
+                       newDummyModifier.setUuid(UsageTermCollection.uuidCountryDummy);\r
                        countryVocabulary.addTerm(newDummyModifier);\r
                        CdmStore.getService(IVocabularyService.class).saveOrUpdate(countryVocabulary);\r
                        conversation.commit(true);\r
@@ -92,9 +113,10 @@ public class UseObjectManager extends ContextListenerAdapter{
                        } catch (URISyntaxException e) {\r
                                e.printStackTrace();\r
                        }\r
-                       plantPartVocabulary = TermVocabulary.NewInstance("Plant Part", "Plant Part", null, termSourceUri);\r
-                       plantPartVocabulary.setUuid(UUID.fromString("369914fe-d54b-4063-99ce-abc81d30ad35"));\r
-                       Modifier newDummyModifier = Modifier.NewInstance("Dummy Plant Part", "Dummy Plant Part", null);\r
+                       plantPartVocabulary = TermVocabulary.NewInstance(UsageTermCollection.plantPartLabel, UsageTermCollection.plantPartLabel, null, termSourceUri);\r
+                       plantPartVocabulary.setUuid(UsageTermCollection.uuidPlantPartVocabulary);\r
+                       Modifier newDummyModifier = Modifier.NewInstance(UsageTermCollection.notAvailableLabel, UsageTermCollection.notAvailableLabel, null);\r
+                       newDummyModifier.setUuid(UsageTermCollection.uuidPlantPartDummy);\r
                        plantPartVocabulary.addTerm(newDummyModifier);\r
                        CdmStore.getService(IVocabularyService.class).saveOrUpdate(plantPartVocabulary);\r
                        conversation.commit(true);\r
@@ -107,27 +129,46 @@ public class UseObjectManager extends ContextListenerAdapter{
                        } catch (URISyntaxException e) {\r
                                e.printStackTrace();\r
                        }\r
-                       humanGroupVocabulary = TermVocabulary.NewInstance("Human Group", "Human Group", null, termSourceUri);\r
-                       humanGroupVocabulary.setUuid(UUID.fromString("ca46cea5-bdf7-438d-9cd8-e2793d2178dc"));\r
-                       Modifier newDummyModifier = Modifier.NewInstance("Dummy Human Group", "Dummy Human Group", null);\r
-                       Modifier newSubDummyModifier = Modifier.NewInstance("Dummy Ethnic Group", "Dummy Ethnic Group", null);\r
+                       humanGroupVocabulary = TermVocabulary.NewInstance(UsageTermCollection.humanGroupLabel, UsageTermCollection.humanGroupLabel, null, termSourceUri);\r
+                       humanGroupVocabulary.setUuid(UsageTermCollection.uuidHumanGroupVocabulary);\r
+                       Modifier newDummyModifier = Modifier.NewInstance(UsageTermCollection.notAvailableLabel, UsageTermCollection.notAvailableLabel, null);\r
+                       newDummyModifier.setUuid(UsageTermCollection.uuidHumanGroupDummy);\r
+                       Modifier newSubDummyModifier = Modifier.NewInstance(UsageTermCollection.notAvailableLabel, UsageTermCollection.notAvailableLabel, null);\r
+                       newSubDummyModifier.setUuid(UsageTermCollection.uuidEthnicGroupDummy);\r
                        newDummyModifier.addIncludes(newSubDummyModifier);\r
                        humanGroupVocabulary.addTerm(newDummyModifier);\r
                        CdmStore.getService(IVocabularyService.class).saveOrUpdate(humanGroupVocabulary);\r
                        conversation.commit(true);\r
                }\r
-               if(featureUseRecord == null) {\r
-                       featureUseRecord = Feature.NewInstance("Use Record", "Use Record", null);\r
-                       featureUseRecord.setUuid(UUID.fromString("8125a59d-b4d5-4485-89ea-67306297b599"));\r
-                       featureUseRecord.setSupportsCategoricalData(true);\r
-                       TermVocabulary<Feature> featureVocabulary = (TermVocabulary<Feature>)CdmStore.getService(IVocabularyService.class).find((UUID.fromString("b187d555-f06f-4d65-9e53-da7c93f8eaa8")));\r
-                       featureVocabulary.addTerm(featureUseRecord);\r
+               \r
+               if(featureUseRecord == null|| featureUseSummary == null) {\r
+                       TermVocabulary<Feature> featureVocabulary = (TermVocabulary<Feature>)CdmStore.getService(IVocabularyService.class).find((UsageTermCollection.uuidFeatureVocabulary));\r
+                       FeatureTree palmWebFeatureTree = CdmStore.getService(IFeatureTreeService.class).find(UsageTermCollection.uuidPalmWebFeatureTree);\r
+                       \r
+                       if (featureUseRecord == null ) {\r
+                               featureUseRecord = Feature.NewInstance(UsageTermCollection.useRecordFeatureLabel, UsageTermCollection.useRecordFeatureLabel, null);\r
+                               featureUseRecord.setUuid(UsageTermCollection.uuidUseRecordFeature);\r
+                               featureUseRecord.isSupportsCategoricalData();\r
+                               featureUseRecord.setSupportsCategoricalData(true);\r
+                               featureVocabulary.addTerm(featureUseRecord);\r
+                               FeatureNode useRecFeatureNode = FeatureNode.NewInstance(featureUseRecord);\r
+                               palmWebFeatureTree.getRoot().addChild(useRecFeatureNode);\r
+                       }\r
+                       if (featureUseSummary == null) {\r
+                               featureUseSummary = Feature.NewInstance(UsageTermCollection.useSummaryFeatureLabel, UsageTermCollection.useSummaryFeatureLabel, null);\r
+                               featureUseSummary.setUuid(UsageTermCollection.uuidUseSummaryFeature);\r
+                               featureUseSummary.isSupportsTextData();\r
+                               featureUseSummary.setSupportsTextData(true);\r
+                               featureVocabulary.addTerm(featureUseSummary);\r
+                               FeatureNode useSumFeatureNode = FeatureNode.NewInstance(featureUseSummary);\r
+                               palmWebFeatureTree.getRoot().addChild(useSumFeatureNode);\r
+                       }\r
+                       \r
                        CdmStore.getService(IVocabularyService.class).saveOrUpdate(featureVocabulary);\r
+                       CdmStore.getService(IFeatureTreeService.class).saveOrUpdate(palmWebFeatureTree);\r
                        conversation.commit(true);\r
                        \r
                }\r
-                       \r
-               \r
                conversation.close();   \r
        }\r
 }\r