/*
 *                 Sun Public License Notice
 * 
 * The contents of this file are subject to the Sun Public License
 * Version 1.0 (the "License"). You may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.sun.com/
 * 
 * The Original Code is NetBeans. The Initial Developer of the Original
 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2003 Sun
 * Microsystems, Inc. All Rights Reserved.
 */
package org.netbeans.modules.xml.tree.nodes;

import org.openide.filesystems.FileObject;
import org.openide.util.Lookup;

import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.util.Map;
import java.util.HashMap;

/**
 * This class should be utilized by any module that overrides
 * the icons/customizers for the ElementNodes of a particular doctype.
 * The module should register its instance of DoctypeElementMap
 * in the openide Services mechanism:
 *
 *  
 *  
 *      
 *          
 *          
 *          
 *      
 *  
 *  
 *
 *
 * @author  Rich Unger
 * @version 0.1
 */
public class DoctypeElementMap 
{
    public DoctypeElementMap() {}

    /**
     * @return the doctype declaration of xml files handled by this
     * class (public ID).
     */
    public String getDoctype()
    {
        return m_sDoctype[0];
    }
    
    public String getNamespaceURI() {
        return m_sDoctype[1];
    }
    
    /**
     * @param sTagName The name of the XML element
     * @return an ElementInfo representing the icon and customizer 
     * for the XML element, or null if no such declaration is made
     */
    public ElementInfo getElementInfo( String sTagName )
    {
        return (ElementInfo)m_tagMap.get(sTagName);
    }

    public void init(URL mapURL)
    {
        // parse URL and put it in m_tagMap
        m_tagMap = new HashMap();
        m_sDoctype = DoctypeMapParser.parse(mapURL, m_tagMap, 
                (ClassLoader)Lookup.getDefault().lookup(ClassLoader.class));
    }

    /**
     * Called directly from XML layer.
     */
    protected static Object configure( FileObject fObj )
        throws IOException
    {
        URL mapURL = (URL) fObj.getAttribute(MAP_ATTRIBUTE);

        DoctypeElementMap dtc = new DoctypeElementMap();
        dtc.init(mapURL);
        return dtc;
    } 

    protected Map m_tagMap;
    protected String[] m_sDoctype;

    public static final String MAP_ATTRIBUTE = "map"; // NOI18N
}