1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
3 * This file is part of the LibreOffice project.
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/.
9 * This file incorporates work covered by the following license notice:
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 .
20 #ifndef INCLUDED_SC_INC_DPTABDAT_HXX
21 #define INCLUDED_SC_INC_DPTABDAT_HXX
23 #include "dpfilteredcache.hxx"
24 #include "calcmacros.hxx"
26 #include <svl/zforlist.hxx>
28 #include <unordered_set>
31 #define SC_DAPI_HIERARCHY_FLAT 0
32 #define SC_DAPI_HIERARCHY_QUARTER 1
33 #define SC_DAPI_HIERARCHY_WEEK 2
35 #define SC_DAPI_FLAT_LEVELS 1 // single level for flat dates
36 #define SC_DAPI_QUARTER_LEVELS 4 // levels in year/quarter/month/day hierarchy
37 #define SC_DAPI_WEEK_LEVELS 3 // levels in year/week/day hierarchy
39 #define SC_DAPI_LEVEL_YEAR 0
40 #define SC_DAPI_LEVEL_QUARTER 1
41 #define SC_DAPI_LEVEL_MONTH 2
42 #define SC_DAPI_LEVEL_DAY 3
43 #define SC_DAPI_LEVEL_WEEK 4
44 #define SC_DAPI_LEVEL_WEEKDAY 5
46 class ScDPResultMember
;
53 * Base class that abstracts different data source types of a datapilot
56 class SC_DLLPUBLIC ScDPTableData
58 // cached data for GetDatePart
63 const ScDocument
* mpDoc
;
66 /** This structure stores dimension information used when calculating
67 results. These data are read only during result calculation, so it
68 should be passed as a const instance. */
71 ::std::vector
<long> aColLevelDims
;
72 ::std::vector
<ScDPDimension
*> aColDims
;
73 ::std::vector
<ScDPLevel
*> aColLevels
;
74 ::std::vector
<long> aRowLevelDims
;
75 ::std::vector
<ScDPDimension
*> aRowDims
;
76 ::std::vector
<ScDPLevel
*> aRowLevels
;
77 ::std::vector
<long> aPageDims
;
78 ::std::vector
<long> aDataSrcCols
;
80 ScDPInitState
* pInitState
;
81 ScDPResultMember
* pColRoot
;
82 ScDPResultMember
* pRowRoot
;
87 ScDPTableData(const ScDPTableData
&) = delete;
88 const ScDPTableData
& operator=(const ScDPTableData
&) = delete;
89 ScDPTableData(const ScDocument
* pDoc
);
90 virtual ~ScDPTableData();
92 OUString
GetFormattedString(long nDim
, const ScDPItemData
& rItem
, bool bLocaleIndependent
) const;
94 long GetDatePart( long nDateVal
, long nHierarchy
, long nLevel
);
96 //! use (new) typed collection instead of ScStrCollection
97 //! or separate Str and ValueCollection
99 virtual long GetColumnCount() = 0;
100 virtual const std::vector
< SCROW
>& GetColumnEntries( long nColumn
) ;
101 virtual OUString
getDimensionName(long nColumn
) = 0;
102 virtual bool getIsDataLayoutDimension(long nColumn
) = 0;
103 virtual bool IsDateDimension(long nDim
) = 0;
104 virtual sal_uInt32
GetNumberFormat(long nDim
);
105 sal_uInt32
GetNumberFormatByIdx( NfIndexTableOffset
);
106 virtual void DisposeData() = 0;
107 virtual void SetEmptyFlags( bool bIgnoreEmptyRows
, bool bRepeatIfEmpty
) = 0;
109 virtual bool IsRepeatIfEmpty();
111 virtual void CreateCacheTable() = 0;
112 virtual void FilterCacheTable(const std::vector
<ScDPFilteredCache::Criterion
>& rCriteria
, const std::unordered_set
<sal_Int32
>& rDataDims
) = 0;
113 virtual void GetDrillDownData(const std::vector
<ScDPFilteredCache::Criterion
>& rCriteria
,
114 const std::unordered_set
<sal_Int32
>& rCatDims
,
115 css::uno::Sequence
< css::uno::Sequence
< css::uno::Any
> >& rData
) = 0;
116 virtual void CalcResults(CalcInfo
& rInfo
, bool bAutoShow
) = 0;
117 virtual const ScDPFilteredCache
& GetCacheTable() const = 0;
118 virtual void ReloadCacheTable() = 0;
120 // override in ScDPGroupTableData:
121 virtual bool IsBaseForGroup(long nDim
) const;
122 virtual long GetGroupBase(long nGroupDim
) const;
123 virtual bool IsNumOrDateGroup(long nDim
) const;
124 virtual bool IsInGroup( const ScDPItemData
& rGroupData
, long nGroupIndex
,
125 const ScDPItemData
& rBaseData
, long nBaseIndex
) const;
126 virtual bool HasCommonElement( const ScDPItemData
& rFirstData
, long nFirstIndex
,
127 const ScDPItemData
& rSecondData
, long nSecondIndex
) const;
129 virtual long GetMembersCount( long nDim
);
130 const ScDPItemData
* GetMemberByIndex( long nDim
, long nIndex
);
131 virtual const ScDPItemData
* GetMemberById( long nDim
, long nId
);
132 virtual long GetSourceDim( long nDim
);
133 virtual long Compare( long nDim
, long nDataId1
, long nDataId2
);
136 virtual void Dump() const;
140 /** This structure stores vector arrays that hold intermediate data for
141 each row during cache table iteration. */
144 ::std::vector
< SCROW
> aColData
;
145 ::std::vector
< SCROW
> aRowData
;
146 ::std::vector
< SCROW
> aPageData
;
147 ::std::vector
<ScDPValue
> aValues
;
150 void FillRowDataFromCacheTable(sal_Int32 nRow
, const ScDPFilteredCache
& rCacheTable
, const CalcInfo
& rInfo
, CalcRowData
& rData
);
151 static void ProcessRowData(CalcInfo
& rInfo
, const CalcRowData
& rData
, bool bAutoShow
);
152 void CalcResultsFromCacheTable(const ScDPFilteredCache
& rCacheTable
, CalcInfo
& rInfo
, bool bAutoShow
);
155 void GetItemData(const ScDPFilteredCache
& rCacheTable
, sal_Int32 nRow
,
156 const ::std::vector
<long>& rDims
, ::std::vector
< SCROW
>& rItemData
);
160 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */