KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * File : $Source: /usr/local/cvs/opencms/src-modules/org/opencms/workplace/tools/content/check/CmsContentCheckCollector.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 org.opencms.file.CmsObject;
35 import org.opencms.workplace.list.CmsListResourcesCollector;
36
37 import java.util.List JavaDoc;
38
39 /**
40  * Collector for receiving CmsResources from a CmsContentCheckResult.<p>
41  *
42  * @author Michael Emmerich
43  *
44  * @version $Revision: 1.2 $
45  *
46  * @since 6.1.2
47  */
48 public class CmsContentCheckCollector extends CmsListResourcesCollector {
49
50     /** Parameter of the default collector name. */
51     public static final String JavaDoc COLLECTOR_NAME = "checkresources";
52
53     /** Parameter to get all resources with errors and warnings. */
54     public static final String JavaDoc PARAM_ALL = "all";
55
56     /** Parameter to get all resources with errors. */
57     public static final String JavaDoc PARAM_ERROR = "error";
58
59     /** Parameter to get all resources with warnings. */
60     public static final String JavaDoc PARAM_WARNING = "warning";
61
62     /** The list of resources delivered by the collector. */
63     private CmsContentCheckResult m_results;
64
65     /**
66      * Constructor, creates a new CmsContentCheckCollector.<p>
67      * @param results a CmsContentCheckResult object, containing the results of the content check.
68      */
69     public CmsContentCheckCollector(CmsContentCheckResult results) {
70
71         super(null);
72         setDefaultCollectorName(COLLECTOR_NAME);
73         setDefaultCollectorParam(PARAM_ALL);
74         m_results = results;
75     }
76
77     /**
78      * @see org.opencms.file.collectors.I_CmsResourceCollector#getCollectorNames()
79      */
80     public List JavaDoc getCollectorNames() {
81
82         List JavaDoc names = super.getCollectorNames();
83         names.add(COLLECTOR_NAME);
84         return names;
85     }
86
87     /**
88      * @see org.opencms.file.collectors.I_CmsResourceCollector#getResults(org.opencms.file.CmsObject)
89      */
90     public List JavaDoc getResults(CmsObject cms) {
91
92         return getResults(cms, COLLECTOR_NAME, getDefaultCollectorParam());
93     }
94
95     /**
96      * @see org.opencms.file.collectors.I_CmsResourceCollector#getResults(org.opencms.file.CmsObject, java.lang.String, java.lang.String)
97      */
98     public List JavaDoc getResults(CmsObject cms, String JavaDoc collectorName, String JavaDoc param) {
99
100         if (param.equals(PARAM_ERROR)) {
101             return m_results.getErrorResources();
102         } else if (param.equals(PARAM_WARNING)) {
103             return m_results.getWarningResources();
104         } else if (param.equals(PARAM_ALL)) {
105             return m_results.getAllResources();
106         } else {
107             // the default is to return all resources
108 return m_results.getAllResources();
109         }
110     }
111 }
112
Popular Tags