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.link;
029
030import org.opencms.file.CmsObject;
031import org.opencms.file.CmsResource;
032import org.opencms.workplace.explorer.CmsResourceUtil;
033import org.opencms.workplace.list.A_CmsListExplorerDialog;
034import org.opencms.workplace.list.A_CmsListResourceCollector;
035import org.opencms.workplace.list.CmsListItem;
036
037import java.util.ArrayList;
038import java.util.List;
039import java.util.Map;
040
041/**
042 * Collector for file with broken links.<p>
043 *
044 * @since 6.1.0
045 */
046public class CmsInternalLinkValidationFilesCollector extends A_CmsListResourceCollector {
047
048    /** Parameter of the default collector name. */
049    public static final String COLLECTOR_NAME = "brokenlinks";
050
051    /** The list of resources with broken links. */
052    private List<CmsResource> m_resourcesBroken;
053
054    /**
055     * Constructor, creates a new instance.<p>
056     *
057     * @param wp the workplace object
058     * @param resources the resources with broken links
059     */
060    public CmsInternalLinkValidationFilesCollector(A_CmsListExplorerDialog wp, List<CmsResource> resources) {
061
062        super(wp);
063        m_resourcesBroken = resources;
064    }
065
066    /**
067     * @see org.opencms.file.collectors.I_CmsResourceCollector#getCollectorNames()
068     */
069    public List<String> getCollectorNames() {
070
071        List<String> names = new ArrayList<String>();
072        names.add(COLLECTOR_NAME);
073        return names;
074    }
075
076    /**
077     * @see org.opencms.workplace.list.A_CmsListResourceCollector#getResources(org.opencms.file.CmsObject, java.util.Map)
078     */
079    @Override
080    public List<CmsResource> getResources(CmsObject cms, Map<String, String> params) {
081
082        return m_resourcesBroken;
083    }
084
085    /**
086     * @see org.opencms.workplace.list.A_CmsListResourceCollector#setAdditionalColumns(org.opencms.workplace.list.CmsListItem, org.opencms.workplace.explorer.CmsResourceUtil)
087     */
088    @Override
089    protected void setAdditionalColumns(CmsListItem item, CmsResourceUtil resUtil) {
090
091        // no-op
092    }
093}