All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.opencms.ade.containerpage.inherited.CmsContainerConfiguration Maven / Gradle / Ivy

Go to download

OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.

There is a newer version: 18.0
Show newest version
/*
 * File   : $Source$
 * Date   : $Date$
 * Version: $Revision$
 *
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (C) 2002 - 2011 Alkacon Software (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.ade.containerpage.inherited;

import org.opencms.xml.containerpage.CmsContainerElementBean;

import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

/**
 * A bean representing a single configuration entry for the inherited container configuration.

* */ public class CmsContainerConfiguration { /** Node name. **/ public static final String N_CONFIGURATION = "Configuration"; /** Node name. **/ public static final String N_ELEMENT = "Element"; /** Node name. **/ public static final String N_HIDDEN = "Hidden"; /** Node name. **/ public static final String N_KEY = "Key"; /** Node name. **/ public static final String N_NAME = "Name"; /** Node name. **/ public static final String N_NEWELEMENT = "NewElement"; /** Node name. **/ public static final String N_ORDERKEY = "OrderKey"; /** Node name. **/ public static final String N_URI = "Uri"; /** Node name. **/ public static final String N_VISIBLE = "Visible"; /** A map containing the new elements. */ private Map m_newElements; /** A list of keys for a new ordering of elements. **/ private List m_ordering; /** The path from which the configuration was fetched. */ private String m_path; /** A map from element keys to Booleans, representing hidden/shown elements. */ private Map m_visibility; /** * Creates a new instance.

* * @param ordering the new ordering list * @param visibility the visibility map * @param newElements the new elements */ public CmsContainerConfiguration( List ordering, Map visibility, Map newElements) { m_ordering = ordering != null ? Collections.unmodifiableList(ordering) : null; m_visibility = Collections.unmodifiableMap(visibility); m_newElements = Collections.unmodifiableMap(newElements); } /** * Generates an empty configuration object.

* * @return an empty configuration object */ public static CmsContainerConfiguration emptyConfiguration() { return new CmsContainerConfiguration( null, new HashMap(), new HashMap()); } /** * Gets the map of new elements.

* * @return the map of new elements */ public Map getNewElements() { return m_newElements; } /** * Gets the new elements in the order in which they appear in the 'ordering' list.

* * @return an ordered map containing the new elements in the correct order */ public LinkedHashMap getNewElementsInOrder() { LinkedHashMap result = new LinkedHashMap(); if (m_ordering != null) { for (String orderKey : m_ordering) { CmsContainerElementBean element = m_newElements.get(orderKey); if (element != null) { result.put(orderKey, element); } } return result; } return new LinkedHashMap(); } /** * Gets the ordering list.

* * @return the ordering list */ public List getOrdering() { return m_ordering; } /** * Gets the path from which this configuration was read.

* * @return the path from which this configuration was read */ public String getPath() { return m_path; } /** * Gets the visibility map for this configuration.

* * @return the visibility map */ public Map getVisibility() { return m_visibility; } /** * Sets the path for this configuration.

* * @param path the new path value */ public void setPath(String path) { m_path = path; } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy