001/*
002 * (C) Copyright 2011 Nuxeo SA (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     Anahide Tchertchian
016 */
017package org.nuxeo.ecm.platform.forms.layout.core.registries;
018
019import java.util.ArrayList;
020import java.util.List;
021
022import org.nuxeo.ecm.platform.forms.layout.api.LayoutDefinition;
023import org.nuxeo.runtime.model.SimpleContributionRegistry;
024
025/**
026 * Registry holding layout definitions for a given category
027 *
028 * @since 5.5
029 */
030public class LayoutDefinitionRegistry extends SimpleContributionRegistry<LayoutDefinition> {
031
032    protected final String category;
033
034    public LayoutDefinitionRegistry(String category) {
035        super();
036        this.category = category;
037    }
038
039    public String getCategory() {
040        return category;
041    }
042
043    public List<String> getLayoutNames() {
044        List<String> res = new ArrayList<String>();
045        res.addAll(currentContribs.keySet());
046        return res;
047    }
048
049    @Override
050    public String getContributionId(LayoutDefinition contrib) {
051        return contrib.getName();
052    }
053
054    public LayoutDefinition getLayoutDefinition(String id) {
055        return getCurrentContribution(id);
056    }
057
058    @Override
059    // overridden to handle aliases
060    public synchronized void addContribution(LayoutDefinition contrib) {
061        super.addContribution(contrib);
062        List<String> aliases = contrib.getAliases();
063        if (aliases != null) {
064            for (String alias : aliases) {
065                FragmentList<LayoutDefinition> head = addFragment(alias, contrib);
066                contributionUpdated(alias, head.merge(this), contrib);
067            }
068        }
069    }
070
071    /**
072     * Overridden to use equals method when removing elements.
073     *
074     * @since 7.2
075     */
076    @Override
077    public synchronized void removeContribution(LayoutDefinition contrib) {
078        removeContribution(contrib, true);
079    }
080
081    @Override
082    // overridden to handle aliases
083    public synchronized void removeContribution(LayoutDefinition contrib, boolean useEqualsMethod) {
084        super.removeContribution(contrib, useEqualsMethod);
085        List<String> aliases = contrib.getAliases();
086        if (aliases != null) {
087            for (String alias : aliases) {
088                FragmentList<LayoutDefinition> head = removeFragment(alias, contrib, useEqualsMethod);
089                if (head != null) {
090                    LayoutDefinition result = head.merge(this);
091                    if (result != null) {
092                        contributionUpdated(alias, result, contrib);
093                    } else {
094                        contributionRemoved(alias, contrib);
095                    }
096                }
097            }
098        }
099    }
100
101}