/* $Id: CrNavFromInterface.java 17849 2010-01-12 19:50:34Z 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:
* maurelio1234
*****************************************************************************
*
* Some portions of this file was previously release using the BSD License:
*/
// Copyright (c) 1996-2007 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.uml.cognitive.critics;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Set;
import org.argouml.cognitive.Critic;
import org.argouml.cognitive.Designer;
import org.argouml.model.Model;
import org.argouml.uml.cognitive.UMLDecision;
/**
* A critic to detect navigation from an Interface to a Class in an
* Association. This is not permitted in UML, since it would require
* the Interface to hold state to represent the association
* reference.<p>
*
* The critic will trigger whenever an association between an
* interface and a class is navigable <em>from</em> the interface.<p>
*
* See the ArgoUML User Manual: Remove Navigation From Interface
*
* @author jrobbins@ics.uci.edu
*/
public class CrNavFromInterface extends CrUML {
/**
* Constructor for the critic.
* <p>
* Sets up the resource name, which will allow headline and description to
* found for the current locale. Provides a design issue category
* (RELATIONSHIPS) and knowledge type (SYNTAX). Adds trigger
* "end_navigable".
*/
public CrNavFromInterface() {
setupHeadAndDesc();
// Specify design issue category and knowledge type
addSupportedDecision(UMLDecision.RELATIONSHIPS);
setKnowledgeTypes(Critic.KT_SYNTAX);
// This may not actually make any difference at present (the code
// behind addTrigger needs more work).
addTrigger("end_navigable");
}
/**
* The trigger for the critic.<p>
*
* Applies to Associations only, not AssociationRoles. The reason is
* that an AssociationRole cannot have greater navigability than the
* Association it specializes, so if the critic has addressed the
* Association, the AssociationRole will effectively be addressed. There
* may of course be a need for a critic to check that Association Roles do
* match their parents in this respect!<p>
*
* As a consequence, we also don't need to check for associations with
* ClassifierRoles.<p>
*
* Iterate over all the AssociationEnds. We only have a problem if:<p>
* <ol>
* <li>There is an end connected to an Interface; and
* <li>An end other than that end is navigable.
* </ol>
*
* @param dm the object to be checked against the critic
* @param dsgr the 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 (!(Model.getFacade().isAAssociation(dm))) {
return NO_PROBLEM;
}
if (Model.getFacade().isAAssociationRole(dm)) {
return NO_PROBLEM;
}
// Iterate over all the AssociationEnds. We only have a problem if 1)
// there is an end connected to an Interface and 2) an end other than
// that end is navigable.
Iterator assocEnds = Model.getFacade().getConnections(dm).iterator();
boolean haveInterfaceEnd = false; // End at an Interface?
boolean otherEndNavigable = false; // Navigable other end?
while (assocEnds.hasNext()) {
// The next AssociationEnd
Object ae = assocEnds.next();
// If its an interface we have an interface end, otherwise its
// something else and we should see if it is navigable. We don't
// check that the end is a Classifier, rather than its child
// ClassifierRole, since we have effectively eliminated that
// possiblity in rejecting AssociationRoles above.
Object type = Model.getFacade().getType(ae);
if (Model.getFacade().isAInterface(type)) {
haveInterfaceEnd = true;
} else if (Model.getFacade().isNavigable(ae)) {
otherEndNavigable = true;
}
// We can give up looking if we've hit both criteria
if (haveInterfaceEnd && otherEndNavigable) {
return PROBLEM_FOUND;
}
}
// If we drop out we didn't meet both criteria, and all is well.
return NO_PROBLEM;
}
/*
* @see org.argouml.uml.cognitive.critics.CrUML#getCriticizedDesignMaterials()
*/
public Set<Object> getCriticizedDesignMaterials() {
Set<Object> ret = new HashSet<Object>();
ret.add(Model.getMetaTypes().getAssociationClass());
return ret;
}
/**
* The UID.
*/
private static final long serialVersionUID = 2660051106458704056L;
} /* end class CrNavFromInterface */