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, 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.ade.publish;
029
030import org.opencms.ade.publish.shared.CmsPublishGroup;
031import org.opencms.ade.publish.shared.CmsPublishResource;
032
033import java.util.ArrayList;
034import java.util.List;
035import java.util.Locale;
036
037/**
038 * Publish group helper which only puts all publish resources into a single group.<p>
039 */
040public class CmsSinglePublishGroupHelper extends A_CmsPublishGroupHelper<CmsPublishResource, CmsPublishGroup> {
041
042    /** The title to use for the single group. */
043    private String m_title;
044
045    /**
046     * Creates a new instance.<p>
047     *
048     * @param locale the locale to use
049     * @param title the title to use for the single group
050     */
051    public CmsSinglePublishGroupHelper(Locale locale, String title) {
052
053        super(locale);
054        m_title = title;
055    }
056
057    /**
058     * @see org.opencms.ade.publish.A_CmsPublishGroupHelper#getGroups(java.util.List)
059     */
060    @Override
061    public List<CmsPublishGroup> getGroups(List<CmsPublishResource> resources) {
062
063        List<CmsPublishGroup> result = new ArrayList<CmsPublishGroup>();
064        if (!resources.isEmpty()) { // only add a group if there are resources
065            List<CmsPublishResource> copyResources = new ArrayList<CmsPublishResource>(resources);
066            CmsPublishGroup singleGroup = new CmsPublishGroup(m_title, copyResources);
067            result.add(singleGroup);
068        }
069        return result;
070    }
071
072    /**
073     * @see org.opencms.ade.publish.A_CmsPublishGroupHelper#createGroup(java.lang.String, java.util.List)
074     */
075    @Override
076    protected CmsPublishGroup createGroup(String name, List<CmsPublishResource> resources) {
077
078        return new CmsPublishGroup(name, resources);
079    }
080
081    /**
082     * @see org.opencms.ade.publish.A_CmsPublishGroupHelper#getDateLastModified(java.lang.Object)
083     */
084    @Override
085    protected long getDateLastModified(CmsPublishResource res) {
086
087        return res.getDateLastModified();
088    }
089
090    /**
091     * @see org.opencms.ade.publish.A_CmsPublishGroupHelper#getRootPath(java.lang.Object)
092     */
093    @Override
094    protected String getRootPath(CmsPublishResource res) {
095
096        return res.getName();
097    }
098
099}