PropertiesView.java

/*********************************************************************************************
 * Copyright (c) 2014-2015  Software Behaviour Analysis Lab, Concordia University, Montreal, Canada
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of Eclipse Public License v1.0 License which
 * accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    Syed Shariyar Murtaza -- Initial design and implementation
 **********************************************************************************************/

package org.eclipse.tracecompass.totalads.ui.properties;

import java.util.ArrayList;
import java.util.HashSet;
import java.util.Iterator;
import org.apache.log4j.Logger;

import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.jface.viewers.ArrayContentProvider;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.TableViewer;
import org.eclipse.jface.viewers.TableViewerColumn;
import org.eclipse.tracecompass.totalads.algorithms.AlgorithmUtility;
import org.eclipse.tracecompass.totalads.algorithms.IDetectionAlgorithm;
import org.eclipse.tracecompass.totalads.dbms.DBMSFactory;
import org.eclipse.tracecompass.totalads.exceptions.TotalADSGeneralException;
import org.eclipse.tracecompass.totalads.ui.models.DataModelsView;
import org.eclipse.tracecompass.totalads.ui.properties.Messages;
import org.eclipse.tracecompass.totalads.ui.properties.NameLabelProvider;
import org.eclipse.tracecompass.totalads.ui.properties.NameVal;
import org.eclipse.tracecompass.totalads.ui.properties.PropertiesView;
import org.eclipse.tracecompass.totalads.ui.properties.ValueLabelProvider;
import org.eclipse.osgi.util.NLS;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Table;
import org.eclipse.ui.ISelectionListener;
import org.eclipse.ui.IWorkbenchPart;
import org.eclipse.ui.part.ViewPart;

/**
 * This class displays settings of a model selected last in the
 * {@link DataModelsView}
 *
 * @author <p>
 *         Syed Shariyar Murtaza justsshary@hotmail.com
 *         </p>
 *
 */
public class PropertiesView extends ViewPart implements ISelectionListener {

    /**
     * VIEW ID
     */
    public static final String VIEW_ID = "org.eclipse.tracecompass.totalads.ui.PropertiesView"; //$NON-NLS-1$
    private TableViewer viewer = null;
    private Table table = null;

    /**
     * Constructor
     */
    public PropertiesView() {

    }

    /*
	 *
	 */
    @Override
    public void createPartControl(Composite parent) {
        table = new Table(parent, SWT.H_SCROLL | SWT.V_SCROLL | SWT.BORDER);
        table.setHeaderVisible(true);
        table.setLinesVisible(true);
        viewer = new TableViewer(table);

        TableViewerColumn name = new TableViewerColumn(viewer, SWT.NONE);
        name.getColumn().setWidth(100);
        name.getColumn().setText(Messages.PropertiesView_NameTitle);
        name.setLabelProvider(new NameLabelProvider());

        TableViewerColumn value = new TableViewerColumn(viewer, SWT.NONE);
        value.getColumn().setWidth(50);
        value.getColumn().setText(Messages.PropertiesView_ValueTitle);
        value.setLabelProvider(new ValueLabelProvider());

        viewer.setContentProvider(new ArrayContentProvider());// new
                                                              // PropertiesTableContentProvider());

        // Registers a listener to Eclipse to get the list of models selected
        // (checked) by the user
        getSite().getPage().addSelectionListener(DataModelsView.VIEW_ID, this);
    }

    /*
     * (non-Javadoc)
     *
     * @see org.eclipse.ui.part.WorkbenchPart#setFocus()
     */
    @Override
    public void setFocus() {

    }

    /**
     * Updates the viewers with settings of the model selected in the end
     *
     * @param models
     *            List of selected models as a HashSet
     */
    private void updateViewer(HashSet<String> models) {
        String msg = ""; //$NON-NLS-1$
        try {
            if (models != null && !models.isEmpty()) {
                Iterator<String> it = models.iterator();
                String model = ""; //$NON-NLS-1$

                while (it.hasNext()) {
                    model = it.next();
                }

                IDetectionAlgorithm alg = AlgorithmUtility.getAlgorithmFromModelName(model);
                String[] defaultSettings = { "", "" }; //$NON-NLS-1$ //$NON-NLS-2$
                String[] settings = alg.getSettingsToDisplay(model, DBMSFactory.INSTANCE.getDataAccessObject());

                // Validate settings object
                if (settings != null && (settings.length % 2 == 1)) {
                    msg = NLS.bind(Messages.PropertiesView_InvalidSettings, model);

                    settings = defaultSettings;

                } else if (settings == null) {
                    settings = defaultSettings;
                }
                // Display settings if everything is alright
                ArrayList<NameVal> settingCollection = new ArrayList<>();
                settingCollection.add(new NameVal(Messages.PropertiesView_Algorithm, alg.getName()));
                settingCollection.add(new NameVal(Messages.PropertiesView_Model, model));

                for (int j = 0; j < settings.length; j += 2) {
                    NameVal keyVal = new NameVal(settings[j], settings[j + 1]);
                    settingCollection.add(keyVal);
                }
                if (alg.isOnlineLearningSupported()) {
                    settingCollection.add(new NameVal(Messages.PropertiesView_OnlineLearning, Messages.PropertiesView_Yes));
                } else {
                    settingCollection.add(new NameVal(Messages.PropertiesView_OnlineLearning, Messages.PropertiesView_No));
                }

                viewer.setInput(settingCollection);
                viewer.refresh();
            } else {
                if (viewer != null && !viewer.getTable().isDisposed()) {
                    viewer.getTable().removeAll();

                }
            }

        } // Catch Exceptions
        catch (TotalADSGeneralException e) {
            msg = e.getMessage();
        } catch (Exception e) {
            if (e.getMessage() != null) {
                msg = e.getMessage();
            } else {
                msg = Messages.PropertiesView_UnknwonErr;
            }
            Logger.getLogger(PropertiesView.class.getName()).error(e.getMessage(), e);
        } finally {
            // Display error message if there is something wrong
            if (!msg.isEmpty()) {
                String msgTitle = "TotalADS"; //$NON-NLS-1$
                MessageDialog.openError(getSite().getShell(), msgTitle, msg);

            }
        }

    }

    /*
     * (non-Javadoc)
     *
     * @see org.eclipse.ui.ISelectionListener#selectionChanged(org.eclipse.ui.
     * IWorkbenchPart, org.eclipse.jface.viewers.ISelection)
     */
    @Override
    @SuppressWarnings("unchecked")
    public void selectionChanged(IWorkbenchPart part, ISelection selection) {

        if (part instanceof DataModelsView) {
            Object obj = ((org.eclipse.jface.viewers.StructuredSelection) selection).getFirstElement();

            HashSet<String> modelList = (HashSet<String>) obj;
            updateViewer(modelList);
        }
    }

    /*
     * (non-Javadoc)
     *
     * @see org.eclipse.ui.part.WorkbenchPart#dispose()
     */
    @Override
    public void dispose() {
        getSite().getPage().removeSelectionListener(DataModelsView.VIEW_ID, this);
    }
}