cmselementdefinitioncollection.java

内容管理

/*
* File   : $Source: /usr/local/cvs/opencms/src/com/opencms/template/cache/CmsElementDefinitionCollection.java,v $
* Date   : $Date: 2003/01/20 23:59:22 $
* Version: $Revision: 1.7 $
*
* This library is part of OpenCms -
* the Open Source Content Mananagement System
*
* Copyright (C) 2001  The OpenCms Group
*
* 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 OpenCms, please see the
* OpenCms 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 com.opencms.template.cache;

import java.util.Enumeration;
import java.util.Hashtable;
import java.util.Vector;

/**
 * Used to collect a set of element definitions.
 * Two CmsElementDefinitionCollections can be merged using the join constructor.
 *
 * @author Alexander Lucas <[e-mail]>
 */
public class CmsElementDefinitionCollection {

    /** Hashtable for storing all definitions */
    private Hashtable m_eldefs = new Hashtable();

    /** Default constructor */
    public CmsElementDefinitionCollection() {
    }

    /**
     * Join cunstructor.
     * Two CmsElementDefinitionCollections can be merged using this constructor.
     * If a definition is defined in both source collections
     * the single parts of this definitions will be merged.
     * If a <em>part</em> of a definition is defined twice, the collection
     * primary will be preferred.
     * @param primary Source CmsElementDefinitionCollection
     * @param secondary Source CmsElementDefinitionCollection
     */
    public CmsElementDefinitionCollection(CmsElementDefinitionCollection primary, CmsElementDefinitionCollection secondary) {
        Vector allKeys = new Vector();
        Enumeration keys1 = primary.m_eldefs.keys();
        Enumeration keys2 = secondary.m_eldefs.keys();
        while(keys1.hasMoreElements()) {
            allKeys.addElement(keys1.nextElement());
        }
        while(keys2.hasMoreElements()) {
            Object o = keys2.nextElement();
            if(!allKeys.contains(o)) {
                allKeys.addElement(o);
            }
        }
        Enumeration loop = allKeys.elements();
        while(loop.hasMoreElements()) {
            String currentKey = (String)loop.nextElement();
            CmsElementDefinition def1 = (CmsElementDefinition)primary.m_eldefs.get(currentKey);
            CmsElementDefinition def2 = (CmsElementDefinition)secondary.m_eldefs.get(currentKey);
            m_eldefs.put(currentKey, new CmsElementDefinition(def1, def2));
        }
    }

    /**
     * Add a definition to the collection.
     * @param def CmsElementDefinition that should be added
     */
    public void add(CmsElementDefinition def) {
        m_eldefs.put(def.getName(), def);
    }

    /**
     * Geta definition from the collection.
     * @param name Name of the element definition requested
     * @return CmsElementDefinition for <code>name</code> or <code>null</code>, if not defined.
     */
    public CmsElementDefinition get(String name) {
        return (CmsElementDefinition)m_eldefs.get(name);
    }

    /**
     * @return a Enumeration with the element names
     */
    public Enumeration getAllElementNames(){
        return m_eldefs.keys();
    }

    /**
     * Get a string representation of this collection.
     * @return String representation.
     */
    public String toString() {
        StringBuffer result = new StringBuffer();
        result.append("-----------------------------------------------------------------\n");
        result.append("Element definition dump: \n");
        Enumeration keys = m_eldefs.keys();
        while(keys.hasMoreElements()) {
            String name = (String)keys.nextElement();
            CmsElementDefinition current = (CmsElementDefinition)m_eldefs.get(name);
            result.append(current.toString() + "\n");
        }
        result.append("-----------------------------------------------------------------\n");
        return result.toString();
    }
}