NeesControlMetadata.java

/*
 * Created on Jun 16, 2004
 */
package org.nees.rbnb;

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

import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;
import org.w3c.dom.Node;

import javax.swing.tree.DefaultMutableTreeNode;
import javax.swing.tree.MutableTreeNode;

public class NeesControlMetadata {

    /* -----
     *  XML Tags used in this package for verious messages etc...
     * -----
     */
    public static final String XML_TAG_FOR_METADATA = "NEESMetadata";
    public static final String XML_TAG_FOR_LINK_LIST = "links";
    public static final String XML_TAG_FOR_LINK = "link";
    public static final String XML_TAG_FOR_TEMPLATE_LIST = "templates";
    public static final String XML_TAG_FOR_TEMPLATE = "template";
    public static final String XML_TAG_FOR_TEMPLATE_NAME = "templateName";
    public static final String XML_TAG_FOR_TEMPLATE_TYPE = "type";
    public static final String XML_TAG_FOR_PARAMETER_LIST = "parameters";
    public static final String XML_TAG_FOR_PARAMETER = "parameter";
    public static final String XML_TAG_FOR_INSTANCE_LIST = "instances";
    public static final String XML_TAG_FOR_INSTANCE = "instance";
    public static final String XML_TAG_FOR_INSTANCE_NAME = "instanceName";
    public static final String XML_TAG_FOR_INSATNCE_TEMPLATE_NAME = "instanceTemplateName";
    public static final String XML_TAG_FOR_INSTANCE_RUNNING_FLAG = "instanceRunningFlag";
    public static final String XML_TAG_FOR_ADDITIONAL_METADATA = "internalMetadata";
    
    public static final String XML_TAG_FOR_COMMAND = "Command";
    
    public static final String IMAGE_TYPE = "image";
    public static final String MOVIE_TYPE = "movie";
    public static final String DATA_TYPE = "data";
    public static final String DAQ_TYPE = "DAQ";
    
    private Vector links = new Vector();
    private Hashtable templates = new Hashtable();
    private Hashtable instances = new Hashtable();
    
    public NeesControlMetadata()
    {
    }
    
    public NeesControlMetadata(String xml)
    {
        setFromXml(xml);
    }
    
    public String toXmlString()
    {
        Document doc = Xml.createDocument();
        buildXmlDoc(doc);
        try {
            return Xml.writeDocumentToString(doc);
        } catch (IOException e) {
            return Xml.errorXml("Failed to generate Control Metadata" , e.toString());
        }
    }
    
    public void buildXmlDoc(Document doc)
    {
        Node root = doc.createElement(XML_TAG_FOR_METADATA);
        if (links.size() > 0) root.appendChild(linksToXml(doc));
        if (templates.size() > 0) root.appendChild(templatesToXml(doc));
        if (instances.size() > 0) root.appendChild(instancesToXml(doc));
        doc.appendChild(root);
    }
    
    private Node linksToXml(Document doc) {
        Node node, root = doc.createElement(XML_TAG_FOR_LINK_LIST);
        Enumeration e = links.elements();
        while (e.hasMoreElements())
        {       
            node = doc.createElement(XML_TAG_FOR_LINK);
            String link = (String) e.nextElement();
            node.appendChild(doc.createTextNode(link));
            root.appendChild(node);
        }
        return root;
    }

    private Node templatesToXml(Document doc) {
        Node root = doc.createElement(XML_TAG_FOR_TEMPLATE_LIST);
        Enumeration e = templates.elements();
        while (e.hasMoreElements())
        {       
            TemplateDescription t = (TemplateDescription) e.nextElement();
            if (t.valid())
                root.appendChild(t.createXmlNode(doc));
        }
        return root;
    }

    private Node instancesToXml(Document doc) {
        Node root = doc.createElement(XML_TAG_FOR_INSTANCE_LIST);
        Enumeration e = instances.elements();
        while (e.hasMoreElements())
        {       
            InstanceDescription i = (InstanceDescription) e.nextElement();
            if (i.valid())
                root.appendChild(i.createXmlNode(doc));
        }
        return root;
    }

    public TemplateDescription getTemplate(String name)
    {
        return (TemplateDescription)templates.get(name);
    }
    
    public Enumeration getTemplatesEnumeration()
    {
        return templates.elements();
    }
    
    public Hashtable getTemplatesHashtable()
    {
        return templates;
    }
    
    public void putTemplate(String templateName, TemplateDescription template) {
        templates.put(templateName,template);
    }

    public InstanceDescription getInstance(String name)
    {
        return (InstanceDescription)instances.get(name);
    }
    
    public boolean deleteInstance(String name)
    {
        if (name == null) return false;
        
        InstanceDescription i = getInstance(name);
        if (i == null) return false;
        
        // can not delete a running instance!
        if (i.isRunning()) return false;
        
        instances.remove(name);
        
        return (null == getInstance(name));
    }
    
    public Enumeration getInstancesEnumeration()
    {
        return instances.elements();
    }
    
    public Hashtable getInstancesHashtable()
    {
        return instances;
    }
    
