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.workingSet.matrix;

import java.io.File;

import java.io.FileInputStream;

import java.io.FileOutputStream;

import java.io.IOException;

import java.util.ArrayList;

import java.util.Arrays;

import java.util.Collection;

import java.util.Collections;

import java.util.HashMap;

import java.util.HashSet;

import java.util.List;

import java.util.Map;

import java.util.Properties;

import java.util.Set;

import java.util.UUID;

import javax.annotation.PostConstruct;

import javax.annotation.PreDestroy;

import javax.inject.Inject;

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

import org.eclipse.core.runtime.IProgressMonitor;

import org.eclipse.e4.ui.di.Focus;

import org.eclipse.e4.ui.di.Persist;

import org.eclipse.e4.ui.model.application.ui.MDirtyable;

import org.eclipse.e4.ui.model.application.ui.basic.MPart;

import org.eclipse.e4.ui.workbench.modeling.ESelectionService;

import org.eclipse.jface.layout.GridDataFactory;

import org.eclipse.jface.viewers.ArrayContentProvider;

import org.eclipse.jface.viewers.ComboViewer;

import org.eclipse.jface.viewers.LabelProvider;

import org.eclipse.jface.viewers.StructuredSelection;

import org.eclipse.jface.window.Window;

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

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

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

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

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

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

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

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.edit.EditConfigAttributes;

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

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.freeze.config.DefaultFreezeGridBindings;

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

import org.eclipse.nebula.widgets.nattable.grid.command.ClientAreaResizeCommand;

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.grid.layer.config.DefaultRowStyleConfiguration;

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.ILayerListener;

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

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

import org.eclipse.nebula.widgets.nattable.layer.config.DefaultColumnHeaderStyleConfiguration;

import org.eclipse.nebula.widgets.nattable.layer.config.DefaultRowHeaderStyleConfiguration;

import org.eclipse.nebula.widgets.nattable.layer.event.ILayerEvent;

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

import org.eclipse.nebula.widgets.nattable.persistence.PersistenceHelper;

import org.eclipse.nebula.widgets.nattable.persistence.command.DisplayPersistenceDialogCommand;

import org.eclipse.nebula.widgets.nattable.persistence.command.DisplayPersistenceDialogCommandHandler;

import org.eclipse.nebula.widgets.nattable.persistence.command.IStateChangedListener;

import org.eclipse.nebula.widgets.nattable.persistence.command.StateChangeEvent;

import org.eclipse.nebula.widgets.nattable.persistence.gui.PersistenceDialog;

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

import org.eclipse.nebula.widgets.nattable.selection.config.DefaultSelectionStyleConfiguration;

import org.eclipse.nebula.widgets.nattable.selection.event.CellSelectionEvent;

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

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

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

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

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

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

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

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.tree.command.TreeCollapseAllCommand;

import org.eclipse.nebula.widgets.nattable.tree.command.TreeExpandAllCommand;

import org.eclipse.nebula.widgets.nattable.ui.menu.AbstractHeaderMenuConfiguration;

import org.eclipse.nebula.widgets.nattable.ui.menu.PopupMenuBuilder;

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.events.SelectionAdapter;

import org.eclipse.swt.events.SelectionEvent;

import org.eclipse.swt.graphics.Color;

import org.eclipse.swt.graphics.FontData;

import org.eclipse.swt.layout.GridData;

import org.eclipse.swt.layout.GridLayout;

import org.eclipse.swt.layout.RowLayout;

import org.eclipse.swt.widgets.Button;

import org.eclipse.swt.widgets.Composite;

import org.eclipse.swt.widgets.Label;

import ca.odell.glazedlists.EventList;

import ca.odell.glazedlists.GlazedLists;

import ca.odell.glazedlists.SortedList;

import ca.odell.glazedlists.TreeList;

import eu.etaxonomy.cdm.api.conversation.ConversationHolder;

import eu.etaxonomy.cdm.api.conversation.IConversationEnabled;

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

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

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

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

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.model.description.WorkingSet;

import eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationBase;

import eu.etaxonomy.cdm.persistence.hibernate.CdmDataChangeMap;

