* 

 * @deprecated Use the {@link org.eclipse.gmf.runtime.emf.core.resources.GMFResource}

 *     class, instead

import org.eclipse.gmf.runtime.emf.core.resources.GMFResource;

import org.eclipse.gmf.runtime.emf.core.resources.IPathmapManager;

	public IStatus addPathVariable(String name, String value) {

		setPathVariable(name, value);

		return Status.OK_STATUS; // TODO: report accurate status

	}

	public IStatus removePathVariable(String name) {

		unsetPathVariable(name);

		return Status.OK_STATUS; // TODO: report accurate status

	}

 * 

 * @deprecated Use the {@link org.eclipse.gmf.runtime.emf.core.resources.GMFHandler}

 *     class, instead

 * 

 * @deprecated Use the {@link org.eclipse.gmf.runtime.emf.core.resources.GMFHelper}

 *     class, instead

 * 

 * @deprecated Use the {@link org.eclipse.gmf.runtime.emf.core.resources.GMFLoad}

 *     class, instead

@see org.eclipse.gmf.runtime.emf.core.resources.PathmapManager

 * 

 * @deprecated Use the {@link org.eclipse.gmf.runtime.emf.core.resources.AbortResourceLoadException}

 *     exception, instead.

/******************************************************************************

 * Copyright (c) 2004, 2006 IBM Corporation 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 Corporation - initial API and implementation 

 ****************************************************************************/

package org.eclipse.gmf.runtime.emf.core.resources;

import org.eclipse.emf.common.util.URI;

import org.eclipse.emf.ecore.xmi.XMLResource;

import org.eclipse.emf.ecore.xmi.impl.XMIHelperImpl;

import org.eclipse.gmf.runtime.emf.core.internal.util.EMFCoreConstants;

/**

 * This class changes the behavior of the default XMIHelper so that references

 * between projects are not deresolved.

 * 

 * @author rafikj

 */

public class GMFHelper

	extends XMIHelperImpl {

	/**

	 * Constructor.

	 */

	public GMFHelper(XMLResource resource) {

		super(resource);

	}

	/**

	 * @see org.eclipse.emf.ecore.xmi.XMLHelper#deresolve(org.eclipse.emf.common.util.URI)

	 */

	public URI deresolve(URI uri) {

		// if this both target and container are within a platform resource and

		// projects

		// or plugins are different then do not deresolve.

		if (((EMFCoreConstants.PLATFORM_SCHEME.equals(uri.scheme())) && (EMFCoreConstants.PLATFORM_SCHEME

			.equals(resourceURI.scheme())))

			&& ((uri.segmentCount() > 2) && (resourceURI.segmentCount() > 2))

			&& ((!uri.segments()[0].equals(resourceURI.segments()[0])) || (!uri

				.segments()[1].equals(resourceURI.segments()[1]))))

			return uri;

		return super.deresolve(uri);

	}

}

/******************************************************************************

 * Copyright (c) 2004-2006 IBM Corporation 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 Corporation - initial API and implementation 

 ****************************************************************************/

package org.eclipse.gmf.runtime.emf.core.resources;

import org.eclipse.emf.common.notify.Adapter;

import org.eclipse.emf.common.notify.Notification;

import org.eclipse.emf.common.notify.NotificationChain;

import org.eclipse.emf.common.util.URI;

import org.eclipse.emf.ecore.EObject;

import org.eclipse.emf.ecore.EStructuralFeature;

import org.eclipse.emf.ecore.resource.ResourceSet;

import org.eclipse.emf.ecore.xmi.XMLHelper;

import org.eclipse.emf.ecore.xmi.XMLLoad;

import org.eclipse.emf.ecore.xmi.XMLSave;

import org.eclipse.emf.ecore.xmi.impl.XMIResourceImpl;

import org.eclipse.emf.ecore.xmi.impl.XMISaveImpl;

import org.eclipse.gmf.runtime.emf.core.internal.util.EMFCoreConstants;

import org.eclipse.gmf.runtime.emf.core.internal.util.Util;

/**

 * Custom implementation of an XMIResource.

 * 

 * @author rafikj

 */