    public void setFromXml(String xml) throws IllegalArgumentException {
        // convert to doc
        Document doc = Xml.readDocumentFromString(xml);
        if (doc == null)
            throw new IllegalArgumentException("XML string unparsable: " + xml);

        // get the root element
        Element root = doc.getDocumentElement();
        if (!(root.getTagName().equals(XML_TAG_FOR_METADATA)))
            throw new IllegalArgumentException(
                "XML string does not have root tag with " + XML_TAG_FOR_METADATA
                + "; found " + root.getTagName() + " instead.");

        links.clear();
        templates.clear();
        instances.clear();
        
        // process the children
        NodeList children = root.getChildNodes();
        final int length = children.getLength();
        for(int i = 0; i < length; i++)
        {
            Node child = children.item(i);
            if (child.getNodeType() == Node.ELEMENT_NODE)
            {
                Element element = (Element)child;
                String name = element.getTagName();
                if (name.equals(XML_TAG_FOR_LINK_LIST))
                    addToLinkList(element);
                else
                if (name.equals(XML_TAG_FOR_TEMPLATE_LIST))
                    addToTemplateList(element);
                else
                if (name.equals(XML_TAG_FOR_INSTANCE_LIST))
                    addToInstanceList(element);
                else
                    throw new IllegalArgumentException("unrecognized XML tag = " + name);
            }
        }
    }

    private void addToLinkList(Node node) {
        // process the links
        NodeList children = node.getChildNodes();
        final int length = children.getLength();
        for(int i = 0; i < length; i++)
        {
            Node child = children.item(i);
            if (child.getNodeType() == Node.ELEMENT_NODE)
            {
                Element element = (Element)child;
                String tag = element.getTagName();
                if (tag.equals(XML_TAG_FOR_LINK))
                {
                    // get string from textNode
                    // <link>link-name</link>
                    links.add(child.getChildNodes().item(0).getNodeValue());
                }
            }
        }
    }

    private void addToTemplateList(Node node) {
        NodeList children = node.getChildNodes();
        final int length = children.getLength();
        for(int i = 0; i < length; i++)
        {
            Node child = children.item(i);
            if (child.getNodeType() == Node.ELEMENT_NODE)
            {
                Element element = (Element)child;
                String tag = element.getTagName();
                if (tag.equals(XML_TAG_FOR_TEMPLATE))
                {
                    TemplateDescription t = new TemplateDescription(this, child);
                    if (t != null) templates.put(t.getName(), t);
                }
            }
        }
    }

    private void addToInstanceList(Node node) {
        NodeList children = node.getChildNodes();
        final int length = children.getLength();
        for(int i = 0; i < length; i++)
        {
            Node child = children.item(i);
            if (child.getNodeType() == Node.ELEMENT_NODE)
            {
                Element element = (Element)child;
                String tag = element.getTagName();
                if (tag.equals(XML_TAG_FOR_INSTANCE))
                {
                    InstanceDescription n = new InstanceDescription(this, child);
                    if (n != null) instances.put(n.getName(), n);
                }
            }
        }
    }

    public void addToTemplateList(String name, String type)
    {
        TemplateDescription t = new TemplateDescription(this, name, type);
        templates.put(name,t);
    }
    
    public void insertParametersToTempateFromBase
    (String name, RBNBBase base)
    {
        TemplateDescription t = (TemplateDescription)templates.get(name);
        if (t != null)
            t.setParamters(base.getParamterTable());
    }

    public void addToInstanceList(String name, String templateName)
    {
        InstanceDescription i = new InstanceDescription(this, name, templateName);
        instances.put(name,i);
    }
    
    public void addToInstanceList
    (String name, String templateName, RBNBBase actualInstance)
    {
        InstanceDescription i =
            new InstanceDescription(this, name, templateName, actualInstance);
        instances.put(name,i);      
    }
    
    public void addParameterToInstance
    (String instanceName, String parameterName, String parameterType, Object value)
    {
        InstanceDescription i = (InstanceDescription)instances.get(instanceName);
        if (i != null)
            i.addParameter(parameterName, parameterType, value);
    }

    public DefaultMutableTreeNode insertIntoSwingTree(DefaultMutableTreeNode top)
    {
        DefaultMutableTreeNode root = new DefaultMutableTreeNode("NeesPOP MCP Metadata");
        root.add(makeSwingTreeLinks());
        root.add(makeSwingTreeTemplates());
        root.add(makeSwingTreeInstances());
        top.add(root);
        return top;
    }

    private MutableTreeNode makeSwingTreeLinks() {
        DefaultMutableTreeNode root = new DefaultMutableTreeNode("Links");
        Enumeration e = links.elements();
        while (e.hasMoreElements())
            root.add(new DefaultMutableTreeNode(e.nextElement()));
        return root;
    }

    protected MutableTreeNode makeSwingTreeTemplates() {
        DefaultMutableTreeNode root = new DefaultMutableTreeNode("Templates");
        Enumeration e = templates.elements();
        while (e.hasMoreElements())
        {
            TemplateDescription t = (TemplateDescription)e.nextElement();
            root.add(t.makeSwingTreeNode());
        }
        return root;
    }

    private MutableTreeNode makeSwingTreeInstances() {
        DefaultMutableTreeNode root = new DefaultMutableTreeNode("Instances");
        Enumeration e = instances.elements();
        while (e.hasMoreElements())
        {
            InstanceDescription i = (InstanceDescription)e.nextElement();
            root.add(i.makeSwingTreeNode());
        }
        return root;
    }

}

---