import eu.etaxonomy.taxeditor.editor.workingSet.matrix.categorical.CategoricalDataCellEditor;

import eu.etaxonomy.taxeditor.editor.workingSet.matrix.categorical.CategoricalDataDisplayConverter;

import eu.etaxonomy.taxeditor.editor.workingSet.matrix.quantitative.QuantitativeDataCellEditor;

import eu.etaxonomy.taxeditor.editor.workingSet.matrix.quantitative.QuantitativeDataDisplayConverter;

import eu.etaxonomy.taxeditor.editor.workingSet.matrix.supplementalInfo.SupplementalInfoDisplayConverter;

import eu.etaxonomy.taxeditor.model.ColorResources;

import eu.etaxonomy.taxeditor.model.DescriptionHelper;

import eu.etaxonomy.taxeditor.model.IDirtyMarkable;

import eu.etaxonomy.taxeditor.model.IPartContentHasDetails;

import eu.etaxonomy.taxeditor.model.ImageResources;

import eu.etaxonomy.taxeditor.model.MessagingUtils;

import eu.etaxonomy.taxeditor.preference.Resources;

import eu.etaxonomy.taxeditor.session.ICdmEntitySession;

import eu.etaxonomy.taxeditor.session.ICdmEntitySessionEnabled;

import eu.etaxonomy.taxeditor.store.CdmStore;

import eu.etaxonomy.taxeditor.workbench.WorkbenchUtility;

import eu.etaxonomy.taxeditor.workbench.part.IE4SavablePart;

/**

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

 * @author pplitzner

 * @since Nov 26, 2017

 *

 */

public class CharacterMatrix implements IE4SavablePart, IPartContentHasDetails, IConversationEnabled, IDirtyMarkable,

