Skip to main content
summaryrefslogtreecommitdiffstats
blob: cd36419caf95dd3ddd4a044b939d7252812ba910 (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
246
247
248
/*******************************************************************************
 * Copyright (c) 2010 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.coverage.store;

import java.io.File;
import java.io.FileInputStream;
import java.io.InputStream;
import java.util.Collection;
import java.util.logging.Level;
import org.eclipse.osee.coverage.event.CoverageEventManager;
import org.eclipse.osee.coverage.event.CoverageEventType;
import org.eclipse.osee.coverage.event.CoveragePackageEvent;
import org.eclipse.osee.coverage.internal.Activator;
import org.eclipse.osee.coverage.model.CoverageImport;
import org.eclipse.osee.coverage.model.CoverageItem;
import org.eclipse.osee.coverage.model.CoverageOptionManager;
import org.eclipse.osee.coverage.model.CoverageOptionManagerDefault;
import org.eclipse.osee.coverage.model.CoveragePackage;
import org.eclipse.osee.coverage.model.CoverageUnit;
import org.eclipse.osee.coverage.model.ICoverage;
import org.eclipse.osee.coverage.model.ICoverageItemProvider;
import org.eclipse.osee.coverage.model.ICoverageUnitProvider;
import org.eclipse.osee.coverage.model.IWorkProductRelatable;
import org.eclipse.osee.coverage.util.ISaveable;
import org.eclipse.osee.framework.core.enums.CoreArtifactTypes;
import org.eclipse.osee.framework.core.enums.CoreAttributeTypes;
import org.eclipse.osee.framework.core.exception.OseeArgumentException;
import org.eclipse.osee.framework.core.exception.OseeCoreException;
import org.eclipse.osee.framework.core.model.Branch;
import org.eclipse.osee.framework.jdk.core.util.Lib;
import org.eclipse.osee.framework.jdk.core.util.Strings;
import org.eclipse.osee.framework.logging.OseeLog;
import org.eclipse.osee.framework.plugin.core.util.OseeData;
import org.eclipse.osee.framework.skynet.core.artifact.Artifact;
import org.eclipse.osee.framework.skynet.core.artifact.ArtifactTypeManager;
import org.eclipse.osee.framework.skynet.core.artifact.search.ArtifactQuery;
import org.eclipse.osee.framework.skynet.core.transaction.SkynetTransaction;
import org.eclipse.osee.framework.skynet.core.utility.ElapsedTime;
import org.eclipse.osee.framework.ui.plugin.util.Result;

/**
 * @author Donald G. Dunne
 */
public class OseeCoveragePackageStore extends OseeCoverageStore implements ISaveable {
   private final CoveragePackage coveragePackage;
   private CoverageOptionManager coverageOptionManager = CoverageOptionManagerDefault.instance();
   public static String IMPORT_RECORD_NAME = "Coverage Import Record";

   public OseeCoveragePackageStore(Artifact artifact) throws OseeCoreException {
      super(null, CoverageArtifactTypes.CoveragePackage, artifact.getBranch());
      this.artifact = artifact;
      coverageOptionManager = new CoverageOptionManagerStore(this).getCoverageOptionManager();
      this.coveragePackage =
         new CoveragePackage(artifact.getGuid(), artifact.getName(), coverageOptionManager,
            new DbWorkProductTaskProvider(this.artifact.getBranch()));
      load(coverageOptionManager);
   }

   public OseeCoveragePackageStore(CoveragePackage coveragePackage, Branch branch) {
      super(coveragePackage, CoverageArtifactTypes.CoveragePackage, branch);
      this.coveragePackage = coveragePackage;
   }

   public CoveragePackage getCoveragePackage() {
      return coveragePackage;
   }

   public static OseeCoveragePackageStore get(CoveragePackage coveragePackage, Branch branch) {
      return new OseeCoveragePackageStore(coveragePackage, branch);
   }

   public static CoveragePackage get(Artifact artifact) throws OseeCoreException {
      OseeCoveragePackageStore packageStore = new OseeCoveragePackageStore(artifact);
      return packageStore.getCoveragePackage();
   }

   private void load(CoverageOptionManager coverageOptionManager) throws OseeCoreException {
      coveragePackage.clearCoverageUnits();
      if (artifact != null) {
         coveragePackage.setEditable(artifact.getSoleAttributeValue(CoreAttributeTypes.Active, true));
         for (Artifact childArt : artifact.getChildren()) {
            if (childArt.isOfType(CoverageArtifactTypes.CoverageUnit, CoverageArtifactTypes.CoverageFolder)) {
               coveragePackage.addCoverageUnit(OseeCoverageUnitStore.get(coveragePackage, childArt,
                  coverageOptionManager));
            }
         }
      }
      loadWorkProductTaskNames(coveragePackage.getCoverageUnits());
   }

   public void loadWorkProductTaskNames(Collection<? extends ICoverage> coverages) {
      this.coveragePackage.getWorkProductTaskProvider().reload();
      loadWorkProductTaskNamesHelper(coverages);
   }

   private void loadWorkProductTaskNamesHelper(Collection<? extends ICoverage> coverages) {
      for (ICoverage coverage : coverages) {
         if (coverage instanceof IWorkProductRelatable) {
            if (Strings.isValid(((IWorkProductRelatable) coverage).getWorkProductTaskGuid())) {
               ((IWorkProductRelatable) coverage).setWorkProductTask(this.coveragePackage.getWorkProductTaskProvider().getWorkProductTask(
                  ((IWorkProductRelatable) coverage).getWorkProductTaskGuid()));
            }
         }
         if (coverage instanceof ICoverageUnitProvider) {
            loadWorkProductTaskNamesHelper(((ICoverageUnitProvider) coverage).getCoverageUnits());
         }
         if (coverage instanceof ICoverageItemProvider) {
            loadWorkProductTaskNamesHelper(((ICoverageItemProvider) coverage).getCoverageItems());
         }
      }
   }

   @Override
   public Result save(SkynetTransaction transaction, CoveragePackageEvent coverageEvent) throws OseeCoreException {
      boolean newCoveragePackage = getArtifact(false) == null;
      getArtifact(true);
      ElapsedTime elapsedTime = new ElapsedTime(getClass().getSimpleName() + " - save");
      artifact.setName(coveragePackage.getName());
      coverageEvent.getPackage().setEventType(newCoveragePackage ? CoverageEventType.Added : CoverageEventType.Modified);
      artifact.setSoleAttributeValue(CoreAttributeTypes.Active, coveragePackage.isEditable().isTrue());
      for (CoverageUnit coverageUnit : coveragePackage.getCoverageUnits()) {
         OseeCoverageUnitStore store = new OseeCoverageUnitStore(coverageUnit, artifact.getBranch());
         store.save(transaction, coverageEvent);
         Artifact childArt = store.getArtifact(false);
         if (childArt.getParent() == null && !artifact.getChildren().contains(childArt)) {
            artifact.addChild(store.getArtifact(false));
         }
      }
      artifact.persist(transaction);
      elapsedTime.end();
      return Result.TrueResult;
   }

   public Result save(SkynetTransaction transaction, CoveragePackageEvent coverageEvent, Collection<ICoverage> coverages) throws OseeCoreException {
      ElapsedTime elapsedTime = new ElapsedTime(getClass().getSimpleName() + " - save(coverages)");
      for (ICoverage coverage : coverages) {
         CoverageUnit coverageUnit = null;
         if (coverage instanceof CoverageItem) {
            coverageUnit = ((CoverageItem) coverage).getCoverageUnit();
         } else if (coverage instanceof CoverageUnit) {
            coverageUnit = (CoverageUnit) coverage;
         } else {
            throw new OseeArgumentException("Unhandled coverage type");
         }
         OseeCoverageUnitStore store = new OseeCoverageUnitStore(coverageUnit, transaction.getBranch());
         store.save(transaction, coverageEvent);
      }
      elapsedTime.end();
      return Result.TrueResult;
   }

   @Override
   public Result saveImportRecord(SkynetTransaction transaction, CoverageImport coverageImport) throws OseeCoreException {
      if (coverageImport == null) {
         return Result.FalseResult;
      }
      Artifact importRecordArt = null;
      for (Artifact artifact : getArtifact(false).getChildren()) {
         if (artifact.getName().equals(IMPORT_RECORD_NAME)) {
            importRecordArt = artifact;
            break;
         }
      }
      if (importRecordArt == null) {
         importRecordArt =
            ArtifactTypeManager.addArtifact(CoreArtifactTypes.GeneralDocument, artifact.getBranch(), IMPORT_RECORD_NAME);
         // must set the extension before setting content
         importRecordArt.setSoleAttributeFromString(CoreAttributeTypes.Extension, "zip");
         getArtifact(false).addChild(importRecordArt);
         getArtifact(false).persist(transaction);
      }
      importRecordArt.setSoleAttributeFromStream(CoreAttributeTypes.NativeContent, getInputStream(coverageImport));
      importRecordArt.persist(transaction);
      return Result.TrueResult;
   }

   public static InputStream getInputStream(CoverageImport coverageImport) {
      try {
         File zipFile = OseeData.getFile("coverage.zip");
         Lib.compressFiles(coverageImport.getImportDirectory(), coverageImport.getImportRecordFiles(),
            zipFile.getAbsolutePath());
         return new FileInputStream(zipFile);
      } catch (Exception ex) {
         OseeLog.log(Activator.class, Level.SEVERE, ex);
      }
      return null;
   }

   @Override
   public void delete(SkynetTransaction transaction, CoveragePackageEvent coverageEvent, boolean purge) throws OseeCoreException {
      if (getArtifact(false) != null) {
         if (purge) {
            getArtifact(false).purgeFromBranch();
         } else {
            getArtifact(false).deleteAndPersist(transaction);
         }
      }
      for (CoverageUnit childCoverageUnit : coveragePackage.getCoverageUnits()) {
         new OseeCoverageUnitStore(childCoverageUnit, transaction.getBranch()).delete(transaction, coverageEvent, purge);
      }
   }

   @Override
   public Result isEditable() {
      return coveragePackage.isEditable();
   }

   public static Collection<Artifact> getCoveragePackageArtifacts(Branch branch) throws OseeCoreException {
      return ArtifactQuery.getArtifactListFromType(CoverageArtifactTypes.CoveragePackage, branch);
   }

   @Override
   public Result save(Collection<ICoverage> coverages) {
      try {
         SkynetTransaction transaction = new SkynetTransaction(branch, "Coverage Save");
         CoveragePackageEvent coverageEvent = new CoveragePackageEvent(coveragePackage, CoverageEventType.Modified);
         save(transaction, coverageEvent, coverages);
         transaction.execute();
         CoverageEventManager.getInstance().sendRemoteEvent(coverageEvent);
      } catch (OseeCoreException ex) {
         OseeLog.log(Activator.class, Level.SEVERE, ex);
         return new Result("Save Failed: " + ex.getLocalizedMessage());
      }
      return Result.TrueResult;

   }

   public CoverageOptionManager getCoverageOptionManager() {
      return coverageOptionManager;
   }

   public void setCoverageOptionManager(CoverageOptionManager coverageOptionManager) {
      this.coverageOptionManager = coverageOptionManager;
   }

   @Override
   public CoveragePackageEvent getBaseCoveragePackageEvent(CoverageEventType coverageEventType) {
      return new CoveragePackageEvent(coveragePackage, coverageEventType);
   }
}

Back to the top