InstanceDescription.java

/*
 * Created on Jun 25, 2004
 *
 * To change the template for this generated file go to
 * Window>Preferences>Java>Code Generation>Code and Comments
 */
package org.nees.rbnb;

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

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

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


class InstanceDescription
{
    private final NeesControlMetadata metadata;
    private String instanceName;
    private String templateName;
    private TemplateDescription itsTemplate;
    Hashtable parameters = new Hashtable();
    private RBNBBase instance;
    private boolean running = false;

    public InstanceDescription(NeesControlMetadata metadata, Node node) {
        NodeList children = node.getChildNodes();
        this.metadata = metadata;
        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(NeesControlMetadata.XML_TAG_FOR_INSTANCE_NAME))
                {
                    // get string from instance name
                    // <instanceName>name</instanceName>
                    String name = child.getChildNodes().item(0).getNodeValue();
                    setName(name);
                }
                else
                if (tag.equals(NeesControlMetadata.XML_TAG_FOR_INSATNCE_TEMPLATE_NAME))
                {
                    // get string from templage name
                    // <instanceTemplateName>name</instanceTemplateName>
                    String name = child.getChildNodes().item(0).getNodeValue();
                    setTemplate(name);
                }
                else
                if (tag.equals(NeesControlMetadata.XML_TAG_FOR_INSTANCE_RUNNING_FLAG))
                {
                    // get string for the value of the state of the instance
                    // <instanceTemplateName>name</instanceTemplateName>
                    String value = child.getChildNodes().item(0).getNodeValue();
                    if (value.equals("true")) running = true;
                    else running = false;
                }
                else
                if (tag.equals(NeesControlMetadata.XML_TAG_FOR_PARAMETER_LIST))
                {
                    NodeList param_children = child.getChildNodes();
                    final int l = param_children.getLength();
                    for(int j = 0; j < l; j++)
                    {
                        Node param_child = param_children.item(j);
                        if (param_child.getNodeType() == Node.ELEMENT_NODE)
                        {
                            Element e = (Element)param_child;
                            String tg = e.getTagName();
                            if (tg.equals(NeesControlMetadata.XML_TAG_FOR_PARAMETER))
                            {
                                RBNBBaseParameterHolder h =
                                    new RBNBBaseParameterHolder(param_child);
                                TemplateDescription t = getTemplate();
                                if (t != null)
                                {
                                    RBNBBaseParameterHolder d = 
                                        t.getParameterTemplate(h.getName());
                                    if (d != null)
                                        h.setDefaultFromTemplate(d);
                                }
                                parameters.put(h.getName(),h);
                            }
                        }
                    }
                }
            } // if (child.getNodeType() == Node.ELEMENT_NODE)
        } // for
    }
    
    public InstanceDescription(NeesControlMetadata metadata, String instanceName, String templateName)
    {
        setName(instanceName);
        this.metadata = metadata;
        setTemplate(templateName);
        itsTemplate = metadata.getTemplate(templateName);
        if (itsTemplate != null)
        {
            Enumeration e = itsTemplate.getParameterEnumeration();
            while (e.hasMoreElements())
            {
                RBNBBaseParameterHolder t =
                    (RBNBBaseParameterHolder) e.nextElement();
                try {
                    RBNBBaseParameterHolder p =
                        new RBNBBaseParameterHolder(t);
                    if (t.getDefaultValue() != null)
                        p.setValue(t.getDefaultValue());
                    parameters.put(t.getName(),p);
                } catch (Exception skip) {}
            }
        }
    }
    
    public InstanceDescription
    (NeesControlMetadata metadata, String instanceName, 
    String templateName, RBNBBase actualInstance)
    {
        this(metadata, instanceName, templateName);
        instance = actualInstance;
        // reset the parameter values to set then in the instance
        Enumeration e = parameters.elements();
        while (e.hasMoreElements())
        {
            RBNBBaseParameterHolder p = 
                (RBNBBaseParameterHolder)e.nextElement();
            setParameter(p.getName(),p.getValue());
        }
    }
    
    public MutableTreeNode makeSwingTreeNode() {
        DefaultMutableTreeNode root = new DefaultMutableTreeNode(this);
        DefaultMutableTreeNode node = new DefaultMutableTreeNode("Template: " + templateName);
        root.add(node);
        String value = "false";
        if (isRunning()) value = "true";
        node = new DefaultMutableTreeNode("Running flag: " + value);
        root.add(node);
        root.add(RBNBBaseParameterHolder.makeParamersSwingTreeNode(parameters));
        return root;
    }

    public Node createXmlNode(Document doc) {
        Node node, root = doc.createElement(NeesControlMetadata.XML_TAG_FOR_INSTANCE);
        if (valid())
        {
            node = doc.createElement(NeesControlMetadata.XML_TAG_FOR_INSTANCE_NAME);
            node.appendChild(doc.createTextNode(instanceName));
            root.appendChild(node);
            
            node = doc.createElement(NeesControlMetadata.XML_TAG_FOR_INSATNCE_TEMPLATE_NAME);
            node.appendChild(doc.createTextNode(getTemplateName()));
            root.appendChild(node);

            node = doc.createElement(NeesControlMetadata.XML_TAG_FOR_INSTANCE_RUNNING_FLAG);
            String value = "false";
            if (isRunning()) value = "true";
            node.appendChild(doc.createTextNode(value));
            root.appendChild(node);

            if ((parameters != null) && (parameters.size() > 0))
                root.appendChild(createParameterListNode(doc));
        }
        return root;
    }
    
    private Node createParameterListNode(Document doc)
    {
        Node node, root = doc.createElement(NeesControlMetadata.XML_TAG_FOR_PARAMETER_LIST);
        Enumeration e = parameters.keys();
        while (e.hasMoreElements())
        {
            // note, use key to account for instance parameters
            // see, getParameter()
            String key = (String)e.nextElement();
            RBNBBaseParameterHolder p = getParameter(key);
            root.appendChild(p.createXmlNode(doc));
        }
        return root;
    }

    public boolean valid() {
        String t = this.getTemplateName();
        return
        (   (instanceName != null)
            && (!instanceName.equals(""))
            && (t != null)
            && (!t.equals(""))
        );
    }

    public void setTemplate(TemplateDescription template)
    {
        itsTemplate = template;
        templateName = template.getName();
        if (metadata.getTemplate(templateName) == null)
            metadata.putTemplate(templateName,template);
    }
    
    public void setTemplate(String name)
    {
        TemplateDescription probe = metadata.getTemplate(name);
        if (probe != null) setTemplate(probe);
        else // defered 
            templateName = name;
    }
    
    public TemplateDescription getTemplate()
    {
        TemplateDescription it = itsTemplate;
        
        // attempt to get the template by name
        if (it == null)
        {
            if (templateName != null)
            {
                TemplateDescription td = 
                    metadata.getTemplate(templateName);
                if (td != null)
                {
                    it = td;
                    itsTemplate = td;
                }
            }
        }
        return it;
    }
    
    public String getTemplateName()
    {
        if (templateName == null)
        {
            if (itsTemplate != null)
                templateName = itsTemplate.getName();
        }
        return templateName;
    }
    
    public void setName(String name)
    {
        instanceName = name;
    }
    
    public String getName()
    {
        return instanceName;
    }
    
    public String toString()
    {
        return getName();
    }
    
    public void addParameter(String name, String type, Object value)
    {
        TemplateDescription t = getTemplate();
        Object d = null;
        if (t != null)
        {
            RBNBBaseParameterHolder template = t.getParameterTemplate(name);
            if (template != null)
            {
                d = template.getDefaultValue();
            }
        }

        RBNBBaseParameterHolder p = new RBNBBaseParameterHolder(name, type, d);
        p.setValue(value);
        
        // update actuall parameter value for real instrances
        parameters.put(name,p);
        if (instance != null)
        {
            if (instance.getParameter(name) != null)
                instance.setParameterValue(name,value);
            else
                instance.setNewParameter(name,type,value);
        }

    }

    public RBNBBaseParameterHolder getParameter(String name)
    {
        RBNBBaseParameterHolder p = null;
        
        if (instance != null)
        {
            p = instance.getParameter(name);
        }
        else
            p = (RBNBBaseParameterHolder)parameters.get(name);
        return p;
    }
    
    public void setParameter(String name, Object value)
    {
        RBNBBaseParameterHolder p = getParameter(name);

        if (p != null)
            p.setValue(value);
        if (instance != null) instance.setParameterValue(name,value);
    }

    public boolean startInstance() {
        return instance.start();
    }

    public boolean stopInstance() {
        return instance.stop();
    }
    
    public boolean isRunning()
    {
        // if this description is coupled to an actual instance...
        // then update the flag... else assume that it is set for elsewhere
        // (as in fatch of metadata)
        if (instance != null)
            running = instance.isRunning();
        return running;
    }
    
} // InstanceDescription

---