KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > opencms > workplace > tools > content > check > CmsContentCheckResult


1 /*
2  * File : $Source: /usr/local/cvs/opencms/src-modules/org/opencms/workplace/tools/content/check/CmsContentCheckResult.java,v $
3  * Date : $Date: 2006/03/27 14:52:54 $
4  * Version: $Revision: 1.2 $
5  *
6  * This library is part of OpenCms -
7  * the Open Source Content Mananagement System
8  *
9  * Copyright (C) 2005 Alkacon Software GmbH (http://www.alkacon.com)
10  *
11  * This library is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Lesser General Public
13  * License as published by the Free Software Foundation; either
14  * version 2.1 of the License, or (at your option) any later version.
15  *
16  * This library is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19  * Lesser General Public License for more details.
20  *
21  * For further information about Alkacon Software GmbH, please see the
22  * company website: http://www.alkacon.com
23  *
24  * For further information about OpenCms, please see the
25  * project website: http://www.opencms.org
26  *
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30  */
31
32 package org.opencms.workplace.tools.content.check;
33
34 import java.util.ArrayList JavaDoc;
35 import java.util.HashMap JavaDoc;
36 import java.util.List JavaDoc;
37 import java.util.Map JavaDoc;
38
39 /**
40  * This class holds the results of the content tests and provides methods to access the collected
41  * errors and warnings.<p>
42  *
43  *
44  * @author Michael Emmerich
45  *
46  * @version $Revision: 1.2 $
47  *
48  * @since 6.1.2
49  */
50 public class CmsContentCheckResult {
51
52     /** List of all CmsContentCheckResource with collected warnings or errors. */
53     private List JavaDoc m_allCheckResources;
54
55     /** List of all resources with collected warnings or errors. */
56     private List JavaDoc m_allResources;
57
58     /** List of all CmsContentCheckResource with collected errors. */
59     private List JavaDoc m_errorCheckResources;
60
61     /** List containing all recouces that collected errors. */
62     private List JavaDoc m_errorResources;
63
64     /**
65      * Map containing all all collected errors. Resourcenames are used as keys,
66      * lists are used as values
67      */
68     private Map JavaDoc m_errors;
69
70     /** List of all CmsContentCheckResource with collected warnings. */
71     private List JavaDoc m_warningCheckResources;
72
73     /** List containing all recouces that collected warnings. */
74     private List JavaDoc m_warningResources;
75
76     /**
77      * Map containing all all collected warnings. Resourcenames are used as keys,
78      * lists are used as values
79      */
80     private Map JavaDoc m_warnings;
81
82     /**
83      * Constructor, creates an empty CmsContentCheckResult.<p> *
84      */
85     public CmsContentCheckResult() {
86
87         m_errors = new HashMap JavaDoc();
88         m_warnings = new HashMap JavaDoc();
89         m_errorResources = new ArrayList JavaDoc();
90         m_warningResources = new ArrayList JavaDoc();
91         m_allResources = new ArrayList JavaDoc();
92         m_errorCheckResources = new ArrayList JavaDoc();
93         m_warningCheckResources = new ArrayList JavaDoc();
94         m_allCheckResources = new ArrayList JavaDoc();
95     }
96
97     /**
98      * Adds the testing results of a CmsContentCheckResource to the result lists.<p>
99      * @param testResource the CmsContentCheckResource to add the results from
100      */
101     public void addResult(CmsContentCheckResource testResource) {
102
103         List JavaDoc warnings = testResource.getWarnings();
104         List JavaDoc errors = testResource.getErrors();
105         // add the warnings if there were any
106 if (warnings != null && warnings.size() > 0) {
107             m_warnings.put(testResource.getResourceName(), warnings);
108             m_warningResources.add(testResource.getResource());
109             m_warningCheckResources.add(testResource);
110         }
111         // add the errors if there were any
112 if (errors != null && errors.size() > 0) {
113             m_errors.put(testResource.getResourceName(), errors);
114             m_errorResources.add(testResource.getResource());
115             m_errorCheckResources.add(testResource);
116         }
117         m_allResources.add(testResource.getResource());
118         m_allCheckResources.add(testResource);
119     }
120
121     /**
122      * Gets a list of all CmsContentCheckResource that colleced an error or a warning during the content check.<p>
123      * @return List of CmsContentCheckResource which collected an error or a warning.
124      */
125     public List JavaDoc getAllCheckResources() {
126
127         return m_allResources;
128     }
129
130     /**
131      * Gets a list of all resources that colleced an error or a warning during the content check.<p>
132      * @return List of CmsResources which collected an error or a warning.
133      */
134     public List JavaDoc getAllResources() {
135
136         return m_allResources;
137     }
138
139     /**
140      * Gets a list of all CmsContentCheckResource that colleced an error during the content check.<p>
141      * @return List of CmsContentCheckResource which collected an error.
142      */
143     public List JavaDoc getErrorCheckResources() {
144
145         return m_errorCheckResources;
146     }
147
148     /**
149      * Gets a list of all resources that colleced an error during the content check.<p>
150      * @return List of CmsResources which collected an error.
151      */
152     public List JavaDoc getErrorResources() {
153
154         return m_errorResources;
155     }
156
157     /**
158      * Gets a map of all error collected during the content check. <p>
159      *
160      * The map contains the complete resource root path as keys and a list of errors
161      * as values.
162      * @return map of collected warnings
163      */
164     public Map JavaDoc getErrors() {
165
166         return m_errors;
167     }
168
169     /**
170      * Gets a list of errors collected during the content check for a given
171      * resource.<p>
172      *
173      * @param resourceName the complete root path of the resource to get the list from
174      * @return list of error messages or null if no warnings are found
175      */
176     public List JavaDoc getErrors(String JavaDoc resourceName) {
177
178         return (List JavaDoc)m_errors.get(resourceName);
179     }
180
181     /**
182      * Gets a list of all CmsContentCheckResource that colleced a warning during the content check.<p>
183      * @return List of CmsContentCheckResource which collected a warning.
184      */
185     public List JavaDoc getWarningCheckResources() {
186
187         return m_warningCheckResources;
188     }
189
190     /**
191      * Gets a list of all resources that colleced a warning during the content check.<p>
192      * @return List of CmsResources which collected a warning.
193      */
194     public List JavaDoc getWarningResources() {
195
196         return m_warningResources;
197     }
198
199     /**
200      * Gets a map of all warnings collected during the content check. <p>
201      *
202      * The map contains the complete resource root path as keys and a list of warnings
203      * as values.
204      * @return map of collected warnings
205      */
206     public Map JavaDoc getWarnings() {
207
208         return m_warnings;
209     }
210
211     /**
212      * Gets a list of warnings collected during the content check for a given
213      * resource.<p>
214      *
215      * @param resourceName the complete root path of the resource to get the list from
216      * @return list of warning messages or null if no warnings are found
217      */
218     public List JavaDoc getWarnings(String JavaDoc resourceName) {
219
220         return (List JavaDoc)m_warnings.get(resourceName);
221     }
222
223 }
224
Popular Tags