001: /*
002: * File : $Source: /usr/local/cvs/opencms/src-modules/org/opencms/workplace/tools/content/check/CmsContentCheckResult.java,v $
003: * Date : $Date: 2008-02-27 12:05:42 $
004: * Version: $Revision: 1.5 $
005: *
006: * This library is part of OpenCms -
007: * the Open Source Content Management System
008: *
009: * Copyright (c) 2002 - 2008 Alkacon Software GmbH (http://www.alkacon.com)
010: *
011: * This library is free software; you can redistribute it and/or
012: * modify it under the terms of the GNU Lesser General Public
013: * License as published by the Free Software Foundation; either
014: * version 2.1 of the License, or (at your option) any later version.
015: *
016: * This library is distributed in the hope that it will be useful,
017: * but WITHOUT ANY WARRANTY; without even the implied warranty of
018: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
019: * Lesser General Public License for more details.
020: *
021: * For further information about Alkacon Software GmbH, please see the
022: * company website: http://www.alkacon.com
023: *
024: * For further information about OpenCms, please see the
025: * project website: http://www.opencms.org
026: *
027: * You should have received a copy of the GNU Lesser General Public
028: * License along with this library; if not, write to the Free Software
029: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
030: */
031:
032: package org.opencms.workplace.tools.content.check;
033:
034: import java.util.ArrayList;
035: import java.util.HashMap;
036: import java.util.List;
037: import java.util.Map;
038:
039: /**
040: * This class holds the results of the content tests and provides methods to access the collected
041: * errors and warnings.<p>
042: *
043: *
044: * @author Michael Emmerich
045: *
046: * @version $Revision: 1.5 $
047: *
048: * @since 6.1.2
049: */
050: public class CmsContentCheckResult {
051:
052: /** List of all CmsContentCheckResource with collected warnings or errors. */
053: private List m_allCheckResources;
054:
055: /** List of all resources with collected warnings or errors. */
056: private List m_allResources;
057:
058: /** List of all CmsContentCheckResource with collected errors. */
059: private List m_errorCheckResources;
060:
061: /** List containing all recouces that collected errors. */
062: private List m_errorResources;
063:
064: /**
065: * Map containing all all collected errors. Resourcenames are used as keys,
066: * lists are used as values.
067: */
068: private Map m_errors;
069:
070: /** List of all CmsContentCheckResource with collected warnings. */
071: private List m_warningCheckResources;
072:
073: /** List containing all recouces that collected warnings. */
074: private List m_warningResources;
075:
076: /**
077: * Map containing all all collected warnings. Resourcenames are used as keys,
078: * lists are used as values.
079: */
080: private Map m_warnings;
081:
082: /**
083: * Constructor, creates an empty CmsContentCheckResult.<p>
084: */
085: public CmsContentCheckResult() {
086:
087: m_errors = new HashMap();
088: m_warnings = new HashMap();
089: m_errorResources = new ArrayList();
090: m_warningResources = new ArrayList();
091: m_allResources = new ArrayList();
092: m_errorCheckResources = new ArrayList();
093: m_warningCheckResources = new ArrayList();
094: m_allCheckResources = new ArrayList();
095: }
096:
097: /**
098: * Adds the testing results of a CmsContentCheckResource to the result lists.<p>
099: * @param testResource the CmsContentCheckResource to add the results from
100: */
101: public void addResult(CmsContentCheckResource testResource) {
102:
103: List warnings = testResource.getWarnings();
104: List 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 getAllCheckResources() {
126:
127: return m_allCheckResources;
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 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 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 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 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 getErrors(String resourceName) {
177:
178: return (List) 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 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 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 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 getWarnings(String resourceName) {
219:
220: return (List) m_warnings.get(resourceName);
221: }
222:
223: }
|