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.io.FileOutputStream;

import java.io.IOException;

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

import javax.annotation.PostConstruct;

import javax.annotation.PreDestroy;

import javax.inject.Inject;

import org.eclipse.core.runtime.IProgressMonitor;

import org.eclipse.e4.core.contexts.ContextInjectionFactory;

import org.eclipse.e4.core.contexts.IEclipseContext;

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.nebula.widgets.nattable.NatTable;

import org.eclipse.swt.SWT;

import org.eclipse.swt.custom.StackLayout;

import org.eclipse.swt.widgets.Composite;

import org.eclipse.swt.widgets.Label;

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

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

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

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

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

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

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

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

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

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

import eu.etaxonomy.taxeditor.model.IDirtyMarkable;

import eu.etaxonomy.taxeditor.model.MessagingUtils;

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 CharacterMatrixPart implements IE4SavablePart, IConversationEnabled, IDirtyMarkable,

ICdmEntitySessionEnabled{

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

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

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

            "descriptions.describedSpecimenOrObservation.gatheringEvent", //$NON-NLS-1$

            "descriptions.describedSpecimenOrObservation.gatheringEvent.actor", //$NON-NLS-1$

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

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

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

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

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

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

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

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

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

            "taxonSubtreeFilter.parent", //$NON-NLS-1$

            "taxonSubtreeFilter.classification", //$NON-NLS-1$

            "taxonSubtreeFilter.taxon", //$NON-NLS-1$

            "taxonSubtreeFilter.taxon.name", //$NON-NLS-1$

            "taxonSubtreeFilter.taxon.name.rank", //$NON-NLS-1$

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

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

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

    });

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

    private DescriptiveDataSet descriptiveDataSet;

    private Collection<UpdateResult> updateResults;

    private ConversationHolder conversation;

    private ICdmEntitySession cdmEntitySession;

    @Inject

    private ESelectionService selService;

    @Inject

    private MDirtyable dirty;

    @Inject

    private MPart thisPart;

    private CharacterMatrix matrix;

    private StackLayout stackLayout;

    @PostConstruct

    public void create(Composite parent, IEclipseContext context) {

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

            conversation = CdmStore.createConversation();

        }

        if(cdmEntitySession == null){

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

        }

        else{

            return;

        }

        stackLayout = new StackLayout();

        parent.setLayout(stackLayout);

        matrix = new CharacterMatrix(parent, this);

        Label label = new Label(parent, SWT.NONE);

        label.setText("Loading matrix...");

        stackLayout.topControl = label;

        ContextInjectionFactory.inject(matrix, context);

    }

    public void init(UUID descriptiveDataSetUuid, boolean treeView) {

        this.descriptiveDataSet = CdmStore.getService(IDescriptiveDataSetService.class).load(descriptiveDataSetUuid, WS_PROPERTY_PATH);

        if(descriptiveDataSet!=null){

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

                MessagingUtils.informationDialog(Messages.CharacterMatrixPart_COULD_NOT_OPEN, Messages.CharacterMatrixPart_COULD_NOT_OPEN_MESSAGE);

                return;

            }

            matrix.initDescriptiveDataSet(descriptiveDataSet);

            matrix.createTable(treeView, true);

            thisPart.setLabel(descriptiveDataSet.getLabel());

            matrix.loadDescriptions(descriptiveDataSet);

        }

    }

    public void setDirty() {

        this.dirty.setDirty(true);

    }

    public DescriptiveDataSet getDescriptiveDataSet() {

        return descriptiveDataSet;

    }

    private File getStatePropertiesFile() {

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

    }

    public NatTable getNatTable() {

        return matrix.getNatTable();

    }

    public ESelectionService getSelectionService() {

        return selService;

    }

    @Persist

    @Override

    public void save(IProgressMonitor monitor) {

        //save descriptions

        matrix.getDescriptions().stream()

        .filter(o->o instanceof RowWrapperDTO)

        .forEach(wrapper->save((RowWrapperDTO)wrapper));

        //save data set

        CdmStore.getService(IDescriptiveDataSetService.class).merge(descriptiveDataSet);

        //save update results (taxon with aggregated description)

        if(updateResults!=null){

            updateResults.forEach(result->

            CdmStore.getService(result.getCdmEntity()).merge(result.getCdmEntity()));

        }

        conversation.commit();

        updateResults = null;

        dirty.setDirty(false);

    }

    private void save(RowWrapperDTO wrapper){

        CdmStore.getService(IDescriptionService.class).merge(wrapper.getSpecimenDescription());

    }

    @Focus

    public void setFocus(){

        if(conversation!=null){

            conversation.bind();

        }

        if(cdmEntitySession != null) {

            cdmEntitySession.bind();

        }

    }

    @PreDestroy

    public void dispose(){

        if (conversation != null) {

            conversation.close();

            conversation = null;

        }

        if(cdmEntitySession != null) {

            cdmEntitySession.dispose();

            cdmEntitySession = null;

        }

        dirty.setDirty(false);

        if(matrix.getNatTableState()!=null){

            try (FileOutputStream tableStateStream =

                    new FileOutputStream(getStatePropertiesFile())) {

                matrix.getNatTableState().store(tableStateStream, null);

            } catch (IOException ioe) {

                ioe.printStackTrace();

            }

        }

    }

    @Override

    public void update(CdmDataChangeMap arg0) {

    }

    @Override

    public ConversationHolder getConversationHolder() {

        return conversation;

    }

    @Override

    public void changed(Object element) {

        setDirty();

        matrix.getNatTable().refresh();

    }

    @Override

    public void forceDirty() {

        setDirty();

    }

    @Override

    public ICdmEntitySession getCdmEntitySession() {

        return cdmEntitySession;

    }

    @Override

    public Collection<DescriptiveDataSet> getRootEntities() {

        return Collections.singleton(this.descriptiveDataSet);

    }

    @Override

    public Map<Object, List<String>> getPropertyPathsMap() {

        Map<Object, List<String>> propertyMap = new HashMap<>();

        propertyMap.put(SpecimenOrObservationBase.class,WS_PROPERTY_PATH);

        return propertyMap;

    }

    public void addUpdateResult(UpdateResult result){

        if(updateResults==null){

            updateResults = new HashSet<>();

        }

        updateResults.add(result);

    }

    public void loadingDone() {

        stackLayout.topControl = matrix;

        matrix.getParent().layout();

    }

}