AbstractDataLoaderResultModel Class Reference

Description

Base class for result tables of data loaders. Derive from this class and return an instance in YourDataLoader::createResultModel(). The result table is the one on the right side when importing CSV files.

Definition at line 24 of file AbstractDataLoaderResultModel.h.

Inheritance diagram for AbstractDataLoaderResultModel:

Collaboration diagram for AbstractDataLoaderResultModel:

Public Types
enum class	ColumnType {   none , line , fileContent , raw ,   processed , error }

Public Member Functions
	AbstractDataLoaderResultModel ()
int	columnCount (const QModelIndex &parent=QModelIndex()) const override
QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const override
QVariant	headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const override
int	rowCount (const QModelIndex &parent) const override
QVector< int >	sectionsOfColumnType (ColumnType type) const
	The table header sections which belong to the given column type. Empty if this column type is not present at all. More...

Protected Member Functions
virtual QString	cellText (ColumnType type, int row, int column) const =0
	The text of the given cell. For convenience, column starts at 0 for the given column type, therefore it is not the same as the "real" section in the table header. This method will not be called for every row/column present in the table. Instead, optimizations will be done before calling it. E.g. the calculated values for lines which contain errors will never be called. Also raw or calculated contents will not be queried if a line is skipped. More...
virtual int	columnCount (ColumnType type) const =0
	The number of existing columns related to the given column type. 0 if the type is not present at all. More...
virtual QString	headerTextOfCalculatedColumn (int column) const =0
	Return the table header text for the given column. For convenience, column starts at 0 for first calculated column, therefore it is not the same as the "real" section in the table header. More...
virtual int	rowCount () const =0
	The row count of the result table. More...
virtual bool	rowHasError (const QModelIndex &index) const
	Returns whether the row given in the index contains errors. Only override this for performance reasons. More...
virtual bool	rowHasError (int row) const =0
	Returns whether the row given in the index contains errors. Row counting starts with 0. More...
virtual bool	rowIsSkipped (const QModelIndex &index) const
	Returns whether the row given in the index is a skipped row. Only override this for performance reasons. More...
virtual bool	rowIsSkipped (int row) const =0
	Returns whether the row given in the index is a skipped row. Row counting starts with 0. More...

Private Member Functions
ColumnType	columnType (const QModelIndex &index) const
	Calculates the column type of the given index. More...
ColumnType	columnType (int section) const
	Calculates the column type of the real header view section. More...
int	firstSectionOfColumnType (ColumnType type) const
	Calculates the first real header view section of the given column type. Returns -1 if the column type does not exist. More...
int	lastSectionOfColumnType (ColumnType type) const
	Calculates the last real header view section of the given column type. Returns -1 if the column type does not exist. More...

Private Attributes
QIcon	m_warningIcon

Member Enumeration Documentation

ColumnType

enum AbstractDataLoaderResultModel::ColumnType

strong

Enumerator
none
line
fileContent
raw
processed
error

Definition at line 26 of file AbstractDataLoaderResultModel.h.

{ none, line, fileContent, raw, processed, error };

Constructor & Destructor Documentation

AbstractDataLoaderResultModel()

AbstractDataLoaderResultModel::AbstractDataLoaderResultModel

(

)

Definition at line 38 of file AbstractDataLoaderResultModel.cpp.

{
    m_warningIcon = QIcon(":/images/warning_16x16.png");
}

References m_warningIcon.

Member Function Documentation

cellText()

virtual QString AbstractDataLoaderResultModel::cellText ( ColumnType  type, int  row, int  column  ) const

protectedpure virtual

The text of the given cell. For convenience, column starts at 0 for the given column type, therefore it is not the same as the "real" section in the table header. This method will not be called for every row/column present in the table. Instead, optimizations will be done before calling it. E.g. the calculated values for lines which contain errors will never be called. Also raw or calculated contents will not be queried if a line is skipped.

Implemented in QREDataLoaderResultModel, and AutomaticDataLoader1DResultModel.