public class GMFResource

	extends XMIResourceImpl {

	/**

	 * Use this option to abort loading a resource immediately when an error occurs.

	 * The default is <code>Boolean.FALSE</code> unless set to <code>Boolean.TRUE</code> explicitly.

	 */

	public static final String OPTION_ABORT_ON_ERROR = "ABORT_ON_ERROR"; //$NON-NLS-1$

	private boolean useIDAttributes = false;

	/**

	 * Constructor.

	 */

	public GMFResource(URI uri) {

		super(uri);

		setTrackingModification(true);

	}

	protected boolean useUUIDs() {

		return true;

	}

	/**

	 * Should we use ID attribute?

	 */

	public void setUseIDAttributes(boolean b) {

		useIDAttributes = b;

	}

	/**

	 * Should we use ID attribute?

	 */

	protected boolean useIDAttributes() {

		return useIDAttributes;

	}

	protected XMLHelper createXMLHelper() {

		return new GMFHelper(this);

	}

	protected XMLLoad createXMLLoad() {

		return new GMFLoad(createXMLHelper());

	}

	protected XMLSave createXMLSave() {

		return new XMISaveImpl(createXMLHelper());

	}

	/**

	 * @see org.eclipse.emf.ecore.resource.Resource#getEObject(java.lang.String)

	 */

	public EObject getEObject(String uriFragment) {

		int index = uriFragment.indexOf(EMFCoreConstants.FRAGMENT_SEPARATOR);

		if (index != -1)

			uriFragment = uriFragment.substring(0, index);

		return super.getEObject(uriFragment);

	}

	/**

	 * Get the saved ID of an EObject.

	 */

	public static String getSavedID(EObject eObject) {

		return (String) DETACHED_EOBJECT_TO_ID_MAP.get(eObject);

	}

	/**

	 * @see org.eclipse.emf.ecore.resource.Resource#setURI(org.eclipse.emf.common.util.URI)

	 */

	public void setURI(URI uri) {

		if (getResourceSet() != null) {

			setRawURI(Util.denormalizeURI(uri, getResourceSet()));

		}

	}

	public NotificationChain basicSetResourceSet(ResourceSet rset, NotificationChain notifications) {

		// when I am added to a new resource set, my optimally denormalized URI

		//     may change according to its different URI converter

		if (rset != null) {

			setURI(getURI());

		}

		return super.basicSetResourceSet(rset, notifications);

	}

	/**

	 * Set the URI of the resource without processing it.

	 */

	public void setRawURI(URI uri) {

		URI oldURI = getURI();

		if ((uri == oldURI) || ((uri != null) && (uri.equals(oldURI))))

			return;

		super.setURI(uri);

	}

	/**

	 * The inherited implementation creates an adapter that <em>always</em> sets

	 * the modified state.  We prefer to check, first, whether the resource

	 * is already modified so that we don't generate redundant notifications.

	 * Moreover, we additionally set modified state only for changes that are

	 * in non-transient features of objects contained (recursively) by

	 * non-transient references.

	 */

	protected Adapter createModificationTrackingAdapter() {

		return new ModificationTrackingAdapter() {

			public void notifyChanged(Notification notification) {

				if (!isModified() && !isTransient(

						notification.getNotifier(), notification.getFeature())) {

					super.notifyChanged(notification);

				}

			}

			/**

			 * Check if the feature or one of the notifier's containers is

			 * transient.

			 * 

			 * @param notifier a notifier

			 * @param feature the feature that changed

			 * 

			 * @return <code>true</code> if the feature is transient or if the

			 *    notifier or any of its ancestors is contained by a transient

			 *    reference; <code>false</code>, otherwise

			 */

			private boolean isTransient(Object notifier, Object feature) {

				if (feature instanceof EStructuralFeature) {

					if (((EStructuralFeature) feature).isTransient())

						return true;

					else

						// calling isTransient could be a lengthy operation.

						//   It is safe to cast because the adapter is only

						//   attached to EObjects, not to the resource

						return isTransient((EObject) notifier);

				}

				return false;

			}

			/**

			 * Is object transient?

			 */

			private boolean isTransient(EObject eObject) {

				EStructuralFeature containmentFeature = eObject.eContainmentFeature();

				while (containmentFeature != null) {

					if (containmentFeature.isTransient())

						return true;

					eObject = eObject.eContainer();

					if (eObject != null)

						containmentFeature =  eObject.eContainmentFeature();

					else

						break;

				}

				return false;

			}};

	}

}

/******************************************************************************

 * Copyright (c) 2006 IBM Corporation 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 Corporation - initial API and implementation 

 ****************************************************************************/

package org.eclipse.gmf.runtime.emf.core.resources;

/**

 * This exception is intended to be thrown during Resource load when an

 * error occurs. This RuntimeException wrapper is required in order to

 * abort loading at any time.

 * 

 * @author Christian Vogt (cvogt)

 */

