EDIT

/**

 * Copyright (C) 2017 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.editor.descriptiveDataSet.matrix;

import java.io.File;

import java.util.ArrayList;

import java.util.Collection;

import java.util.HashMap;

import java.util.List;

import java.util.Map;

import java.util.Properties;

import java.util.Set;

import java.util.UUID;

import java.util.stream.Collectors;

import org.apache.commons.collections4.map.LinkedMap;

import org.eclipse.core.runtime.ICoreRunnable;

import org.eclipse.core.runtime.IProgressMonitor;

import org.eclipse.core.runtime.jobs.Job;

import org.eclipse.jface.layout.GridDataFactory;

import org.eclipse.jface.viewers.ComboViewer;

import org.eclipse.nebula.widgets.nattable.NatTable;

import org.eclipse.nebula.widgets.nattable.config.ConfigRegistry;

import org.eclipse.nebula.widgets.nattable.config.DefaultNatTableStyleConfiguration;

import org.eclipse.nebula.widgets.nattable.coordinate.PositionCoordinate;

import org.eclipse.nebula.widgets.nattable.data.IDataProvider;

import org.eclipse.nebula.widgets.nattable.data.ListDataProvider;

import org.eclipse.nebula.widgets.nattable.export.command.ExportCommandHandler;

import org.eclipse.nebula.widgets.nattable.extension.glazedlists.GlazedListsEventLayer;

import org.eclipse.nebula.widgets.nattable.extension.glazedlists.GlazedListsSortModel;

import org.eclipse.nebula.widgets.nattable.extension.glazedlists.tree.GlazedListTreeData;

import org.eclipse.nebula.widgets.nattable.extension.glazedlists.tree.GlazedListTreeRowModel;

import org.eclipse.nebula.widgets.nattable.freeze.CompositeFreezeLayer;

import org.eclipse.nebula.widgets.nattable.freeze.FreezeHelper;

import org.eclipse.nebula.widgets.nattable.freeze.FreezeLayer;

import org.eclipse.nebula.widgets.nattable.grid.GridRegion;

import org.eclipse.nebula.widgets.nattable.grid.data.DefaultColumnHeaderDataProvider;

import org.eclipse.nebula.widgets.nattable.grid.data.DefaultCornerDataProvider;

import org.eclipse.nebula.widgets.nattable.grid.data.DefaultRowHeaderDataProvider;

import org.eclipse.nebula.widgets.nattable.grid.data.FixedSummaryRowHeaderLayer;

import org.eclipse.nebula.widgets.nattable.grid.layer.ColumnHeaderLayer;

import org.eclipse.nebula.widgets.nattable.grid.layer.CornerLayer;

import org.eclipse.nebula.widgets.nattable.grid.layer.DefaultRowHeaderDataLayer;

import org.eclipse.nebula.widgets.nattable.grid.layer.GridLayer;

import org.eclipse.nebula.widgets.nattable.layer.AbstractLayer;

import org.eclipse.nebula.widgets.nattable.layer.CompositeLayer;

import org.eclipse.nebula.widgets.nattable.layer.DataLayer;

import org.eclipse.nebula.widgets.nattable.layer.ILayer;

import org.eclipse.nebula.widgets.nattable.layer.cell.ColumnOverrideLabelAccumulator;

import org.eclipse.nebula.widgets.nattable.layer.stack.DefaultBodyLayerStack;

import org.eclipse.nebula.widgets.nattable.selection.SelectionLayer;

import org.eclipse.nebula.widgets.nattable.sort.SortHeaderLayer;

import org.eclipse.nebula.widgets.nattable.sort.config.SingleClickSortConfiguration;

import org.eclipse.nebula.widgets.nattable.style.HorizontalAlignmentEnum;

import org.eclipse.nebula.widgets.nattable.style.theme.ModernNatTableThemeConfiguration;

import org.eclipse.nebula.widgets.nattable.summaryrow.FixedSummaryRowLayer;

import org.eclipse.nebula.widgets.nattable.summaryrow.SummaryRowLayer;

import org.eclipse.nebula.widgets.nattable.tree.ITreeRowModel;

import org.eclipse.nebula.widgets.nattable.tree.TreeLayer;

import org.eclipse.nebula.widgets.nattable.util.GUIHelper;

import org.eclipse.nebula.widgets.nattable.viewport.ViewportLayer;

import org.eclipse.swt.SWT;

import org.eclipse.swt.layout.GridData;

import org.eclipse.swt.layout.GridLayout;

import org.eclipse.swt.widgets.Button;

import org.eclipse.swt.widgets.Composite;

import ca.odell.glazedlists.BasicEventList;

import ca.odell.glazedlists.EventList;

import ca.odell.glazedlists.SortedList;

import ca.odell.glazedlists.TreeList;

import eu.etaxonomy.cdm.api.application.CdmApplicationState;

import eu.etaxonomy.cdm.api.service.IDescriptiveDataSetService;

import eu.etaxonomy.cdm.api.service.IProgressMonitorService;

import eu.etaxonomy.cdm.api.service.dto.RowWrapperDTO;

import eu.etaxonomy.cdm.common.monitor.IRemotingProgressMonitor;

import eu.etaxonomy.cdm.model.description.DescriptiveDataSet;

import eu.etaxonomy.cdm.model.description.Feature;

import eu.etaxonomy.cdm.model.description.FeatureNode;

import eu.etaxonomy.cdm.model.description.FeatureTree;

import eu.etaxonomy.cdm.model.description.MeasurementUnit;

import eu.etaxonomy.cdm.model.description.SpecimenDescription;

import eu.etaxonomy.cdm.model.description.State;

import eu.etaxonomy.cdm.persistence.dto.SpecimenNodeWrapper;

import eu.etaxonomy.taxeditor.editor.l10n.Messages;

import eu.etaxonomy.taxeditor.model.MessagingUtils;

import eu.etaxonomy.taxeditor.store.CdmStore;

import eu.etaxonomy.taxeditor.workbench.WorkbenchUtility;

/**

 * Character matrix editor for editing specimen/taxon descriptions in a table

 * @author pplitzner

 * @since Nov 26, 2017

 *

 */

