EDIT

// $Id$

/**

* Copyright (C) 2016 EDIT

* European Distributed Institute of Taxonomy

* http://www.e-taxonomy.eu

*

* The contents of this file are subject to the Mozilla Public License Version 1.1

* See LICENSE.TXT at the top of this package for the full license terms.

*/

package eu.etaxonomy.taxeditor.molecular.io.wizard;

import info.bioinfweb.commons.io.ContentExtensionFileFilter;

import info.bioinfweb.commons.io.ContentExtensionFileFilter.TestStrategy;

import info.bioinfweb.commons.io.ExtensionFileFilter;

import info.bioinfweb.jphyloio.formatinfo.JPhyloIOFormatInfo;

import java.io.File;

import org.eclipse.core.databinding.DataBindingContext;

import org.eclipse.core.databinding.validation.MultiValidator;

import org.eclipse.core.databinding.validation.ValidationStatus;

import org.eclipse.core.runtime.IStatus;

import org.eclipse.jface.databinding.swt.ISWTObservableValue;

import org.eclipse.jface.databinding.swt.SWTObservables;

import org.eclipse.jface.databinding.wizard.WizardPageSupport;

import org.eclipse.jface.wizard.WizardPage;

import org.eclipse.swt.SWT;

import org.eclipse.swt.events.SelectionAdapter;

import org.eclipse.swt.events.SelectionEvent;

import org.eclipse.swt.layout.FormAttachment;

import org.eclipse.swt.layout.FormData;

import org.eclipse.swt.layout.FormLayout;

import org.eclipse.swt.widgets.Button;

import org.eclipse.swt.widgets.Combo;

import org.eclipse.swt.widgets.Composite;

import org.eclipse.swt.widgets.FileDialog;

import org.eclipse.swt.widgets.Label;

import org.eclipse.swt.widgets.Text;

/**

 * Wizard page that allows to specify which parts of a single read alignment shall be exported to an alignment file.

 *

 * @author Ben Stöver

 * @date 18.04.2016

 */

public class ExportSingleReadAlignmentWizardPage extends WizardPage {

    private Text consensusSequenceLabelTextField;

    private Button exportConsensusSequenceCB;

    private Button exportSingleReadsCB;

    private Text fileTextField;

    private Combo formatComboBox;

    /**

     * Create the wizard.

     */

    public ExportSingleReadAlignmentWizardPage() {

        super("SingleReadSequencesExport");  //TODO Which pageName should be used here? Any conventions?

        setTitle("Sequence export");  //TODO multi language

        setDescription("Defines which sequences of the single read alignment shall be exported.");  //TODO multi language

    }

    /**

     * Create contents of the wizard.

     *

     * @param parent the parent component

     */

    @Override