public class AbortResourceLoadException extends RuntimeException {

	private static final long serialVersionUID = -5621491416138595586L;

	/**

	 * Initializes me without any details.

	 */

	public AbortResourceLoadException() {

		super();

	}

	/**

	 * Initializes me with a useful message.

	 * 

	 * @param message

	 *            a message

	 */

	public AbortResourceLoadException(String message) {

		super(message);

	}

	/**

	 * Initializes me with a cause.

	 * 

	 * @param cause

	 *            the cause of this exception.

	 */

	public AbortResourceLoadException(Throwable cause) {

		super(null == cause ? null

			: cause.toString(), cause);

	}

}

/******************************************************************************

 * Copyright (c) 2004, 2006 IBM Corporation 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 Corporation - initial API and implementation 

 ****************************************************************************/

package org.eclipse.gmf.runtime.emf.core.resources;

import java.io.IOException;

import java.io.InputStream;

import java.util.Map;

import org.eclipse.emf.ecore.resource.Resource;

import org.eclipse.emf.ecore.xmi.UnresolvedReferenceException;

import org.eclipse.emf.ecore.xmi.XMLHelper;

import org.eclipse.emf.ecore.xmi.XMLResource;

import org.eclipse.emf.ecore.xmi.impl.SAXWrapper;

import org.eclipse.emf.ecore.xmi.impl.XMILoadImpl;

import org.xml.sax.helpers.DefaultHandler;

/**

 * This class changes the behavior of the default XMILoader so that

 * UnresolvedReferenceExceptions are not thrown back.

 * 

 * @author rafikj

 */

public class GMFLoad

	extends XMILoadImpl {

	/**

	 * Constructor.

	 */

	public GMFLoad(XMLHelper helper) {

		super(helper);

	}

	/**

	 * @see org.eclipse.emf.ecore.xmi.XMLLoad#load(org.eclipse.emf.ecore.xmi.XMLResource,

	 *      java.io.InputStream, java.util.Map)

	 */

	public void load(XMLResource r, InputStream s, Map o)

		throws IOException {

		try {

			super.load(r, s, o);

		} catch (Resource.IOWrappedException e) {

			if (!(e.getWrappedException() instanceof UnresolvedReferenceException))

				throw e;

		} catch (AbortResourceLoadException arle) {

			throw new Resource.IOWrappedException((Exception)arle.getCause());

		}

	}

	/**

	 * @see org.eclipse.emf.ecore.xmi.impl.XMLLoadImpl#makeDefaultHandler()

	 */

	protected DefaultHandler makeDefaultHandler() {

		return new SAXWrapper(new GMFHandler(resource, helper, options));

	}

}

/******************************************************************************

 * Copyright (c) 2004, 2006 IBM Corporation 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 Corporation - initial API and implementation 

 ****************************************************************************/

package org.eclipse.gmf.runtime.emf.core.resources;

import java.util.HashMap;

import java.util.Iterator;

import java.util.Map;

import org.eclipse.emf.common.util.URI;

import org.eclipse.emf.ecore.EFactory;

import org.eclipse.emf.ecore.EObject;

import org.eclipse.emf.ecore.EPackage;

import org.eclipse.emf.ecore.EStructuralFeature;

import org.eclipse.emf.ecore.InternalEObject;

import org.eclipse.emf.ecore.resource.Resource;

import org.eclipse.emf.ecore.resource.impl.ResourceImpl;

import org.eclipse.emf.ecore.xmi.XMIException;

import org.eclipse.emf.ecore.xmi.XMLHelper;

import org.eclipse.emf.ecore.xmi.XMLResource;

import org.eclipse.emf.ecore.xmi.impl.SAXXMIHandler;

import org.eclipse.emf.ecore.xml.type.AnyType;

/**

 * The SAX handler for MSL resources. Updates demand-created packages with their

 * namespace prefixes and schema locations.

 * 

 * @author khussey

 */

