qgsstringstatisticalsummary.h

Go to the documentation of this file.

/***************************************************************************
  qgsstringstatisticalsummary.h
  -----------------------------
  Date                 : May 2016
  Copyright            : (C) 2016 by Nyall Dawson
  Email                : nyall dot dawson at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSSTRINGSTATISTICALSUMMARY_H
#define QGSSTRINGSTATISTICALSUMMARY_H
 
#include "qgis.h"
#include "qgis_core.h"
 
#include <QSet>
#include <QVariantList>
 
/***************************************************************************
 * This class is considered CRITICAL and any change MUST be accompanied with
 * full unit tests in test_qgsstringstatisticalsummary.py.
 * See details in QEP #17
 ****************************************************************************/

 
class CORE_EXPORT QgsStringStatisticalSummary
{
  public:
    QgsStringStatisticalSummary( Qgis::StringStatistics stats = Qgis::StringStatistic::All );

    Qgis::StringStatistics statistics() const { return mStatistics; }

    void setStatistics( Qgis::StringStatistics stats ) { mStatistics = stats; }

    void reset();

    void calculate( const QStringList &values );

    void calculateFromVariants( const QVariantList &values );

    void addString( const QString &string );

    void addValue( const QVariant &value );

    void finalize();

    QVariant statistic( Qgis::StringStatistic stat ) const;

    int count() const { return mCount; }

    int countDistinct() const { return mValues.count(); }

    QSet< QString > distinctValues() const;

    int countMissing() const { return mCountMissing; }

    QString min() const { return mMin; }

    QString max() const { return mMax; }

    int minLength() const { return mMinLength; }

    int maxLength() const { return mMaxLength; }

    double meanLength() const { return mMeanLength; }

    QString minority() const { return mMinority; }

    QString majority() const { return mMajority; }

    static QString displayName( Qgis::StringStatistic statistic );
 
  private:
    Qgis::StringStatistics mStatistics;
 
    int mCount;
    QMap< QString, int > mValues;
    int mCountMissing;
    QString mMin;
    QString mMax;
    int mMinLength;
    int mMaxLength;
    long mSumLengths;
    double mMeanLength;
    QString mMinority;
    QString mMajority;
 
    void testString( const QString &string );
};
 
#endif // QGSSTRINGSTATISTICALSUMMARY_H