/* $Id: CrUML.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:
* tfmorris
*****************************************************************************
*
* Some portions of this file was previously release using the BSD License:
*/
// Copyright (c) 1996-2006 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 org.apache.log4j.Logger;
import org.argouml.cognitive.Critic;
import org.argouml.cognitive.Designer;
import org.argouml.cognitive.ListSet;
import org.argouml.cognitive.ToDoItem;
import org.argouml.cognitive.Translator;
import org.argouml.model.Model;
import org.argouml.ocl.CriticOclEvaluator;
import org.argouml.uml.cognitive.UMLToDoItem;
import org.tigris.gef.ocl.ExpansionException;
/**
* "Abstract" Critic subclass that captures commonalities among all
* critics in the UML domain. This class also defines and registers
* the categories of design decisions that the critics can
* address. IT also deals with particular UMLToDoItems.
*
* @see org.argouml.cognitive.Designer
* @see org.argouml.cognitive.DecisionModel
*
* @author jrobbins
*/
public class CrUML extends Critic {
/**
* Logger.
*/
private static final Logger LOG = Logger.getLogger(CrUML.class);
/**
* By default looks for the localized strings at the <code>critics</code>
* Resource, but critics defined elsewhere (out of ArgoUML main tree)
* may override this parameter
*/
private String localizationPrefix = "critics";
/**
* The constructor for this class.
*/
public CrUML() {
}
/**
* The constructor for this class overriding the default
* localization resource.
*
* @param nonDefaultLocalizationPrefix the overriding localization resource
*/
public CrUML(String nonDefaultLocalizationPrefix) {
if (nonDefaultLocalizationPrefix != null) {
this.localizationPrefix = nonDefaultLocalizationPrefix;
setupHeadAndDesc();
}
}
/**
* Set the resources for this critic based on the class name.
*
* @param key is the class name.
*/
public void setResource(String key) {
super.setHeadline(getLocalizedString(key, "-head"));
super.setDescription(getLocalizedString(key, "-desc"));
}
/**
* Returns a localized string for the current critic class.
*
* @param suffix the suffix of the key
* @return the localized string
*/
protected String getLocalizedString(String suffix) {
return getLocalizedString(getClassSimpleName(), suffix);
}
/**
* Returns a localized string for the given key and suffix.
*
* @param key the main key
* @param suffix the suffix of the key
* @return the localized string
*/
protected String getLocalizedString(String key, String suffix) {
return Translator.localize(localizationPrefix + "." + key + suffix);
}
/**
* Loads the localized wizard's instruction.
*
* @return the instructions
*/
protected String getInstructions() {
return getLocalizedString("-ins");
}
/**
* Loads the localized wizard's default suggestion.
*
* @return the default suggestion
*/
protected String getDefaultSuggestion() {
return getLocalizedString("-sug");
}
/**
* @see org.argouml.cognitive.Critic#setHeadline(java.lang.String)
*
* Set up the locale specific text for the critic headline
* (the one liner that appears in the to-do pane)
* and the critic description (the detailed explanation that
* appears in the to-do tab of the details pane).
*
* MVW: Maybe we can make it part of the constructor CrUML()?
*
* FIXME: why override if nobody uses?
*/
//@Override
//public final void setHeadline(String s) {
//setupHeadAndDesc();
//}
/**
* Set up the locale specific text for the critic headline
* (the one liner that appears in the to-do pane)
* and the critic description (the detailed explanation that
* appears in the to-do tab of the details pane).
*/
public final void setupHeadAndDesc() {
setResource(getClassSimpleName());
}
/*
* @see org.argouml.cognitive.critics.Critic#predicate( java.lang.Object,
* org.argouml.cognitive.Designer)
*/
@Override
public boolean predicate(Object dm, Designer dsgr) {
if (Model.getFacade().isAModelElement(dm)
&& Model.getUmlFactory().isRemoved(dm)) {
return NO_PROBLEM;
} else {
return predicate2(dm, dsgr);
}
}
/**
* This is the decision routine for the critic.
*
* @param dm is the UML entity that is being checked.
* @param dsgr is for future development and can be ignored.
*
* @return boolean problem found
*/
public boolean predicate2(Object dm, Designer dsgr) {
return super.predicate(dm, dsgr);
}
////////////////////////////////////////////////////////////////
// display related methods
private static final String OCL_START = "<ocl>";
private static final String OCL_END = "</ocl>";
/**
* Expand text with ocl brackets in it.
* No recursive expansion.
*
* @return the expanded text
* @param res is the text to expand.
* @param offs is the elements to replace
*/
public String expand(String res, ListSet offs) {
if (offs.size() == 0) {
return res;
}
Object off1 = offs.get(0);
StringBuffer beginning = new StringBuffer("");
int matchPos = res.indexOf(OCL_START);
// replace all occurances of OFFENDER with the name of the
// first offender
while (matchPos != -1) {
int endExpr = res.indexOf(OCL_END, matchPos + 1);
// check if there is no OCL_END; if so, the critic expression
// is not correct and can not be expanded
if (endExpr == -1) {
break;
}
if (matchPos > 0) {
beginning.append(res.substring(0, matchPos));
}
String expr = res.substring(matchPos + OCL_START.length(), endExpr);
String evalStr = null;
try {
evalStr =
CriticOclEvaluator.getInstance().evalToString(off1, expr);
} catch (ExpansionException e) {
// Really ought to have a CriticException to throw here.
LOG.error("Failed to evaluate critic expression", e);
}
if (expr.endsWith("") && evalStr.equals("")) {
evalStr = Translator.localize("misc.name.anon");
}
beginning.append(evalStr);
res = res.substring(endExpr + OCL_END.length());
matchPos = res.indexOf(OCL_START);
}
if (beginning.length() == 0) {
// return original string if no replacements made
return res;
} else {
return beginning.append(res).toString();
}
}
/*
* @see org.argouml.cognitive.critics.Critic#toDoItem(Object, Designer)
*/
@Override
public ToDoItem toDoItem(Object dm, Designer dsgr) {
return new UMLToDoItem(this, dm, dsgr);
}
/**
* Get the name of the current class.
*
* @return the name of the current class without any leading packages
*/
private final String getClassSimpleName() {
// TODO: This method can be replaced by getClass().getSimpleName()
// when Argo drops support for Java versions < 1.5
String className = getClass().getName();
return className.substring(className.lastIndexOf('.') + 1);
}
/**
* The UID.
*/
private static final long serialVersionUID = 1785043010468681602L;
}