public class CharacterMatrix extends Composite {

    private static final String CHARACTER_MATRIX_STATE_PROPERTIES = "characterMatrixState.properties"; //$NON-NLS-1$

    static final int LEADING_COLUMN_COUNT = 4;

    static final String TAXON_COLUMN = "taxon_column"; //$NON-NLS-1$

    static final String COLLECTOR_COLUMN = "collector_column"; //$NON-NLS-1$

    static final String IDENTIFIER_COLUMN = "identifier_column"; //$NON-NLS-1$

    static final String COUNTRY_COLUMN = "country_column"; //$NON-NLS-1$

    static final String LABEL_TAXON_ROW = "TAXON_ROW"; //$NON-NLS-1$

    private DescriptiveDataSet descriptiveDataSet;

    private NatTable natTable;

    private Map<Integer, Feature> indexToFeatureMap = new HashMap<>();

    private Map<Feature, List<State>> categoricalFeatureToStateMap = new HashMap<>();

    private LinkedMap<String, String> propertyToLabelMap = new LinkedMap<>();

    private EventList<Object> descriptions;

    private Collection<SpecimenNodeWrapper> specimenCache = null;

    private ListDataProvider<Object> bodyDataProvider;

    private FreezeLayer freezeLayer;

    private ViewportLayer viewportLayer;

    private List<Feature> features;

    private CharacterMatrixPart part;

    private AbstractLayer topMostLayer;

    private FixedSummaryRowLayer summaryRowLayer;

    private ConfigRegistry configRegistry;

    private DefaultBodyLayerStack bodyLayer;

    private boolean isTreeView = true;

    private CharacterMatrixToolbar toolbar;

    public CharacterMatrix(Composite parent, CharacterMatrixPart part) {

        super(parent, SWT.NONE);

        this.part = part;

        this.setLayout(new GridLayout());

        createToolBar();

        natTable = new NatTable(this, false);

        createBottomToolbar();

    }

