/* $Id: GoalModel.java 17813 2010-01-12 18:33:21Z linus $
 *****************************************************************************
 * Copyright (c) 2009 Contributors - see below
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    tfmorris
 *****************************************************************************
 *
 * Some portions of this file was previously release using the BSD License:
 */

// Copyright (c) 1996-2006 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.

package org.argouml.cognitive;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import java.util.Observable;

/**
 * Models the designers goals in making this design.  Provides useful
 * control information to the Agency so that only critics relevant to
 * the designers goals are ever executed.
 *
 * TODO: Really this should be part of a domain extension
 * and not the kernel.  I have not developed this part of Argo very
 * much.
 *
 * @author Jason Robbins
 */
public class GoalModel extends Observable implements Serializable {
    private List<Goal> goals = new ArrayList<Goal>();

    /**
     * The constructor.
     *
     */
    public GoalModel() {
	addGoal(Goal.getUnspecifiedGoal());
    }


    /**
     * @return the list of goals
     */
    public List<Goal> getGoalList() {
        return goals;
    }

    
    /**
     * @param g the goal to be added
     */
    public void addGoal(Goal g) {
        goals.add(g);
    }

    /**
     * @param g the goal to be removed
     */
    public void removeGoal(Goal g) {
        goals.remove(g);
    }

    /**
     * Reply true iff the Designer wants to achieve the given goal.
     *
     * @param goalName the given goal
     * @return true if the designer wants this
     */
    public boolean hasGoal(String goalName) {
        for (Goal g : goals) {
	    if (g.getName().equals(goalName)) {
		return g.getPriority() > 0;
	    }
	}
	return false;
    }

    /**
     * @param goalName the given goal
     * @param priority the new priority for the goal
     */
    public synchronized void setGoalPriority(String goalName, int priority) {
	Goal g = new Goal(goalName, priority);
	goals.remove(g);
	goals.add(g);
    }

    //   public Object getGoalInfo(String goal) {
    //     return _goals.getProperty(goal);
    //     /* TODO: we need a better representation of goals */
    //   }

    //   public void setGoalInfo(String goal, String info) {
    //     _goals.put(goal, info);
    //     /* TODO: we need a better representation of goals */
    //   }

    /**
     * The Designer wants to achieve the given goal.
     *
     * @param goalName the wanted goal
     */
    public void startDesiring(String goalName) {
	addGoal(new Goal(goalName, 1));
    }

    /**
     * The Designer does not care about the given goal.
     *
     * @param goalName the unwanted goal
     */
    public void stopDesiring(String goalName) {
	removeGoal(new Goal(goalName, 0));
    }


}