Skip to main content
summaryrefslogtreecommitdiffstats
blob: dd26f9bd731161a2863835c2fb8f1ee36b3ff940 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
/*******************************************************************************
 * Copyright (c) 2004, 2007 Boeing.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Boeing - initial API and implementation
 *******************************************************************************/
package org.eclipse.osee.framework.ui.skynet.widgets.workflow;

import static org.eclipse.osee.framework.skynet.core.artifact.DeletionFlag.EXCLUDE_DELETED;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.logging.Level;
import org.eclipse.osee.framework.core.enums.CoreArtifactTypes;
import org.eclipse.osee.framework.core.enums.CoreAttributeTypes;
import org.eclipse.osee.framework.core.enums.CoreRelationTypes;
import org.eclipse.osee.framework.core.exception.OseeArgumentException;
import org.eclipse.osee.framework.core.exception.OseeCoreException;
import org.eclipse.osee.framework.core.exception.OseeStateException;
import org.eclipse.osee.framework.logging.OseeLog;
import org.eclipse.osee.framework.skynet.core.artifact.Artifact;
import org.eclipse.osee.framework.skynet.core.artifact.BranchManager;
import org.eclipse.osee.framework.skynet.core.artifact.search.ArtifactQuery;
import org.eclipse.osee.framework.skynet.core.event.model.EventBasicGuidArtifact;
import org.eclipse.osee.framework.ui.skynet.SkynetGuiPlugin;
import org.eclipse.osee.framework.ui.skynet.widgets.workflow.WorkItemDefinition.WriteType;

/**
 * @author Donald G. Dunne
 */
public class WorkItemDefinitionFactory {

   private static Map<String, WorkItemDefinition> itemIdToDefinition;
   private static Map<String, Artifact> itemIdToWidArtifact;

   public static void deCache(WorkItemDefinition workItemDefinition) {
      deCache(workItemDefinition.getId());
   }

   public synchronized static void deCache(String workItemDefinitionId) {
      itemIdToDefinition.remove(workItemDefinitionId);
      itemIdToWidArtifact.remove(workItemDefinitionId);
   }

   public static void deCache(Artifact artifact) {
      if (itemIdToWidArtifact.containsValue(artifact)) {
         for (Entry<String, Artifact> entry : itemIdToWidArtifact.entrySet()) {
            if (entry.getValue().equals(artifact)) {
               deCache(entry.getKey());
               return;
            }
         }
      }
   }

   public static void deCache(EventBasicGuidArtifact guidArt) {
      for (Entry<String, Artifact> entry : itemIdToWidArtifact.entrySet()) {
         if (entry.getValue().getGuid().equals(guidArt.getGuid())) {
            deCache(entry.getKey());
            return;
         }
      }
   }

   public synchronized static void loadDefinitions() throws OseeCoreException {
      if (itemIdToDefinition == null) {
         OseeLog.log(SkynetGuiPlugin.class, Level.INFO, "Loading Work Item Definitions");
         itemIdToDefinition = new HashMap<String, WorkItemDefinition>();
         itemIdToWidArtifact = new HashMap<String, Artifact>();

         // Add all work item definitions provided through extension points
         for (IWorkDefinitionProvider provider : WorkDefinitionProvider.getWorkDefinitionProviders()) {
            for (WorkItemDefinition def : provider.getProgramaticWorkItemDefinitions()) {
               addItemDefinition(WriteType.New, def);
            }
         }

         // This load is faster than loading each by artifact type
         for (Artifact art : ArtifactQuery.getArtifactListFromTypeWithInheritence(CoreArtifactTypes.WorkItemDefinition,
            BranchManager.getCommonBranch(), EXCLUDE_DELETED)) {
            if (art.isOfType(CoreArtifactTypes.WorkRuleDefinition)) {
               addItemDefinition(WriteType.New, new WorkRuleDefinition(art), art);
            } else if (art.isOfType(CoreArtifactTypes.WorkWidgetDefinition)) {
               addItemDefinition(WriteType.New, new WorkWidgetDefinition(art), art);
            } else if (art.isOfType(CoreArtifactTypes.WorkPageDefinition)) {
               addItemDefinition(WriteType.New, new WorkPageDefinition(art), art);
            } else if (art.isOfType(CoreArtifactTypes.WorkFlowDefinition)) {
               addItemDefinition(WriteType.New, new WorkFlowDefinition(art), art);
            }
         }
      }
   }

   /**
    * This should only be called on database initialization or when new work item definitions are created during
    * run-time.
    */
   public static void cacheWorkItemDefinitionArtifact(WriteType writeType, WorkItemDefinition workItemDefinition, Artifact artifact) throws OseeCoreException {
      addItemDefinition(writeType, workItemDefinition, artifact);
   }

   public static void relateWorkItemDefinitions(String parentWorkflowId, String childWorkflowId) throws OseeCoreException {
      List<Artifact> parentArts =
         ArtifactQuery.getArtifactListFromAttribute(CoreAttributeTypes.WorkId, parentWorkflowId,
            BranchManager.getCommonBranch());
      if (parentArts == null || parentArts.isEmpty()) {
         throw new IllegalArgumentException("Can't access parentWorkflowId " + parentWorkflowId);
      }
      Artifact parentArt = parentArts.iterator().next();
      List<Artifact> childArts =
         ArtifactQuery.getArtifactListFromAttribute(CoreAttributeTypes.WorkId, childWorkflowId,
            BranchManager.getCommonBranch());
      if (childArts == null || childArts.isEmpty()) {
         throw new IllegalArgumentException("Can't access childWorkflowId " + childWorkflowId);
      }
      Artifact childArt = childArts.iterator().next();
      if (!parentArt.getRelatedArtifacts(CoreRelationTypes.WorkItem__Child, Artifact.class).contains(childArt)) {
         parentArt.addRelation(CoreRelationTypes.WorkItem__Child, childArt);
         parentArt.persist();
      }
   }

