org.eclipse.uml2.uml.internal.operations.ExtensionOperations Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2005, 2014 IBM Corporation, CEA, 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:
 *   IBM - initial API and implementation
 *   Kenn Hussey (CEA) - 327039, 418466
 *
 */
package org.eclipse.uml2.uml.internal.operations;

import java.util.Map;

import org.eclipse.emf.common.util.BasicDiagnostic;
import org.eclipse.emf.common.util.Diagnostic;
import org.eclipse.emf.common.util.DiagnosticChain;
import org.eclipse.emf.common.util.EList;

import org.eclipse.uml2.uml.Extension;
import org.eclipse.uml2.uml.Property;
import org.eclipse.uml2.uml.Stereotype;
import org.eclipse.uml2.uml.Type;

import org.eclipse.uml2.uml.UMLPackage;

import org.eclipse.uml2.uml.util.UMLValidator;

/**
 * 
 * A static utility class that provides operations related to 'Extension' model objects.
 * 
 *
 * 
 * The following operations are supported:
 * 

 *   {@link org.eclipse.uml2.uml.Extension#validateNonOwnedEnd(org.eclipse.emf.common.util.DiagnosticChain, java.util.Map) Validate Non Owned End}
 *   {@link org.eclipse.uml2.uml.Extension#validateIsBinary(org.eclipse.emf.common.util.DiagnosticChain, java.util.Map) Validate Is Binary}
 *   {@link org.eclipse.uml2.uml.Extension#getStereotype() Get Stereotype}
 *   {@link org.eclipse.uml2.uml.Extension#getStereotypeEnd() Get Stereotype End}
 *   {@link org.eclipse.uml2.uml.Extension#isRequired() Is Required}
 *   {@link org.eclipse.uml2.uml.Extension#getMetaclass() Get Metaclass}
 *   {@link org.eclipse.uml2.uml.Extension#metaclassEnd() Metaclass End}
 * 
 * 
 *
 * @generated
 */