ICdmEntitySessionEnabled{

    private static final List<String> WS_PROPERTY_PATH = Arrays.asList(new String[] {

            "descriptions", //$NON-NLS-1$

            "descriptions.descriptionElements", //$NON-NLS-1$

            "descriptions.descriptionElements.inDescription", //$NON-NLS-1$

            "descriptions.descriptionElements.inDescription.descriptionElements", //$NON-NLS-1$

            "descriptions.descriptionElements.feature", //$NON-NLS-1$

    });

    private static final String CHARACTER_MATRIX_STATE_PROPERTIES = "characterMatrixState.properties";

    private static final int LEADING_COLUMN_COUNT = 4;

    private static final String TAXON_COLUMN = "taxon_column";

    private static final String COLLECTOR_COLUMN = "collector_column";

    private static final String IDENTIFIER_COLUMN = "identifier_column";

    private static final String COUNTRY_COLUMN = "country_column";

    private WorkingSet workingSet;

    private ConversationHolder conversation;

    private ICdmEntitySession cdmEntitySession;

    @Inject

    private ESelectionService selService;

    @Inject

    private MDirtyable dirty;

    @Inject

    private MPart thisPart;

    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 Properties natTableState;

    private EventList<Object> descriptions;

    private Collection<SpecimenOrObservationBase> specimenCache = null;

    private ListDataProvider<Object> bodyDataProvider;

    private FreezeLayer freezeLayer;

    private ViewportLayer viewportLayer;

    private Label wsLabel;

    private Composite parent;

    private List<Feature> features;

    private DisplayPersistenceDialogCommandHandler displayPersistenceDialogCommandHandler;

    @PostConstruct

    public void create(Composite parent) {

        if(CdmStore.isActive() && conversation==null){

            conversation = CdmStore.createConversation();

        }

        if(cdmEntitySession == null){

            cdmEntitySession = CdmStore.getCurrentSessionManager().newSession(this, true);

        }

        else{

            return;

        }

        this.parent = parent;

        parent.setLayout(new GridLayout());

        Composite toolbarComposite = new Composite(parent, SWT.NONE);

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

        toolbarComposite.setLayout(new GridLayout(9, false));

        natTable = new NatTable(parent, false);

        wsLabel = new Label(toolbarComposite, SWT.NONE);

        Button btnToggleTree = new Button(toolbarComposite, SWT.PUSH);

        Button btnToggleFlat = new Button(toolbarComposite, SWT.PUSH);

        Button btnCollapseAll = new Button(toolbarComposite, SWT.PUSH);

        Button btnExpandAll = new Button(toolbarComposite, SWT.PUSH);

        Button btnFreezeSuppInfo = new Button(toolbarComposite, SWT.TOGGLE);

        ComboViewer comboStates = new ComboViewer(toolbarComposite, SWT.DROP_DOWN);

        Button btnManageState = new Button(toolbarComposite, SWT.PUSH);

        Button btnExcelExport = new Button(toolbarComposite, SWT.PUSH);

        /**

         * Toogle tree button

         */

        btnToggleTree.setImage(ImageResources.getImage(ImageResources.HIERARCHICAL));

        btnToggleTree.setToolTipText("Show taxon hierarchy");

        btnToggleTree.setSelection(true);

        btnToggleTree.setEnabled(false);

        btnToggleTree.addSelectionListener(new SelectionAdapter() {

            @Override

            public void widgetSelected(SelectionEvent e) {

                toggleTreeFlat(true, btnToggleFlat, btnToggleTree, btnCollapseAll, btnExpandAll);

            }

        });

        /**

         * Toogle flat button

         */

        btnToggleFlat.setImage(ImageResources.getImage(ImageResources.FLAT));

        btnToggleFlat.setToolTipText("Show flat list");

        btnToggleFlat.addSelectionListener(new SelectionAdapter() {

            @Override

            public void widgetSelected(SelectionEvent e) {

                toggleTreeFlat(false, btnToggleFlat, btnToggleTree, btnCollapseAll, btnExpandAll);

            }

        });

        /**

         *

         * Collapse button

         */

        btnCollapseAll.setImage(ImageResources.getImage(ImageResources.COLLAPSE_ALL));

        btnCollapseAll.setToolTipText("Collapse all");

        btnCollapseAll.addSelectionListener(new SelectionAdapter() {

            @Override

            public void widgetSelected(SelectionEvent e) {

                natTable.doCommand(new TreeCollapseAllCommand());

            }

        });

        /**

         * Expand button

         */

        btnExpandAll.setImage(ImageResources.getImage(ImageResources.EXPAND_ALL));

        btnExpandAll.setToolTipText("Expand all");

        btnExpandAll.addSelectionListener(new SelectionAdapter() {

            @Override

            public void widgetSelected(SelectionEvent e) {

                natTable.doCommand(new TreeExpandAllCommand());

            }

        });

        /**

         * Freeze supplemental info button

         */

        btnFreezeSuppInfo.setImage(ImageResources.getImage(ImageResources.LOCK_ICON));

        btnFreezeSuppInfo.setToolTipText("Lock specimen columns");

        btnFreezeSuppInfo.setSelection(true);

        btnFreezeSuppInfo.addSelectionListener(new SelectionAdapter() {

            @Override

            public void widgetSelected(SelectionEvent e) {

                boolean isSelected = btnFreezeSuppInfo.getSelection();

                freezeSupplementalColumns(isSelected);

                btnFreezeSuppInfo.setImage(isSelected?

                                ImageResources.getImage(ImageResources.LOCK_ICON):

                                    ImageResources.getImage(ImageResources.LOCK_OPEN_ICON));

            }

        });

        /**

         * Table state persistence

         */

        natTableState = new Properties();

        //load persisted state

        File statePropertiesFile = getStatePropertiesFile();

        FileInputStream inputStream;

        try {

            inputStream = new FileInputStream(statePropertiesFile);

            natTableState.load(inputStream);

        } catch (IOException e) {

            MessagingUtils.info("No initial state properties file found for character matrix");

        }

        // create a combobox for showing the available view states

        Collection<String> availableStates = PersistenceHelper.getAvailableStates(natTableState);

        comboStates.setLabelProvider(new LabelProvider(){

            @Override

            public String getText(Object element) {

                if(element instanceof String && ((String) element).isEmpty()){

                    return "-default-";

                }

                return super.getText(element);

            }

        });

        comboStates.setContentProvider(new ArrayContentProvider());

        comboStates.addSelectionChangedListener(e->

        {

            int index = comboStates.getCombo().getSelectionIndex();

            if (index >= 0) {

                String selected = comboStates.getCombo().getItem(index);

                // load the state

                natTable.loadState(selected, natTableState);

                natTableState.setProperty(PersistenceDialog.ACTIVE_VIEW_CONFIGURATION_KEY, selected);

            }

        });

        comboStates.setInput(availableStates);

        if(comboStates.getCombo().getItemCount()>0){

            comboStates.getCombo().select(0);

        }

        displayPersistenceDialogCommandHandler = new DisplayPersistenceDialogCommandHandler(natTableState, natTable);

        // add listener to update the combo on view state management changes

        displayPersistenceDialogCommandHandler.addStateChangeListener(new IStateChangedListener() {

            @Override

            public void handleStateChange(StateChangeEvent event) {

                comboStates.setInput(PersistenceHelper.getAvailableStates(natTableState));

                selectStateItem(comboStates, event.getViewConfigName());

            }

        });

        // add button to show dialog

        btnManageState.setImage(ImageResources.getImage(ImageResources.SETTINGS));

        btnManageState.setToolTipText("View configuration");

        btnManageState.addSelectionListener(new SelectionAdapter() {

            @Override

            public void widgetSelected(SelectionEvent e) {

                natTable.doCommand(new DisplayPersistenceDialogCommand(natTable));

                selectStateItem(comboStates, natTableState.get(PersistenceDialog.ACTIVE_VIEW_CONFIGURATION_KEY).toString());

            }

        });

        /**

         * excel export

         */

        btnExcelExport.setToolTipText("Export to Excel");

        btnExcelExport.setImage(ImageResources.getImage(ImageResources.EXPORT));

        btnExcelExport.addSelectionListener(new SelectionAdapter() {

            @Override

            public void widgetSelected(SelectionEvent e) {

                natTable.doCommand(

                        new ExportCommand(

                                natTable.getConfigRegistry(),

                                natTable.getShell()));

            }

        });

        Composite buttonPanel = new Composite(parent, SWT.NONE);

        buttonPanel.setLayout(new RowLayout());

        GridDataFactory.fillDefaults().grab(true, false).applyTo(buttonPanel);

        /**

         * Add description button

         */

        Button btnAddDescription = new Button(buttonPanel, SWT.PUSH);

        btnAddDescription.setImage(ImageResources.getImage(ImageResources.ADD_ICON));

        btnAddDescription.addSelectionListener(new SelectionAdapter() {

            @Override

            public void widgetSelected(SelectionEvent e) {

                SpecimenSelectionDialog dialog = new SpecimenSelectionDialog(natTable.getShell(), CharacterMatrix.this);

                if(dialog.open()==Window.OK){

                    Collection<SpecimenOrObservationBase> specimens = dialog.getSpecimen();

                    boolean hasAdded = false;

                    for (SpecimenOrObservationBase specimen : specimens) {

                        SpecimenDescription description = getDescriptionForWorkingSet(specimen);

                        if(!workingSet.getDescriptions().contains(description)){

                            CharacterMatrix.this.descriptions.add(new RowWrapper(description));

                            workingSet.addDescription(description);

                            hasAdded = true;

                        }

                    }

                    if(hasAdded){

                        setDirty();

                    }

                }

            }

        });

        applyStyles();

    }

    private void applyStyles(){

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

        // they are disposed properly (required by SWT)

        DefaultNatTableStyleConfiguration natTableConfiguration = new DefaultNatTableStyleConfiguration();

        natTableConfiguration.bgColor = GUIHelper.getColor(249, 172, 7);

        natTableConfiguration.fgColor = GUIHelper.getColor(30, 76, 19);

        natTableConfiguration.hAlign = HorizontalAlignmentEnum.LEFT;

        natTableConfiguration.vAlign = VerticalAlignmentEnum.TOP;

//        natTableConfiguration.borderStyle = new BorderStyle(1, GUIHelper.getColor(249, 172, 7), LineStyleEnum.SOLID);

        // Setup even odd row colors - row colors override the NatTable default

        // colors

        DefaultRowStyleConfiguration rowStyleConfiguration = new DefaultRowStyleConfiguration();

        rowStyleConfiguration.oddRowBgColor = ColorResources.getColor(Resources.COLOR_LIST_ODD);

        rowStyleConfiguration.evenRowBgColor = ColorResources.getColor(Resources.COLOR_LIST_EVEN);

        // Setup selection styling

        DefaultSelectionStyleConfiguration selectionStyle = new DefaultSelectionStyleConfiguration();

//        selectionStyle.selectionFont = GUIHelper.getFont(new FontData("Verdana", 8, SWT.NORMAL));

//        selectionStyle.selectionBgColor = GUIHelper.getColor(217, 232, 251);

//        selectionStyle.selectionFgColor = GUIHelper.COLOR_BLACK;

//        selectionStyle.anchorBorderStyle = new BorderStyle(1, GUIHelper.COLOR_DARK_GRAY, LineStyleEnum.SOLID);

//        selectionStyle.anchorBgColor = GUIHelper.getColor(65, 113, 43);

        selectionStyle.selectedHeaderBgColor = GUIHelper.getColor(156, 209, 103);

        // Add all style configurations to NatTable

        natTable.addConfiguration(natTableConfiguration);

        natTable.addConfiguration(rowStyleConfiguration);

        natTable.addConfiguration(selectionStyle);

        // Column/Row header style and custom painters

        DefaultRowHeaderStyleConfiguration rowHeaderConfig = new DefaultRowHeaderStyleConfiguration();

        Color rowColumnColor = GUIHelper.getColor(230, 255, 255);

        rowHeaderConfig.bgColor = rowColumnColor;

        natTable.addConfiguration(rowHeaderConfig);

        DefaultColumnHeaderStyleConfiguration columnHeaderStyle = new DefaultColumnHeaderStyleConfiguration();

        columnHeaderStyle.bgColor = rowColumnColor;

        columnHeaderStyle.font = GUIHelper.getFont(new FontData("Verdana", 9, SWT.BOLD));

        natTable.addConfiguration(columnHeaderStyle);

    }

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

        init(workingSet.getUuid(), isTree);

        btnToggleFlat.setEnabled(isTree);

        btnToggleTree.setEnabled(!isTree);

        btnCollapseAll.setEnabled(isTree);

        btnExpandAll.setEnabled(isTree);

        natTable.doCommand(new ClientAreaResizeCommand(natTable));

    }

    public void init(UUID workingSetUuid, boolean treeView) {

        if(workingSet==null){

            this.workingSet = CdmStore.getService(IWorkingSetService.class).load(workingSetUuid, WS_PROPERTY_PATH);

            if(workingSet.getDescriptiveSystem()==null){

                MessagingUtils.informationDialog("Editor could not be opened", "The working set has no feature tree selected.");

                return;

            }

            thisPart.setLabel(workingSet.getLabel());

            //get features/columns stored in working set

            FeatureTree tree = workingSet.getDescriptiveSystem();

            features = new ArrayList<>(tree.getDistinctFeatures());

            Collections.sort(features);

            //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 = GlazedLists.eventList(getDescriptions(workingSet));

        }

        // 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(workingSet), TreeList.NODES_START_EXPANDED);

        /**

         * data provider

         */

        SpecimenColumnPropertyAccessor columnPropertyAccessor = new SpecimenColumnPropertyAccessor(this);

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

        ConfigRegistry configRegistry = new ConfigRegistry();

        /**

         * BODY layer

         *

         *

        CompositeLayer

         - (top) SummaryRowLayer

         - (bottom) ViewportLayer

             ^

        ViewportLayer

             ^

        TreeLayer (default visible)

             ^

        SelectionLayer

             ^

        RowHideShowLayer

             ^

        ColumnHideShowLayer

             ^

        ColumnReorderLayer

             ^

        RowReorderLayer

             ^

        DataLayer

         *

         */

        DataLayer bodyDataLayer = new DataLayer(bodyDataProvider);

        //register labels for columns

        ColumnOverrideLabelAccumulator bodyColumnLabelAccumulator =new ColumnOverrideLabelAccumulator(bodyDataLayer);

        bodyDataLayer.setConfigLabelAccumulator(bodyColumnLabelAccumulator);

        propertyToLabelMap.put(TAXON_COLUMN, "Taxon");

        bodyColumnLabelAccumulator.registerColumnOverrides(0, TAXON_COLUMN);

        propertyToLabelMap.put(COLLECTOR_COLUMN, "Collector + No");

        bodyColumnLabelAccumulator.registerColumnOverrides(1, COLLECTOR_COLUMN);

        propertyToLabelMap.put(IDENTIFIER_COLUMN, "Identifier");

        bodyColumnLabelAccumulator.registerColumnOverrides(2, IDENTIFIER_COLUMN);

        propertyToLabelMap.put(COUNTRY_COLUMN, "Country");

        bodyColumnLabelAccumulator.registerColumnOverrides(3, COUNTRY_COLUMN);

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

            Feature feature = features.get(i);

            initLabels(bodyColumnLabelAccumulator, 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);

//        ColumnReorderLayer columnReorderLayer;

//        ColumnHideShowLayer columnHideShowLayer;

//        SelectionLayer selectionLayer;

//        TreeLayer treeLayer;

//        ViewportLayer viewportLayer;

//        if(treeView){

//            columnReorderLayer = new ColumnReorderLayer(eventLayer);

//            columnHideShowLayer = new ColumnHideShowLayer(columnReorderLayer);

//            selectionLayer = new SelectionLayer(columnHideShowLayer);

//            treeLayer = new TreeLayer(selectionLayer, treeRowModel);

//            viewportLayer = treeView?new ViewportLayer(treeLayer):new ViewportLayer(selectionLayer);

//        }

//        else{

//            RowReorderLayer rowReorderLayer = new RowReorderLayer(eventLayer);

//            columnReorderLayer = new ColumnReorderLayer(rowReorderLayer);

//            columnHideShowLayer = new ColumnHideShowLayer(columnReorderLayer);

//            RowHideShowLayer rowHideShowLayer = new RowHideShowLayer(columnHideShowLayer);

//            selectionLayer = new SelectionLayer(rowHideShowLayer);

//            treeLayer = new TreeLayer(selectionLayer, treeRowModel);

//            viewportLayer = treeView?new ViewportLayer(treeLayer):new ViewportLayer(selectionLayer);

//        }

        final DefaultBodyLayerStack bodyLayer = new DefaultBodyLayerStack(

                bodyDataLayer);

        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);

