// $Id: CrUnconventionalClassName.java 15512 2008-08-05 17:33:53Z maurelio1234 $
// 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.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;
/**
* Critic to detect whether a class name obeys to certain rules.
*/
public class CrUnconventionalClassName extends AbstractCrUnconventionalName {
/**
* The constructor.
*/
public CrUnconventionalClassName() {
setupHeadAndDesc();
addSupportedDecision(UMLDecision.NAMING);
setKnowledgeTypes(Critic.KT_SYNTAX);
addTrigger("name");
}
/*
* @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;
}
Object cls = /*(MClassifier)*/ dm;
String myName = Model.getFacade().getName(cls);
if (myName == null || myName.equals("")) {
return NO_PROBLEM;
}
String nameStr = myName;
if (nameStr == null || nameStr.length() == 0) {
return NO_PROBLEM;
}
char initialChar = nameStr.charAt(0);
if (Character.isDigit(initialChar)
|| !Character.isUpperCase(initialChar)) {
return PROBLEM_FOUND;
}
return NO_PROBLEM;
}
/*
* @see org.argouml.cognitive.Poster#getClarifier()
*/
@Override
public Icon getClarifier() {
return ClClassName.getTheInstance();
}
/*
* @see org.argouml.cognitive.critics.Critic#initWizard(
* org.argouml.cognitive.ui.Wizard)
*/
@Override
public void initWizard(Wizard w) {
if (w instanceof WizMEName) {
ToDoItem item = (ToDoItem) w.getToDoItem();
Object me = item.getOffenders().get(0);
String sug = Model.getFacade().getName(me);
sug = computeSuggestion(sug);
String ins = super.getInstructions();
((WizMEName) w).setInstructions(ins);
((WizMEName) w).setSuggestion(sug);
}
}
/*
* @see org.argouml.uml.cognitive.critics.AbstractCrUnconventionalName#computeSuggestion(java.lang.String)
*/
public String computeSuggestion(String sug) {
if (sug == null) {
return "";
}
StringBuffer sb = new StringBuffer(sug);
while (sb.length() > 0 && Character.isDigit(sb.charAt(0))) {
sb.deleteCharAt(0);
}
if (sb.length() == 0) {
return "";
}
return sb.replace(0, 1,
Character.toString(Character.toUpperCase(sb.charAt(0))))
.toString();
}
/*
* @see org.argouml.cognitive.critics.Critic#getWizardClass(org.argouml.cognitive.ToDoItem)
*/
@Override
public Class getWizardClass(ToDoItem item) { return WizMEName.class; }
/*
* @see org.argouml.uml.cognitive.critics.CrUML#getCriticizedDesignMaterials()
*/
public Set<Object> getCriticizedDesignMaterials() {
Set<Object> ret = new HashSet<Object>();
ret.add(Model.getMetaTypes().getUMLClass());
return ret;
}
/**
* The UID.
*/
private static final long serialVersionUID = -3341858698991522822L;
}