examples/org.eclipse.ocl.examples.pivot/src/org/eclipse/ocl/examples/pivot/utilities/PathElement.java

/**
 * <copyright>
 *
 * Copyright (c) 2010,2011 E.D.Willink 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:
 *     E.D.Willink - initial API and implementation
 *
 * </copyright>
 *
 * $Id$
 */
package org.eclipse.ocl.examples.pivot.utilities;

import java.util.ArrayList;
import java.util.List;

import org.eclipse.emf.ecore.EObject;
import org.eclipse.ocl.examples.pivot.Element;
import org.eclipse.ocl.examples.pivot.Namespace;
import org.eclipse.ocl.examples.pivot.manager.MetaModelManager;

/**
 * A PathElement represents a segment in a qualified name.
 * <br>
 * A pair of Lists of PathElement can have their common prefix skipped by @link{getCommonLength}
 * to provide a scope dependent qualified name.
 */
public class PathElement
{
	public static int getCommonLength(List<PathElement> firstPath, List<PathElement> secondPath) {
		int iMax = Math.min(firstPath.size(), secondPath.size());
		for (int i = 0; i < iMax; i++) {
			Element objectElement = firstPath.get(i).element;
			Element contextElement = secondPath.get(i).element;
			if (!objectElement.equals(contextElement)) {
				return i;
			}
		}
		return iMax;
	}
	  
    public static List<PathElement> getPath(EObject element) {
        List<PathElement> path = new ArrayList<PathElement>();
        EObject parent = element;
        for (; (parent != null) && !(parent instanceof Namespace); parent = parent.eContainer()) {
        }
        for (; parent instanceof Namespace; parent = parent.eContainer()) {
            Namespace namespace = (Namespace)parent;
			path.add(0, new PathElement(namespace.getName(), namespace));
        }
        return path;
    }
	  
    public static List<PathElement> getPath(EObject element, MetaModelManager metaModelManager) {
        List<PathElement> path = new ArrayList<PathElement>();
        EObject parent = element;
        for (; (parent != null) && !(parent instanceof Namespace); parent = parent.eContainer()) {
        }
        for (; parent instanceof Namespace; parent = parent.eContainer()) {
            Namespace namespace = (Namespace)parent;
            if (metaModelManager != null) {
            	namespace = metaModelManager.getPrimaryElement(namespace);
            }
			path.add(0, new PathElement(namespace.getName(), namespace));
        }
        return path;
    }

	protected final String name;
	protected final Element element;
	
	public PathElement(String name, Element element) {
		super();
		this.name = name;
		this.element = element;
	}

	public final Element getElement() {
		return element;
	}

	public final String getName() {
		return name;
	}
	
	@Override
	public String toString() {
		return name;
	}
}