Home

Contribute

Source code


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

/*******************************************************************************
 * 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.report;

import java.util.HashSet;
import java.util.Set;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.osee.framework.jdk.core.type.OseeCoreException;
import org.eclipse.osee.framework.skynet.core.artifact.Artifact;

/**
 * @author Roberto E. Escobar
 */
public abstract class AbstractReport {
   protected static final String EMPTY_STRING = "";
   private final Set<IReportDataCollector> dataCollectors;

   public AbstractReport() {
      this.dataCollectors = new HashSet<IReportDataCollector>();
   }

   public void addReportDataCollector(IReportDataCollector collector) {
      if (collector != null) {
         dataCollectors.add(collector);
      }
   }

   public void removeReportDataCollector(IReportDataCollector collector) {
      if (collector != null) {
         dataCollectors.remove(collector);
      }
   }

   protected void notifyOnTableHeader(String... header) {
      if (header != null && header.length > 0) {
         for (IReportDataCollector collector : dataCollectors) {
            collector.addTableHeader(header);
         }
      }
   }

   protected void notifyOnRowData(Artifact rowArt, String... rowData) {
      if (rowData != null && rowData.length > 0) {
         for (IReportDataCollector collector : dataCollectors) {
            collector.addRow(rowArt, rowData);
         }
      }
   }

   protected void notifyOnEndTable() {
      for (IReportDataCollector collector : dataCollectors) {
         collector.endTable();
      }
   }

   public abstract void process(IProgressMonitor monitor) throws OseeCoreException;

   public void clear() {
      // do nothing
   }
}