Referenced by data().

columnCount() [1/2]

virtual int AbstractDataLoaderResultModel::columnCount ( ColumnType  type ) const

protectedpure virtual

The number of existing columns related to the given column type. 0 if the type is not present at all.

Implemented in QREDataLoaderResultModel, and AutomaticDataLoader1DResultModel.

columnCount() [2/2]

int AbstractDataLoaderResultModel::columnCount ( const QModelIndex &  parent = QModelIndex() ) const

override

Definition at line 43 of file AbstractDataLoaderResultModel.cpp.

{
    if (parent.isValid())
        return 0;
 
    const auto colTypes = {ColumnType::line, ColumnType::fileContent, ColumnType::raw,
                           ColumnType::processed, ColumnType::error};
 
    int cols = 0;
    for (ColumnType type : colTypes)
        cols += columnCount(type);
 
    return cols;
}

Referenced by firstSectionOfColumnType(), and lastSectionOfColumnType().

columnType() [1/2]

AbstractDataLoaderResultModel::ColumnType AbstractDataLoaderResultModel::columnType ( const QModelIndex &  index ) const

private

Calculates the column type of the given index.

Definition at line 195 of file AbstractDataLoaderResultModel.cpp.

{
    return columnType(index.column());
}

Referenced by data(), and headerData().

columnType() [2/2]

AbstractDataLoaderResultModel::ColumnType AbstractDataLoaderResultModel::columnType ( int  section ) const

private

Calculates the column type of the real header view section.

Definition at line 177 of file AbstractDataLoaderResultModel.cpp.

{
    const auto colTypes = {ColumnType::line, ColumnType::fileContent, ColumnType::raw,
                           ColumnType::processed, ColumnType::error};
 
    for (ColumnType type : colTypes) {
        const int firstSection = firstSectionOfColumnType(type);
        if (firstSection < 0)
            continue;
 
        if (section >= firstSection && section <= lastSectionOfColumnType(type))
            return type;
    }
 
    return ColumnType::none;
}

References error, fileContent, firstSectionOfColumnType(), lastSectionOfColumnType(), line, none, processed, and raw.

Here is the call graph for this function:

data()

QVariant AbstractDataLoaderResultModel::data ( const QModelIndex &  index, int  role = Qt::DisplayRole  ) const

override

Definition at line 63 of file AbstractDataLoaderResultModel.cpp.

{
    if (!index.isValid())
        return QVariant();
 
    const auto colType = columnType(index);
 
    if (role == Qt::BackgroundRole) {
        switch (colType) {
        case ColumnType::line:
        case ColumnType::fileContent:
            return Palette::backgroundColorFileContent;
        case ColumnType::raw:
            return rowIsSkipped(index) ? QVariant() : Palette::backgroundColorRawContent;
        case ColumnType::processed:
            return rowIsSkipped(index) || rowHasError(index)
                       ? QVariant()
                       : Palette::backgroundColorProcessedContent;
        case ColumnType::error:
            return rowIsSkipped(index) || !rowHasError(index) ? QVariant()
                                                              : Palette::backgroundColorErrors;
        default:
            return QVariant();
        }
    }
 
    if (role == Qt::ForegroundRole) {
        if (colType == ColumnType::fileContent && rowIsSkipped(index))
            return Palette::skippedLineTextColor;
        return QVariant();
    }
 
    if (role == Qt::DisplayRole) {
        switch (colType) {
        case ColumnType::line:
            return QString::number(index.row() + 1);
 
        case ColumnType::fileContent: {
            QString lineContent =
                cellText(colType, index.row(), index.column() - firstSectionOfColumnType(colType));
            lineContent.replace("\t", " --> ");
            return lineContent;
        }
 
        case ColumnType::raw:
        case ColumnType::error: {
            if (!rowIsSkipped(index))
                return cellText(colType, index.row(),
                                index.column() - firstSectionOfColumnType(colType));
        } break;
 
        case ColumnType::processed: {
            if (!rowIsSkipped(index) && !rowHasError(index))
                return cellText(colType, index.row(),
                                index.column() - firstSectionOfColumnType(colType));
        } break;
        default:
            break;
        }
 
        return QVariant();
    }
 
    if (role == Qt::DecorationRole && (colType == ColumnType::line || colType == ColumnType::error)
        && rowHasError(index))
        return m_warningIcon;
 
    if (role == Qt::TextAlignmentRole && colType == ColumnType::line)
        return QVariant(Qt::AlignRight | Qt::AlignVCenter);
 
    if (role == Qt::ToolTipRole && colType == ColumnType::line && rowHasError(index))
        return cellText(ColumnType::error, index.row(), 0);
 
    return QVariant();
}

