/* $Id: StandardCM.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-2008 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.util.ArrayList;
import java.util.List;

/**
 * The standard Control Mech. It extends an ANDControlMech with the individual
 * cm's
 * <ul>
 * <li>EnabledCM
 * <li>NotSnoozedCM
 * <li>DesignGoalsCM
 * <li>CurDecisionCM
 * </ul>
 *
 * implying that a critic is relevant if and if only it is enabled, not snoozed,
 * applicable to the current goals and relevant decisions to be supported.<p>
 * 
 * Mech is short for Mechanism. 
 * A Control Mechanism is a structured way 
 * to calculate a single condition from multiple different unrelated ones. 
 * In the case of a StandardCM, 
 * the single condition holds if we are enabled, 
 * and not snoozed, 
 * and fulfill designgoals, 
 * and the designer is interested in these decisions.
 */
public class StandardCM extends AndCM {

    /**
     * The constructor.
     *
     */
    public StandardCM() {
        addMech(new EnabledCM());
        addMech(new NotSnoozedCM());
        addMech(new DesignGoalsCM());
        addMech(new CurDecisionCM());
    }
} /* end class StandardCM */


class EnabledCM implements ControlMech {
    
    /*
     * @see org.argouml.cognitive.critics.ControlMech#isRelevant(org.argouml.cognitive.critics.Critic, org.argouml.cognitive.Designer)
     */
    public boolean isRelevant(Critic c, Designer d) {
        return c.isEnabled();
    }
} // end class EnabledCM

class NotSnoozedCM implements ControlMech {
    /*
     * @see org.argouml.cognitive.critics.ControlMech#isRelevant(org.argouml.cognitive.critics.Critic, org.argouml.cognitive.Designer)
     */
    public boolean isRelevant(Critic c, Designer d) {
        return !c.snoozeOrder().getSnoozed();
    }
} // end class NotSnoozedCM

class DesignGoalsCM implements ControlMech {
    /*
     * @see org.argouml.cognitive.critics.ControlMech#isRelevant(org.argouml.cognitive.critics.Critic, org.argouml.cognitive.Designer)
     */
    public boolean isRelevant(Critic c, Designer d) {
        return c.isRelevantToGoals(d);
    }
} // end class DesignGoalsCM

// How much control should critics have over when they are relavant?
// Does doing that in code instead of declaratively limit reasoning?
// How does using more semantically rich method calls impact
// componentization?

class CurDecisionCM implements ControlMech {
    /*
     * @see org.argouml.cognitive.critics.ControlMech#isRelevant(org.argouml.cognitive.critics.Critic, org.argouml.cognitive.Designer)
     */
    public boolean isRelevant(Critic c, Designer d) {
        return c.isRelevantToDecisions(d);
    }
} // end class CurDecisionCM

abstract class CompositeCM implements ControlMech {
    private List<ControlMech> mechs = new ArrayList<ControlMech>();

    /**
     * @return a list of the ControlMechs.
     */
    protected List<ControlMech> getMechList() {
        return mechs;
    }

    /**
     * @param cm
     *            the ControlMech
     */
    public void addMech(ControlMech cm) {
        mechs.add(cm);
    }
} // end class CompositeCM

class AndCM extends CompositeCM {
    /*
     * @see org.argouml.cognitive.critics.ControlMech#isRelevant(org.argouml.cognitive.critics.Critic, org.argouml.cognitive.Designer)
     */
    public boolean isRelevant(Critic c, Designer d) {
        for (ControlMech cm : getMechList()) {
            if (!cm.isRelevant(c, d)) {
                return false;
            }
        }
        return true;
    }
} // end class AndCM

class OrCM extends CompositeCM {
    /*
     * @see org.argouml.cognitive.critics.ControlMech#isRelevant(org.argouml.cognitive.critics.Critic, org.argouml.cognitive.Designer)
     */
    public boolean isRelevant(Critic c, Designer d) {
        for (ControlMech cm : getMechList()) {
            if (cm.isRelevant(c, d)) {
                return true;
            }
        }
        return false;
    }
} // end class OrCM