/* $Id: CrNoOperations.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 javax.swing.Icon;
import org.argouml.cognitive.Critic;
import org.argouml.cognitive.Designer;
import org.argouml.cognitive.ToDoItem;
import org.argouml.cognitive.critics.Wizard;
import org.argouml.model.Model;
import org.argouml.uml.cognitive.UMLDecision;
/**
* A critic to detect when a class or interface or its base class doesn't
* have any operations.
*/
public class CrNoOperations extends CrUML {
/**
* The constructor.
*/
public CrNoOperations() {
setupHeadAndDesc();
addSupportedDecision(UMLDecision.BEHAVIOR);
setKnowledgeTypes(Critic.KT_COMPLETENESS);
addTrigger("behavioralFeature");
}
/*
* @see org.argouml.uml.cognitive.critics.CrUML#predicate2(
* java.lang.Object, org.argouml.cognitive.Designer)
*/
@Override
public boolean predicate2(Object dm, Designer dsgr) {
if (!(Model.getFacade().isAClass(dm)
|| Model.getFacade().isAInterface(dm))) {
return NO_PROBLEM;
}
if (!(Model.getFacade().isPrimaryObject(dm))) {
return NO_PROBLEM;
}
// if the object does not have a name,
// than no problem
if ((Model.getFacade().getName(dm) == null)
|| ("".equals(Model.getFacade().getName(dm)))) {
return NO_PROBLEM;
}
// types can probably contain operations, but we should not nag at them
// not having any.
if (Model.getFacade().isType(dm)) {
return NO_PROBLEM;
}
// utility is a namespace collection - also not strictly
// required to have operations.
if (Model.getFacade().isUtility(dm)) {
return NO_PROBLEM;
}
//TODO: different critic or special message for classes
//that inherit all ops but define none of their own.
if (findInstanceOperationInInherited(dm, 0)) {
return NO_PROBLEM;
}
return PROBLEM_FOUND;
}
/*
* @see org.argouml.cognitive.Poster#getClarifier()
*/
@Override
public Icon getClarifier() {
return ClOperationCompartment.getTheInstance();
}
private boolean findInstanceOperationInInherited(Object dm, int depth) {
Iterator ops = Model.getFacade().getOperations(dm).iterator();
while (ops.hasNext()) {
if (!Model.getFacade().isStatic(ops.next())) {
return true;
}
}
if (depth > 50)
return false;
Iterator iter = Model.getFacade().getGeneralizations(dm).iterator();
while (iter.hasNext()) {
Object parent = Model.getFacade().getGeneral(iter.next());
if (parent == dm)
continue;
if (Model.getFacade().isAClassifier(parent)
&& findInstanceOperationInInherited(parent, depth + 1)) {
return true;
}
}
return false;
}
/*
* @see org.argouml.cognitive.critics.Critic#initWizard(
* org.argouml.cognitive.ui.Wizard)
*/
@Override
public void initWizard(Wizard w) {
if (w instanceof WizAddOperation) {
String ins = super.getInstructions();
String sug = super.getDefaultSuggestion();
((WizAddOperation) w).setInstructions(ins);
((WizAddOperation) w).setSuggestion(sug);
}
}
/*
* @see org.argouml.cognitive.critics.Critic#getWizardClass(org.argouml.cognitive.ToDoItem)
*/
@Override
public Class getWizardClass(ToDoItem item) {
return WizAddOperation.class;
}
/*
* @see org.argouml.uml.cognitive.critics.CrUML#getCriticizedDesignMaterials()
*/
public Set<Object> getCriticizedDesignMaterials() {
Set<Object> ret = new HashSet<Object>();
ret.add(Model.getMetaTypes().getUMLClass());
ret.add(Model.getMetaTypes().getInterface());
return ret;
}
}