References cellText(), columnType(), error, fileContent, firstSectionOfColumnType(), line, m_warningIcon, processed, raw, rowHasError(), and rowIsSkipped().

Referenced by AutomaticDataLoader1DResultModel::cellText(), and AutomaticDataLoader1DResultModel::rowCount().

Here is the call graph for this function:

firstSectionOfColumnType()

int AbstractDataLoaderResultModel::firstSectionOfColumnType ( ColumnType  type ) const

private

Calculates the first real header view section of the given column type. Returns -1 if the column type does not exist.

Definition at line 200 of file AbstractDataLoaderResultModel.cpp.

{
    const int lineColumnCount = columnCount(ColumnType::line);
    const int fileContentColumnCount = columnCount(ColumnType::fileContent);
 
    if (type == ColumnType::line)
        return lineColumnCount > 0 ? 0 : -1;
 
    if (type == ColumnType::fileContent)
        return columnCount(ColumnType::fileContent) > 0 ? lineColumnCount : -1;
 
    if (type == ColumnType::raw) {
        const bool hasRawContent = columnCount(ColumnType::raw) > 0;
        return hasRawContent ? lineColumnCount + fileContentColumnCount : -1;
    }
 
    if (type == ColumnType::processed) {
        const bool hasProcessedContent = columnCount(ColumnType::processed) > 0;
        return hasProcessedContent
                   ? (lineColumnCount + fileContentColumnCount + columnCount(ColumnType::raw))
                   : -1;
    }
 
    if (type == ColumnType::error) {
        const bool hasParsingErrors = columnCount(ColumnType::error) > 0;
        return hasParsingErrors
                   ? (lineColumnCount + fileContentColumnCount + columnCount(ColumnType::raw)
                      + columnCount(ColumnType::processed))
                   : -1;
    }
 
    return -1;
}

References columnCount(), error, fileContent, line, processed, and raw.

Referenced by columnType(), data(), headerData(), lastSectionOfColumnType(), and sectionsOfColumnType().

Here is the call graph for this function:

headerData()

QVariant AbstractDataLoaderResultModel::headerData ( int  section, Qt::Orientation  orientation, int  role = Qt::DisplayRole  ) const

override

Definition at line 140 of file AbstractDataLoaderResultModel.cpp.

{
    if (role == Qt::DisplayRole && orientation == Qt::Horizontal) {
        switch (columnType(section)) {
        case ColumnType::line:
            return "Line";
        case ColumnType::fileContent:
            return "File content (text)";
        case ColumnType::raw:
            return QString("Column %1 raw")
                .arg(section - firstSectionOfColumnType(ColumnType::raw) + 1);
        case ColumnType::processed:
            return headerTextOfCalculatedColumn(section
                                                - firstSectionOfColumnType(ColumnType::processed));
        case ColumnType::error:
            return "Parser warnings";
        default:
            return QVariant();
        }
    }
 
    return QAbstractTableModel::headerData(section, orientation, role);
}

References columnType(), error, fileContent, firstSectionOfColumnType(), headerTextOfCalculatedColumn(), line, processed, and raw.

Here is the call graph for this function:

headerTextOfCalculatedColumn()

