sc/inc/dpobject.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: dpobject.hxx,v $
  10  * $Revision: 1.15 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef SC_DPOBJECT_HXX
  32 #define SC_DPOBJECT_HXX
  33
  34 #include "scdllapi.h"
  35 #include "global.hxx"
  36 #include "address.hxx"
  37 #include "collect.hxx"
  38 #include "dpoutput.hxx"
  39 #include <com/sun/star/sheet/XDimensionsSupplier.hpp>
  40
  41 #include <boost/shared_ptr.hpp>
  42
  43 //------------------------------------------------------------------
  44
  45 namespace com { namespace sun { namespace star { namespace sheet {
  46
  47     struct DataPilotTablePositionData;
  48     struct DataPilotTableHeaderData;
  49
  50 }}}}
  51
  52 namespace com { namespace sun { namespace star { namespace sheet {
  53     struct DataPilotFieldFilter;
  54 }}}}
  55
  56 class Rectangle;
  57 class SvStream;
  58 class ScDPSaveData;
  59 class ScDPOutput;
  60 class ScPivot;
  61 class ScPivotCollection;
  62 struct ScPivotParam;
  63 struct ScImportSourceDesc;
  64 struct ScSheetSourceDesc;
  65 class ScStrCollection;
  66 class TypedScStrCollection;
  67 struct PivotField;
  68 class ScDPCacheTable;
  69 class ScDPTableData;
  70
  71 struct ScDPServiceDesc
  72 {
  73     String      aServiceName;
  74     String      aParSource;
  75     String      aParName;
  76     String      aParUser;
  77     String      aParPass;
  78
  79     ScDPServiceDesc( const String& rServ, const String& rSrc, const String& rNam,
  80                         const String& rUser, const String& rPass ) :
  81         aServiceName( rServ ), aParSource( rSrc ), aParName( rNam ),
  82         aParUser( rUser ), aParPass( rPass ) {  }
  83
  84     BOOL operator==     ( const ScDPServiceDesc& rOther ) const
  85         { return aServiceName == rOther.aServiceName &&
  86                  aParSource   == rOther.aParSource &&
  87                  aParName     == rOther.aParName &&
  88                  aParUser     == rOther.aParUser &&
  89                  aParPass     == rOther.aParPass; }
  90 };
  91
  92
  93 class SC_DLLPUBLIC ScDPObject : public ScDataObject
  94 {
  95 private:
  96     ScDocument*                         pDoc;
  97                                             // settings
  98     ScDPSaveData*                       pSaveData;
  99     String                                      aTableName;
 100     String                                      aTableTag;
 101     ScRange                                     aOutRange;
 102     ScSheetSourceDesc*          pSheetDesc;             //      for sheet data
 103     ScImportSourceDesc*         pImpDesc;               //      for database data
 104     ScDPServiceDesc*            pServDesc;              //      for external service
 105     ::boost::shared_ptr<ScDPTableData>  mpTableData;
 106                                             // cached data
 107     com::sun::star::uno::Reference<com::sun::star::sheet::XDimensionsSupplier> xSource;
 108     ScDPOutput*                         pOutput;
 109     BOOL                                        bSettingsChanged;
 110     BOOL                                        bAlive;                 // FALSE if only used to hold settings
 111         USHORT                                  nAutoFormatIndex;
 112     BOOL                                        bAllowMove;
 113     long                                        nHeaderRows;    // page fields plus filter button
 114     bool                    bHeaderLayout;  // TRUE : grid, FALSE : standard
 115
 116
 117     SC_DLLPRIVATE ScDPTableData*    GetTableData();
 118     SC_DLLPRIVATE void                          CreateObjects();
 119     SC_DLLPRIVATE void                          CreateOutput();
 120
 121 public:
 122                 ScDPObject( ScDocument* pD );
 123                 ScDPObject(const ScDPObject& r);
 124     virtual             ~ScDPObject();
 125
 126     virtual     ScDataObject*   Clone() const;
 127
 128     void                                SetAlive(BOOL bSet);
 129     void                                SetAllowMove(BOOL bSet);
 130
 131     void                                InvalidateData();
 132     void                                InvalidateSource();
 133
 134
 135     void                                Output( const ScAddress& rPos );
 136     ScRange                             GetNewOutputRange( BOOL& rOverflow );
 137     const ScRange       GetOutputRangeByType( sal_Int32 nType );
 138
 139     void                                SetSaveData(const ScDPSaveData& rData);
 140     ScDPSaveData*               GetSaveData() const             { return pSaveData; }
 141
 142     void                                SetOutRange(const ScRange& rRange);
 143     const ScRange&              GetOutRange() const             { return aOutRange; }
 144
 145         void                    SetAutoFormatIndex (const USHORT nIndex);
 146         USHORT                  GetAutoFormatIndex ()   { if (this == NULL) return 65535; else return nAutoFormatIndex; }
 147
 148     void                SetHeaderLayout (bool bUseGrid);
 149     bool                GetHeaderLayout ()  const { return bHeaderLayout; }
 150
 151     void                                SetSheetDesc(const ScSheetSourceDesc& rDesc);
 152     void                                SetImportDesc(const ScImportSourceDesc& rDesc);
 153     void                                SetServiceData(const ScDPServiceDesc& rDesc);
 154
 155     void                                WriteSourceDataTo( ScDPObject& rDest ) const;
 156     void                                WriteTempDataTo( ScDPObject& rDest ) const;
 157
 158     const ScSheetSourceDesc* GetSheetDesc() const       { return pSheetDesc; }
 159     const ScImportSourceDesc* GetImportSourceDesc() const       { return pImpDesc; }
 160     const ScDPServiceDesc* GetDPServiceDesc() const     { return pServDesc; }
 161
 162     com::sun::star::uno::Reference<com::sun::star::sheet::XDimensionsSupplier> GetSource();
 163
 164     BOOL                                IsSheetData() const;
 165     BOOL                                IsImportData() const { return(pImpDesc != NULL); }
 166     BOOL                                IsServiceData() const { return(pServDesc != NULL); }
 167
 168     void                                SetName(const String& rNew);
 169     const String&               GetName() const                                 { return aTableName; }
 170     void                                SetTag(const String& rNew);
 171     const String&               GetTag() const                                  { return aTableTag; }
 172
 173     /**
 174      *  Data description cell displays the description of a data dimension if
 175      *  and only if there is only one data dimension.  It's usually located at
 176      *  the upper-left corner of the table output.
 177      */
 178     bool                IsDataDescriptionCell(const ScAddress& rPos);
 179
 180     bool                IsDimNameInUse(const ::rtl::OUString& rName) const;
 181     String                              GetDimName( long nDim, BOOL& rIsDataLayout );
 182     BOOL                IsDuplicated( long nDim );
 183     long                GetDimCount();
 184     void                GetHeaderPositionData(const ScAddress& rPos, ::com::sun::star::sheet::DataPilotTableHeaderData& rData);
 185     long                                GetHeaderDim( const ScAddress& rPos, USHORT& rOrient );
 186     BOOL                                GetHeaderDrag( const ScAddress& rPos, BOOL bMouseLeft, BOOL bMouseTop,
 187                                         long nDragDim,
 188                                         Rectangle& rPosRect, USHORT& rOrient, long& rDimPos );
 189     BOOL                                IsFilterButton( const ScAddress& rPos );
 190
 191     BOOL                GetPivotData( ScDPGetPivotDataField& rTarget, /* returns result */
 192                                       const std::vector< ScDPGetPivotDataField >& rFilters );
 193     BOOL                ParseFilters( ScDPGetPivotDataField& rTarget,
 194                                       std::vector< ScDPGetPivotDataField >& rFilters,
 195                                       const String& rFilterList );
 196
 197     void                GetMemberResultNames( ScStrCollection& rNames, long nDimension );
 198
 199     void                                FillPageList( TypedScStrCollection& rStrings, long nField );
 200
 201     void                ToggleDetails(const ::com::sun::star::sheet::DataPilotTableHeaderData& rElemDesc, ScDPObject* pDestObj);
 202
 203     BOOL                                FillOldParam(ScPivotParam& rParam, BOOL bForFile) const;
 204     BOOL                                FillLabelData(ScPivotParam& rParam);
 205     void                                InitFromOldPivot(const ScPivot& rOld, ScDocument* pDoc, BOOL bSetSource);
 206
 207     BOOL                GetHierarchiesNA( sal_Int32 nDim, com::sun::star::uno::Reference< com::sun::star::container::XNameAccess >& xHiers );
 208     BOOL                GetHierarchies( sal_Int32 nDim, com::sun::star::uno::Sequence< rtl::OUString >& rHiers );
 209
 210     sal_Int32           GetUsedHierarchy( sal_Int32 nDim );
 211
 212     BOOL                GetMembersNA( sal_Int32 nDim, com::sun::star::uno::Reference< com::sun::star::container::XNameAccess >& xMembers );
 213     BOOL                GetMembers( sal_Int32 nDim,
 214                             com::sun::star::uno::Sequence< rtl::OUString >& rMembers,
 215                             com::sun::star::uno::Sequence< sal_Bool >* pVisible = 0,
 216                             com::sun::star::uno::Sequence< sal_Bool >* pShowDet = 0 );
 217
 218     BOOL                GetMembersNA( sal_Int32 nDim, sal_Int32 nHier, com::sun::star::uno::Reference< com::sun::star::container::XNameAccess >& xMembers );
 219     BOOL                GetMembers( sal_Int32 nDim, sal_Int32 nHier,
 220                             com::sun::star::uno::Sequence< rtl::OUString >& rMembers,
 221                             com::sun::star::uno::Sequence< sal_Bool >* pVisible = 0,
 222                             com::sun::star::uno::Sequence< sal_Bool >* pShowDet = 0 );
 223
 224     void                                UpdateReference( UpdateRefMode eUpdateRefMode,
 225                                          const ScRange& r, SCsCOL nDx, SCsROW nDy, SCsTAB nDz );
 226     BOOL                                RefsEqual( const ScDPObject& r ) const;
 227     void                                WriteRefsTo( ScDPObject& r ) const;
 228
 229     void                GetPositionData(const ScAddress& rPos, ::com::sun::star::sheet::DataPilotTablePositionData& rPosData);
 230
 231     bool                GetDataFieldPositionData(const ScAddress& rPos,
 232                                                  ::com::sun::star::uno::Sequence<
 233                                                     ::com::sun::star::sheet::DataPilotFieldFilter >& rFilters);
 234
 235     void                GetDrillDownData(const ScAddress& rPos,
 236                                          ::com::sun::star::uno::Sequence<
 237                                             ::com::sun::star::uno::Sequence<
 238                                                 ::com::sun::star::uno::Any > >& rTableData);
 239
 240     // apply drop-down attribute, initialize nHeaderRows, without accessing the source
 241     // (button attribute must be present)
 242     void                                RefreshAfterLoad();
 243
 244     void                BuildAllDimensionMembers();
 245
 246     static BOOL                 HasRegisteredSources();
 247     static com::sun::star::uno::Sequence<rtl::OUString> GetRegisteredSources();
 248     static com::sun::star::uno::Reference<com::sun::star::sheet::XDimensionsSupplier>
 249                         CreateSource( const ScDPServiceDesc& rDesc );
 250
 251     static void                 ConvertOrientation( ScDPSaveData& rSaveData,
 252                             PivotField* pFields, SCSIZE nCount, USHORT nOrient,
 253                             ScDocument* pDoc, SCROW nRow, SCTAB nTab,
 254                             const com::sun::star::uno::Reference<
 255                                 com::sun::star::sheet::XDimensionsSupplier>& xSource,
 256                             BOOL bOldDefaults,
 257                             PivotField* pRefColFields = NULL, SCSIZE nRefColCount = 0,
 258                             PivotField* pRefRowFields = NULL, SCSIZE nRefRowCount = 0,
 259                             PivotField* pRefPageFields = NULL, SCSIZE nRefPageCount = 0 );
 260 };
 261
 262 // ============================================================================
 263
 264 struct ScDPCacheCell
 265 {
 266     sal_Int32   mnStrId;
 267     sal_uInt8   mnType;
 268     double      mfValue;
 269     bool        mbNumeric;
 270
 271     ScDPCacheCell();
 272     ScDPCacheCell(const ScDPCacheCell& r);
 273     ~ScDPCacheCell();
 274 };
 275
 276 // ============================================================================
 277
 278 class ScDPCollection : public ScCollection
 279 {
 280 private:
 281     ScDocument* pDoc;
 282     ScSimpleSharedString maSharedString;
 283
 284     struct CacheCellHash
 285     {
 286         size_t operator()(const ScDPCacheCell* pCell) const;
 287     };
 288     struct CacheCellEqual
 289     {
 290         bool operator()(const ScDPCacheCell* p1, const ScDPCacheCell* p2) const;
 291     };
 292     typedef ::std::hash_set<ScDPCacheCell*, CacheCellHash, CacheCellEqual> CacheCellPoolType;
 293
 294     CacheCellPoolType maCacheCellPool;
 295
 296 public:
 297                 ScDPCollection(ScDocument* pDocument);
 298                 ScDPCollection(const ScDPCollection& r);
 299     virtual             ~ScDPCollection();
 300
 301     virtual     ScDataObject*   Clone() const;
 302
 303     ScDPObject* operator[](USHORT nIndex) const {return (ScDPObject*)At(nIndex);}
 304
 305     void        DeleteOnTab( SCTAB nTab );
 306     void                UpdateReference( UpdateRefMode eUpdateRefMode,
 307                                  const ScRange& r, SCsCOL nDx, SCsROW nDy, SCsTAB nDz );
 308
 309     BOOL                RefsEqual( const ScDPCollection& r ) const;
 310     void                WriteRefsTo( ScDPCollection& r ) const;
 311
 312     String              CreateNewName( USHORT nMin = 1 ) const;
 313
 314     ScSimpleSharedString& GetSharedString();
 315
 316     ScDPCacheCell* getCacheCellFromPool(const ScDPCacheCell& rCell);
 317     void clearCacheCellPool();
 318 };
 319
 320
 321 #endif
 322