    private void createToolBar(){

        toolbar = new CharacterMatrixToolbar(this, SWT.NONE);

    }

    @SuppressWarnings("unused")

    private void createBottomToolbar() {

        new CharacterMatrixBottomToolbar(this, SWT.NONE);

    }

    private void applyStyles(){

        ModernNatTableThemeConfiguration configuration = new ModernNatTableThemeConfiguration();

        configuration.summaryRowHAlign = HorizontalAlignmentEnum.CENTER;

        // NOTE: Getting the colors and fonts from the GUIHelper ensures that

        // they are disposed properly (required by SWT)

        configuration.summaryRowBgColor = GUIHelper.getColor(255, 255, 153);

        configuration.cHeaderBgColor = GUIHelper.getColor(211, 211, 211);

        configuration.rHeaderBgColor = GUIHelper.getColor(211, 211, 211);

        natTable.addConfiguration(configuration);

    }

    void toggleTreeFlat(boolean isTree, Button btnToggleFlat, Button btnToggleTree, Button btnCollapseAll, Button btnExpandAll, Button btnFreezeSuppInfo) {

        isTreeView = isTree;

        createTable(isTree);

        btnToggleFlat.setEnabled(isTree);

        btnToggleTree.setEnabled(!isTree);

        btnCollapseAll.setEnabled(isTree);

        btnExpandAll.setEnabled(isTree);

    }

    public boolean isTreeView() {

        return isTreeView;

    }

