ClassificationMapping.java

/*
 * Copyright (c) 2012 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:
 *     HUMBOLDT EU Integrated Project #030962
 *     Data Harmonisation Panel <http://www.dhpanel.eu>
 */

package eu.esdihumboldt.cst.functions.core;

import java.util.Map;

import com.google.common.collect.ListMultimap;

import eu.esdihumboldt.hale.common.align.model.functions.ClassificationMappingFunction;
import eu.esdihumboldt.hale.common.align.model.functions.ClassificationMappingUtil;
import eu.esdihumboldt.hale.common.align.model.impl.PropertyEntityDefinition;
import eu.esdihumboldt.hale.common.align.transformation.engine.TransformationEngine;
import eu.esdihumboldt.hale.common.align.transformation.function.PropertyValue;
import eu.esdihumboldt.hale.common.align.transformation.function.TransformationException;
import eu.esdihumboldt.hale.common.align.transformation.function.impl.AbstractSingleTargetPropertyTransformation;
import eu.esdihumboldt.hale.common.align.transformation.function.impl.NoResultException;
import eu.esdihumboldt.hale.common.align.transformation.report.TransformationLog;
import eu.esdihumboldt.hale.common.core.io.Value;
import eu.esdihumboldt.hale.common.lookup.LookupTable;

/**
 * Classification mapping function to map values of an attribute to a different
 * classification system.
 * 
 * @author Kai Schwierczek
 */
public class ClassificationMapping
		extends AbstractSingleTargetPropertyTransformation<TransformationEngine>
		implements ClassificationMappingFunction {

	@Override
	protected Object evaluate(String transformationIdentifier, TransformationEngine engine,
			ListMultimap<String, PropertyValue> variables, String resultName,
			PropertyEntityDefinition resultProperty, Map<String, String> executionParameters,
			TransformationLog log) throws TransformationException, NoResultException {

		String source = variables.values().iterator().next().getValueAs(String.class);

		LookupTable lookup = ClassificationMappingUtil.getClassificationLookup(getParameters(),
				getExecutionContext());
		if (lookup == null) {
//			throw new TransformationException("No classification specified");
			log.warn(log.createMessage("No classification specified", null));
		}
		else {
			Value target = lookup.lookup(Value.of(source));
			if (target != null) {
				// return value w/ transformation variables replaced
				return getExecutionContext().getVariables().replaceVariables(target);
			}
		}

		String notClassifiedAction = getOptionalParameter(PARAMETER_NOT_CLASSIFIED_ACTION,
				Value.of(USE_NULL_ACTION)).as(String.class);

		if (USE_SOURCE_ACTION.equals(notClassifiedAction)) {
			return source;
		}
		else if (notClassifiedAction.startsWith(USE_FIXED_VALUE_ACTION_PREFIX)) {
			String notClassified = notClassifiedAction
					.substring(notClassifiedAction.indexOf(':') + 1);
			// return w/ transformation variables replaced
			return getExecutionContext().getVariables().replaceVariables(notClassified);
		}
		else {
			// USE_NULL_ACTION or null or something unknown
			throw new NoResultException(); // return null;
		}
	}
}