   private static void addItemDefinition(WriteType writeType, WorkItemDefinition workItemDefinition) throws OseeCoreException {
      if (workItemDefinition.getId() == null) {
         throw new OseeArgumentException("Item Id can't be null");
      }
      if (writeType == WriteType.New && itemIdToDefinition.containsKey(workItemDefinition.getId())) {
         throw new OseeArgumentException(
            "Item Id must be unique.  Already work item with id \"" + workItemDefinition.getId() + "\"");
      }
      itemIdToDefinition.put(workItemDefinition.getId(), workItemDefinition);
   }

   private static void addItemDefinition(WriteType writeType, WorkItemDefinition workItemDefinition, Artifact artifact) throws OseeCoreException {
      addItemDefinition(writeType, workItemDefinition);
      itemIdToWidArtifact.put(workItemDefinition.id, artifact);
   }

   public static void updateDefinitions(Collection<Artifact> arts) throws OseeCoreException {
      loadDefinitionsInternal(WriteType.Update, arts);
   }

   public static void loadDefinitions(Collection<Artifact> arts) throws OseeCoreException {
      loadDefinitionsInternal(WriteType.New, arts);
   }

   private static void loadDefinitionsInternal(WriteType writeType, Collection<Artifact> arts) throws OseeCoreException {
      for (Artifact art : arts) {
         if (art.isOfType(CoreArtifactTypes.WorkRuleDefinition)) {
            System.out.println("Updating WorkItemDefinition cache with " + art);
            addItemDefinition(writeType, new WorkRuleDefinition(art), art);
         }
         if (art.isOfType(CoreArtifactTypes.WorkWidgetDefinition)) {
            System.out.println("Updating WorkItemDefinition cache with " + art);
            addItemDefinition(writeType, new WorkWidgetDefinition(art), art);
         }
         if (art.isOfType(CoreArtifactTypes.WorkPageDefinition)) {
            System.out.println("Updating WorkItemDefinition cache with " + art);
            addItemDefinition(writeType, new WorkPageDefinition(art), art);
         }
         if (art.isOfType(CoreArtifactTypes.WorkFlowDefinition)) {
            System.out.println("Updating WorkItemDefinition cache with " + art);
            addItemDefinition(writeType, new WorkFlowDefinition(art), art);
         }
      }
   }

   public static WorkItemDefinition getWorkItemDefinition(String id) throws OseeCoreException {
      if (id == null) {
         throw new OseeStateException("WorkItemDefinition id can't be null");
      }
      loadDefinitions();
      WorkItemDefinition wid = itemIdToDefinition.get(id);
      if (wid == null) {
         // Attempt to get from DB
         loadDefinitions(ArtifactQuery.getArtifactListFromAttribute(CoreAttributeTypes.WorkId, id,
            BranchManager.getCommonBranch()));
      }
      return itemIdToDefinition.get(id);
   }

   public static Artifact getWorkItemDefinitionArtifact(String id) throws OseeCoreException {
      if (id == null) {
         throw new OseeStateException("WorkItemDefinition id can't be null");
      }
      loadDefinitions();
      Artifact art = itemIdToWidArtifact.get(id);
      if (art == null) {
         // Attempt to get from DB
         loadDefinitions(ArtifactQuery.getArtifactListFromAttribute(CoreAttributeTypes.WorkId, id,
            BranchManager.getCommonBranch()));
      }
      return itemIdToWidArtifact.get(id);
   }

   public static List<WorkItemDefinition> getWorkItemDefinition(java.util.Collection<String> ids) throws OseeCoreException {
      loadDefinitions();
      List<WorkItemDefinition> defs = new ArrayList<WorkItemDefinition>();
      for (String id : ids) {
         WorkItemDefinition def = getWorkItemDefinition(id);
         if (def == null) {
            throw new IllegalArgumentException("Work Item Id \"" + id + "\" is not a defined work item");
         }
         defs.add(def);
      }
      return defs;
   }

   public static List<WorkItemDefinition> getWorkItemDefinitionsStartsWithId(String id) throws OseeCoreException {
      loadDefinitions();
      List<WorkItemDefinition> defs = new ArrayList<WorkItemDefinition>();
      for (Entry<String, WorkItemDefinition> entry : itemIdToDefinition.entrySet()) {
         if (entry.getKey().startsWith(id)) {
            defs.add(entry.getValue());
         }
      }
      return defs;
   }

   public static List<WorkItemDefinition> getWorkItemDefinitions(Collection<String> pageids) throws OseeCoreException {
      loadDefinitions();
      List<WorkItemDefinition> defs = new ArrayList<WorkItemDefinition>();
      for (String itemId : pageids) {
         WorkItemDefinition def = getWorkItemDefinition(itemId);
         if (def == null) {
            throw new IllegalArgumentException("Item Id \"" + itemId + "\" is not a defined item");
         }
         defs.add(def);
      }
      return defs;
   }

   public static Collection<WorkItemDefinition> getWorkItemDefinitions() throws OseeCoreException {
      loadDefinitions();
      return itemIdToDefinition.values();
   }

}

Back to the top