virtual QString AbstractDataLoaderResultModel::headerTextOfCalculatedColumn ( int  column ) const

protectedpure virtual

Return the table header text for the given column. For convenience, column starts at 0 for first calculated column, therefore it is not the same as the "real" section in the table header.

Implemented in QREDataLoaderResultModel, and AutomaticDataLoader1DResultModel.

Referenced by headerData().

lastSectionOfColumnType()

int AbstractDataLoaderResultModel::lastSectionOfColumnType ( ColumnType  type ) const

private

Calculates the last real header view section of the given column type. Returns -1 if the column type does not exist.

Definition at line 234 of file AbstractDataLoaderResultModel.cpp.

{
    const int firstSection = firstSectionOfColumnType(type);
    if (firstSection == -1)
        return -1;
 
    return firstSection + columnCount(type) - 1;
}

References columnCount(), and firstSectionOfColumnType().

Referenced by columnType(), and sectionsOfColumnType().

Here is the call graph for this function:

rowCount() [1/2]

virtual int AbstractDataLoaderResultModel::rowCount ( ) const

protectedpure virtual

The row count of the result table.

Implemented in QREDataLoaderResultModel, and AutomaticDataLoader1DResultModel.

Referenced by rowCount().

rowCount() [2/2]

int AbstractDataLoaderResultModel::rowCount ( const QModelIndex &  parent ) const

override

Definition at line 58 of file AbstractDataLoaderResultModel.cpp.

{
    return parent.isValid() ? 0 : rowCount();
}

References rowCount().

Here is the call graph for this function:

rowHasError() [1/2]

bool AbstractDataLoaderResultModel::rowHasError ( const QModelIndex &  index ) const

protectedvirtual

Returns whether the row given in the index contains errors. Only override this for performance reasons.

Definition at line 248 of file AbstractDataLoaderResultModel.cpp.

{
    return rowHasError(index.row());
}

Referenced by data().

rowHasError() [2/2]

virtual bool AbstractDataLoaderResultModel::rowHasError ( int  row ) const

protectedpure virtual

Returns whether the row given in the index contains errors. Row counting starts with 0.

Implemented in QREDataLoaderResultModel, and AutomaticDataLoader1DResultModel.

rowIsSkipped() [1/2]

bool AbstractDataLoaderResultModel::rowIsSkipped ( const QModelIndex &  index ) const

protectedvirtual

Returns whether the row given in the index is a skipped row. Only override this for performance reasons.

Definition at line 243 of file AbstractDataLoaderResultModel.cpp.

{
    return rowIsSkipped(index.row());
}

Referenced by data().

rowIsSkipped() [2/2]

virtual bool AbstractDataLoaderResultModel::rowIsSkipped ( int  row ) const

protectedpure virtual

Returns whether the row given in the index is a skipped row. Row counting starts with 0.

Implemented in QREDataLoaderResultModel, and AutomaticDataLoader1DResultModel.

sectionsOfColumnType()

QVector< int > AbstractDataLoaderResultModel::sectionsOfColumnType

(

ColumnType

type

)

const

The table header sections which belong to the given column type. Empty if this column type is not present at all.

Definition at line 165 of file AbstractDataLoaderResultModel.cpp.

{
    QVector<int> sections;
    for (int section = firstSectionOfColumnType(type); section <= lastSectionOfColumnType(type);
         section++)
        if (section >= 0)
            sections << section;
 
    return sections;
}

References firstSectionOfColumnType(), and lastSectionOfColumnType().

Referenced by SpecularDataImportWidget::updatePreview().

Here is the call graph for this function:

Member Data Documentation

m_warningIcon

QIcon AbstractDataLoaderResultModel::m_warningIcon

private

Definition at line 93 of file AbstractDataLoaderResultModel.h.

Referenced by AbstractDataLoaderResultModel(), and data().

---

The documentation for this class was generated from the following files:

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Support/IO/AbstractDataLoaderResultModel.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Support/IO/AbstractDataLoaderResultModel.cpp