//        ViewportLayer viewportLayer = new ViewportLayer(treeLayer);

//        FreezeLayer freezeLayer = new FreezeLayer(viewportLayer);

//        CompositeFreezeLayer compositeFreezeLayer = new CompositeFreezeLayer(freezeLayer, viewportLayer, selectionLayer);

        AbstractLayer topMostLayer = treeView?treeLayer:compositeFreezeLayer;

        // create a standalone FixedSummaryRowLayer

        // since the summary row should be fixed at the top of the body

        // region the horizontal dependency of the FixedSummaryRowLayer

        // is the ViewportLayer

        FixedSummaryRowLayer 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);

        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");

        /**

         * 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);

        /**

         * CONFIGURATION

         */

        natTable.setConfigRegistry(configRegistry);

        //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());

        }

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

        // with hide/show actions

        natTable.addConfiguration(new AbstractHeaderMenuConfiguration(natTable) {

            @Override

            protected PopupMenuBuilder createColumnHeaderMenu(NatTable natTable) {

                return super.createColumnHeaderMenu(natTable)

                        .withHideColumnMenuItem()

                        .withShowAllColumnsMenuItem();

            }

        });

        Style cellStyle = new Style();

        cellStyle.setAttributeValue(CellStyleAttributes.HORIZONTAL_ALIGNMENT, HorizontalAlignmentEnum.LEFT);

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

        topMostLayer.addConfiguration(new AbstractRegistryConfiguration() {

            @Override

            public void configureRegistry(IConfigRegistry configRegistry) {

                //add display converter for string representation

                configRegistry.registerConfigAttribute(

                        CellConfigAttributes.DISPLAY_CONVERTER,

                        new SupplementalInfoDisplayConverter(),

                        DisplayMode.NORMAL,

                        TAXON_COLUMN);

                configRegistry.registerConfigAttribute(

                        CellConfigAttributes.CELL_STYLE,

                        cellStyle,

                        DisplayMode.NORMAL,

                        TAXON_COLUMN);

                configRegistry.registerConfigAttribute(

                        CellConfigAttributes.DISPLAY_CONVERTER,

                        new SupplementalInfoDisplayConverter(),

                        DisplayMode.NORMAL,

                        COLLECTOR_COLUMN);

                configRegistry.registerConfigAttribute(

                        CellConfigAttributes.CELL_STYLE,

                        cellStyle,

                        DisplayMode.NORMAL,

                        COLLECTOR_COLUMN);

                configRegistry.registerConfigAttribute(

                        CellConfigAttributes.DISPLAY_CONVERTER,

                        new SupplementalInfoDisplayConverter(),

                        DisplayMode.NORMAL,

                        IDENTIFIER_COLUMN);

                configRegistry.registerConfigAttribute(

                        CellConfigAttributes.CELL_STYLE,

                        cellStyle,

                        DisplayMode.NORMAL,

                        IDENTIFIER_COLUMN);

                configRegistry.registerConfigAttribute(

                        CellConfigAttributes.DISPLAY_CONVERTER,

                        new SupplementalInfoDisplayConverter(),

                        DisplayMode.NORMAL,

                        COUNTRY_COLUMN);

                configRegistry.registerConfigAttribute(

                        CellConfigAttributes.CELL_STYLE,

                        cellStyle,

                        DisplayMode.NORMAL,

                        COUNTRY_COLUMN);

                features.forEach(feature->registerColumnConfiguration(feature, configRegistry));

            }

        });

        //register aggregation configuration for each feature

        features.forEach(feature->summaryRowLayer.addConfiguration(new AggregationConfiguration(bodyDataProvider, feature)));

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

        // exporting work

        topMostLayer.registerCommandHandler(new ExportCommandHandler(topMostLayer));

        //propagate single cell selection

        natTable.addLayerListener(new ILayerListener() {

            @Override

            public void handleLayerEvent(ILayerEvent event) {

                if(event instanceof CellSelectionEvent){

                    CellSelectionEvent cellSelectionEvent = (CellSelectionEvent)event;

                    int columnPosition = cellSelectionEvent.getColumnPosition();

                    if(columnPosition>LEADING_COLUMN_COUNT){

                        Collection<ILayerCell> selectedCells = cellSelectionEvent.getSelectionLayer().getSelectedCells();

                        StructuredSelection selection = new StructuredSelection();

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

                            ILayerCell cell = selectedCells.iterator().next();

                            Object dataValue = cell.getDataValue();

                            if(dataValue!=null){

                                selection = new StructuredSelection(dataValue);

                            }

                        }

                        selService.setSelection(selection);

                    }

                }

            }

        });

        //register handler for view configuration menu

        natTable.registerCommandHandler(displayPersistenceDialogCommandHandler);

        natTable.configure();

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

        wsLabel.setText(workingSet.getLabel());

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

        wsLabel.getParent().layout();

        freezeSupplementalColumns(true);

        parent.layout();

        natTable.addConfiguration(new DefaultFreezeGridBindings());

    }

    private 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);

        }

    }

    private 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 SpecimenDescription getDescriptionForWorkingSet(SpecimenOrObservationBase specimen){

        Set<Feature> wsFeatures = workingSet.getDescriptiveSystem().getDistinctFeatures();

        List<DescriptionElementBase> matchingDescriptionElements = new ArrayList<>();

        for (SpecimenDescription specimenDescription : (Set<SpecimenDescription>) specimen.getDescriptions()) {

            Set<Feature> specimenDescriptionFeatures = new HashSet<>();

            //gather specimen description features and check for match with WS features

            for (DescriptionElementBase specimenDescriptionElement : specimenDescription.getElements()) {

                Feature feature = specimenDescriptionElement.getFeature();

                specimenDescriptionFeatures.add(feature);

                if(wsFeatures.contains(feature)){

                    matchingDescriptionElements.add(specimenDescriptionElement);