001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software GmbH & Co. KG, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.workplace.tools.content.check;
029
030import org.opencms.file.CmsObject;
031import org.opencms.workplace.explorer.CmsResourceUtil;
032import org.opencms.workplace.list.A_CmsListExplorerDialog;
033import org.opencms.workplace.list.A_CmsListResourceCollector;
034import org.opencms.workplace.list.CmsListItem;
035import org.opencms.workplace.list.I_CmsListResourceCollector;
036
037import java.util.ArrayList;
038import java.util.List;
039import java.util.Map;
040
041/**
042 * Collector for receiving {@link org.opencms.file.CmsResource} objects from a {@link CmsContentCheckResult}.<p>
043 *
044 * @since 6.1.2
045 */
046public class CmsContentCheckCollector extends A_CmsListResourceCollector {
047
048    /** Parameter of the default collector name. */
049    public static final String COLLECTOR_NAME = "checkresources";
050
051    /** Parameter to get all resources with errors and warnings. */
052    public static final String PARAM_ALL = "all";
053
054    /** Parameter to get all resources with errors. */
055    public static final String PARAM_ERROR = "error";
056
057    /** Parameter to get all resources with  warnings. */
058    public static final String PARAM_WARNING = "warning";
059
060    /** The list of resources delivered by the collector. */
061    private CmsContentCheckResult m_results;
062
063    /**
064     * Constructor, creates a new CmsContentCheckCollector.<p>
065     *
066     * @param wp the workplace object
067     *
068     * @param results a CmsContentCheckResult object, containing the results of the content check.
069     */
070    public CmsContentCheckCollector(A_CmsListExplorerDialog wp, CmsContentCheckResult results) {
071
072        super(wp);
073        m_collectorParameter += I_CmsListResourceCollector.SEP_PARAM + PARAM_ALL;
074        m_results = results;
075    }
076
077    /**
078     * @see org.opencms.file.collectors.I_CmsResourceCollector#getCollectorNames()
079     */
080    public List getCollectorNames() {
081
082        List names = new ArrayList();
083        names.add(COLLECTOR_NAME);
084        return names;
085    }
086
087    /**
088     * @see org.opencms.workplace.list.A_CmsListResourceCollector#getResources(org.opencms.file.CmsObject, java.util.Map)
089     */
090    @Override
091    public List getResources(CmsObject cms, Map params) {
092
093        if (params.containsKey(PARAM_ERROR)) {
094            return m_results.getErrorResources();
095        } else if (params.containsKey(PARAM_WARNING)) {
096            return m_results.getWarningResources();
097        } else if (params.containsKey(PARAM_ALL)) {
098            return m_results.getAllResources();
099        } else {
100            // the default is to return all resources
101            return m_results.getAllResources();
102        }
103    }
104
105    /**
106     * @see org.opencms.workplace.list.A_CmsListResourceCollector#setAdditionalColumns(org.opencms.workplace.list.CmsListItem, org.opencms.workplace.explorer.CmsResourceUtil)
107     */
108    @Override
109    protected void setAdditionalColumns(CmsListItem item, CmsResourceUtil resUtil) {
110
111        // no-op
112    }
113}