01: /*
02: * Hammurapi
03: * Automated Java code review system.
04: * Copyright (C) 2004 Hammurapi Group
05: *
06: * This program is free software; you can redistribute it and/or modify
07: * it under the terms of the GNU General Public License as published by
08: * the Free Software Foundation; either version 2 of the License, or
09: * (at your option) any later version.
10: *
11: * This program is distributed in the hope that it will be useful,
12: * but WITHOUT ANY WARRANTY; without even the implied warranty of
13: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14: * GNU General Public License for more details.
15: *
16: * You should have received a copy of the GNU General Public License
17: * along with this program; if not, write to the Free Software
18: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19: *
20: * URL: http://www.hammurapi.org
21: * e-Mail: support@hammurapi.biz
22: */
23: package org.hammurapi.results;
24:
25: import java.util.Collection;
26: import java.util.Map;
27:
28: import org.hammurapi.HammurapiException;
29: import org.hammurapi.Violation;
30: import org.hammurapi.Waiver;
31: import org.hammurapi.WaiverSet;
32:
33: import com.pavelvlasov.review.SourceMarker;
34:
35: /**
36: * @author Pavel Vlasov
37: * @version $Revision: 1.5 $
38: */
39: public interface AggregatedResults extends BasicResults {
40: /**
41: * Add violation to severity summary
42: * @param violation
43: * @return null if violation was added, Waiver if it was waived
44: */
45: Waiver addViolation(Violation violation) throws HammurapiException;
46:
47: Map getSeveritySummary();
48:
49: Collection getWarnings();
50:
51: boolean hasWarnings();
52:
53: void addWarning(Violation warning);
54:
55: void addMetric(SourceMarker source, String name, double value);
56:
57: Map getMetrics();
58:
59: // public boolean isIncomplete() {
60: void aggregate(AggregatedResults agregee);
61:
62: /**
63: * Sets number of reviews.
64: * @param reviews The reviews to set.
65: */
66: void setReviewsNumber(long reviews);
67:
68: void setCodeBase(long codeBase);
69:
70: void addAnnotation(Annotation annotation);
71:
72: Collection getAnnotations();
73:
74: WaiverSet getWaiverSet();
75:
76: /**
77: * Commits results, which means that all calculations
78: * for results was completed successfully.
79: */
80: void commit() throws HammurapiException;
81:
82: /**
83: * @return true this review result or one of its children is
84: * different from the previous run.
85: */
86: boolean isNew();
87:
88: /**
89: *
90: * @return Baseline basic results
91: */
92: BasicResults getBaseLine();
93: }
|