ModelUtils.java

/*******************************************************************************
 * Copyright (c) 2006, 2007 Spring IDE Developers
 * 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:
 *     Spring IDE Developers - initial API and implementation
 *******************************************************************************/
package org.springframework.ide.eclipse.core.model;

import org.eclipse.core.resources.IMarker;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.IWorkspace;
import org.eclipse.core.resources.IWorkspaceRunnable;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.springframework.beans.BeanMetadataElement;
import org.springframework.ide.eclipse.core.MarkerUtils;
import org.springframework.ide.eclipse.core.SpringCore;
import org.springframework.ide.eclipse.core.model.xml.XmlSourceLocation;

/**
 * Some model-related helper methods.
 * @author Torsten Juergeleit
 * @author Christian Dupuis
 */
public final class ModelUtils {

	/**
	 * Returns <code>true</code> if a given {@link IModelElement element} is
	 * not defined within the same {@link IProject project } as the specified
	 * {@link IModelElement context}.
	 */
	public static boolean isExternal(IModelElement element,
			IModelElement context) {
		if (context instanceof IResourceModelElement
				&& element instanceof IResourceModelElement) {
			IProject contextProject = ((IResourceModelElement) context)
					.getElementResource().getProject();
			IProject elementProject = ((IResourceModelElement) element)
					.getElementResource().getProject();
			if (!elementProject.equals(contextProject)) {
				return true;
			}
		}
		return false;
	}

	/**
	 * Creates an <code>IMarker</code> with the information (if any) provided
	 * by a given <code>IResourceModelElement</code> or
	 * <code>ISourceModelElement</code>.
	 */
	public static IMarker createMarker(final IModelElement element) {
		if (element instanceof IResourceModelElement) {
			final IResource resource = ((IResourceModelElement) element)
					.getElementResource();
			if (resource != null) {
				try {
					final IMarker[] markers = new IMarker[1];
					IWorkspaceRunnable runnable = new IWorkspaceRunnable() {
						public void run(IProgressMonitor monitor)
								throws CoreException {
							IMarker marker = resource
									.createMarker(IMarker.TEXT);
							marker.setAttribute(IMarker.MESSAGE, toString());
							if (element instanceof ISourceModelElement) {
								marker.setAttribute(IMarker.LINE_NUMBER,
										((ISourceModelElement) element)
												.getElementStartLine());
								marker.setAttribute(IMarker.LOCATION, "line "
										+ ((ISourceModelElement) element)
												.getElementStartLine());
							}
							markers[0] = marker;
						}
					};
					resource.getWorkspace().run(runnable, null,
							IWorkspace.AVOID_UPDATE, null);
					return markers[0];
				} catch (CoreException e) {
					SpringCore.log(e);
				}
			}
		}
		return null;
	}

	/**
	 * Removes all Spring problem markers (including the inherited ones) from
	 * given <code>IModelElement</code>.
	 */
	public static void deleteProblemMarkers(IModelElement element) {
		if (element instanceof IResourceModelElement) {
			IResource resource = ((IResourceModelElement) element)
					.getElementResource();
			MarkerUtils.deleteMarkers(resource, SpringCore.MARKER_ID);
		}
	}

	/**
	 * Returns the full path of the give element's resource or
	 * <code>null</code> if no <code>IResourceModelElement</code> or resource
	 * found.
	 */
	public static String getResourcePath(IModelElement element) {
		if (element instanceof IResourceModelElement) {
			IResource resource = ((IResourceModelElement) element)
					.getElementResource();
			if (resource != null) {
				return resource.getFullPath().toString();
			}
		}
		return null;
	}

	/**
	 * Returns the {@link IModelSourceLocation} of the given
	 * {@link BeanMetadataElement} or <code>null</code> if no
	 * {@link ISourceModelElement} found.
	 */
	public static IModelSourceLocation getSourceLocation(
			BeanMetadataElement element) {
		if (element != null) {
			Object source = element.getSource();
			if (source instanceof IModelSourceLocation) {
				return (IModelSourceLocation) source;
			}
		}
		return null;
	}

	/**
	 * Returns the {@link XmlSourceLocation} of the given element or
	 * <code>null</code> if no {@link ISourceModelElement} or no
	 * {@link XmlSourceLocation} found.
	 */
	public static XmlSourceLocation getXmlSourceLocation(
			IModelElement element) {
		if (element instanceof ISourceModelElement) {
			IModelSourceLocation location = ((ISourceModelElement) element)
					.getElementSourceLocation();
			if (location instanceof XmlSourceLocation) {
				return (XmlSourceLocation) location;
			} else if (element.getElementParent() != null) {
				return getXmlSourceLocation(element.getElementParent());
			}
		}
		return null;
	}

	/**
	 * Returns the namespace URI for the given element or <code>null</code> if
	 * no {@link XmlSourceLocation} with a valid namespace URI found.
	 */
	public static String getNameSpaceURI(ISourceModelElement element) {
		XmlSourceLocation location = getXmlSourceLocation(element);
		return (location != null ? location.getNamespaceURI() : null);
	}

	/**
	 * Returns the node's local name for the given element or <code>null</code>
	 * if no {@link XmlSourceLocation} with a valid local name found.
	 */
	public static String getLocalName(ISourceModelElement element) {
		XmlSourceLocation location = getXmlSourceLocation(element);
		return (location != null ? location.getLocalName() : null);
	}

	/**
	 * Returns the node name for the given element or <code>null</code>
	 * if no {@link XmlSourceLocation} with a valid node name found.
	 */
	public static String getNodeName(ISourceModelElement element) {
		XmlSourceLocation location = getXmlSourceLocation(element);
		return (location != null ? location.getNodeName() : null);
	}
}