// $Id: Design.java,v 1.6 2004/09/05 10:32:30 mvw Exp $
// Copyright (c) 1996-99 The Regents of the University of California. All
// Rights Reserved. Permission to use, copy, modify, and distribute this
// software and its documentation without fee, and without a written
// agreement is hereby granted, provided that the above copyright notice
// and this paragraph appear in all copies.  This software program and
// documentation are copyrighted by The Regents of the University of
// California. The software program and documentation are supplied "AS
// IS", without any accompanying services from The Regents. The Regents
// does not warrant that the operation of the program will be
// uninterrupted or error-free. The end-user understands that the program
// was developed for research purposes and is advised not to rely
// exclusively on the program for any reason.  IN NO EVENT SHALL THE
// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

// File: Design.java
// Classes: Design
// Original Author: jrobbins@ics.uci.edu
// $Id: Design.java,v 1.6 2004/09/05 10:32:30 mvw Exp $

package org.argouml.cognitive;

import java.util.Enumeration;
import java.util.Iterator;
import java.util.Vector;

/** A composite DesignMaterial that contains other
 *  DesignMaterial's. */

public class Design extends DesignMaterial {

    ////////////////////////////////////////////////////////////////
    // instance variables

    /** The contained DesignMaterial's (including other Design's). */
    private Vector subdesigns = new Vector();

    ////////////////////////////////////////////////////////////////
    // constructor

    /** Construct a new Design. This method is currently empty. The
     * _subdesigns instance variable is set through an initializer. */
    public Design() { }

    ////////////////////////////////////////////////////////////////
    // accessors

    /** 
     * Reply a vector of contained DesignMaterial's. 
     * 
     * @return the contained design material
     */
    public Vector getSubdesigns() { return subdesigns; }

    /** 
     * Set the vector of contained DesignMaterial's.
     * 
     * @param subs replace the complete list of dm
     */
    public void setSubdesigns(Vector subs) { subdesigns = subs; }

    /** 
     * Enumerate all contained DesignMaterial's. 
     * 
     * @return an enumeration for all dm
     */
    public Enumeration elements() { return subdesigns.elements(); }
    
    /** 
     * Iterate through all contained DesignMaterial's. 
     * 
     * @return an iterator for the subdesigns
     */
    public Iterator iterator() { return subdesigns.iterator(); }

    /** 
     * Reply true if the given DesignMaterial is part of this design.
     * 
     * @param dm the design material
     * @return true if the dm is included
     */
    public boolean transativelyIncludes(DesignMaterial dm) {
	Enumeration cur = elements();
	while (cur.hasMoreElements()) {
	    DesignMaterial dm2 = (DesignMaterial) cur.nextElement();
	    if (dm == dm2) return true;
	    if ((dm2 instanceof Design) 
                && (((Design) dm2).transativelyIncludes(dm))) {
		return true;
	    }
	}
	return false;
    }

    /** 
     * Add the given DesignMaterial to this Design, if it is not
     * already.
     *  
     * @param dm the design material
     */
    public synchronized void addElement(DesignMaterial dm) {
	if (!transativelyIncludes(dm)) {
	    subdesigns.addElement(dm);
	    dm.addParent(this);
	}
    }

    /** 
     * Remove the given DesignMaterial from this Design. 
     * 
     * @param dm the design material 
     */
    public synchronized void removeElement(DesignMaterial dm) {
	subdesigns.removeElement(dm);
	dm.removeParent(this);
    }

    ////////////////////////////////////////////////////////////////
    // critiquing

    /** Critique a Design by critiquing each contained
     * DesignMaterial. 

     *
     * TODO: in the future Argo will use less tree walking
     * and more trigger-driven critiquing. I.e., critiquing will be done
     * in response to specific manipulations in the editor.  
     * 
     * @see org.argouml.cognitive.DesignMaterial#critique(org.argouml.cognitive.Designer)
     */
    public void critique(Designer d) {
	super.critique(d);
	Enumeration cur = elements();
	// alternative execution policies here?
	while (cur.hasMoreElements()) {
	    DesignMaterial dm = (DesignMaterial) cur.nextElement();
	    dm.critique(d);
	}
    }

    /** 
     * Reply a string that describes this Design. Inteneded for
     * debugging. 
     * 
     * @see java.lang.Object#toString()
     */
    public String toString() {
	String printString = super.toString() + " [\n";
	Enumeration cur = elements();
	while (cur.hasMoreElements()) {
	    DesignMaterial dm = (DesignMaterial) cur.nextElement();
	    printString = printString + "  " + dm.toString() + "\n";
	}
	return printString + "]\n";
    }

} /* end class Design */