yakindu/test-plugins/org.yakindu.sct.test.models/src/util/TestModels.java

/**
 * Copyright (c) 2012 committers of YAKINDU 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:
 *     committers of YAKINDU - initial API and implementation
 */
package util;

import java.io.IOException;

import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.emf.ecore.resource.impl.ResourceSetImpl;
import org.eclipse.emf.ecore.util.EcoreUtil;
import org.yakindu.sct.model.sexec.ExecutionFlow;
import org.yakindu.sct.model.sexec.transformation.ModelSequencer;
import org.yakindu.sct.model.sgraph.SGraphPackage;
import org.yakindu.sct.model.sgraph.Statechart;

import com.google.inject.Inject;

/**
 * Provides access to the testmodels.
 * 
 * @author andreas muelder - Initial contribution and API
 * 
 */
public class TestModels {

	private static final String TESTMODEL_DIR = "org.yakindu.sct.test.models/testmodels/";

	public static final String GUARD = "Guard.sct";
	public static final String SIMPLE_HIERACHY = "SimpleHierachy.sct";
	public static final String DEEP_HISTORY = "DeepHistory.sct";
	public static final String STATE_ACTIVE = "StateIsActive.sct";
	public static final String VALUED_EVENTS = "ValuedEvents.sct";
	public static final String FEATURE_CALLS = "FeatureCalls.sct";
	public static final String STATECHART_LOCAL_REACTIONS = "StatechartLocalReactions.sct";

	@Inject
	private ModelSequencer sequencer;

	/**
	 * <img src="../../images/Guard.png" /> <br />
	 * 
	 * @return the {@link ExecutionFlow}
	 * @throws IOException
	 */
	public ExecutionFlow createGuardModel() throws IOException {
		return loadExecutionFlowFromResource(GUARD);
	}

	/**
	 * <img src="../../images/SimpleHierachy.png" /> <br />
	 * 
	 * @return the {@link ExecutionFlow}
	 * @throws IOException
	 */
	public ExecutionFlow createSimpleHierachyModel() throws IOException {
		return loadExecutionFlowFromResource(SIMPLE_HIERACHY);
	}

	/**
	 * <img src="../../images/DeepHistory.png" /> <br />
	 * 
	 * @return the {@link ExecutionFlow}
	 * @throws IOException
	 */
	public ExecutionFlow createDeepHistoryModel() throws IOException {
		return loadExecutionFlowFromResource(DEEP_HISTORY);
	}

	/**
	 * <img src="../../images/StateIsActive.png" /> <br />
	 * 
	 * @return the {@link ExecutionFlow}
	 * @throws IOException
	 */
	public ExecutionFlow createStateIsActiveModel() throws IOException {
		return loadExecutionFlowFromResource(STATE_ACTIVE);
	}

	/**
	 * <img src="../../images/ValuedEvents.png" /> <br />
	 * 
	 * @return the {@link ExecutionFlow}
	 * @throws IOException
	 */
	public ExecutionFlow createValuedEventsModel() throws IOException {
		return loadExecutionFlowFromResource(VALUED_EVENTS);
	}

	/**
	 * <img src="../../images/FeatureCalls.png" /> <br />
	 * 
	 * @return the {@link ExecutionFlow}
	 * @throws IOException
	 */
	public ExecutionFlow createFeatureCallModel() throws IOException {
		return loadExecutionFlowFromResource(FEATURE_CALLS);
	}

	/**
	 * <img src="../../images/StatechartLocalReactions.png" /> <br />
	 * 
	 * @return the {@link ExecutionFlow}
	 * @throws IOException
	 */
	public ExecutionFlow createStatechartLocalReactionsModel()
			throws IOException {
		return loadExecutionFlowFromResource(STATECHART_LOCAL_REACTIONS);
	}

	/**
	 * Helper method - loads a testmodel from the Testmodel directory
	 * 
	 * @param fileName
	 *            the filename of the testmodel
	 * @return the {@link ExecutionFlow}
	 * @throws IOException
	 */
	public ExecutionFlow loadExecutionFlowFromResource(String fileName) throws IOException {
		Statechart statechart = loadStatechartFromResource(fileName);
		final ExecutionFlow flow = sequencer.transform(statechart);
		return flow;
	}

	public Statechart loadStatechartFromResource(String fileName) {
		URI uri = URI.createPlatformPluginURI(TESTMODEL_DIR + fileName, true);
		ResourceSetImpl impl = new ResourceSetImpl();
		Resource resource = impl.getResource(uri, true);
		Statechart statechart = (Statechart) EcoreUtil.getObjectByType(
				resource.getContents(), SGraphPackage.Literals.STATECHART);
		return statechart;
	}
}