// $Id: ModelElementNameNotationUml.java 14791 2008-05-23 17:08:28Z mvw $
// Copyright (c) 2005-2008 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.notation.providers.uml;
import java.text.ParseException;
import java.util.Collection;
import java.util.Map;
import java.util.Iterator;
import java.util.Stack;
import org.argouml.application.events.ArgoEventPump;
import org.argouml.application.events.ArgoEventTypes;
import org.argouml.application.events.ArgoHelpEvent;
import org.argouml.i18n.Translator;
import org.argouml.kernel.Project;
import org.argouml.kernel.ProjectManager;
import org.argouml.kernel.ProjectSettings;
import org.argouml.model.Model;
import org.argouml.notation.providers.ModelElementNameNotation;
/**
* Handles the notation of the name of a modelelement in UML,
* ie a string on the format:<pre>
* [ << stereotype >>] [+|-|#] [name]
* </pre>
*
* @author mvw@tigris.org
*/
public class ModelElementNameNotationUml extends ModelElementNameNotation {
/**
* The constructor.
*
* @param name the uml object
*/
public ModelElementNameNotationUml(Object name) {
super(name);
}
/*
* @see org.argouml.notation.providers.NotationProvider#parse(java.lang.Object, java.lang.String)
*/
public void parse(Object modelElement, String text) {
try {
NotationUtilityUml.parseModelElement(modelElement, text);
} catch (ParseException pe) {
String msg = "statusmsg.bar.error.parsing.node-modelelement";
Object[] args = {
pe.getLocalizedMessage(),
Integer.valueOf(pe.getErrorOffset()),
};
ArgoEventPump.fireEvent(new ArgoHelpEvent(
ArgoEventTypes.HELP_CHANGED, this,
Translator.messageFormat(msg, args)));
}
}
/*
* @see org.argouml.notation.providers.NotationProvider#getParsingHelp()
*/
public String getParsingHelp() {
return "parsing.help.fig-nodemodelelement";
}
/*
* @see org.argouml.notation.providers.NotationProvider#toString(java.lang.Object, java.util.Map)
*/
public String toString(Object modelElement, Map args) {
String name = Model.getFacade().getName(modelElement);
StringBuffer sb = new StringBuffer("");
if (isValue("fullyHandleStereotypes", args)) {
sb.append(generateStereotypes(modelElement, args));
}
sb.append(generateVisibility(modelElement, args));
if (isValue("pathVisible", args)) {
sb.append(NotationUtilityUml.generatePath(modelElement));
}
if (name != null) {
sb.append(name);
}
return sb.toString();
}
/**
* @param modelElement the UML element to generate for
* @param args arguments that influence the generation
* @return a string which represents the stereotypes
*/
protected String generateStereotypes(Object modelElement, Map args) {
Collection c = Model.getFacade().getStereotypes(modelElement);
StringBuffer sb = new StringBuffer(50);
Iterator i = c.iterator();
boolean first = true;
while (i.hasNext()) {
Object o = i.next();
if (!first) {
sb.append(',');
}
if (o != null) {
sb.append(Model.getFacade().getName(o));
first = false;
}
}
Project project =
ProjectManager.getManager().getCurrentProject();
ProjectSettings ps = project.getProjectSettings();
return first ? "" : ps.getLeftGuillemot()
+ sb.toString()
+ ps.getRightGuillemot();
}
/**
* @param modelElement the UML element to generate for
* @param args arguments that influence the generation
* @return a string which represents the path
*/
protected String generatePath(Object modelElement, Map args) {
StringBuilder s = new StringBuilder();
if (isValue("pathVisible", args)) {
Object p = modelElement;
Stack stack = new Stack();
Object ns = Model.getFacade().getNamespace(p);
while (ns != null && !Model.getFacade().isAModel(ns)) {
stack.push(Model.getFacade().getName(ns));
ns = Model.getFacade().getNamespace(ns);
}
while (!stack.isEmpty()) {
s.append((String) stack.pop() + "::");
}
if (s.length() > 0 && !(s.lastIndexOf(":") == s.length() - 1)) {
s.append("::");
}
}
return s.toString();
}
/**
* @param modelElement the UML element to generate for
* @param args arguments that influence the generation
* @return a string representing the visibility
*/
protected String generateVisibility(Object modelElement, Map args) {
String s = "";
if (isValue("visibilityVisible", args)) {
Object v = Model.getFacade().getVisibility(modelElement);
if (v != null) {
s = NotationUtilityUml.generateVisibility(v);
}
/* When nothing is generated: omit the space. */
if (s.length() > 0) {
s = s + " ";
}
}
return s;
}
}