ParameterEditorExtension.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.hale.ui.function.extension;

import java.util.List;

import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.ui.PlatformUI;

import de.fhg.igd.eclipse.util.extension.AbstractExtension;
import de.fhg.igd.eclipse.util.extension.ExtensionObjectFactoryCollection;
import de.fhg.igd.eclipse.util.extension.FactoryFilter;
import de.fhg.igd.slf4jplus.ALogger;
import de.fhg.igd.slf4jplus.ALoggerFactory;
import eu.esdihumboldt.hale.common.align.extension.function.FunctionParameterDefinition;
import eu.esdihumboldt.hale.common.align.model.ParameterValue;
import eu.esdihumboldt.hale.ui.common.AttributeEditor;
import eu.esdihumboldt.hale.ui.common.EditorFactory;
import eu.esdihumboldt.hale.ui.common.definition.AttributeEditorFactory;
import eu.esdihumboldt.hale.ui.function.extension.impl.ParameterEditorFactoryImpl;
import eu.esdihumboldt.hale.ui.transformation.TransformationVariableReplacer;

/**
 * {@link ParameterEditorFactory} extension.
 * 
 * @author Simon Templer
 */
public class ParameterEditorExtension
		extends AbstractExtension<EditorFactory, ParameterEditorFactory> {

	private static final ALogger log = ALoggerFactory.getLogger(ParameterEditorExtension.class);

	private static ParameterEditorExtension instance;

	/**
	 * Get the extension instance.
	 * 
	 * @return the parameter page extension
	 */
	public static ParameterEditorExtension getInstance() {
		if (instance == null) {
			instance = new ParameterEditorExtension();
		}
		return instance;
	}

	/**
	 * Default constructor.
	 */
	public ParameterEditorExtension() {
		super(FunctionWizardExtension.ID);
	}

	/**
	 * @see AbstractExtension#createFactory(IConfigurationElement)
	 */
	@Override
	protected ParameterEditorFactory createFactory(IConfigurationElement conf) throws Exception {
		if (conf.getName().equals("propertyParameterEditor")
				|| conf.getName().equals("typeParameterEditor"))
			return new ParameterEditorFactoryImpl(conf);

		return null;
	}

	/**
	 * Create an editor for a parameter.
	 * 
	 * @param parent the parent composite
	 * @param functionId the ID of the function the parameter is associated with
	 * @param parameter the parameter
	 * @param initialValue the initial value, may be <code>null</code>
	 * @return the editor
	 */
	public AttributeEditor<?> createEditor(final Composite parent, final String functionId,
			final FunctionParameterDefinition parameter, final ParameterValue initialValue) {
		List<ParameterEditorFactory> factories = getFactories(
				new FactoryFilter<EditorFactory, ParameterEditorFactory>() {

					@Override
					public boolean acceptFactory(ParameterEditorFactory factory) {
						return factory.getParameterName().equals(parameter.getName())
								&& factory.getFunctionId().equals(functionId);
					}

					@Override
					public boolean acceptCollection(
							ExtensionObjectFactoryCollection<EditorFactory, ParameterEditorFactory> collection) {
						return true;
					}
				});

		if (!factories.isEmpty()) {
			ParameterEditorFactory fact = factories.get(0);
			try {
				AttributeEditor<?> editor = fact.createExtensionObject().createEditor(parent);
				if (initialValue != null)
					editor.setAsText(initialValue.as(String.class));
				return editor;
			} catch (Exception e) {
				// ignore, use default
				log.error("Could not create editor for parameter, using default editor instead.");
			}
		}

		// default editor
		AttributeEditorFactory aef = PlatformUI.getWorkbench()
				.getService(AttributeEditorFactory.class);

		// set variable replacer
		AttributeEditor<?> editor = aef.createEditor(parent, parameter, initialValue);
		editor.setVariableReplacer(new TransformationVariableReplacer());

		return editor;
	}

}