summaryrefslogtreecommitdiff
path: root/oox/inc/oox/xls/pivottablebuffer.hxx
blob: 1c8876d7d876d3aadce4423830b929517e88b8ac (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: pivottablebuffer.hxx,v $
 *
 *  $Revision: 1.2 $
 *
 *  last change: $Author: rt $ $Date: 2008-01-17 08:05:49 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2007 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/

#ifndef OOX_XLS_PIVOTTABLEBUFFER_HXX
#define OOX_XLS_PIVOTTABLEBUFFER_HXX

#include <hash_map>
#include <vector>
#include <boost/shared_ptr.hpp>
#include <com/sun/star/table/CellRangeAddress.hpp>
#include <com/sun/star/table/CellAddress.hpp>
#include "oox/xls/sheetcellrangemap.hxx"
#include "oox/xls/workbookhelper.hxx"

namespace oox {
namespace xls {

// ============================================================================

struct PivotCacheField
{
    ::rtl::OUString                     maName;
    ::std::vector< ::rtl::OUString >    maItems;
};

typedef ::std::vector< PivotCacheField >    PivotCacheFields;

// ----------------------------------------------------------------------------

struct PivotCacheData
{
    enum SourceType
    {
        WORKSHEET,
        EXTERNAL
    };
    SourceType              meSourceType;

    struct BaseSource {};

    struct WorksheetSource : public BaseSource
    {
        ::rtl::OUString maSrcRange;
        ::rtl::OUString maSheetName;
    };

    struct ExternalSource : public BaseSource
    {
    };

    typedef ::boost::shared_ptr< BaseSource >   SourceRef;
    SourceRef                                   mpSourceProp;

    PivotCacheFields                            maFields;

    PivotCacheData();

    WorksheetSource* getWorksheetSource() const;
    ExternalSource*  getExternalSource() const;
};

// ============================================================================

struct PivotTableField
{
    enum AxisType
    {
        COLUMN,
        ROW,
        PAGE,
        VALUES
    };

    AxisType    meAxis;

    ::std::vector< sal_uInt32 > maItems;    /// IDs pointing to corresponding items in pivot cache field.
    bool mbDataField;

    PivotTableField();
};

typedef ::std::vector< PivotTableField >    PivotTableFields;

// ----------------------------------------------------------------------------

struct PivotTableData
{
    ::com::sun::star::table::CellRangeAddress   maRange;    /// destination cell range
    sal_uInt32          mnCacheId;                          /// cache ID

    PivotTableFields    maFields;

    PivotTableData();
};

// ----------------------------------------------------------------------------

class PivotTableBuffer : public WorkbookHelper
{
public:
    explicit            PivotTableBuffer( const WorkbookHelper& rHelper );

    /** Returns a pointer to the pivot cache instance by ID. */
    const PivotCacheData*     getPivotCache( sal_uInt32 nCacheId ) const;

    /** Sets a new pivot cache data.  It will overwrite an existing cache data if
        any exists at the specified ID location. */
    void                setPivotCache( sal_uInt32 nCacheId, const PivotCacheData& aData );

    PivotTableData*     getPivotTable( const ::rtl::OUString& aName );

    void                setPivotTable( const ::rtl::OUString& aName, const PivotTableData& aData );

    /** Check if a given cell address overlaps one of pivot table destination
        ranges. */
    bool                isOverlapping( const ::com::sun::star::table::CellAddress& aCellAddress ) const;

    void                finalizeImport() const;

private:

    typedef ::std::hash_map< sal_uInt32, PivotCacheData >   PivotCacheMapType;
    typedef ::std::hash_map< ::rtl::OUString, PivotTableData, ::rtl::OUStringHash, ::std::equal_to< ::rtl::OUString > > PivotTableMapType;

    void                writePivotTable( const ::rtl::OUString& aName, const PivotTableData& aData ) const;

    bool                getSourceRange( const ::rtl::OUString& aSheetName, const ::rtl::OUString& aRefName,
                                        ::com::sun::star::table::CellRangeAddress& rRange ) const;

private:

    PivotCacheMapType       maPivotCacheMap;    /// A collection of pivot cache data organized by IDs.
    PivotTableMapType       maPivotTableMap;    /// A collection of pivot table data organized by IDs.
    SheetCellRangeMap       maCellRangeMap;
};

// ============================================================================

} // namespace xls
} // namespace oox

#endif