Skip to main content
summaryrefslogtreecommitdiffstats
blob: 0d6f65b8653eebd3713cb8c16790a29c40b08e96 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
/*******************************************************************************
 * Copyright (c) 2015, 2016 Willink Transformations 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:
 *   E.D.Willink - Initial API and implementation
 *******************************************************************************/
package org.eclipse.qvtd.runtime.invocation;

import java.util.Map;

import org.eclipse.emf.ecore.resource.ResourceSet;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import org.eclipse.osgi.util.NLS;

/**
 * TransformationTechnology defines a polymorphic interface by which a variety of alternative transformation
 * technologies my be invoked.
 *
 * @noimplement clients should derive from AbstractTransformationTechnology
 */
public interface TransformationTechnology
{
	@SuppressWarnings("serial")
	public class TransformationException extends Exception {
		protected final @NonNull Map<@NonNull String, Object> parametersMap;

		public TransformationException(@NonNull Map<@NonNull String, Object> parametersMap, @Nullable Throwable cause, @NonNull String message, Object... objects) {
			super(NLS.bind(message, objects), cause);
			this.parametersMap = parametersMap;
		}
	}

	/**
	 * Perform a transformation.
	 * Optionally use resources within resourceSet.
	 * Optionally bind model names to models using modelMap.
	 * Optionally bind named parameters to arbitrary objects using parametersMap.
	 * Optionally return model names bound via a return Map.
	 * Throw an Exception if execution is unsuccessful.
	 */
	@NonNull Map<@NonNull String, Object> execute(@NonNull ResourceSet resourceSet, @NonNull Map<@NonNull String, Object> modelMap,
			@NonNull Map<@NonNull String, Object> parametersMap) throws TransformationException;

	/**
	 * Return the TransformationTechnology name used as the TransformationTechnologyContribution.REGISTRY key.
	 */
	@NonNull String getName();
}

Back to the top