plugins/org.eclipse.egf.core/src/org/eclipse/egf/core/helper/ResourceHelper.java

/**
 * Copyright (c) 2009-2010 Thales Corporate Services S.A.S.
 * 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:
 * Thales Corporate Services S.A.S - initial API and implementation
 */
package org.eclipse.egf.core.helper;

import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;

import org.eclipse.core.runtime.Assert;
import org.eclipse.egf.common.helper.EMFHelper;
import org.eclipse.egf.core.l10n.EGFCoreMessages;
import org.eclipse.emf.common.util.BasicDiagnostic;
import org.eclipse.emf.common.util.Diagnostic;
import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.common.util.UniqueEList;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.EStructuralFeature;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.emf.ecore.util.EcoreUtil;
import org.eclipse.osgi.util.NLS;

/**
 * @author Xavier Maysonnave
 * 
 */
public class ResourceHelper {

    private ResourceHelper() {
        // Prevent instantiation
    }

    /**
     * Returns a diagnostic describing the errors and warnings listed in the resource
     * and the specified exception (if any).
     */
    public static Diagnostic analyzeResourceProblems(Resource resource, Exception exception, String message) {
        if (resource.getErrors().isEmpty() == false || resource.getWarnings().isEmpty() == false) {
            BasicDiagnostic basicDiagnostic = new BasicDiagnostic(Diagnostic.ERROR, message, 0, NLS.bind(EGFCoreMessages.DiagnosticResourceProblems_message, resource.getURI()), new Object[] {
                exception == null ? (Object) resource : exception
            });
            basicDiagnostic.merge(EcoreUtil.computeDiagnostic(resource, true));
            return basicDiagnostic;
        } else if (exception != null) {
            return new BasicDiagnostic(Diagnostic.ERROR, message, 0, NLS.bind(EGFCoreMessages.DiagnosticResourceProblems_message, resource.getURI()), new Object[] {
                exception
            });
        } else {
            return Diagnostic.OK_INSTANCE;
        }
    }

    /**
     * is there any unresolved proxy against this resource ?
     * This method doesn't resolve proxies while analysed
     */
    public static boolean hasProxyReferences(Resource resource, URI uri) {
        Assert.isNotNull(resource);
        if (uri == null) {
            return false;
        }
        Map<EObject, Collection<EStructuralFeature.Setting>> proxies = EcoreUtil.ProxyCrossReferencer.find(resource);
        for (EObject reference : proxies.keySet()) {
            URI innerURI = EcoreUtil.getURI(reference);
            if (innerURI == null) {
                continue;
            }
            if (innerURI.trimFragment().equals(uri)) {
                return true;
            }
        }
        return false;
    }

    /**
     * return unresolved proxies for this resource ?
     * This method doesn't resolve proxies while analysed
     */
    public static List<EObject> getProxyReferences(Resource resource, URI uri) {
        Assert.isNotNull(resource);
        List<EObject> references = new UniqueEList<EObject>();
        if (uri == null) {
            return references;
        }
        Map<EObject, Collection<EStructuralFeature.Setting>> proxies = EcoreUtil.ProxyCrossReferencer.find(resource);
        for (EObject reference : proxies.keySet()) {
            URI innerURI = EcoreUtil.getURI(reference);
            if (innerURI == null) {
                continue;
            }
            if (innerURI.trimFragment().equals(uri)) {
                references.add(reference);
            }
        }
        return references;
    }

    /**
     * is there any unresolved proxy against this resource ?
     * This method doesn't resolve proxies while analysed
     */
    public static boolean hasURIProxyReferences(Resource resource, URI uri) {
        Assert.isNotNull(resource);
        if (uri == null) {
            return false;
        }
        Map<EObject, Collection<EStructuralFeature.Setting>> proxies = EMFHelper.URIProxyCrossReferencer.find(resource, uri);
        return proxies != null && proxies.size() > 0;
    }

    /**
     * return unresolved proxies for this resource ?
     * This method doesn't resolve proxies while analysed
     */
    public static Map<EObject, Collection<EStructuralFeature.Setting>> getURIProxyReferences(Resource resource, URI uri) {
        Assert.isNotNull(resource);
        Map<EObject, Collection<EStructuralFeature.Setting>> references = new HashMap<EObject, Collection<EStructuralFeature.Setting>>();
        if (uri == null) {
            return references;
        }
        return EMFHelper.URIProxyCrossReferencer.find(resource, uri);
    }

    /**
     * return owners of proxies who qualify a resource URI
     * This method doesn't resolve proxies while analysed
     */
    public static List<EObject> getURIProxyReferenceOwners(Resource resource, URI uri) {
        Assert.isNotNull(resource);
        List<EObject> owners = new UniqueEList<EObject>();
        if (uri == null) {
            return owners;
        }
        // Build proxies list
        for (Iterator<Map.Entry<EObject, Collection<EStructuralFeature.Setting>>> it = getURIProxyReferences(resource, uri).entrySet().iterator(); it.hasNext();) {
            // Build holders list
            for (EStructuralFeature.Setting setting : it.next().getValue()) {
                URI holderURI = EcoreUtil.getURI(setting.getEObject());
                if (holderURI == null) {
                    continue;
                }
                // Looking for an holder who match our current resource uri
                // Since the first one we found we iterate
                if (resource.getURI().equals(holderURI.trimFragment())) {
                    owners.add(setting.getEObject());
                    break;
                }
            }
        }
        return owners;
    }
}