deprecated/plugins/org.eclipse.uml2/src/org/eclipse/uml2/internal/operation/UML2Operations.java - uml2/org.eclipse.uml2 - Git at Google

 /*
  * Copyright (c) 2003, 2004 IBM Corporation and others.
  * All rights reserved.   This program and the accompanying materials
  * are made available under the terms of the Common Public License v1.0
  * which accompanies this distribution, and is available at
  * http://www.eclipse.org/legal/cpl-v10.html
  *
  * Contributors:
  *   IBM - Initial API and implementation
  *
  * $Id: UML2Operations.java,v 1.6 2004/05/21 20:20:27 khussey Exp $
  */
 package org.eclipse.uml2.internal.operation;

 import java.util.ArrayList;
 import java.util.List;
 import java.util.Locale;
 import java.util.Map;

 import org.eclipse.emf.common.util.EList;
 import org.eclipse.emf.common.util.URI;
 import org.eclipse.emf.ecore.EAnnotation;
 import org.eclipse.emf.ecore.EModelElement;
 import org.eclipse.emf.ecore.EObject;
 import org.eclipse.emf.ecore.EValidator;
 import org.eclipse.emf.ecore.EcoreFactory;
 import org.eclipse.emf.ecore.resource.Resource;
 import org.eclipse.emf.ecore.util.EcoreUtil;
 import org.eclipse.uml2.Artifact;
 import org.eclipse.uml2.DataType;
 import org.eclipse.uml2.Element;
 import org.eclipse.uml2.Interface;
 import org.eclipse.uml2.NamedElement;
 import org.eclipse.uml2.Signal;
 import org.eclipse.uml2.StructuredClassifier;
 import org.eclipse.uml2.Type;
 import org.eclipse.uml2.util.UML2Switch;

 /**
  * The base class for all UML2 operation utility classes.
  */
 class UML2Operations {

 	/**
 	 * The empty string.
 	 */
 	protected static final String EMPTY_STRING = ""; //$NON-NLS-1$

 	/**
 	 * The standard extension for properties files.
 	 */
 	protected static final String PROPERTIES_FILE_EXTENSION = "properties"; //$NON-NLS-1$

 	protected static EAnnotation createEAnnotation(String source,
 			EModelElement eModelElement) {

 		if (Element.class.isInstance(eModelElement)) {
 			return ((Element) eModelElement).createEAnnotation(source);
 		} else {
 			EAnnotation eAnnotation = EcoreFactory.eINSTANCE
 				.createEAnnotation();

 			eAnnotation.setSource(source);
 			eAnnotation.setEModelElement(eModelElement);

 			return eAnnotation;
 		}
 	}

 	protected static EAnnotation getOrCreateEAnnotation(String source,
 			EModelElement eModelElement) {
 		EAnnotation eAnnotation = eModelElement.getEAnnotation(source);

 		return null == eAnnotation
 			? createEAnnotation(source, eModelElement) : eAnnotation;
 	}

 	protected static EAnnotation getEAnnotation(String source,
 			EModelElement eModelElement) {
 		EAnnotation eAnnotation = eModelElement.getEAnnotation(source);

 		return null == eAnnotation
 			? EcoreFactory.eINSTANCE.createEAnnotation() : eAnnotation;
 	}

 	protected static boolean safeEquals(Object thisObject, Object thatObject) {
 		return null == thisObject
 			? null == thatObject : thisObject.equals(thatObject);
 	}

 	protected static boolean isEmpty(String string) {
 		return null == string || 0 == string.length();
 	}

 	protected static EList getOwnedAttributes(Type type) {

 		if (null == type) {
 			return null;
 		}

 		return (EList) new UML2Switch() {

 			public Object caseArtifact(Artifact object) {
 				return object.getOwnedAttributes();
 			}

 			public Object caseDataType(DataType object) {
 				return object.getOwnedAttributes();
 			}

 			public Object caseInterface(Interface object) {
 				return object.getOwnedAttributes();
 			}

 			public Object caseSignal(Signal object) {
 				return object.getOwnedAttributes();
 			}

 			public Object caseStructuredClassifier(StructuredClassifier object) {
 				return object.getOwnedAttributes();
 			}
 		}.doSwitch(type);
 	}

 	private static String getMessageSubstitution(Map context, Object object) {

 		if (EObject.class.isInstance(object)) {
 			EObject eObject = (EObject) object;

 			if (NamedElement.class.isInstance(object)) {
 				String qualifiedName = ((NamedElement) object)
 					.getQualifiedName();

 				if (!isEmpty(qualifiedName)) {
 					return qualifiedName;
 				}
 			}

 			if (null != context) {

 				EValidator.SubstitutionLabelProvider substitutionLabelProvider = (EValidator.SubstitutionLabelProvider) context
 					.get(EValidator.SubstitutionLabelProvider.class);

 				if (null != substitutionLabelProvider) {
 					return substitutionLabelProvider.getObjectLabel(eObject);
 				}
 			}

 			Resource resource = eObject.eResource();

 			if (null != resource) {
 				return resource.getURI().lastSegment() + '#'
 					+ resource.getURIFragment(eObject);
 			}

 			return EcoreUtil.getIdentification((EObject) object);
 		} else {
 			return String.valueOf(object);
 		}
 	}

 	protected static Object[] getMessageSubstitutions(Map context,
 			Object object0) {
 		return new Object[] {getMessageSubstitution(context, object0)};
 	}

 	protected static Object[] getMessageSubstitutions(Map context,
 			Object object0, Object object1) {
 		return new Object[] {getMessageSubstitution(context, object0),
 			getMessageSubstitution(context, object1)};
 	}

 	protected static Object[] getMessageSubstitutions(Map context,
 			Object object0, Object object1, Object object2) {
 		return new Object[] {getMessageSubstitution(context, object0),
 			getMessageSubstitution(context, object1),
 			getMessageSubstitution(context, object2)};
 	}

 	/**
 	 * Obtains a valid (Java) identifier based on the specified name.
 	 *
 	 * @param name
 	 *            The name from which to obtain a valid identifier.
 	 * @return A valid (Java) identifier or the empty string.
 	 */
 	protected static String getValidIdentifier(String name) {

 		if (isEmpty(name)) {
 			return EMPTY_STRING;
 		}

 		StringBuffer validIdentifier = new StringBuffer();

 		if (Character.isJavaIdentifierStart(name.charAt(0))) {
 			validIdentifier.append(name.charAt(0));
 		} else {
 			validIdentifier.append('_');

 			if (Character.isJavaIdentifierPart(name.charAt(0))) {
 				validIdentifier.append(name.charAt(0));
 			}
 		}

 		for (int i = 1; i < name.length(); ++i) {

 			if (Character.isJavaIdentifierPart(name.charAt(i))) {
 				validIdentifier.append(name.charAt(i));
 			}
 		}

 		return validIdentifier.toString();
 	}

 	/**
 	 * Retrieves the candidate resource bundle URIs based on the specified base
 	 * URI and base segment in the specified locale.
 	 *
 	 * @param baseURI
 	 *            The base URI (i.e. without the last segment) for the candidate
 	 *            resource bundle URIs.
 	 * @param baseSegment
 	 *            The base segment (i.e. the last segment without the extension)
 	 *            for the candidate resource bundle URIs.
 	 * @param locale
 	 *            The locale within which to base the candidate resource bundle
 	 *            URIs.
 	 * @return The candidate resource bundle URIs with the base URI and base
 	 *         segment in the locale.
 	 */
 	private static List getResourceBundleURIs(URI baseURI, String baseSegment,
 			Locale locale) {
 		List resourceBundleURIs = new ArrayList();

 		String language = locale.getLanguage();

 		if (language.length() > 0) {
 			baseSegment += ('_' + language);
 			resourceBundleURIs.add(0, baseURI.appendSegment(baseSegment)
 				.appendFileExtension(PROPERTIES_FILE_EXTENSION));

 			String country = locale.getCountry();

 			if (country.length() > 0) {
 				baseSegment += ('_' + country);
 				resourceBundleURIs.add(0, baseURI.appendSegment(baseSegment)
 					.appendFileExtension(PROPERTIES_FILE_EXTENSION));

 				String variant = locale.getVariant();

 				if (variant.length() > 0) {
 					baseSegment += ('_' + variant);
 					resourceBundleURIs.add(0, baseURI
 						.appendSegment(baseSegment).appendFileExtension(
 							PROPERTIES_FILE_EXTENSION));
 				}
 			}
 		}

 		return resourceBundleURIs;
 	}

 	/**
 	 * Retrieves the candidate resource bundle URIs for the specified URI in the
 	 * specified locale.
 	 *
 	 * @param uri
 	 *            The URI upon which to base the candidate resource bundle URIs.
 	 * @param locale
 	 *            The locale within which to base the candidate resource bundle
 	 *            URIs.
 	 * @return The candidate resource bundle URIs for the URI in the locale.
 	 */
 	protected static List getResourceBundleURIs(URI uri, Locale locale) {
 		List resourceBundleURIs = new ArrayList();

 		URI baseURI = uri.trimSegments(1);
 		String baseSegment = uri.trimFileExtension().lastSegment();

 		resourceBundleURIs.add(baseURI.appendSegment(baseSegment)
 			.appendFileExtension(PROPERTIES_FILE_EXTENSION));

 		Locale defaultLocale = Locale.getDefault();

 		resourceBundleURIs.addAll(0, getResourceBundleURIs(baseURI,
 			baseSegment, defaultLocale));

 		if (!defaultLocale.equals(locale)) {
 			resourceBundleURIs.addAll(0, getResourceBundleURIs(baseURI,
 				baseSegment, defaultLocale));
 		}

 		return resourceBundleURIs;
 	}

 }
	/*
	* Copyright (c) 2003, 2004 IBM Corporation and others.
	* All rights reserved. This program and the accompanying materials
	* are made available under the terms of the Common Public License v1.0
	* which accompanies this distribution, and is available at
	* http://www.eclipse.org/legal/cpl-v10.html
	*
	* Contributors:
	* IBM - Initial API and implementation
	*
	* $Id: UML2Operations.java,v 1.6 2004/05/21 20:20:27 khussey Exp $
	*/
	package org.eclipse.uml2.internal.operation;

	import java.util.ArrayList;
	import java.util.List;
	import java.util.Locale;
	import java.util.Map;

	import org.eclipse.emf.common.util.EList;
	import org.eclipse.emf.common.util.URI;
	import org.eclipse.emf.ecore.EAnnotation;
	import org.eclipse.emf.ecore.EModelElement;
	import org.eclipse.emf.ecore.EObject;
	import org.eclipse.emf.ecore.EValidator;
	import org.eclipse.emf.ecore.EcoreFactory;
	import org.eclipse.emf.ecore.resource.Resource;
	import org.eclipse.emf.ecore.util.EcoreUtil;
	import org.eclipse.uml2.Artifact;
	import org.eclipse.uml2.DataType;
	import org.eclipse.uml2.Element;
	import org.eclipse.uml2.Interface;
	import org.eclipse.uml2.NamedElement;
	import org.eclipse.uml2.Signal;
	import org.eclipse.uml2.StructuredClassifier;
	import org.eclipse.uml2.Type;
	import org.eclipse.uml2.util.UML2Switch;

	/**
	* The base class for all UML2 operation utility classes.
	*/
	class UML2Operations {

	/**
	* The empty string.
	*/
	protected static final String EMPTY_STRING = ""; //$NON-NLS-1$

	/**
	* The standard extension for properties files.
	*/
	protected static final String PROPERTIES_FILE_EXTENSION = "properties"; //$NON-NLS-1$

	protected static EAnnotation createEAnnotation(String source,
	EModelElement eModelElement) {

	if (Element.class.isInstance(eModelElement)) {
	return ((Element) eModelElement).createEAnnotation(source);
	} else {
	EAnnotation eAnnotation = EcoreFactory.eINSTANCE
	.createEAnnotation();

	eAnnotation.setSource(source);
	eAnnotation.setEModelElement(eModelElement);

	return eAnnotation;
	}
	}

	protected static EAnnotation getOrCreateEAnnotation(String source,
	EModelElement eModelElement) {
	EAnnotation eAnnotation = eModelElement.getEAnnotation(source);

	return null == eAnnotation
	? createEAnnotation(source, eModelElement) : eAnnotation;
	}

	protected static EAnnotation getEAnnotation(String source,
	EModelElement eModelElement) {
	EAnnotation eAnnotation = eModelElement.getEAnnotation(source);

	return null == eAnnotation
	? EcoreFactory.eINSTANCE.createEAnnotation() : eAnnotation;
	}

	protected static boolean safeEquals(Object thisObject, Object thatObject) {
	return null == thisObject
	? null == thatObject : thisObject.equals(thatObject);
	}

	protected static boolean isEmpty(String string) {
	return null == string \|\| 0 == string.length();
	}

	protected static EList getOwnedAttributes(Type type) {

	if (null == type) {
	return null;
	}

	return (EList) new UML2Switch() {

	public Object caseArtifact(Artifact object) {
	return object.getOwnedAttributes();
	}

	public Object caseDataType(DataType object) {
	return object.getOwnedAttributes();
	}

	public Object caseInterface(Interface object) {
	return object.getOwnedAttributes();
	}

	public Object caseSignal(Signal object) {
	return object.getOwnedAttributes();
	}

	public Object caseStructuredClassifier(StructuredClassifier object) {
	return object.getOwnedAttributes();
	}
	}.doSwitch(type);
	}

	private static String getMessageSubstitution(Map context, Object object) {

	if (EObject.class.isInstance(object)) {
	EObject eObject = (EObject) object;

	if (NamedElement.class.isInstance(object)) {
	String qualifiedName = ((NamedElement) object)
	.getQualifiedName();

	if (!isEmpty(qualifiedName)) {
	return qualifiedName;
	}
	}

	if (null != context) {

	EValidator.SubstitutionLabelProvider substitutionLabelProvider = (EValidator.SubstitutionLabelProvider) context
	.get(EValidator.SubstitutionLabelProvider.class);

	if (null != substitutionLabelProvider) {
	return substitutionLabelProvider.getObjectLabel(eObject);
	}
	}

	Resource resource = eObject.eResource();

	if (null != resource) {
	return resource.getURI().lastSegment() + '#'
	+ resource.getURIFragment(eObject);
	}

	return EcoreUtil.getIdentification((EObject) object);
	} else {
	return String.valueOf(object);
	}
	}

	protected static Object[] getMessageSubstitutions(Map context,
	Object object0) {
	return new Object[] {getMessageSubstitution(context, object0)};
	}

	protected static Object[] getMessageSubstitutions(Map context,
	Object object0, Object object1) {
	return new Object[] {getMessageSubstitution(context, object0),
	getMessageSubstitution(context, object1)};
	}

	protected static Object[] getMessageSubstitutions(Map context,
	Object object0, Object object1, Object object2) {
	return new Object[] {getMessageSubstitution(context, object0),
	getMessageSubstitution(context, object1),
	getMessageSubstitution(context, object2)};
	}

	/**
	* Obtains a valid (Java) identifier based on the specified name.
	*
	* @param name
	* The name from which to obtain a valid identifier.
	* @return A valid (Java) identifier or the empty string.
	*/
	protected static String getValidIdentifier(String name) {

	if (isEmpty(name)) {
	return EMPTY_STRING;
	}

	StringBuffer validIdentifier = new StringBuffer();

	if (Character.isJavaIdentifierStart(name.charAt(0))) {
	validIdentifier.append(name.charAt(0));
	} else {
	validIdentifier.append('_');

	if (Character.isJavaIdentifierPart(name.charAt(0))) {
	validIdentifier.append(name.charAt(0));
	}
	}

	for (int i = 1; i < name.length(); ++i) {

	if (Character.isJavaIdentifierPart(name.charAt(i))) {
	validIdentifier.append(name.charAt(i));
	}
	}

	return validIdentifier.toString();
	}

	/**
	* Retrieves the candidate resource bundle URIs based on the specified base
	* URI and base segment in the specified locale.
	*
	* @param baseURI
	* The base URI (i.e. without the last segment) for the candidate
	* resource bundle URIs.
	* @param baseSegment
	* The base segment (i.e. the last segment without the extension)
	* for the candidate resource bundle URIs.
	* @param locale
	* The locale within which to base the candidate resource bundle
	* URIs.
	* @return The candidate resource bundle URIs with the base URI and base
	* segment in the locale.
	*/
	private static List getResourceBundleURIs(URI baseURI, String baseSegment,
	Locale locale) {
	List resourceBundleURIs = new ArrayList();

	String language = locale.getLanguage();

	if (language.length() > 0) {
	baseSegment += ('_' + language);
	resourceBundleURIs.add(0, baseURI.appendSegment(baseSegment)
	.appendFileExtension(PROPERTIES_FILE_EXTENSION));

	String country = locale.getCountry();

	if (country.length() > 0) {
	baseSegment += ('_' + country);
	resourceBundleURIs.add(0, baseURI.appendSegment(baseSegment)
	.appendFileExtension(PROPERTIES_FILE_EXTENSION));

	String variant = locale.getVariant();

	if (variant.length() > 0) {
	baseSegment += ('_' + variant);
	resourceBundleURIs.add(0, baseURI
	.appendSegment(baseSegment).appendFileExtension(
	PROPERTIES_FILE_EXTENSION));
	}
	}
	}

	return resourceBundleURIs;
	}

	/**
	* Retrieves the candidate resource bundle URIs for the specified URI in the
	* specified locale.
	*
	* @param uri
	* The URI upon which to base the candidate resource bundle URIs.
	* @param locale
	* The locale within which to base the candidate resource bundle
	* URIs.
	* @return The candidate resource bundle URIs for the URI in the locale.
	*/
	protected static List getResourceBundleURIs(URI uri, Locale locale) {
	List resourceBundleURIs = new ArrayList();

	URI baseURI = uri.trimSegments(1);
	String baseSegment = uri.trimFileExtension().lastSegment();

	resourceBundleURIs.add(baseURI.appendSegment(baseSegment)
	.appendFileExtension(PROPERTIES_FILE_EXTENSION));

	Locale defaultLocale = Locale.getDefault();

	resourceBundleURIs.addAll(0, getResourceBundleURIs(baseURI,
	baseSegment, defaultLocale));

	if (!defaultLocale.equals(locale)) {
	resourceBundleURIs.addAll(0, getResourceBundleURIs(baseURI,
	baseSegment, defaultLocale));
	}

	return resourceBundleURIs;
	}

	}