public class GMFHandler

	extends SAXXMIHandler {

	protected final Map urisToProxies;

	protected boolean abortOnError;

	/**

	 * Constructs a new MSL handler for the specified resource with the

	 * specified helper and options.

	 * 

	 * @param xmiResource

	 *            The resource for the new handler.

	 * @param helper

	 *            The helper for the new handler.

	 * @param options

	 *            The load options for the new handler.

	 */

	public GMFHandler(XMLResource xmiResource, XMLHelper helper, Map options) {

		super(xmiResource, helper, options);

		urisToProxies = new HashMap();

		if (Boolean.TRUE.equals(options.get(GMFResource.OPTION_ABORT_ON_ERROR))) {

			abortOnError = true;

		}

	}

	/**

	 * @see org.eclipse.emf.ecore.xmi.impl.XMLHandler#endDocument()

	 */

	public void endDocument() {

		super.endDocument();

		if (null != extendedMetaData) {

			for (Iterator demandedPackages = extendedMetaData

				.demandedPackages().iterator(); demandedPackages.hasNext();) {

				EPackage ePackage = (EPackage) demandedPackages.next();

				String nsURI = ePackage.getNsURI();

				if (null != nsURI) {

					if (null != urisToLocations) {

						URI locationURI = (URI) urisToLocations.get(nsURI);

						if (null != locationURI) {

							// set the schema location

							Resource resource = new ResourceImpl();

							resource.setURI(locationURI);

							resource.getContents().add(ePackage);

						}

					}

					for (Iterator entries = helper.getPrefixToNamespaceMap()

						.iterator(); entries.hasNext();) {

						Map.Entry entry = (Map.Entry) entries.next();

						if (nsURI.equals(entry.getValue())) {

							// set the namespace prefix

							ePackage.setNsPrefix((String) entry.getKey());

						}

					}

				}

			}

		}

	}

	/**

	 * @see org.eclipse.emf.ecore.xmi.impl.XMLHandler#validateCreateObjectFromFactory(org.eclipse.emf.ecore.EFactory,

	 *      java.lang.String, org.eclipse.emf.ecore.EObject,

	 *      org.eclipse.emf.ecore.EStructuralFeature)

	 */

	protected EObject validateCreateObjectFromFactory(EFactory factory,

			String typeName, EObject newObject, EStructuralFeature feature) {

		if (!(objects.peek() instanceof AnyType) && null != newObject

			&& newObject.eIsProxy() && !sameDocumentProxies.contains(newObject)) {

			URI proxyURI = ((InternalEObject) newObject).eProxyURI();

			Map typeNamesToProxies = (Map) urisToProxies.get(proxyURI);

			if (null == typeNamesToProxies) {

				urisToProxies.put(proxyURI, typeNamesToProxies = new HashMap());

			}

			EObject proxy = (EObject) typeNamesToProxies.get(typeName);

			if (null == proxy) {

				typeNamesToProxies.put(typeName, proxy = newObject);

			}

			// canonicalize proxies

			newObject = proxy;

		}

		return super.validateCreateObjectFromFactory(factory, typeName,

			newObject, feature);

	}

	/**

	 * @see org.eclipse.emf.ecore.xmi.impl.XMLHandler#error(org.eclipse.emf.ecore.xmi.XMIException)

	 */

	public void error(XMIException e) {

		super.error(e);

		if (abortOnError) {

			if (e.getWrappedException() != null) {

				throw new AbortResourceLoadException(e.getWrappedException());

			}

			throw new AbortResourceLoadException(e);

		}

	}

}

/******************************************************************************

 * Copyright (c) 2002, 2006 IBM Corporation 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 Corporation - initial API and implementation 

 ****************************************************************************/

package org.eclipse.gmf.runtime.emf.core.resources;

import org.eclipse.core.runtime.IStatus;

/**

 * Specification of an object that manages URI mappings (path variables) for

 * the <code>pathmap</code> URI scheme on an editing domain's resource set.

 * 

 * @author rafikj

 */

public interface IPathmapManager {

	/**

	 * Set the value of a path variable.

	 * 

	 * @param name the path variable name

	 * @param value the path variable value (a file URI)

	 * 

	 * @return a status indicating success (OK) or failure (ERROR) to set the

	 *     path variable.  In case of error, the status message provides a

	 *     user-friendly explanation of the reason 

	 */

	IStatus addPathVariable(String name, String value);

	/**

	 * Removes a path variable and its value.

	 * 

	 * @param name the path variable name

	 * 

	 * @return a status indicating success (OK) or failure (ERROR) to remove the

	 *     path variable.  In case of error, the status message provides a

	 *     user-friendly explanation of the reason 

	 */

	IStatus removePathVariable(String name);

	/**

	 * Queries the current value of a path variable.

	 * 

	 * @param name the path variable name

	 * @return the path variable value (a URI) or an empty string if

	 *    the specified variable is undefined

	 */

	String getPathVariable(String name);

}