001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (C) Alkacon Software (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.containerpage;
029
030import org.opencms.file.CmsResource;
031import org.opencms.util.CmsUUID;
032
033import java.util.ArrayList;
034import java.util.Collections;
035import java.util.HashSet;
036import java.util.List;
037import java.util.Set;
038
039import com.google.gwt.user.client.rpc.IsSerializable;
040
041/**
042 * Helper bean used to collect a list of resources (usually relation targets) and keep track of whether any of them
043 * have the "changed" state.<p>
044 */
045public class CmsRelationTargetListBean implements IsSerializable {
046
047    /** True if any of the resources have been changed. */
048    private boolean m_changed;
049
050    /** The already processed structure IDs, used to eliminate duplicates. */
051    private transient Set<CmsUUID> m_processedIds = new HashSet<CmsUUID>();
052
053    /** The collected resources. */
054    private List<CmsResource> m_resources = new ArrayList<CmsResource>();
055
056    /**
057     * Creates a new instance.<p>
058     */
059    public CmsRelationTargetListBean() {
060
061    }
062
063    /**
064     * Adds a new resource.<p>
065     *
066     * @param resource the resource to add
067     */
068    public void add(CmsResource resource) {
069
070        if (!m_processedIds.contains(resource.getStructureId())) {
071            m_resources.add(resource);
072            m_processedIds.add(resource.getStructureId());
073            m_changed |= !(resource.getState().isUnchanged());
074        }
075    }
076
077    /**
078     * Gets the list of resources which have been added.<p>
079     *
080     * @return the list of added resource
081     */
082    public List<CmsResource> getResources() {
083
084        return Collections.unmodifiableList(m_resources);
085    }
086
087    /**
088     * Returns true if any of the added resources have been changed.<p>
089     *
090     * @return true if any of the resources have been changed
091     */
092    public boolean isChanged() {
093
094        return m_changed;
095    }
096
097}