Skip to main content
summaryrefslogtreecommitdiffstats
blob: 2fa7e324e2f3a4113940e453a58179088487c8b8 (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
/*******************************************************************************
 * 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.define.traceability.data;

import java.util.List;
import java.util.Map;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.osee.define.DefinePlugin;
import org.eclipse.osee.framework.core.model.Branch;
import org.eclipse.osee.framework.skynet.core.artifact.Artifact;

/**
 * @author Roberto E. Escobar
 */
public abstract class BaseTraceDataCache {

   private boolean isInitialized;
   private final Branch branch;
   private final String traceType;

   public BaseTraceDataCache(String traceType, Branch branch) {
      isInitialized = false;
      this.traceType = traceType;
      this.branch = branch;
   }

   public boolean isInitialized() {
      return isInitialized;
   }

   public Branch getBranch() {
      return branch;
   }

   public final IStatus initialize(IProgressMonitor monitor) {
      IStatus toReturn = Status.CANCEL_STATUS;
      try {
         reset();
         monitor.subTask(String.format("Loading %s from: [%s]", traceType, getBranch().getShortName()));

         doBulkLoad(monitor);

         if (monitor.isCanceled() != true) {
            toReturn = Status.OK_STATUS;
         }
         isInitialized = true;
      } catch (Exception ex) {
         toReturn = new Status(IStatus.ERROR, DefinePlugin.PLUGIN_ID, String.format("Loading %s ", traceType), ex);
      }
      return toReturn;
   }

   protected abstract void doBulkLoad(IProgressMonitor monitor) throws Exception;

   protected void populateTraceMap(IProgressMonitor monitor, List<Artifact> artList, Map<String, Artifact> toPopulate) {
      for (Artifact artifact : artList) {
         toPopulate.put(asTraceMapKey(artifact), artifact);
      }
   }

   protected String asTraceMapKey(Artifact artifact) {
      return artifact.getName();
   }

   public void reset() {
      isInitialized = false;
   }
}

Back to the top