    public void createTable(boolean treeView){

        /**

         * layers

         */

        createLayers(treeView);

        /**

         * configuration

         */

        configureNatTable(treeView, configRegistry, topMostLayer, summaryRowLayer);

        /**

         * handlers and listeners

         */

        registerHandlersAndListeners(topMostLayer);

        //grab all space

        GridDataFactory.fillDefaults().grab(true, true).applyTo(natTable);

        //update label to current data set

        toolbar.getWsLabel().setText(descriptiveDataSet.getLabel());

        toolbar.getWsLabel().setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, false));

        toolbar.getWsLabel().getParent().layout();

        //initial freeze of supplemental columns

        freezeSupplementalColumns(true);

        this.layout();

    }

    private List<Feature> initFeatureList(FeatureNode node){

        List<Feature> features = new ArrayList<>();

        node.getChildNodes().forEach(childNode->

                {

                    features.add(childNode.getFeature());

                    features.addAll(initFeatureList(childNode));

                });

        return features;

    }

    public void initDescriptiveDataSet(DescriptiveDataSet descriptiveDataSet){

        this.descriptiveDataSet = descriptiveDataSet;

        //get features/columns stored in descriptive data set

        FeatureTree tree = descriptiveDataSet.getDescriptiveSystem();

        features = initFeatureList(tree.getRoot());

        //init state data for categorical features

        features.forEach(feature->

        {

            if(feature.isSupportsCategoricalData()){

                List<State> supportedStates = new ArrayList<>();

                feature.getSupportedCategoricalEnumerations().forEach(voc->supportedStates.addAll(voc.getTerms()));

                categoricalFeatureToStateMap.put(feature, supportedStates);

            }

        });

        descriptions = new BasicEventList<>();

    }

    private void createLayers(boolean treeView) {

        // use the SortedList constructor with 'null' for the Comparator

        // because the Comparator will be set by configuration

        SortedList<Object> sortedList = new SortedList<>(descriptions, new MatrixRowComparator());

        // wrap the SortedList with the TreeList

        TreeList<Object> treeList = new TreeList(sortedList, new DescriptionTreeFormat(descriptiveDataSet), TreeList.NODES_START_EXPANDED);

        /**

         * data provider

         */

        SpecimenColumnPropertyAccessor columnPropertyAccessor = new SpecimenColumnPropertyAccessor(this);

        bodyDataProvider = treeView?new ListDataProvider<>(treeList, columnPropertyAccessor):new ListDataProvider<>(sortedList, columnPropertyAccessor);

        configRegistry = new ConfigRegistry();

        /**

         * BODY layer

         *

         *

        CompositeLayer

         - (top) SummaryRowLayer

         - (bottom) ViewportLayer

             ^

        ViewportLayer

             ^

        TreeLayer (default visible)

             ^

        CompositeFreezeLayer

         - viewportLayer

         - selectionLayer

         - freezeLayer

             ^

        FreezeLayer

             ^

        SelectionLayer

             ^

        ColumnHideShowLayer

             ^

        ColumnReorderLayer

             ^

        DataLayer

         *

         */

        DataLayer bodyDataLayer = new DataLayer(bodyDataProvider);

        //register labels

        CharacterMatrixConfigLabelAccumulator labelAccumulator = new CharacterMatrixConfigLabelAccumulator(this);

        bodyDataLayer.setConfigLabelAccumulator(labelAccumulator);

        propertyToLabelMap.put(TAXON_COLUMN, Messages.CharacterMatrix_TAXON);

        propertyToLabelMap.put(COLLECTOR_COLUMN, Messages.CharacterMatrix_COLLECTOR_NO);

        propertyToLabelMap.put(IDENTIFIER_COLUMN, Messages.CharacterMatrix_IDENTIFIER);

        propertyToLabelMap.put(COUNTRY_COLUMN, Messages.CharacterMatrix_COUNTRY);

        for(int i=0;i<features.size();i++){

            Feature feature = features.get(i);

            initLabels(i, feature);

        }

        // layer for event handling of GlazedLists and PropertyChanges

        GlazedListsEventLayer eventLayer = new GlazedListsEventLayer<>(bodyDataLayer, treeList);

        GlazedListTreeData treeData = new GlazedListTreeData<>(treeList);

        ITreeRowModel treeRowModel = new GlazedListTreeRowModel<>(treeData);

        bodyLayer = new DefaultBodyLayerStack(

                eventLayer);

        viewportLayer = bodyLayer.getViewportLayer();

        final SelectionLayer selectionLayer = bodyLayer.getSelectionLayer();

        freezeLayer = new FreezeLayer(selectionLayer);

        final CompositeFreezeLayer compositeFreezeLayer = new CompositeFreezeLayer(

                freezeLayer, bodyLayer.getViewportLayer(), selectionLayer);

        TreeLayer treeLayer = new TreeLayer(compositeFreezeLayer, treeRowModel);

        topMostLayer = treeView?treeLayer:compositeFreezeLayer;

        summaryRowLayer = new FixedSummaryRowLayer(bodyDataLayer, topMostLayer, configRegistry, false);

        //regoster labels with summary prefix for summary layer

        ColumnOverrideLabelAccumulator summaryColumnLabelAccumulator =new ColumnOverrideLabelAccumulator(bodyDataLayer);

        summaryRowLayer.setConfigLabelAccumulator(summaryColumnLabelAccumulator);

        for(int i=0;i<features.size();i++){

            Feature feature = features.get(i);

            summaryColumnLabelAccumulator.registerColumnOverrides(

                    i+LEADING_COLUMN_COUNT,

                    SummaryRowLayer.DEFAULT_SUMMARY_COLUMN_CONFIG_LABEL_PREFIX+MatrixUtility.getProperty(feature));

        }

        // because the horizontal dependency is the ViewportLayer

        // we need to set the composite dependency to false

        summaryRowLayer.setHorizontalCompositeDependency(false);

        CompositeLayer composite = new CompositeLayer(1, 2);

        composite.setChildLayer("SUMMARY", summaryRowLayer, 0, 0); //$NON-NLS-1$

        composite.setChildLayer(GridRegion.BODY, topMostLayer, 0, 1);

        /**

         * column header layer

         */

        IDataProvider columnHeaderDataProvider = new DefaultColumnHeaderDataProvider(

                propertyToLabelMap.values().toArray(new String[] {}), propertyToLabelMap);

        DataLayer columnHeaderDataLayer = new DataLayer(columnHeaderDataProvider);

        ColumnHeaderLayer columnHeaderLayer = new ColumnHeaderLayer(columnHeaderDataLayer, topMostLayer, selectionLayer);

        // add the SortHeaderLayer to the column header layer stack

        // as we use GlazedLists, we use the GlazedListsSortModel which

        // delegates the sorting to the SortedList

        final SortHeaderLayer<SpecimenDescription> sortHeaderLayer = new SortHeaderLayer<>(

                columnHeaderLayer,

                new GlazedListsSortModel<>(

                        sortedList,

                        columnPropertyAccessor,

                        configRegistry,

                        columnHeaderDataLayer));

        /**

         * row header layer

         */

        IDataProvider rowHeaderDataProvider = new DefaultRowHeaderDataProvider(bodyDataProvider);

        DefaultRowHeaderDataLayer rowHeaderDataLayer = new DefaultRowHeaderDataLayer(rowHeaderDataProvider);

        FixedSummaryRowHeaderLayer fixedSummaryRowHeaderLayer = new FixedSummaryRowHeaderLayer(rowHeaderDataLayer,

                composite, selectionLayer);

        fixedSummaryRowHeaderLayer.setSummaryRowLabel("\u2211"); //$NON-NLS-1$

        /**

         * corner layer

         */

        ILayer cornerLayer = new CornerLayer(

                new DataLayer(new DefaultCornerDataProvider(columnHeaderDataProvider, rowHeaderDataProvider)),

                fixedSummaryRowHeaderLayer, sortHeaderLayer);

        /**

         * GRID layer (composition of all other layers)

         */

        GridLayer gridLayer = new GridLayer(composite, sortHeaderLayer, fixedSummaryRowHeaderLayer, cornerLayer);

        natTable.setLayer(gridLayer);

    }

    private void registerHandlersAndListeners(AbstractLayer topMostLayer) {

        // add the ExportCommandHandler to the ViewportLayer in order to make

        // exporting work

        topMostLayer.registerCommandHandler(new ExportCommandHandler(topMostLayer));

        //propagate single cell selection

        natTable.addLayerListener(new CellSelectionListener(part));

        //register handler for view configuration menu

        natTable.registerCommandHandler(toolbar.getDisplayPersistenceDialogCommandHandler());

    }

    private void configureNatTable(boolean treeView,

            ConfigRegistry configRegistry,

            AbstractLayer topMostLayer,

            FixedSummaryRowLayer summaryRowLayer) {

        /**

         * CONFIGURATION

         */

        natTable.setConfigRegistry(configRegistry);

        applyStyles();

        //add default configuration because autoconfigure is set to false in constructor

        natTable.addConfiguration(new DefaultNatTableStyleConfiguration());

        //FIXME: this is for DEBUG ONLY

        //        natTable.addConfiguration(new DebugMenuConfiguration(natTable));

        // override the default sort configuration and change the mouse bindings

        // to sort on a single click

        if(!treeView){

            natTable.addConfiguration(new SingleClickSortConfiguration());

        }

        natTable.addConfiguration(new CharacterMatrixLabelStyleConfiguration());

        // add the header menu configuration for adding the column header menu

        // with hide/show actions

        natTable.addConfiguration(new CharacterMatrixHeaderMenuConfiguration(natTable));

        // add custom configuration for data conversion and add column labels to viewport layer

        topMostLayer.addConfiguration(new DataConversionConfiguration(this));

        //register aggregation configuration

        summaryRowLayer.addConfiguration(new AggregationConfiguration(this));

        natTable.configure();

    }

    void freezeSupplementalColumns(boolean freeze){

        if(freeze){

            FreezeHelper.freeze(freezeLayer, viewportLayer,

                    new PositionCoordinate(viewportLayer, 0, 0),

                    new PositionCoordinate(viewportLayer, LEADING_COLUMN_COUNT-1, -1));

        }

        else{

            FreezeHelper.unfreeze(freezeLayer, viewportLayer);

        }

    }

    void selectStateItem(ComboViewer comboStates, String stateName){

        String[] items = comboStates.getCombo().getItems();

        for(int i=0;i<items.length;i++){

            if(items[i].equals(stateName)){

                comboStates.getCombo().select(i);

                break;

            }

        }

    }

    private void initLabels(int index, Feature feature) {

        indexToFeatureMap.put(index+LEADING_COLUMN_COUNT, feature);

        String featureLabel = feature.getLabel();

        String property = featureLabel;

        //show unit for quantitative data

        if(feature.isSupportsQuantitativeData()){

            Set<MeasurementUnit> recommendedMeasurementUnits = feature.getRecommendedMeasurementUnits();

            if(recommendedMeasurementUnits.size()>1){

                MessagingUtils.warningDialog(Messages.CharacterMatrix_INIT_PROBLEM, CharacterMatrix.class,

                        String.format(Messages.CharacterMatrix_INIT_PROBLEM_MESSAGE, feature.getLabel()));

            }

            if(recommendedMeasurementUnits.size()==1){

                MeasurementUnit unit = recommendedMeasurementUnits.iterator().next();

                featureLabel += " ["+unit.getIdInVocabulary()+"]"; //$NON-NLS-1$ //$NON-NLS-2$

            }

        }

        propertyToLabelMap.put(property, featureLabel);

    }

    public void loadDescriptions(DescriptiveDataSet descriptiveDataSet) {

        UUID monitorUuid = CdmStore.getService(IDescriptiveDataSetService.class).monitGetRowWrapper(descriptiveDataSet);

        IProgressMonitorService progressMonitorService = CdmApplicationState.getCurrentAppConfig().getProgressMonitorService();

        String jobLabel = "Load character data";

        Job job = Job.create(jobLabel, (ICoreRunnable) monitor -> {

            monitor.beginTask(jobLabel, IProgressMonitor.UNKNOWN);

            while(progressMonitorService.isMonitorThreadRunning(monitorUuid)){

                if(monitor.isCanceled()){

                    progressMonitorService.interrupt(monitorUuid);

                }

            }

            IRemotingProgressMonitor remotingMonitor = progressMonitorService.getRemotingMonitor(monitorUuid);

            Collection<RowWrapperDTO> wrappers = (Collection<RowWrapperDTO>) remotingMonitor.getResult();

            if(wrappers!=null){

                wrappers.forEach(wrapper->CharacterMatrix.this.descriptions.add(wrapper));

            }

            monitor.done();

        });

        job.schedule(1000);

    }

    public List<State> getSupportedStatesForCategoricalFeature(Feature feature){

        return categoricalFeatureToStateMap.get(feature);

    }

    public Map<Integer, Feature> getIndexToFeatureMap() {

        return indexToFeatureMap;

    }

    public LinkedMap<String, String> getPropertyToLabelMap() {

        return propertyToLabelMap;

    }

    public void setDirty() {

        part.setDirty();

    }

    public NatTable getNatTable() {

        return natTable;

    }

    public EventList<Object> getDescriptions() {

        return descriptions;

    }

    public DescriptiveDataSet getDescriptiveDataSet() {

        return descriptiveDataSet;

    }

    public Collection<SpecimenNodeWrapper> getSpecimenCache() {

        return specimenCache;

    }

    public void setSpecimenCache(Collection<SpecimenNodeWrapper> specimenCache) {

        this.specimenCache = specimenCache.stream()

                .filter(wrapper ->

        //map descriptions on a list of uuids of the described specimen

        !this.descriptions.stream()

        .map(o->((RowWrapperDTO)o).getSpecimen().getUuid())

        .collect(Collectors.toList())

        //an check if the specimen to add is already contained

        .contains(wrapper.getUuidAndTitleCache().getUuid())

        )

        .collect(Collectors.toList());

    }

    public Properties getNatTableState() {

        return toolbar.getNatTableState();

    }

    public ListDataProvider<Object> getBodyDataProvider() {

        return bodyDataProvider;

    }

    DefaultBodyLayerStack getBodyLayer() {

        return bodyLayer;

    }

    File getStatePropertiesFile() {

        return new File(WorkbenchUtility.getBaseLocation(), CHARACTER_MATRIX_STATE_PROPERTIES);

    }

    public List<Feature> getFeatures() {

        return features;

    }

}