SortTableWorkspaceDialog.cpp

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
//------------------------------------------------------------------------------
// Includes
//------------------------------------------------------------------------------
#include "MantidQtWidgets/Plugins/AlgorithmDialogs/SortTableWorkspaceDialog.h"
#include "MantidAPI/AnalysisDataService.h"
#include "MantidAPI/ITableWorkspace.h"
#include "MantidKernel/Exception.h"
#include "MantidQtWidgets/Common/AlgorithmInputHistory.h"
 
using namespace MantidQt::API;
 
namespace MantidQt::CustomDialogs {
 
// Declare the dialog. Name must match the class name
DECLARE_DIALOG(SortTableWorkspaceDialog)
 
 
SortTableWorkspaceDialog::SortTableWorkspaceDialog(QWidget *parent) : API::AlgorithmDialog(parent), m_form() {}
 
void SortTableWorkspaceDialog::initLayout() {
  // set up the GUI elements
  m_form.setupUi(this);
 
  // add the Run/Cancel buttons
  m_form.dialogLayout->addLayout(this->createDefaultButtonLayout());
 
  // correct the tab order
  QWidget::setTabOrder(m_form.groupBox, m_form.cbColumnName);
  QWidget::setTabOrder(m_form.cbColumnName, m_form.cbAscending);
 
  // disable Add/Remove buttons in case there are no table workspaces at all
  m_form.btnRemoveColumn->setEnabled(false);
  m_form.btnAddColumn->setEnabled(false);
 
  // connect the slots
  connect(m_form.workspace, SIGNAL(currentTextChanged(const QString &)), this, SLOT(workspaceChanged(const QString &)));
  connect(m_form.workspace, SIGNAL(emptied()), this, SLOT(clearGUI()));
  connect(m_form.cbColumnName, SIGNAL(currentIndexChanged(int)), this, SLOT(changedColumnName(int)));
  connect(m_form.btnAddColumn, SIGNAL(clicked()), this, SLOT(addColumn()));
  connect(m_form.btnRemoveColumn, SIGNAL(clicked()), this, SLOT(removeColumn()));
 
  tieStaticWidgets(true);
}
 
void SortTableWorkspaceDialog::parseInput() {
  QStringList columns;
  QStringList ascending;
 
  // extract column names to sort by from the controls, sort order too
  auto n = m_sortColumns.size();
  for (int i = 0; i < n; ++i) {
    auto itemColumn = m_form.columnsLayout->itemAtPosition(i, 1);
    auto itemAscending = m_form.columnsLayout->itemAtPosition(i, 2);
    if (!itemColumn || !itemColumn->widget() || !itemAscending || !itemAscending->widget()) {
      throw std::logic_error("Logic error in SortTableWorkspaceDialog: internal inconsistency.");
    }
 
    auto name = dynamic_cast<QComboBox *>(itemColumn->widget())->currentText();
    auto ia = dynamic_cast<QComboBox *>(itemAscending->widget())->currentIndex();
    columns << name;
    ascending << QString::number(ia == 0 ? 1 : 0);
  }
 
  // pass the properties to the algorithm
  storePropertyValue("Columns", columns.join(","));
  storePropertyValue("Ascending", ascending.join(","));
}
 
void SortTableWorkspaceDialog::tieStaticWidgets(const bool /*unused*/) {
  QStringList allowedTypes;
  allowedTypes << "TableWorkspace";
  m_form.workspace->setWorkspaceTypes(allowedTypes);
  tie(m_form.workspace, "InputWorkspace");
  tie(m_form.output, "OutputWorkspace");
  if (!m_form.workspace->currentText().isEmpty()) {
    // start with output == input
    m_form.output->setText(m_form.workspace->currentText());
  }
}
 
void SortTableWorkspaceDialog::workspaceChanged(const QString &wsName) {
  // start with output == input
  m_form.output->setText(wsName);
  // prepare the controls for new values
  clearGUI();
  if (wsName.isEmpty())
    return;
  try {
    auto ws =
        Mantid::API::AnalysisDataService::Instance().retrieveWS<Mantid::API::ITableWorkspace>(wsName.toStdString());
    if (!ws)
      return;
    m_columnNames.clear();
    // get and cache the column names from the workspace
    auto columnNames = ws->getColumnNames();
    for (const auto &columnName : columnNames) {
      m_columnNames << QString::fromStdString(columnName);
    }
    m_form.cbColumnName->addItems(m_columnNames);
    // the GUI already has the controls to set the first column
    // if there are no other columns in the table no more names can be added
    if (m_columnNames.size() <= 1) {
      m_form.btnAddColumn->setEnabled(false);
    } else {
      m_form.btnAddColumn->setEnabled(true);
    }
    // cache the selected column name
    m_sortColumns[0] = m_form.cbColumnName->currentText();
  } catch (Mantid::Kernel::Exception::NotFoundError &) {
    return;
  }
}
 
void SortTableWorkspaceDialog::clearGUI() {
  m_columnNames.clear();
  m_form.lblColumnName->setText("Column");
  m_form.cbColumnName->clear();
  m_form.cbAscending->setCurrentIndex(0);
  m_form.btnAddColumn->setEnabled(false);
  m_form.btnRemoveColumn->setEnabled(false);
  // remove controls for any additional columns
  auto nRows = m_form.columnsLayout->rowCount();
  for (auto row = nRows - 1; row > 0; --row) {
    for (int col = 0; col < 3; ++col) {
      auto item = m_form.columnsLayout->itemAtPosition(row, col);
      if (item) {
        auto index = m_form.columnsLayout->indexOf(item->widget());
        m_form.columnsLayout->takeAt(index);
        item->widget()->deleteLater();
      }
    }
  }
  // leave a space for one column name
  // size of m_sortColumns is used to get the number of selected columns
  m_sortColumns.clear();
  m_sortColumns << "";
}
 
void SortTableWorkspaceDialog::addColumn() {
  m_form.lblColumnName->setText("Column 1");
  // create controls for setting new column
  int newRow = static_cast<int>(m_sortColumns.size());
  assert(newRow <= m_columnNames.size());
  QLabel *label = new QLabel(QString("Column %1").arg(newRow + 1));
  auto *columnName = new QComboBox();
  columnName->addItems(m_columnNames);
  columnName->setToolTip(m_form.cbColumnName->toolTip());
  connect(columnName, SIGNAL(currentIndexChanged(int)), this, SLOT(changedColumnName(int)));
  auto *ascending = new QComboBox();
  ascending->addItem("Ascending");
  ascending->addItem("Descending");
  ascending->setToolTip(m_form.cbAscending->toolTip());
  // add them to the layout
  m_form.columnsLayout->addWidget(label, newRow, 0);
  m_form.columnsLayout->addWidget(columnName, newRow, 1);
  m_form.columnsLayout->addWidget(ascending, newRow, 2);
  // correct the tab order
  QWidget::setTabOrder(m_form.columnsLayout->itemAtPosition(newRow - 1, 2)->widget(), columnName);
  QWidget::setTabOrder(columnName, ascending);
 
  // suggest a name for the new column: one that hasn't been used in
  // other sort columns
  const auto it = std::find_if(m_columnNames.cbegin(), m_columnNames.cend(),
                               [&](const auto &name) { return !m_sortColumns.contains(name); });
  if (it != m_columnNames.cend()) {
    columnName->setItemText(-1, *it);
  }
  // cache the column name
  m_sortColumns << columnName->currentText();
  // set the Add/Remove buttons into a correct state
  if (m_sortColumns.size() == m_columnNames.size()) {
    m_form.btnAddColumn->setEnabled(false);
  }
  m_form.btnRemoveColumn->setEnabled(true);
}
 
void SortTableWorkspaceDialog::changedColumnName(int /*unused*/) {
  // don't try to figure out which column changed - just reset all cached names
  auto n = m_sortColumns.size();
  for (int i = 0; i < n; ++i) {
    auto item = m_form.columnsLayout->itemAtPosition(i, 1);
    if (!item || !item->widget() || !dynamic_cast<QComboBox *>(item->widget())) {
      throw std::logic_error("Logic error in SortTableWorkspaceDialog: internal inconsistency.");
    }
 
    auto name = dynamic_cast<QComboBox *>(item->widget())->currentText();
    m_sortColumns[i] = name;
  }
}
 
void SortTableWorkspaceDialog::removeColumn() {
  assert(m_columnNames.size() > 1);
  // remove the last column
  m_sortColumns.removeLast();
  int row = static_cast<int>(m_sortColumns.size());
  for (int col = 0; col < 3; ++col) {
    auto item = m_form.columnsLayout->itemAtPosition(row, col);
    if (item) {
      auto index = m_form.columnsLayout->indexOf(item->widget());
      m_form.columnsLayout->takeAt(index);
      item->widget()->deleteLater();
    }
  }
  // leave the Add/Remove buttons in a correct state
  if (m_sortColumns.size() == 1) {
    m_form.btnRemoveColumn->setEnabled(false);
    m_form.lblColumnName->setText("Column");
  }
  m_form.btnAddColumn->setEnabled(true);
}
 
} // namespace MantidQt::CustomDialogs