core/plugins/org.eclipse.mdht.uml.common/src/org/eclipse/mdht/uml/common/util/NamedElementUtil.java - mdht/org.eclipse.mdht - Git at Google

 /*****************************************************************************
  * Copyright (c) 2006, 2011 CEA LIST, IBM Corporation, and others.
  *
  *
  * 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:
  *  Yann TANGUY (CEA LIST) yann.tanguy@cea.fr - Initial API and implementation
  *  Kenn Hussey - added utilities to get, remove, and set "business name"
  *
  *****************************************************************************/
 package org.eclipse.mdht.uml.common.util;

 import java.util.LinkedHashMap;
 import java.util.Map;

 import org.eclipse.emf.common.util.URI;
 import org.eclipse.uml2.common.util.UML2Util;
 import org.eclipse.uml2.uml.NamedElement;

 /**
  * Utility class for <code>org.eclipse.uml2.uml.NamedElement</code><BR>
  */
 public class NamedElementUtil extends UMLUtil {

 	public static final String QUALIFIED_NAME_SEPARATOR = "::";

 	private final static String PUBLIC_STRING = "+";

 	private final static String PROTECTED_STRING = "#";

 	private final static String PRIVATE_STRING = "-";

 	private final static String PACKAGE_STRING = "~";

 	/**
 	 * A helper method to calculate the max depth of an element
 	 *
 	 * @param the
 	 *            named element
 	 * @return the maximum depth found in qualified name
 	 */
 	public static int getQualifiedNameMaxDepth(NamedElement namedElement) {
 		int d = 0;
 		String s = namedElement.getQualifiedName();
 		if (s == null) {
 			return 0;
 		}
 		int n = 0;
 		while ((n = s.indexOf(QUALIFIED_NAME_SEPARATOR, n)) != -1) {
 			n += 2;
 			d++;
 		}
 		return d;
 	}

 	/**
 	 * Give the visibility of the {@link NamedElement} as a string, as defined
 	 * in the UML2 standard.
 	 *
 	 * @return A String representing the visibility of the {@link NamedElement}.
 	 *         Possible values:
 	 *         <ul>
 	 *         <li>public: <code>"+"</code>
 	 *         <li>private: <code>"-"</code>
 	 *         <li>protected: <code>"#"</code>
 	 *         <li>package: <code>"~"</code>
 	 *         </ul>
 	 */
 	public static String getVisibilityAsSign(NamedElement element) {
 		String vKindValue = "";

 		switch (element.getVisibility().getValue()) {
 			case org.eclipse.uml2.uml.VisibilityKind.PUBLIC:
 				vKindValue = PUBLIC_STRING;
 				break;
 			case org.eclipse.uml2.uml.VisibilityKind.PRIVATE:
 				vKindValue = PRIVATE_STRING;
 				break;
 			case org.eclipse.uml2.uml.VisibilityKind.PACKAGE:
 				vKindValue = PACKAGE_STRING;
 				break;
 			case org.eclipse.uml2.uml.VisibilityKind.PROTECTED:
 				vKindValue = PROTECTED_STRING;
 				break;
 		}
 		return vKindValue;
 	}

 	/**
 	 * Returns a (model) properties file key for the specified named element.
 	 *
 	 * @param namedElement
 	 *            The named element.
 	 * @return A property key for the named element.
 	 */
 	public static String getPropertyKey(NamedElement namedElement, String prefix) {
 		String qualifiedName = namedElement.getQualifiedName();
 		String prefixString = prefix == null
 				? ""
 				: "_" + prefix + "_";
 		return prefixString + UML2Util.getValidJavaIdentifier(UML2Util.isEmpty(qualifiedName)
 				? UML2Util.EMPTY_STRING
 				: qualifiedName.replace(':', '_'));
 	}

 	/**
 	 * Returns the property value for the specified named element, using the given key prefix.
 	 *
 	 * @param namedElement
 	 *            The named element.
 	 * @return The property value, or null if none exists.
 	 */
 	public static String getPropertyValue(NamedElement namedElement, String prefix) {
 		String properties = readProperties(getPropertiesURI(namedElement.eResource()));

 		if (properties != null) {
 			String property = parseProperties(properties).get(getPropertyKey(namedElement, prefix));

 			if (property != null) {
 				int index = property.indexOf('=');

 				if (index > 0) {
 					return property.substring(index + 1).trim();
 				}
 			}
 		}

 		return null;
 	}

 	/**
 	 * Sets the property value for the specified named element, and given key prefix,
 	 * to the given string value.
 	 *
 	 * @param namedElement
 	 *            The named element.
 	 * @param businessName
 	 *            The new value.
 	 * @return Whether the value was successfully set.
 	 */
 	public static boolean setPropertyValue(NamedElement namedElement, String prefix, String value) {
 		URI uri = getPropertiesURI(namedElement.eResource());
 		String properties = readProperties(uri);
 		Map<String, String> parsedProperties = properties != null
 				? parseProperties(properties)
 				: new LinkedHashMap<String, String>();
 		String key = getPropertyKey(namedElement, prefix);
 		String property = parsedProperties.get(key);
 		int index = property != null
 				? property.indexOf('=')
 				: -1;
 		parsedProperties.put(key, (index != -1 && property.indexOf('#') != -1
 				? "#"
 				: "") + key + " = " + value + System.getProperty("line.separator"));
 		return writeProperties(uri, parsedProperties);
 	}

 	/**
 	 * Removes the property value that is currently set for the specified named
 	 * element, if any.
 	 *
 	 * @param namedElement
 	 *            The named element.
 	 * @return The value that was set for the element (if one
 	 *         existed); otherwise <code>null</code>.
 	 */
 	public static String removePropertyValue(NamedElement namedElement, String prefix) {
 		URI uri = getPropertiesURI(namedElement.eResource());
 		String properties = readProperties(uri);

 		if (properties != null) {
 			Map<String, String> parsedProperties = parseProperties(properties);
 			String property = parsedProperties.remove(getPropertyKey(namedElement, prefix));

 			if (property != null && writeProperties(uri, parsedProperties)) {
 				int index = property.indexOf('=');

 				if (index > 0) {
 					return property.substring(index + 1).trim();
 				}
 			}
 		}

 		return null;
 	}

 	/**
 	 * Returns a (model) properties file key for the specified named element with 'label' prefix.
 	 *
 	 * @param namedElement
 	 *            The named element.
 	 * @return A label property key for the named element.
 	 */
 	public static String getLabelPropertyKey(NamedElement namedElement) {
 		String value = getPropertyKey(namedElement, "label");
 		return (value == null)
 				? namedElement.getName()
 				: value;
 	}

 	/**
 	 * Returns the "business name" for the specified named element, or the name
 	 * if none exists. The "business name" of a named element corresponds to the
 	 * (potentially localized) label that is stored in a properties file and
 	 * returned for the element by {@link NamedElement#getLabel()}.
 	 *
 	 * @param namedElement
 	 *            The named element.
 	 * @return The "business name" for the element (if one exists); otherwise,
 	 *         the name of the element.
 	 */
 	public static String getBusinessName(NamedElement namedElement) {
 		String value = getPropertyValue(namedElement, "label");
 		return (value == null)
 				? namedElement.getName()
 				: value;
 	}

 	/**
 	 * Returns the "name" for the specified named element, or the name
 	 * if none exists. The "business name" of a named element corresponds to the
 	 * (potentially localized) label that is stored in a properties file and
 	 * returned for the element by {@link NamedElement#getLabel()}.
 	 *
 	 * @param namedElement
 	 *            The named element.
 	 * @return The "name" for the element (if one exists); otherwise,
 	 *         the name of the element.
 	 */
 	public static String getElementName(NamedElement namedElement) {
 		String value = getPropertyValue(namedElement, "name");
 		return (value == null)
 				? namedElement.getName()
 				: value;
 	}

 	/**
 	 * Removes the "business name" that is currently set for the specified named
 	 * element, if any.
 	 *
 	 * @param namedElement
 	 *            The named element.
 	 * @return The "business name" that was set for the element (if one
 	 *         existed); otherwise <code>null</code>.
 	 */
 	public static String removeBusinessName(NamedElement namedElement) {
 		return removePropertyValue(namedElement, "label");
 	}

 	/**
 	 * Sets the "name" for the specified named element to the given
 	 * string.
 	 *
 	 * @param namedElement
 	 *            The named element.
 	 * @param businessName
 	 *            The new "name" for the element.
 	 * @return Whether the "name" was successfully set.
 	 */
 	public static boolean setElementName(NamedElement namedElement, String name) {
 		return setPropertyValue(namedElement, "name", name);
 	}

 	/**
 	 * Sets the "business name" for the specified named element to the given
 	 * string.
 	 *
 	 * @param namedElement
 	 *            The named element.
 	 * @param businessName
 	 *            The new "business name" for the element.
 	 * @return Whether the "business name" was successfully set.
 	 */
 	public static boolean setBusinessName(NamedElement namedElement, String businessName) {
 		return setPropertyValue(namedElement, "label", businessName);
 	}

 }
	/*****************************************************************************
	* Copyright (c) 2006, 2011 CEA LIST, IBM Corporation, and others.
	*
	*
	* 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:
	* Yann TANGUY (CEA LIST) yann.tanguy@cea.fr - Initial API and implementation
	* Kenn Hussey - added utilities to get, remove, and set "business name"
	*
	*****************************************************************************/
	package org.eclipse.mdht.uml.common.util;

	import java.util.LinkedHashMap;
	import java.util.Map;

	import org.eclipse.emf.common.util.URI;
	import org.eclipse.uml2.common.util.UML2Util;
	import org.eclipse.uml2.uml.NamedElement;

	/**
	* Utility class for <code>org.eclipse.uml2.uml.NamedElement</code><BR>
	*/
	public class NamedElementUtil extends UMLUtil {

	public static final String QUALIFIED_NAME_SEPARATOR = "::";

	private final static String PUBLIC_STRING = "+";

	private final static String PROTECTED_STRING = "#";

	private final static String PRIVATE_STRING = "-";

	private final static String PACKAGE_STRING = "~";

	/**
	* A helper method to calculate the max depth of an element
	*
	* @param the
	* named element
	* @return the maximum depth found in qualified name
	*/
	public static int getQualifiedNameMaxDepth(NamedElement namedElement) {
	int d = 0;
	String s = namedElement.getQualifiedName();
	if (s == null) {
	return 0;
	}
	int n = 0;
	while ((n = s.indexOf(QUALIFIED_NAME_SEPARATOR, n)) != -1) {
	n += 2;
	d++;
	}
	return d;
	}

	/**
	* Give the visibility of the {@link NamedElement} as a string, as defined
	* in the UML2 standard.
	*
	* @return A String representing the visibility of the {@link NamedElement}.
	* Possible values:
	* <ul>
	* <li>public: <code>"+"</code>
	* <li>private: <code>"-"</code>
	* <li>protected: <code>"#"</code>
	* <li>package: <code>"~"</code>
	* </ul>
	*/
	public static String getVisibilityAsSign(NamedElement element) {
	String vKindValue = "";

	switch (element.getVisibility().getValue()) {
	case org.eclipse.uml2.uml.VisibilityKind.PUBLIC:
	vKindValue = PUBLIC_STRING;
	break;
	case org.eclipse.uml2.uml.VisibilityKind.PRIVATE:
	vKindValue = PRIVATE_STRING;
	break;
	case org.eclipse.uml2.uml.VisibilityKind.PACKAGE:
	vKindValue = PACKAGE_STRING;
	break;
	case org.eclipse.uml2.uml.VisibilityKind.PROTECTED:
	vKindValue = PROTECTED_STRING;
	break;
	}
	return vKindValue;
	}

	/**
	* Returns a (model) properties file key for the specified named element.
	*
	* @param namedElement
	* The named element.
	* @return A property key for the named element.
	*/
	public static String getPropertyKey(NamedElement namedElement, String prefix) {
	String qualifiedName = namedElement.getQualifiedName();
	String prefixString = prefix == null
	? ""
	: "_" + prefix + "_";
	return prefixString + UML2Util.getValidJavaIdentifier(UML2Util.isEmpty(qualifiedName)
	? UML2Util.EMPTY_STRING
	: qualifiedName.replace(':', '_'));
	}

	/**
	* Returns the property value for the specified named element, using the given key prefix.
	*
	* @param namedElement
	* The named element.
	* @return The property value, or null if none exists.
	*/
	public static String getPropertyValue(NamedElement namedElement, String prefix) {
	String properties = readProperties(getPropertiesURI(namedElement.eResource()));

	if (properties != null) {
	String property = parseProperties(properties).get(getPropertyKey(namedElement, prefix));

	if (property != null) {
	int index = property.indexOf('=');

	if (index > 0) {
	return property.substring(index + 1).trim();
	}
	}
	}

	return null;
	}

	/**
	* Sets the property value for the specified named element, and given key prefix,
	* to the given string value.
	*
	* @param namedElement
	* The named element.
	* @param businessName
	* The new value.
	* @return Whether the value was successfully set.
	*/
	public static boolean setPropertyValue(NamedElement namedElement, String prefix, String value) {
	URI uri = getPropertiesURI(namedElement.eResource());
	String properties = readProperties(uri);
	Map<String, String> parsedProperties = properties != null
	? parseProperties(properties)
	: new LinkedHashMap<String, String>();
	String key = getPropertyKey(namedElement, prefix);
	String property = parsedProperties.get(key);
	int index = property != null
	? property.indexOf('=')
	: -1;
	parsedProperties.put(key, (index != -1 && property.indexOf('#') != -1
	? "#"
	: "") + key + " = " + value + System.getProperty("line.separator"));
	return writeProperties(uri, parsedProperties);
	}

	/**
	* Removes the property value that is currently set for the specified named
	* element, if any.
	*
	* @param namedElement
	* The named element.
	* @return The value that was set for the element (if one
	* existed); otherwise <code>null</code>.
	*/
	public static String removePropertyValue(NamedElement namedElement, String prefix) {
	URI uri = getPropertiesURI(namedElement.eResource());
	String properties = readProperties(uri);

	if (properties != null) {
	Map<String, String> parsedProperties = parseProperties(properties);
	String property = parsedProperties.remove(getPropertyKey(namedElement, prefix));

	if (property != null && writeProperties(uri, parsedProperties)) {
	int index = property.indexOf('=');

	if (index > 0) {
	return property.substring(index + 1).trim();
	}
	}
	}

	return null;
	}

	/**
	* Returns a (model) properties file key for the specified named element with 'label' prefix.
	*
	* @param namedElement
	* The named element.
	* @return A label property key for the named element.
	*/
	public static String getLabelPropertyKey(NamedElement namedElement) {
	String value = getPropertyKey(namedElement, "label");
	return (value == null)
	? namedElement.getName()
	: value;
	}

	/**
	* Returns the "business name" for the specified named element, or the name
	* if none exists. The "business name" of a named element corresponds to the
	* (potentially localized) label that is stored in a properties file and
	* returned for the element by {@link NamedElement#getLabel()}.
	*
	* @param namedElement
	* The named element.
	* @return The "business name" for the element (if one exists); otherwise,
	* the name of the element.
	*/
	public static String getBusinessName(NamedElement namedElement) {
	String value = getPropertyValue(namedElement, "label");
	return (value == null)
	? namedElement.getName()
	: value;
	}

	/**
	* Returns the "name" for the specified named element, or the name
	* if none exists. The "business name" of a named element corresponds to the
	* (potentially localized) label that is stored in a properties file and
	* returned for the element by {@link NamedElement#getLabel()}.
	*
	* @param namedElement
	* The named element.
	* @return The "name" for the element (if one exists); otherwise,
	* the name of the element.
	*/
	public static String getElementName(NamedElement namedElement) {
	String value = getPropertyValue(namedElement, "name");
	return (value == null)
	? namedElement.getName()
	: value;
	}

	/**
	* Removes the "business name" that is currently set for the specified named
	* element, if any.
	*
	* @param namedElement
	* The named element.
	* @return The "business name" that was set for the element (if one
	* existed); otherwise <code>null</code>.
	*/
	public static String removeBusinessName(NamedElement namedElement) {
	return removePropertyValue(namedElement, "label");
	}

	/**
	* Sets the "name" for the specified named element to the given
	* string.
	*
	* @param namedElement
	* The named element.
	* @param businessName
	* The new "name" for the element.
	* @return Whether the "name" was successfully set.
	*/
	public static boolean setElementName(NamedElement namedElement, String name) {
	return setPropertyValue(namedElement, "name", name);
	}

	/**
	* Sets the "business name" for the specified named element to the given
	* string.
	*
	* @param namedElement
	* The named element.
	* @param businessName
	* The new "business name" for the element.
	* @return Whether the "business name" was successfully set.
	*/
	public static boolean setBusinessName(NamedElement namedElement, String businessName) {
	return setPropertyValue(namedElement, "label", businessName);
	}

	}