plugins/org.eclipse.jst.j2ee.web/war-validation/org/eclipse/jst/j2ee/internal/web/validation/WarHelper.java

/***************************************************************************************************
 * Copyright (c) 2003, 2004 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.jst.j2ee.internal.web.validation;



//import org.eclipse.wst.validation.internal.core.core.IMessage;
import java.util.Hashtable;

import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.runtime.IPath;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.EPackage;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.jst.j2ee.commonarchivecore.internal.CommonarchivePackage;
import org.eclipse.jst.j2ee.commonarchivecore.internal.WARFile;
import org.eclipse.jst.j2ee.internal.validation.J2EEValidationHelper;
import org.eclipse.jst.j2ee.internal.web.archive.operations.WTProjectLoadStrategyImpl;
import org.eclipse.jst.j2ee.model.internal.validation.WARMessageConstants;
import org.eclipse.jst.j2ee.web.componentcore.util.WebArtifactEdit;


public class WarHelper extends J2EEValidationHelper {
	Hashtable warFileMap = new Hashtable();
	final static String HelperID = "org.eclipse.wst.validation.internal.core.war.workbenchimpl.WarHelper"; //$NON-NLS-1$

	/**
	 * WarHelper constructor comment.
	 */

	public WarHelper() {
		super();

		registerModel(WARMessageConstants.WAR_MODEL_NAME, "loadWarFile"); //$NON-NLS-1$
	}

	/**
	 * This method will be invoked indirectly from the WarValidator (via. the WorkbenchReporter). It
	 * will expect the coming object to be a EObject for the node who generated this message. Note:
	 * This methods may need to be implemented higher up in the class stack.
	 */
	public int getLineNo(Object object) {


		if (object instanceof Integer) { // Error discovered using the XML parser
			return ((Integer) object).intValue();
		}

		return super.getLineNo(object);
	}

	/**
	 * Given a resource, return its non-eclipse-specific location. If this resource, or type of
	 * resource, isn't handled by this helper, return null.
	 */
	public String getPortableName(IResource resource) {
		if (!(resource instanceof IFile)) {
			return null;
		}

		IPath resourcePath = resource.getFullPath();
		if (resourcePath != null)
			return resourcePath.toString();

		return null;
	}

	/**
	 * Similar to the getFile() method, we know that we are talking about web.xml, but need a unique
	 * ID.
	 * 
	 * @return java.lang.String
	 * @param object
	 *            Object
	 */
	public String getTargetObjectName(Object object) {
		String ret = null;
		if (object != null) {
			IFile warFile = (IFile) warFileMap.get(getProject().toString());// validator framework
																			// will call getFile()
																			// first.
			if (warFile != null) {
				ret = (warFile.toString() + HelperID);
			}
		}
		return ret;
	}

	/**
	 * Get the WAR file for validation
	 */

	public EObject loadWarFile() {
		IProject proj = getProject();
		if (proj == null)
			return null;
		//      openFilesCache = new ArrayList();
		WARFile warFile = null; // Default return value.
		WebArtifactEdit webEdit = null;
		Resource webDD = null;
		try {
			WTProjectLoadStrategyImpl loader = new WTProjectLoadStrategyImpl(proj);
			//migrate to use components
			//webEdit = (WebArtifactEdit) StructureEdit.getFirstArtifactEditForRead(proj);
       		if (webEdit != null)
       			webDD = webEdit.getDeploymentDescriptorResource();
			loader.setResourceSet(webDD.getResourceSet());
			warFile = ((CommonarchivePackage) EPackage.Registry.INSTANCE.getEPackage(CommonarchivePackage.eNS_URI)).getCommonarchiveFactory().openWARFile(loader, proj.getName());
			//openFilesCache.add(warFile);
		} catch (Exception e) {
			e.printStackTrace();
		}  finally{
			if( webEdit != null )
				webEdit.dispose();
		}
		return warFile;
	}
	
}