sc/inc/dpfilteredcache.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_SC_INC_DPFILTEREDCACHE_HXX
  21 #define INCLUDED_SC_INC_DPFILTEREDCACHE_HXX
  22
  23 #include <sal/types.h>
  24 #include "dpitemdata.hxx"
  25 #include "calcmacros.hxx"
  26
  27 #include <unordered_set>
  28 #include <vector>
  29
  30 #include <mdds/flat_segment_tree.hpp>
  31
  32 class ScDPCache;
  33 struct ScDPValue;
  34 struct ScQueryParam;
  35
  36 /**
  37  * This class is only a wrapper to the actual cache, to provide filtering on
  38  * the raw data based on the query filter and/or page field filters.
  39  */
  40 class SC_DLLPUBLIC ScDPFilteredCache
  41 {
  42     typedef mdds::flat_segment_tree<SCROW, bool> RowFlagType;
  43
  44 public:
  45     /** interface class used for filtering of rows. */
  46     class FilterBase
  47     {
  48     public:
  49         virtual ~FilterBase() {}
  50         /** returns true if the matching condition is met for a single cell
  51             value, or false otherwise. */
  52         virtual bool match( const  ScDPItemData& rCellData ) const = 0;
  53
  54         virtual std::vector<ScDPItemData> getMatchValues() const = 0;
  55     };
  56
  57     /** ordinary single-item filter. */
  58     class SingleFilter : public FilterBase
  59     {
  60     public:
  61         explicit SingleFilter(const ScDPItemData &rItem);
  62
  63         virtual bool match(const ScDPItemData& rCellData) const override;
  64         virtual std::vector<ScDPItemData> getMatchValues() const override;
  65
  66     private:
  67         ScDPItemData maItem;
  68     };
  69
  70     /** multi-item (group) filter. */
  71     class GroupFilter : public FilterBase
  72     {
  73     public:
  74         GroupFilter();
  75         virtual bool match(const ScDPItemData& rCellData) const override;
  76         virtual std::vector<ScDPItemData> getMatchValues() const override;
  77         void addMatchItem(const ScDPItemData& rItem);
  78         size_t getMatchItemCount() const;
  79
  80     private:
  81         ::std::vector<ScDPItemData> maItems;
  82     };
  83
  84     /** single filtering criterion. */
  85     struct Criterion
  86     {
  87         sal_Int32 mnFieldIndex;
  88         std::shared_ptr<FilterBase> mpFilter;
  89
  90         Criterion();
  91     };
  92
  93     ScDPFilteredCache(const ScDPCache& rCache);
  94     ~ScDPFilteredCache();
  95
  96     sal_Int32 getRowSize() const;
  97     sal_Int32 getColSize() const;
  98
  99     const ScDPCache& getCache() const { return mrCache;}
 100
 101     void fillTable(const ScQueryParam& rQuery, bool bIgnoreEmptyRows, bool bRepeatIfEmpty);
 102
 103     void fillTable();
 104
 105     /** Check whether a specified row is active or not.  When a row is active,
 106         it is used in calculation of the results data.  A row becomes inactive
 107         when it is filtered out by page field. */
 108     bool isRowActive(sal_Int32 nRow, sal_Int32* pLastRow = nullptr) const;
 109
 110     /** Set filter on/off flag to each row to control visibility.  The caller
 111         must ensure that the table is filled before calling this function. */
 112     void filterByPageDimension(const std::vector<Criterion>& rCriteria, const std::unordered_set<sal_Int32>& rRepeatIfEmptyDims);
 113
 114     /** Get the cell instance at specified location within the data grid. Note
 115         that the data grid doesn't include the header row.  Don't delete the
 116         returned object! */
 117     const ScDPItemData* getCell(SCCOL nCol, SCROW nRow, bool bRepeatIfEmpty) const;
 118     void  getValue( ScDPValue& rVal, SCCOL nCol, SCROW nRow) const;
 119     OUString getFieldName(SCCOL nIndex) const;
 120
 121    /** Get the unique entries for a field specified by index.  The caller must
 122        make sure that the table is filled before calling function, or it will
 123        get an empty collection. */
 124     const ::std::vector<SCROW>& getFieldEntries( sal_Int32 nColumn ) const;
 125
 126     /** Filter the table based on the specified criteria, and copy the
 127         result to rTabData.  This method is used, for example, to generate
 128         a drill-down data table. */
 129     void filterTable(const std::vector<Criterion>& rCriteria,
 130                      css::uno::Sequence< css::uno::Sequence< css::uno::Any > >& rTabData,
 131                      const std::unordered_set<sal_Int32>& rRepeatIfEmptyDims);
 132
 133     void clear();
 134     bool empty() const;
 135
 136 #if DUMP_PIVOT_TABLE
 137     static void dumpRowFlag( const RowFlagType& rFlag );
 138     void dump() const;
 139 #endif
 140
 141 private:
 142     ScDPFilteredCache(const ScDPFilteredCache&) = delete;
 143
 144     /**
 145      * Check if a given row meets all specified criteria.
 146      *
 147      * @param nRow index of row to be tested.
 148      * @param rCriteria a list of criteria
 149      */
 150     bool isRowQualified(sal_Int32 nRow, const ::std::vector<Criterion>& rCriteria, const std::unordered_set<sal_Int32>& rRepeatIfEmptyDims) const;
 151
 152 private:
 153
 154     /** unique field entires for each field (column). */
 155     ::std::vector< ::std::vector<SCROW> > maFieldEntries;
 156
 157     /** Rows visible by standard filter query. */
 158     RowFlagType maShowByFilter;
 159     /** Rows visible by page dimension filtering. */
 160     RowFlagType maShowByPage;
 161
 162     const ScDPCache& mrCache;
 163 };
 164 #endif
 165
 166 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */