plugins/org.eclipse.ocl.ecore/src/org/eclipse/ocl/ecore/internal/EcoreForeignMethods.java

/*******************************************************************************
 * Copyright (c) 2007, 2018 IBM Corporation and others.
 * All rights reserved.   This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v2.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v20.html
 *
 * Contributors:
 *   IBM - Initial API and implementation
 *   E.D.Willink - Refactoring to support extensibility and flexible error handling
 *******************************************************************************/

package org.eclipse.ocl.ecore.internal;

import org.eclipse.emf.ecore.EClassifier;
import org.eclipse.emf.ecore.ENamedElement;
import org.eclipse.emf.ecore.EPackage;
import org.eclipse.ocl.parser.AbstractOCLAnalyzer;


/**
 * A collection of <i>Foreign Methods</i> for the UML API.
 * 
 * @author Christian W. Damus (cdamus)
 */
public class EcoreForeignMethods {
    /**
     * Not instantiable by clients.
     */
    private EcoreForeignMethods() {
        super();
    }
    
    /**
     * Checks whether the specified element has the given name, accounting for
     * possibility of underscore-escaped names.
     * 
     * @param name a possibly underscore-escaped name of an element
     * @param element a named element
     * 
     * @return whether the element has this name
     */
    public static boolean isNamed(String name, ENamedElement element) {
        return AbstractOCLAnalyzer.equalName(name, element.getName());
    }
    
    /**
     * Foreign method for {@link EPackage#getEClassifier(String)}
     * that accounts for possibility of underscore-escaped names.
     * 
     * @param pkg a package
     * @param name a possibly underscore-escaped name of a nested classifier
     * 
     * @return the matching classifier, or <code>null</code> if none
     */
    public static EClassifier getEClassifier(EPackage pkg, String name) {
        EClassifier result = pkg.getEClassifier(name);
        
        if ((result == null) && AbstractOCLAnalyzer.isEscaped(name)) {
            // try the unescaped name
            result = pkg.getEClassifier(AbstractOCLAnalyzer.unescape(name));
        }
        
        return result;
    }
    
    /**
     * Foreign method for {@link EPackage#getESubpackages()} that searches by
     * name and accounts for possibility of underscore-escaped names.
     * 
     * @param pkg a package
     * @param name a possibly underscore-escaped name of a nested package
     * 
     * @return the matching sub-package, or <code>null</code> if none
     */
    public static EPackage getESubpackage(EPackage pkg, String name) {
        for (EPackage sub : pkg.getESubpackages()) {
            if (name.equals(sub.getName())) {
                return sub;
            }
        }
        
        if (AbstractOCLAnalyzer.isEscaped(name)) {
            // try the unescaped name
            name = AbstractOCLAnalyzer.unescape(name);
            
            for (EPackage sub : pkg.getESubpackages()) {
                if (name.equals(sub.getName())) {
                    return sub;
                }
            }
        }
        
        return null;
    }

}