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

import java.io.IOException;

import java.util.Arrays;

import java.util.Collection;

import java.util.Collections;

import java.util.HashMap;

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.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.widgets.Composite;

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

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.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"; //$NON-NLS-1$

    private WorkingSet workingSet;

    private ConversationHolder conversation;

    private ICdmEntitySession cdmEntitySession;

    @Inject

    private ESelectionService selService;

    @Inject

    private MDirtyable dirty;

    @Inject

    private MPart thisPart;

    private CharacterMatrix matrix;

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

        }

        matrix = new CharacterMatrix(parent, this);

    }

    public void init(UUID workingSetUuid, boolean treeView) {

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

        if(workingSet!=null){

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

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

                return;

            }

            matrix.initWorkingSet(workingSet);

            matrix.createTable(treeView);

            thisPart.setLabel(workingSet.getLabel());

            matrix.loadDescriptions(workingSet);

        }

    }

    public void setDirty() {

        this.dirty.setDirty(true);

    }

    public WorkingSet getWorkingSet() {

        return workingSet;

    }

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

        CdmStore.getService(IWorkingSetService.class).merge(workingSet, true);

        conversation.commit();

        dirty.setDirty(false);

    }

    @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<WorkingSet> getRootEntities() {

        return Collections.singleton(this.workingSet);

    }

    @Override

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

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

        propertyMap.put(SpecimenOrObservationBase.class,WS_PROPERTY_PATH);

        return propertyMap;

    }

}