Source code: com/aendvari/cerberus/component/descriptor/ComponentInstance.java

   /*
    * ComponentInstance.java
    *
    * Copyright (c) 2001, 2002 Aendvari, Ltd. All Rights Reserved.
    *
    * See the file LICENSE for terms of use.
    *
    */
   
  package com.aendvari.cerberus.component.descriptor;
  
  import java.util.HashMap;
  import java.util.Collection;
  import java.util.Iterator;
  
  /**
   * <p>Represents an instance of a {@link ComponentDefinition}.</p>
   *
   * @author  Trevor Milne
   *
   */
  
  public class ComponentInstance
  {
    /** The name of this component. */
    protected String name;
  
    /** The component definition of the component instance. */
    protected String definition;
  
    /** The messages for this component. */
    protected HashMap messages;
  
    /** The attributes for this component. */
    protected HashMap attributes;
  
  
    /* Constructors. */
  
  
    /**
     * Constructs a <code>ComponentInstance</code>.
     *
     */
  
    public ComponentInstance()
    {
      name = null;
      definition = null;
  
      messages = new HashMap();
      attributes = new HashMap();
    }
  
    /**
     * Constructs a <code>ComponentInstance</code> as a copy of the one supplied.
     *
     * @param    setName            The name of this component.
     *
     */
  
    public ComponentInstance(ComponentInstance instance)
    {
      name = instance.getName();
      definition = instance.getDefinition();
  
      messages = new HashMap();
      attributes = new HashMap();
  
      // copy messages
      Iterator messageIterator = instance.getMessages().iterator();
  
      while (messageIterator.hasNext())
      {
        ComponentMessage copyMessage = (ComponentMessage)messageIterator.next();
        ComponentMessage newMessage = new ComponentMessage(copyMessage);
  
        addMessage(newMessage);
      }
  
      // copy attributes
      Iterator attributeIterator = instance.getAttributes().iterator();
  
      while (attributeIterator.hasNext())
      {
        ComponentAttribute copyAttribute = (ComponentAttribute)attributeIterator.next();
        ComponentAttribute newAttribute = new ComponentAttribute(copyAttribute);
  
        addAttribute(newAttribute);
      }
    }
  
  
    /* Accessors. */
  
  
    /* Name. */
  
    /**
    * Sets the name of this component.
    *
    * @param    setName            The name of this component.
    *
    */
 
   public void setName(String setName)
   {
     name = setName;
   }
 
   /**
    * Returns the name of this component.
    *
    * @return                  The name of this component.
    *
    */
 
   public String getName()
   {
     return name;
   }
 
   /* Definition. */
 
   /**
    * Sets the definition for this component.
    *
    * @param    setDefinition        The definition for this component.
    *
    */
 
   public void setDefinition(String setDefinition)
   {
     definition = setDefinition;
   }
 
   /**
    * Returns the definition for this component.
    *
    * @return                  The definition for this component.
    *
    */
 
   public String getDefinition()
   {
     return definition;
   }
 
   /* Attributes. */
 
   /**
    * Adds an attribute to this component.
    *
    * @param    attribute          An attribute for this component.
    *
    */
 
   public void addAttribute(ComponentAttribute attribute)
   {
     attributes.put(attribute.getName(), attribute);
   }
 
   /**
    * Updates the specified attribute. This allows the attribute to be renamed.
    *
    * @param    name            The name of the attribute to update.
    * @param    attribute          A new attribute for this component.
    *
    */
 
   public void updateAttribute(String name, ComponentAttribute attribute)
   {
     // remove old attribute
     attributes.remove(name);
 
     // add new attribute
     addAttribute(attribute);
   }
 
   /**
    * Returns the specified attribute.
    *
    * @param    name            The name of the attribute.
    *
    * @return                  The {@link ComponentAttribute} having the supplied name.
    *
    */
 
   public ComponentAttribute getAttribute(String name)
   {
     return (ComponentAttribute)attributes.get(name);
   }
 
   /**
    * Returns the attributes of this component.
    *
    * @return                  A <code>Collection</code> of {@link ComponentAttribute ComponentAttributes}.
    *
    */
 
   public Collection getAttributes()
   {
     return attributes.values();
   }
 
   /* Messages. */
 
   /**
    * Adds a message to this component.
    *
    * @param    message            A message for this component.
    *
    */
 
   public void addMessage(ComponentMessage message)
   {
     messages.put(message.getName(), message);
   }
 
   /**
    * Updates the specified message. This allows the message to be renamed.
    *
    * @param    name            The name of the message to update.
    * @param    message            A new message for this component.
    *
    */
 
   public void updateMessage(String name, ComponentMessage message)
   {
     // remove old message
     messages.remove(name);
 
     // add new message
     addMessage(message);
   }
 
   /**
    * Returns the specified message.
    *
    * @param    name            The name of the message.
    *
    * @return                  The {@link ComponentMessage} having the supplied name.
    *
    */
 
   public ComponentMessage getMessage(String name)
   {
     return (ComponentMessage)messages.get(name);
   }
 
   /**
    * Returns the messages of this component.
    *
    * @return                  A <code>Collection</code> of {@link ComponentMessage ComponentMessages}.
    *
    */
 
   public Collection getMessages()
   {
     return messages.values();
   }
 
 
   /* Debug. */
 
 
   public String toString()
   {
     StringBuffer buffer = new StringBuffer();
 
     buffer.append("ComponentInstance=[");
 
     buffer.append("name=");
     buffer.append(name);
 
     buffer.append("; definition=");
     buffer.append(definition);
 
     buffer.append("; attributes=[");
 
     Iterator attributeIterator = attributes.values().iterator();
 
     while (attributeIterator.hasNext())
     {
       ComponentAttribute attribute = (ComponentAttribute)attributeIterator.next();
 
       buffer.append(attribute.getName());
       buffer.append("=");
       buffer.append(attribute.getValue());
 
       if (attributeIterator.hasNext())
       {
         buffer.append("; ");
       }
     }
 
     buffer.append("]; messages=[");
 
     Iterator messageIterator = messages.values().iterator();
 
     while (messageIterator.hasNext())
     {
       ComponentMessage message = (ComponentMessage)messageIterator.next();
 
       buffer.append(message.getName());
       buffer.append("=");
       buffer.append(message.getTopic());
 
       if (messageIterator.hasNext())
       {
         buffer.append("; ");
       }
     }
 
     buffer.append("]]");
 
     return buffer.toString();
   }
 }