Skip to main content
summaryrefslogtreecommitdiffstats
blob: 5af40533acab9b978128202fec5da726b009643e (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
/*******************************************************************************
 * 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.core.util;

import java.util.ArrayList;
import java.util.List;
import java.util.regex.Pattern;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.osee.framework.jdk.core.type.CountingMap;
import org.eclipse.osee.framework.jdk.core.util.Collections;
import org.eclipse.osee.framework.jdk.core.util.Lib;
import org.eclipse.osee.framework.logging.IHealthStatus;
import org.eclipse.osee.framework.logging.SevereLoggingMonitor;

/**
 * Used to log Info, Warning and Errors to multiple locations (logger, stderr/out and XResultView). Upon completion, a
 * call to report(title) will open results in the ResultsView
 *
 * @author Donald G. Dunne
 */
public class XResultData {

   public static final Pattern ErrorPattern = Pattern.compile("Error: ");
   public static final Pattern WarningPattern = Pattern.compile("Warning: ");
   public List<IResultDataListener> listeners;
   public String title;

   public static enum Type {
      Severe,
      Warning,
      Info;
   }

   private StringBuilder sb;
   private CountingMap<Type> count;

   private boolean enableOseeLog;

   public XResultData() {
      this(true);
   }

   public XResultData(boolean enableOseeLog) {
      super();
      this.enableOseeLog = enableOseeLog;
      clear();
   }

   public XResultData(boolean enableOseeLog, IResultDataListener... listeners) {
      super();
      this.enableOseeLog = enableOseeLog;
      clear();
      if (listeners != null && listeners.length > 0) {
         this.listeners = Collections.getAggregate(listeners);
      }
   }

   public void clear() {
      sb = new StringBuilder();
      count = new CountingMap<Type>();
   }

   public void addRaw(String str) {
      sb.append(str);
   }

   public void reportSevereLoggingMonitor(SevereLoggingMonitor monitorLog) {
      List<IHealthStatus> stats = monitorLog.getAllLogs();
      for (IHealthStatus stat : new ArrayList<IHealthStatus>(stats)) {
         if (stat.getException() != null) {
            error("Exception: " + Lib.exceptionToString(stat.getException()));
         }
      }
   }

   public void log(IProgressMonitor monitor, String str) {
      log(str);
      if (monitor != null) {
         monitor.setTaskName(str);
      }
   }

   /**
    * Adds string with newline to log
    */
   public void log(String str) {
      logStr(Type.Info, str + "\n");
   }

   public void logf(String formatStr, Object... objs) {
      logStr(Type.Info, String.format(formatStr, objs));
   }

   /**
    * Adds string with newline to log as error
    */
   public void error(String str) {
      logStr(Type.Severe, str + "\n");
   }

   public void errorf(String formatStr, Object... objs) {
      logStr(Type.Severe, String.format(formatStr + "\n", objs));
   }

   /**
    * Adds string with newline to log as warning
    */
   public void warning(String str) {
      logStr(Type.Warning, str + "\n");
   }

   public void warningf(String formatStr, Object... objs) {
      logStr(Type.Warning, String.format(formatStr + "\n", objs));
   }

   public boolean isEmpty() {
      return toString().equals("");
   }

   public void bumpCount(Type type, int byAmt) {
      count.put(type, byAmt);
   }

   public void logStr(Type type, final String str) {
      bumpCount(type, 1);
      String resultStr = "";
      if (type == Type.Warning) {
         resultStr = "Warning: " + str;
      } else if (type == Type.Severe) {
         resultStr = "Error: " + str;
      } else {
         resultStr = str;
      }
      addRaw(resultStr);
      if (listeners != null) {
         for (IResultDataListener listener : listeners) {
            listener.log(type, resultStr);
         }
      }
   }

   public void dispose() {
      // provided for subclass implementation
   }

   @Override
   public String toString() {
      return sb.toString();
   }

   private int getCount(Type type) {
      return count.get(type);
   }

   public int getNumErrors() {
      return getCount(Type.Severe);
   }

   /**
    * XResultData counts number of errors logged with logError, however users can insert their own "Error: " strings to
    * produce errors. This counts based on these occurrences.
    */
   public int getNumErrorsViaSearch() {
      return Lib.getMatcherCount(ErrorPattern, toString());
   }

   /**
    * XResultData counts number of warnings logged with logWarning, however users can insert their own "Error: " strings
    * to produce errors. This counts based on these occurrences.
    */
   public int getNumWarningsViaSearch() {
      return Lib.getMatcherCount(WarningPattern, toString());
   }

   public int getNumWarnings() {
      return getCount(Type.Warning);
   }

   public boolean isEnableOseeLog() {
      return enableOseeLog;
   }

   public void setEnableOseeLog(boolean enableOseeLog) {
      this.enableOseeLog = enableOseeLog;
   }

   public boolean isErrors() {
      return getNumErrors() > 0;
   }

   public String getTitle() {
      return title;
   }

   public void setTitle(String title) {
      this.title = title;
   }

}

Back to the top