KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > hammurapi > results > AggregatedResults


1 /*
2  * Hammurapi
3  * Automated Java code review system.
4  * Copyright (C) 2004 Hammurapi Group
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (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 JavaDoc;
26 import java.util.Map JavaDoc;
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 JavaDoc getSeveritySummary();
48     Collection JavaDoc getWarnings();
49     boolean hasWarnings();
50     void addWarning(Violation warning);
51     void addMetric(SourceMarker source, String JavaDoc name, double value);
52     Map JavaDoc getMetrics();
53     // public boolean isIncomplete() {
54 void aggregate(AggregatedResults agregee);
55     /**
56      * Sets number of reviews.
57      * @param reviews The reviews to set.
58      */
59     void setReviewsNumber(long reviews);
60     void setCodeBase(long codeBase);
61     
62     void addAnnotation(Annotation annotation);
63     Collection JavaDoc getAnnotations();
64     
65     WaiverSet getWaiverSet();
66     
67     /**
68      * Commits results, which means that all calculations
69      * for results was completed successfully.
70      */
71     void commit() throws HammurapiException;
72     
73     /**
74      * @return true this review result or one of its children is
75      * different from the previous run.
76      */
77     boolean isNew();
78     
79     /**
80      *
81      * @return Baseline basic results
82      */
83     BasicResults getBaseLine();
84 }
Popular Tags