public class ExtensionOperations
		extends AssociationOperations {

	/**
	 * 
	 * 
	 * @generated
	 */
	protected ExtensionOperations() {
		super();
	}

	/**
	 * 
	 * 
	 * 
	 * The non-owned end of an Extension is typed by a Class.
	 * metaclassEnd()->notEmpty() and metaclassEnd().type.oclIsKindOf(Class)
	 * @param extension The receiving 'Extension' model object.
	 * @param diagnostics The chain of diagnostics to which problems are to be appended.
	 * @param context The cache of context-specific information.
	 * 
	 * @generated
	 */
	public static boolean validateNonOwnedEnd(Extension extension,
			DiagnosticChain diagnostics, Map context) {
		// TODO: implement this method
		// -> specify the condition that violates the invariant
		// -> verify the details of the diagnostic, including severity and message
		// Ensure that you remove @generated or mark it @generated NOT
		if (false) {
			if (diagnostics != null) {
				diagnostics
					.add(new BasicDiagnostic(
						Diagnostic.ERROR,
						UMLValidator.DIAGNOSTIC_SOURCE,
						UMLValidator.EXTENSION__NON_OWNED_END,
						org.eclipse.emf.ecore.plugin.EcorePlugin.INSTANCE
							.getString(
								"_UI_GenericInvariant_diagnostic", new Object[]{"validateNonOwnedEnd", org.eclipse.emf.ecore.util.EObjectValidator.getObjectLabel(extension, context)}), //$NON-NLS-1$ //$NON-NLS-2$
						new Object[]{extension}));
			}
			return false;
		}
		return true;
	}

	/**
	 * 
	 * 
	 * 
	 * An Extension is binary, i.e., it has only two memberEnds.
	 * memberEnd->size() = 2
	 * @param extension The receiving 'Extension' model object.
	 * @param diagnostics The chain of diagnostics to which problems are to be appended.
	 * @param context The cache of context-specific information.
	 * 
	 * @generated
	 */
	public static boolean validateIsBinary(Extension extension,
			DiagnosticChain diagnostics, Map context) {
		// TODO: implement this method
		// -> specify the condition that violates the invariant
		// -> verify the details of the diagnostic, including severity and message
		// Ensure that you remove @generated or mark it @generated NOT
		if (false) {
			if (diagnostics != null) {
				diagnostics
					.add(new BasicDiagnostic(
						Diagnostic.ERROR,
						UMLValidator.DIAGNOSTIC_SOURCE,
						UMLValidator.EXTENSION__IS_BINARY,
						org.eclipse.emf.ecore.plugin.EcorePlugin.INSTANCE
							.getString(
								"_UI_GenericInvariant_diagnostic", new Object[]{"validateIsBinary", org.eclipse.emf.ecore.util.EObjectValidator.getObjectLabel(extension, context)}), //$NON-NLS-1$ //$NON-NLS-2$
						new Object[]{extension}));
			}
			return false;
		}
		return true;
	}

	/**
	 * 
	 * 
	 * 
	 * Retrieves the extension end that is typed by a stereotype (as opposed to a metaclass).
	 * @param extension The receiving 'Extension' model object.
	 * 
	 * @generated NOT
	 */
	public static Property getStereotypeEnd(Extension extension) {
		EList ownedEnds = extension.getOwnedEnds();
		return ownedEnds.size() > 0
			? ownedEnds.get(0)
			: null;
	}

	/**
	 * 
	 * 
	 * 
	 * Retrieves the stereotype that extends a metaclass through this extension.
	 * @param extension The receiving 'Extension' model object.
	 * 
	 * @generated NOT
	 */
	public static Stereotype getStereotype(Extension extension) {
		Property stereotypeEnd = extension.getStereotypeEnd();

		if (stereotypeEnd != null) {
			Type type = stereotypeEnd.getType();

			if (type instanceof Stereotype) {
				return (Stereotype) type;
			}
		}

		return null;
	}

	/**
	 * 
	 * 
	 * 
	 * The query metaclassEnd() returns the Property that is typed by a metaclass (as opposed to a stereotype).
	 * result = (memberEnd->reject(p | ownedEnd->includes(p.oclAsType(ExtensionEnd)))->any(true))
	 * From package UML::Packages.
	 * @param extension The receiving 'Extension' model object.
	 * 
	 * @generated NOT
	 */
	public static Property metaclassEnd(Extension extension) {
		EList ownedEnds = extension.getOwnedEnds();

		for (Property memberEnd : extension.getMemberEnds()) {

			if (!ownedEnds.contains(memberEnd)) {
				return memberEnd;
			}
		}

		return null;
	}

	/**
	 * 
	 * 
	 * 
	 * The query metaclass() returns the metaclass that is being extended (as opposed to the extending stereotype).
	 * result = (metaclassEnd().type.oclAsType(Class))
	 * From package UML::Packages.
	 * @param extension The receiving 'Extension' model object.
	 * 
	 * @generated NOT
	 */
	public static org.eclipse.uml2.uml.Class getMetaclass(Extension extension) {
		Property metaclassEnd = extension.metaclassEnd();

		if (metaclassEnd != null) {
			Object type = metaclassEnd.eGet(
				UMLPackage.Literals.TYPED_ELEMENT__TYPE, false);

			if (type instanceof org.eclipse.uml2.uml.Class) {
				return (org.eclipse.uml2.uml.Class) type;
			}
		}

		return null;
	}

	/**
	 * 
	 * 
	 * 
	 * The query isRequired() is true if the owned end has a multiplicity with the lower bound of 1.
	 * result = (ownedEnd->lowerBound() = 1)
	 * From package UML::Packages.
	 * @param extension The receiving 'Extension' model object.
	 * 
	 * @generated NOT
	 */
	public static boolean isRequired(Extension extension) {
		EList ownedEnds = extension.getOwnedEnds();
		return ownedEnds.size() > 0 && ownedEnds.get(0).lowerBound() == 1;
	}

} // ExtensionOperations