org.opencms.ade.containerpage.inherited.CmsContainerConfigurationGroup Maven / Gradle / Ivy
Show all versions of opencms-test Show documentation
/*
* 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.file.CmsResource;
import org.opencms.i18n.CmsLocaleManager;
import org.opencms.util.CmsUUID;
import java.util.Locale;
import java.util.Map;
/**
* A class which represents all the configuration entries which have been read from an inherited container
* configuration file.
*
*/
public class CmsContainerConfigurationGroup {
/** The configurations grouped by locales. */
private Map> m_configurations;
/** Root path of the file from which this configuration was read. */
private String m_rootPath;
/** Structure id of the file from which this configuration was read. */
private CmsUUID m_structureId;
/**
* Creates a new instance.
*
* @param configurations the data contained by this configuration group
*/
public CmsContainerConfigurationGroup(Map> configurations) {
m_configurations = configurations;
}
/**
* Gets the configuration for a given name and locale.
*
* @param name the configuration name
*
* @return the configuration for the name and locale
*/
public CmsContainerConfiguration getConfiguration(String name) {
Map configurationsForLocale = null;
if (m_configurations.containsKey(CmsLocaleManager.MASTER_LOCALE)) {
configurationsForLocale = m_configurations.get(CmsLocaleManager.MASTER_LOCALE);
} else if (!m_configurations.isEmpty()) {
configurationsForLocale = m_configurations.values().iterator().next();
} else {
return null;
}
return configurationsForLocale.get(name);
}
/**
* Gets the root path of the file from which this configuration was read.
*
* @return the root path of the configuration resource
*/
public String getRootPath() {
return m_rootPath;
}
/**
* Gets the structure id of the file from which this configuration was read.
*
* @return the structure id of the configuration file
*/
public CmsUUID getStructureId() {
return m_structureId;
}
/**
* Initializes the information about the resource from which this configuration was read.
*
* @param configResource the configuration file
*/
public void setResource(CmsResource configResource) {
m_structureId = configResource.getStructureId();
m_rootPath = configResource.getRootPath();
}
}