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

   /*
    * ComponentDefinition.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.ArrayList;
  import java.util.HashMap;
  import java.util.Collection;
  import java.util.Iterator;
  
  /**
   * <p>Describes the various properties of a component.</p>
   *
   * <p>The messages and attributes for a component are described by this class.</p>
   *
   * <p>A component may extend one or more definitions. The messages and attributes of the definition
   * are inherited.</p>
   *
   * @author  Trevor Milne
   *
   */
  
  public class ComponentDefinition
  {
    /** The name of this component. */
    protected String name;
  
    /** The description of this component. */
    protected String description;
  
    /** The backing class for this component. */
    protected String backingClass;
  
    /** The definitions this component extends. */
    protected ArrayList parents;
  
    /** The attributes for this component. */
    protected HashMap attributes;
  
    /** The messages for this component. */
    protected HashMap messages;
  
    /** The components within this component. */
    protected ArrayList components;
  
  
    /* Constructors. */
  
  
    /**
     * Constructs a <code>ComponentDefinition</code> instance.
     *
     */
  
    public ComponentDefinition()
    {
      name = null;
      description = null;
  
      backingClass = null;
  
      parents = new ArrayList();
  
      attributes = new HashMap();
      messages = new HashMap();
      components = new ArrayList();
    }
  
    /**
     * Constructs a <code>ComponentDefinition</code> instance as a copy of the one supplied.
     *
     * @param    definition          The <code>ComponentDefinition</code> to copy.
     *
     */
  
    public ComponentDefinition(ComponentDefinition definition)
    {
      name = definition.getName();
      description = definition.getDescription();
  
      backingClass = definition.getBackingClass();
  
      parents = new ArrayList();
  
      attributes = new HashMap();
      messages = new HashMap();
      components = new ArrayList();
  
      // copy parents
      Iterator parentIterator = definition.getParents().iterator();
  
      while (parentIterator.hasNext())
      {
       String parent = (String)parentIterator.next();
       addParent(parent);
     }
 
     // copy attributes
     Iterator attributeIterator = definition.getAttributes().iterator();
 
     while (attributeIterator.hasNext())
     {
       ComponentAttribute copyAttribute = (ComponentAttribute)attributeIterator.next();
       ComponentAttribute newAttribute = new ComponentAttribute(copyAttribute);
 
       addAttribute(newAttribute);
     }
 
     // copy messages
     Iterator messageIterator = definition.getMessages().iterator();
 
     while (messageIterator.hasNext())
     {
       ComponentMessage copyMessage = (ComponentMessage)messageIterator.next();
       ComponentMessage newMessage = new ComponentMessage(copyMessage);
 
       addMessage(newMessage);
     }
 
     // copy components
     Iterator componentIterator = definition.getComponents().iterator();
 
     while (componentIterator.hasNext())
     {
       ComponentInstance copyComponent = (ComponentInstance)componentIterator.next();
       ComponentInstance newComponent = new ComponentInstance(copyComponent);
 
       addComponent(newComponent);
     }
   }
 
 
   /* 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;
   }
 
   /* Description. */
 
   /**
    * Sets the description of this component.
    *
    * @param    setDescription        The description of this component.
    *
    */
 
   public void setDescription(String setDescription)
   {
     description = setDescription;
   }
 
   /**
    * Returns the description of this component.
    *
    * @return                  The description of this component.
    *
    */
 
   public String getDescription()
   {
     return description;
   }
 
   /* Class. */
 
   /**
    * Sets the class of this component.
    *
    * @param    setClass          The component's class.
    *
    */
 
   public void setBackingClass(String setClass)
   {
     backingClass = setClass;
   }
 
   /**
    * Returns the class of this component.
    *
    * @return                  The class of this component.
    *
    */
 
   public String getBackingClass()
   {
     return backingClass;
   }
 
   /* Parents. */
 
   /**
    * Adds a parent definition that this component extends.
    *
    * @param    definition          The name of a component definition for this component to extend.
    *
    */
 
   public void addParent(String definition)
   {
     if (parents.contains(definition)) return;
     parents.add(definition);
   }
 
   /**
    * Returns the definitions this component extends.
    *
    * @return                  A <code>Collection</code> of names (<code>Strings</code>) of
    *                      definitions this component extends.
    *
    */
 
   public Collection getParents()
   {
     return parents;
   }
 
   /* 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();
   }
 
   /* Components. */
 
   /**
    * Adds a component to this composite.
    *
    * @param    component          A component for this composite.
    *
    */
 
   public void addComponent(ComponentInstance component)
   {
     components.add(component);
   }
 
   /**
    * Returns the components of this composite.
    *
    * @return                  A <code>Collection</code> of {@link ComponentInstance ComponentInstances}.
    *
    */
 
   public Collection getComponents()
   {
     return components;
   }
 
 
   /* Debug. */
 
 
   public String toString()
   {
     StringBuffer buffer = new StringBuffer();
 
     buffer.append("ComponentDefinition=[");
 
     buffer.append("name=");
     buffer.append(name);
 
     buffer.append("; class=");
     buffer.append(backingClass);
 
     buffer.append("; parents=[");
 
     Iterator parentIterator = parents.iterator();
 
     while (parentIterator.hasNext())
     {
       String parent = (String)parentIterator.next();
 
       buffer.append(parent);
 
       if (parentIterator.hasNext())
       {
         buffer.append("; ");
       }
     }
 
     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("]; components=[");
 
     Iterator componentIterator = components.iterator();
 
     while (componentIterator.hasNext())
     {
       ComponentInstance component = (ComponentInstance)componentIterator.next();
 
       buffer.append(component.getName());
 
       if (componentIterator.hasNext())
       {
         buffer.append("; ");
       }
     }
 
     buffer.append("]]");
 
     return buffer.toString();
   }
 }