GroovyRetype.java

/*
 * Copyright (c) 2013 Data Harmonisation Panel
 * 
 * All rights reserved. This program and the accompanying materials are made
 * available under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the License,
 * or (at your option) any later version.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution. If not, see <http://www.gnu.org/licenses/>.
 * 
 * Contributors:
 *     Data Harmonisation Panel <http://www.dhpanel.eu>
 */

package eu.esdihumboldt.cst.functions.groovy;

import java.util.Map;

import eu.esdihumboldt.cst.functions.groovy.internal.GroovyUtil;
import eu.esdihumboldt.hale.common.align.model.Cell;
import eu.esdihumboldt.hale.common.align.transformation.engine.TransformationEngine;
import eu.esdihumboldt.hale.common.align.transformation.function.ExecutionContext;
import eu.esdihumboldt.hale.common.align.transformation.function.TransformationException;
import eu.esdihumboldt.hale.common.align.transformation.function.impl.AbstractTypeTransformation;
import eu.esdihumboldt.hale.common.align.transformation.function.impl.NoResultException;
import eu.esdihumboldt.hale.common.align.transformation.report.TransformationLog;
import eu.esdihumboldt.hale.common.instance.groovy.InstanceBuilder;
import eu.esdihumboldt.hale.common.instance.model.FamilyInstance;
import eu.esdihumboldt.hale.common.instance.model.MutableInstance;
import eu.esdihumboldt.hale.common.schema.model.TypeDefinition;
import eu.esdihumboldt.util.groovy.sandbox.GroovyService;
import groovy.lang.Binding;
import groovy.lang.Script;

/**
 * 1:1 retype based on a Groovy script.
 * 
 * @author Simon Templer
 */
public class GroovyRetype extends AbstractTypeTransformation<TransformationEngine>
		implements GroovyConstants {

	@Override
	public void execute(String transformationIdentifier, TransformationEngine engine,
			Map<String, String> executionParameters, TransformationLog log, Cell cell)
					throws TransformationException {
		// for each source instance create a target instance
		TypeDefinition targetType = getTarget().values().iterator().next().getDefinition()
				.getDefinition();

		InstanceBuilder builder = new InstanceBuilder(false);

		Binding binding = createBinding(getSource(), cell, builder, log, getExecutionContext(),
				targetType);

		try {
			GroovyService service = getExecutionContext().getService(GroovyService.class);
			Script script = GroovyUtil.getScript(this, binding, service);
			Iterable<MutableInstance> targets = GroovyUtil.evaluateAll(script, builder, targetType,
					service);

			for (MutableInstance target : targets) {
				getPropertyTransformer().publish(getSource(), target, log, cell);
			}
		} catch (TransformationException e) {
			throw e;
		} catch (NoResultException e) {
			log.info(log.createMessage(
					"Skipping target instance because received NoResultException from script",
					null));
		} catch (Exception e) {
			throw new TransformationException(e.getMessage(), e);
		}
	}

	/**
	 * Create the binding for the Groovy Retype script function.
	 * 
	 * @param source the source instance
	 * @param typeCell the type cell
	 * @param builder the instance builder
	 * @param log the transformation log
	 * @param context the execution context
	 * @param targetInstanceType type of the target instance
	 * @return the binding
	 */
	public static Binding createBinding(FamilyInstance source, Cell typeCell,
			InstanceBuilder builder, TransformationLog log, ExecutionContext context,
			TypeDefinition targetInstanceType) {
		Binding binding = GroovyUtil.createBinding(builder, typeCell, typeCell, log, context,
				targetInstanceType);
		binding.setVariable(BINDING_SOURCE, source);
		return binding;
	}

}