// $Id: CrCrossNamespaceAssoc.java,v 1.13 2004/09/21 19:03:25 mvw Exp $
// Copyright (c) 1996-2004 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: CrCrossNamespaceAssoc.java
// Classes: CrCrossNamespaceAssoc
// Original Author: jrobbins@ics.uci.edu

package org.argouml.uml.cognitive.critics;

import java.util.Iterator;
import org.argouml.cognitive.Designer;
import org.argouml.cognitive.critics.Critic;
import org.argouml.model.ModelFacade;

// Uses Model through ModelFacade

/**
 * 
A critic to check that the classifiers associated with the ends of an
 *   association are in the same namespace as the association.
 *
 * 
With hierarchical namespaces, this would appear to allow any
 *   association. However the intent would seem to be that, whilst association
 *   between packages is reasonable, association between sub-systems or models
 *   is not.
 *
 * 
This is the fourth well-formedness rule for associations in the UML 1.3
 *   standard (see section 2.5.3 of the standard).
 *
 * 
 Since ArgoUML currently only supports a single model, and no subsystems,
 *   there is no way to trigger the critic at present. Although a deleted
 *   classifier will appear in the separate "trash" namespace, this will also
 *   delete the association, so the critic will not trigger. However it will be
 *   useful for the future when multiple models and sub-systems are
 *   supported.
 *
 * @see 
 * ArgoUML User Manual: Classifier not in Namespace of its Association
 */
public class CrCrossNamespaceAssoc extends CrUML {
    /**
     * 
Constructor for the critic.
     *
     * 
Sets up the resource name, which will allow headline and description
     * to found for the current locale. Provides a design issue category
     * (MODULARITY) and a knowledge type (SYNTAX).
     */
    public CrCrossNamespaceAssoc() {
        setResource("CrCrossNamespaceAssoc");
        addSupportedDecision(CrUML.DEC_MODULARITY);
        setKnowledgeTypes(Critic.KT_SYNTAX);
    }

    /**
     * 
The trigger for the critic.
     *
     * 
Get the association. Then loop through the association ends, checking
     * that their associated classifiers are in the namespace, i.e. are part of
     * the same model or subsystem.
     *
     * @param  dm    the {@link java.lang.Object Object} to be checked against
     *               the critic.
     *
     * @param  dsgr  the {@link org.argouml.cognitive.Designer Designer}
     *               creating the model. Not used, this is for future
     *               development of ArgoUML.
     *
     * @return       {@link #PROBLEM_FOUND PROBLEM_FOUND} if the critic is
     *               triggered, otherwise {@link #NO_PROBLEM NO_PROBLEM}.
     */
    public boolean predicate2(Object dm, Designer dsgr) {
        // Only look at associations
        if (!ModelFacade.isAAssociation(dm))
            return NO_PROBLEM;

        Object ns = ModelFacade.getNamespace(dm);
        if (ns == null)
            return PROBLEM_FOUND;

        // Get the Association and its connections.
        // Iterate over all the AssociationEnds and check that each connected
        // classifier is in the same sub-system or model
        Iterator assocEnds = ModelFacade.getConnections(dm).iterator();
        while (assocEnds.hasNext()) {
            // The next AssociationEnd, and its classifier. Check the
            // classifier is in the namespace of the association. If not we
            // have a problem.
            Object clf = ModelFacade.getType(assocEnds.next());
            if (ns != ModelFacade.getNamespace(clf))
                return PROBLEM_FOUND;
        }
        // If we drop out there is no problem
        return NO_PROBLEM;
    }
} /* end class CrCrossNamespaceAssoc.java */