AlignmentMappingExportConfigurationPage.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.hale.io.csv.ui;

import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;

import eu.esdihumboldt.hale.common.core.io.Value;
import eu.esdihumboldt.hale.io.csv.writer.AbstractAlignmentMappingExport;
import eu.esdihumboldt.hale.io.csv.writer.MappingTableConstants;
import eu.esdihumboldt.hale.ui.io.config.AbstractConfigurationPage;

/**
 * Configuration page for export alignment mappings
 * 
 * @author Patrick Lieb
 */
public class AlignmentMappingExportConfigurationPage extends
		AbstractConfigurationPage<AbstractAlignmentMappingExport, AlignmentMappingExportWizard>
		implements MappingTableConstants {

	private Button defaultExport;
	private Button noBaseAlignments;
	private Button propertyCells;
	private Button includeNamespaces;
	private Button transformationDisabledFor;

	/**
	 * Create a mapping export configuration page for alignments
	 */
	public AlignmentMappingExportConfigurationPage() {
		super("sel.mappingExportCells");
		setTitle("Mapping table");
		setDescription("Please specify which mapping cells should be part of the mapping table.");
	}

	/**
	 * @see eu.esdihumboldt.hale.ui.io.config.AbstractConfigurationPage#enable()
	 */
	@Override
	public void enable() {
		// do nothing
	}

	/**
	 * @see eu.esdihumboldt.hale.ui.io.config.AbstractConfigurationPage#disable()
	 */
	@Override
	public void disable() {
		// do nothing
	}

	/**
	 * @see eu.esdihumboldt.hale.ui.io.IOWizardPage#updateConfiguration(eu.esdihumboldt.hale.common.core.io.IOProvider)
	 */
	@Override
	public boolean updateConfiguration(AbstractAlignmentMappingExport provider) {

		provider.setParameter(INCLUDE_NAMESPACES, Value.of(includeNamespaces.getSelection()));
		provider.setParameter(TRANSFORMATION_AND_DISABLED_FOR,
				Value.of(transformationDisabledFor.getSelection()));

		// set export mode in provider
		if (defaultExport.getSelection()) {
			provider.setParameter(PARAMETER_MODE, Value.of(MODE_ALL));
		}
		else if (noBaseAlignments.getSelection()) {
			provider.setParameter(PARAMETER_MODE, Value.of(MODE_EXCLUDE_BASE));
		}
		else if (propertyCells.getSelection()) {
			provider.setParameter(PARAMETER_MODE, Value.of(MODE_BY_TYPE_CELLS));
		}
		else
			return false;
		return true;
	}

	/**
	 * @see eu.esdihumboldt.hale.ui.HaleWizardPage#createContent(org.eclipse.swt.widgets.Composite)
	 */
	@Override
	protected void createContent(Composite page) {

		// layout of the page is a grid layout with one column
		page.setLayout(new GridLayout(1, false));

		propertyCells = new Button(page, SWT.RADIO);
		propertyCells.setText("Type cells with associated property cells");
		propertyCells.setSelection(true);

		defaultExport = new Button(page, SWT.RADIO);
		defaultExport.setText("All mapping cells (unordered)");

		noBaseAlignments = new Button(page, SWT.RADIO);
		noBaseAlignments
				.setText("Only mapping cells defined in this alignment (exclude base alignments)");

		includeNamespaces = new Button(page, SWT.CHECK);
		includeNamespaces.setText("Include namespace information");

		transformationDisabledFor = new Button(page, SWT.CHECK);
		transformationDisabledFor
				.setText("Include information about the transformation mode and the disabled cells");
		// enable by default
		transformationDisabledFor.setSelection(true);
	}

}