models/epidemiology/org.eclipse.stem.internal.diseasemodels.models/src/org/eclipse/stem/internal/data/specifications/DiseaseModelModelSpecification.java

// DiseaseModelModelSpecification.java
package org.eclipse.stem.internal.data.specifications;

/*******************************************************************************
 * Copyright (c) 2009 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
 *******************************************************************************/

import java.io.File;
import java.util.Map;

import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.plugin.EcorePlugin;
import org.eclipse.stem.core.Utility;
import org.eclipse.stem.core.model.Model;
import org.eclipse.stem.core.model.ModelPackage;
import org.eclipse.stem.data.geography.ISOKey;
import org.eclipse.stem.diseasemodels.standard.DiseaseModel;
import org.eclipse.stem.diseasemodels.standard.StandardPackage;
import org.eclipse.stem.internal.data.generatedplugin.DublinCore;
import org.eclipse.stem.internal.data.geography.specifications.AdminLevelSet;
import org.eclipse.stem.internal.data.geography.specifications.CountryGraphPropertyFileSpecification;

/**
 * This class represents a {@link ModelSpecification} for a Disease model.
 */
public class DiseaseModelModelSpecification extends ModelSpecification
		implements Comparable<DiseaseModelModelSpecification> {

	/**
	 * This is referenced to cause the {@link ModelPackage} to register itself
	 * as a package.
	 */
	@SuppressWarnings("unused")
	private final ModelPackage modelPackage = ModelPackage.eINSTANCE;
	@SuppressWarnings("unused")
	private final StandardPackage standardPackage = StandardPackage.eINSTANCE;

	private final DublinCore populationModelDC;
	@SuppressWarnings("unused")
	private final DublinCore diseaseModelDC;

	private final DiseaseModel diseaseModel;
	
	private final ISOKey isoKey;
	private final AdminLevelSet adminLevelSet;
	private final String diseaseName;

	static {
		// This sets up the mapping between the "platform" URI's and the
		// projects in the file system.

		// CWD is the current working directory
		final String CWD = System.getProperty("user.dir"); //$NON-NLS-1$
		// WORKSPACE is the directory of the parent workspace
		final String WORKSPACE = CWD.substring(0, CWD
				.lastIndexOf(File.separator));

		// The path to the generated population data project
		final String HUMAN_POPULATION_MODELS_PROJECT_ROOT = WORKSPACE
				+ File.separator
				+ org.eclipse.stem.data.geography.population.human.models.Activator.PLUGIN_ID
				+ File.separator;

		// The path to the diseases project
		final String DISEASES_PROJECT_ROOT = WORKSPACE + File.separator
				+ org.eclipse.stem.diseases.Activator.PLUGIN_ID
				+ File.separator;

		final Map<String, URI> platformResourceMap = EcorePlugin
				.getPlatformResourceMap();

		// Register the mapping between the project id and the absolute path to
		// the project in the file system. This will be found later when
		// deserializing when the platform URI is mapped.

		platformResourceMap
				.put(
						org.eclipse.stem.data.geography.population.human.models.Activator.PLUGIN_ID,
						URI.createFileURI(HUMAN_POPULATION_MODELS_PROJECT_ROOT));

		platformResourceMap.put(
				org.eclipse.stem.diseases.Activator.PLUGIN_ID, URI
						.createFileURI(DISEASES_PROJECT_ROOT));
	} // static

	/**
	 * @param isoKey
	 *            the {@link ISOKey} for a single region
	 * @param levelSet
	 *            the {@link AdminLevelSet} covered
	 * @param populationModelDC
	 *            {@link DublinCore} instance that describes the population
	 *            model
	 * @param diseaseModelDC
	 *            {@link DublinCore} instance that describes a disease model
	 * @param diseaseModel 
	 */
	public DiseaseModelModelSpecification(ISOKey isoKey,
			AdminLevelSet levelSet, DublinCore populationModelDC,
			DublinCore diseaseModelDC, final DiseaseModel diseaseModel) {
		this.isoKey = isoKey;
		this.adminLevelSet = levelSet;
		this.populationModelDC = populationModelDC;
		this.diseaseModelDC = diseaseModelDC;
		this.diseaseModel = diseaseModel;
		this.diseaseName = diseaseModel.getDiseaseName();
	} // DiseaseModelModelSpecification

	/**
	 * @see org.eclipse.stem.internal.data.specifications.ModelSpecification#createIdentifiableInstance()
	 */
	@Override
	protected Model createIdentifiableInstance() {
		final Model retValue = super.createIdentifiableInstance();
		// The generated Graphs etc., all have dublin core that references
		// them as plugins. This is as it should be when STEM is running,
		// but right now we're running stand-alone and want to access the
		// plugins as projects (they aren't plugged into our running version
		// of Eclipse). Substitute "resource" for "plugin" in the URI's we
		// use and all will be well.

		retValue
				.getModels()
				.add(
						(Model) Utility
								.getIdentifiable(getIdentifiableProjectURI(populationModelDC)));
		
		retValue.getNodeDecorators().add(diseaseModel);
		return retValue;
	} // createIdentifiableInstance

	public int compareTo(DiseaseModelModelSpecification pms) {
		return adminLevelSet.getNumAdminLevels() > pms.adminLevelSet
				.getNumAdminLevels() ? 1 : -1;
	} // compareTo

	/**
	 * @see java.lang.Object#toString()
	 */
	@Override
	public String toString() {
		final StringBuilder sb = new StringBuilder();
		sb.append(isoKey);
		sb.append(":"); //$NON-NLS-1$
		sb.append(diseaseName);
		sb.append(" "); //$NON-NLS-1$
		sb.append(adminLevelSet.toString());
		return sb.toString();
	} // toString

	@Override
	protected String getRelativeSerializationPath() {
		final StringBuilder sb = new StringBuilder();
		sb.append(CountryGraphPropertyFileSpecification.COUNTRY_DIR);
		sb.append(File.separatorChar);
		sb.append(isoKey.toString());
		return sb.toString();
	}

	@Override
	protected String getSerializationFileNameRoot() {
		final StringBuilder sb = new StringBuilder(isoKey.toString());
		sb.append("_"); //$NON-NLS-1$
		sb.append(adminLevelSet.toString());
		sb.append("_disease_"); //$NON-NLS-1$
		sb.append(diseaseName.replace(" ", "_"));  //$NON-NLS-1$//$NON-NLS-2$
		return sb.toString();
	}

	@Override
	protected String getTargetPluginId() {
		return org.eclipse.stem.data.diseasemodels.models.Activator.PLUGIN_ID;
	}

	@Override
	protected String getTitleDescriptor() {
		final StringBuilder sb = new StringBuilder(isoKey.toString());
		sb.append(" Disease "); //$NON-NLS-1$
		sb.append(diseaseName);
		sb
				.append(adminLevelSet.getNumAdminLevels() > 1 ? " (Levels: " : " (Level: "); //$NON-NLS-1$ //$NON-NLS-2$
		sb.append(adminLevelSet.toString(",")); //$NON-NLS-1$
		sb.append(")"); //$NON-NLS-1$
		return sb.toString();
	}

	/**
	 * @see org.eclipse.stem.internal.data.specifications.IdentifiableSpecification#createDubinCoreCoverage()
	 */
	@Override
	protected String createDubinCoreCoverage() {
		return populationModelDC.getCoverage();
	}

	/**
	 * @see org.eclipse.stem.internal.data.specifications.IdentifiableSpecification#createDubinCoreSubject()
	 */
	@Override
	protected String createDubinCoreSubject() {
		return GraphPropertyFileSpecification.createDublinCoreSubjectString(
				ModelPackage.Literals.MODEL.getName(), "disease"); //$NON-NLS-1$
	}

} // DiseaseModelModelSpecification