    public void createControl(Composite parent) {

        DataBindingContext dbc = new DataBindingContext();

        WizardPageSupport.create(this, dbc);

        Composite container = new Composite(parent, SWT.NULL);

        setControl(container);

        container.setLayout(new FormLayout());

        exportSingleReadsCB = new Button(container, SWT.CHECK);

        FormData fd_exportSingleReadsCB = new FormData();

        fd_exportSingleReadsCB.left = new FormAttachment(0, 10);

        exportSingleReadsCB.setLayoutData(fd_exportSingleReadsCB);

        exportSingleReadsCB.setText("Export single reads");

        final ISWTObservableValue exportSingleReadsObservable = SWTObservables.observeSelection(exportSingleReadsCB);

        dbc.bindValue(exportSingleReadsObservable, getWizard().getModel().getExportSingleReadsObservable());

        exportSingleReadsCB.setSelection(false);

        exportSingleReadsCB.setSelection(true);  // Must happen after the component has been bound to the model.

        exportConsensusSequenceCB = new Button(container, SWT.CHECK);

        exportConsensusSequenceCB.addSelectionListener(new SelectionAdapter() {

            @Override

            public void widgetSelected(SelectionEvent e) {

                consensusSequenceLabelTextField.setEnabled(exportConsensusSequenceCB.getSelection());

            }

        });

        FormData fd_exportConsensusSequenceCB = new FormData();

        fd_exportConsensusSequenceCB.top = new FormAttachment(exportSingleReadsCB, 6);

        fd_exportConsensusSequenceCB.left = new FormAttachment(0, 10);

        exportConsensusSequenceCB.setLayoutData(fd_exportConsensusSequenceCB);

        exportConsensusSequenceCB.setText("Export consensus sequence");

        final ISWTObservableValue exportConsensusSequenceObservable = SWTObservables.observeSelection(exportConsensusSequenceCB);

        dbc.bindValue(exportConsensusSequenceObservable, getWizard().getModel().getExportConsensusSequenceObservable());

        exportConsensusSequenceCB.setSelection(false);

        exportConsensusSequenceCB.setSelection(true);  // Must happen after the component has been bound to the model.

        consensusSequenceLabelTextField = new Text(container, SWT.BORDER);

        FormData fd_consensusSequenceNameTextField = new FormData();

        fd_consensusSequenceNameTextField.bottom = new FormAttachment(exportConsensusSequenceCB, 32, SWT.BOTTOM);

        fd_consensusSequenceNameTextField.left = new FormAttachment(0, 32);

        fd_consensusSequenceNameTextField.right = new FormAttachment(100, -10);

        fd_consensusSequenceNameTextField.top = new FormAttachment(exportConsensusSequenceCB, 6);

        consensusSequenceLabelTextField.setLayoutData(fd_consensusSequenceNameTextField);

        final ISWTObservableValue consensusSequenceLabelObservable = SWTObservables.observeText(consensusSequenceLabelTextField, SWT.Modify);

        dbc.bindValue(consensusSequenceLabelObservable, getWizard().getModel().getConsensusSequenceLabelObservable());

        consensusSequenceLabelTextField.setText("ConsensusSequence");  // Must happen after the component has been bound to the model.

        Label lblFormat = new Label(container, SWT.NONE);

        FormData fd_lblFormat = new FormData();

        fd_lblFormat.top = new FormAttachment(consensusSequenceLabelTextField, 36);

        fd_lblFormat.left = new FormAttachment(exportSingleReadsCB, 0, SWT.LEFT);

        lblFormat.setLayoutData(fd_lblFormat);

        lblFormat.setText("Select the export format:");  //TODO multi language

        Label lblSelectTheData = new Label(container, SWT.NONE);

        fd_exportSingleReadsCB.top = new FormAttachment(lblSelectTheData, 6);

        FormData fd_lblSelectTheData = new FormData();

        fd_lblSelectTheData.left = new FormAttachment(0, 10);

        fd_lblSelectTheData.top = new FormAttachment(0, 10);

        lblSelectTheData.setLayoutData(fd_lblSelectTheData);

        lblSelectTheData.setText("Select the data to export:");  //TODO multi language

        Label lblSelectTheExport = new Label(container, SWT.NONE);

        FormData fd_lblSelectTheExport = new FormData();

        fd_lblSelectTheExport.top = new FormAttachment(lblFormat, 57);

        fd_lblSelectTheExport.left = new FormAttachment(exportSingleReadsCB, 0, SWT.LEFT);

        lblSelectTheExport.setLayoutData(fd_lblSelectTheExport);

        lblSelectTheExport.setText("Select the export destination:");  //TODO multi language

        Label lblAlignmentFile = new Label(container, SWT.NONE);

        FormData fd_lblAlignmentFile = new FormData();

        fd_lblAlignmentFile.top = new FormAttachment(lblSelectTheExport, 9);

        fd_lblAlignmentFile.left = new FormAttachment(exportSingleReadsCB, 0, SWT.LEFT);

        lblAlignmentFile.setLayoutData(fd_lblAlignmentFile);

        lblAlignmentFile.setText("Alignment file:");  //TODO multi language

        fileTextField = new Text(container, SWT.BORDER);

        FormData fd_text = new FormData();

        fd_text.right = new FormAttachment(100, -10);

        fd_text.left = new FormAttachment(lblAlignmentFile, 6);

        fd_text.top = new FormAttachment(lblSelectTheExport, 6);

        fileTextField.setLayoutData(fd_text);

        final ISWTObservableValue fileNameObservable = SWTObservables.observeText(fileTextField, SWT.Modify);

        dbc.bindValue(fileNameObservable, getWizard().getModel().getFileNameObservable());

        Button btnBrowse = new Button(container, SWT.NONE);

        btnBrowse.addSelectionListener(new SelectionAdapter() {

            @Override

            public void widgetSelected(SelectionEvent e) {

                FileDialog dialog = new FileDialog(getShell(), SWT.OPEN);

                dialog.setText("Export to");  //TODO multi language

                ContentExtensionFileFilter filter = getSelectedFormat().createFileFilter(TestStrategy.EXTENSION);

                dialog.setFilterExtensions(new String[]{filter.getExtensionsAsString()});

                dialog.setFilterNames(new String[]{filter.getDescription()});

                String selectedFile = dialog.open();

                if (selectedFile != null) {  // Otherwise selecting was canceled.

                    fileTextField.setText(selectedFile);

                }

            }

        });

        FormData fd_btnBrowse = new FormData();

        fd_btnBrowse.left = new FormAttachment(100, -128);

        fd_btnBrowse.bottom = new FormAttachment(fileTextField, 43, SWT.BOTTOM);

        fd_btnBrowse.top = new FormAttachment(fileTextField, 13);

        fd_btnBrowse.right = new FormAttachment(100, -10);

        btnBrowse.setLayoutData(fd_btnBrowse);

        btnBrowse.setText("Browse...");

        formatComboBox = new Combo(container, SWT.READ_ONLY);

        for (JPhyloIOFormatInfo formatInfo : ExportSingleReadAlignmentWizardModel.FORMAT_NAMES_TO_INFO_MAP.values()) {

            formatComboBox.add(formatInfo.getFormatName());

        }

        FormData fd_formatComboBox = new FormData();

        fd_formatComboBox.left = new FormAttachment(0, 10);

        fd_formatComboBox.right = new FormAttachment(100, -10);

        fd_formatComboBox.top = new FormAttachment(lblFormat, 6);

        formatComboBox.setLayoutData(fd_formatComboBox);

        final ISWTObservableValue formatObservable = SWTObservables.observeSelection(formatComboBox);  // ViewerProperties.singleSelection().observe(formatComboBox); falls ein ComboViewer verwendet wird. (Dann kann direkt FormatInfo verwendet werden.)

        dbc.bindValue(formatObservable, getWizard().getModel().getFormatInfoObservable());

        formatComboBox.select(0);  // Must happen after the component has been bound to the model.

        Button appendExtensionButton = new Button(container, SWT.NONE);

        appendExtensionButton.addSelectionListener(new SelectionAdapter() {

            @Override

            public void widgetSelected(SelectionEvent e) {

                fileTextField.setText(fileTextField.getText() + ExtensionFileFilter.EXTENSION_SEPARATOR +

                        getSelectedFormat().createFileFilter(TestStrategy.EXTENSION).getDefaultExtension());

            }

        });

        FormData fd_btnNewButton = new FormData();

        fd_btnNewButton.left = new FormAttachment(btnBrowse, -217, SWT.LEFT);

        fd_btnNewButton.right = new FormAttachment(btnBrowse, -6);

        fd_btnNewButton.bottom = new FormAttachment(fileTextField, 43, SWT.BOTTOM);

        fd_btnNewButton.top = new FormAttachment(fileTextField, 13);

        appendExtensionButton.setLayoutData(fd_btnNewButton);

        appendExtensionButton.setText("Append default extension");  //TODO multi language

        dbc.addValidationStatusProvider(new MultiValidator() {

            @Override

            protected IStatus validate() {

                String label = (String)consensusSequenceLabelObservable.getValue();

                boolean exportConsensus = (Boolean)exportConsensusSequenceObservable.getValue();

                boolean exportReads = (Boolean)exportSingleReadsObservable.getValue();

                if (!exportConsensus && !exportReads) {

                    return ValidationStatus.error("Either single reads or the consensus sequence have to be selected for export.");  //TODO multi language

                }

                else if (exportConsensus && ((label == null) || label.isEmpty())) {

                    return ValidationStatus.error("The consensus sequence label must not be empty.");  //TODO multi language

                }

                String fileName = (String)fileNameObservable.getValue();

                if ((fileName == null) || fileName.isEmpty()) {

                    return ValidationStatus.error("The file name must not be empty.");  //TODO multi language

                }

                else if (!getSelectedFormat().createFileFilter(TestStrategy.EXTENSION).accept(new File(fileName))) {

                    return ValidationStatus.warning("The file name does have a valid extension for the selected format.");  //TODO multi language

                }

                else if (fileName.charAt(0) == ExtensionFileFilter.EXTENSION_SEPARATOR) {

                    return ValidationStatus.warning("File starting with '" + ExtensionFileFilter.EXTENSION_SEPARATOR +

                            "' are not supported on all operating systems.");  //TODO multi language

                }

                else {

                    return ValidationStatus.ok();

                }

            }

        });

    }

    private JPhyloIOFormatInfo getSelectedFormat() {

        return ExportSingleReadAlignmentWizardModel.FORMAT_NAMES_TO_INFO_MAP.get(formatComboBox.getText());

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public ExportSingleReadAlignmentWizard getWizard() {

        return (ExportSingleReadAlignmentWizard)super.getWizard();  // Would throw an exception, if this page is used within another wizard.

    }

}