/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* * This file is part of the Collabora Office project. * * This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. * * This file incorporates work covered by the following license notice: * * Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed * with this work for additional information regarding copyright * ownership. The ASF licenses this file to you under the Apache * License, Version 2.0 (the "License"); you may not use this file * except in compliance with the License. You may obtain a copy of * the License at http://www.apache.org/licenses/LICENSE-2.0 . */ #pragma once #include #include #include #include "workbookhelper.hxx" namespace oox { class AttributeList; } namespace oox { class SequenceInputStream; } namespace oox::core { class Relations; } class ScDPSaveDimension; class ScDPObject; class Date; class ScDataPilotFieldObj; class ScTokenArray; namespace oox::xls { class WorksheetHelper; typedef ::std::pair< sal_Int32, OUString > IdCaptionPair; typedef ::std::vector< IdCaptionPair > IdCaptionPairList; class PivotCacheItem { public: explicit PivotCacheItem(); /** Reads the string value from a pivot cache item. */ void readString( const AttributeList& rAttribs ); /** Reads the double value from a pivot cache item. */ void readNumeric( const AttributeList& rAttribs ); /** Reads the date/time value from a pivot cache item. */ void readDate( const AttributeList& rAttribs ); /** Reads the boolean value from a pivot cache item. */ void readBool( const AttributeList& rAttribs ); /** Reads the error code value from a pivot cache item. */ void readError( const AttributeList& rAttribs ); /** Reads the index of a shared item. */ void readIndex( const AttributeList& rAttribs ); /** Reads the string value from a pivot cache item. */ void readString( SequenceInputStream& rStrm ); /** Reads the double value from a pivot cache item. */ void readDouble( SequenceInputStream& rStrm ); /** Reads the date/time value from a pivot cache item. */ void readDate( SequenceInputStream& rStrm ); /** Reads the boolean value from a pivot cache item. */ void readBool( SequenceInputStream& rStrm ); /** Reads the error code value from a pivot cache item. */ void readError(SequenceInputStream& rStrm, const UnitConverter& rUnitConverter); /** Reads the index of a shared item. */ void readIndex( SequenceInputStream& rStrm ); /** Returns the type of the item. */ sal_Int32 getType() const { return mnType; } /** Returns the value of the item. */ const cpo::uno::Any& getValue() const { return maValue; } /** Returns the string representation of the item. */ OUString getName() const; /** Returns the string representation of the item, using the actual formatting. */ OUString getFormattedName(const ScDPSaveDimension& rSaveDim, ScDPObject* pObj, const Date& rNullDate) const; /** Returns true if the item is unused. */ bool isUnused() const { return mbUnused; } private: friend class PivotCacheItemList; // #FIXME hack Sets the value of this item to the given string ( and overwrites type if necessary void setStringValue( const OUString& sName ); cpo::uno::Any maValue; /// Value of the item. sal_Int32 mnType; /// Value type (OOXML token identifier). bool mbUnused; }; class PivotCacheItemList : public WorkbookHelper { public: explicit PivotCacheItemList( const WorkbookHelper& rHelper ); /** Imports the item from the passed attribute list. */ void importItem( sal_Int32 nElement, const AttributeList& rAttribs ); /** Imports the item from the passed stream and record. */ void importItem( sal_Int32 nRecId, SequenceInputStream& rStrm ); /** Returns true, if this item list is empty. */ bool empty() const { return maItems.empty(); } /** Returns the size of the item list. */ size_t size() const { return maItems.size(); } /** Returns the specified item. */ const PivotCacheItem* getCacheItem( sal_Int32 nItemIdx ) const; /** Returns the names of all items. */ void getCacheItemNames( ::std::vector< OUString >& orItemNames ) const; void applyItemCaptions( const IdCaptionPairList& vCaptions ); private: /** Creates and returns a new item at the end of the items list. */ PivotCacheItem& createItem(); /** Imports an array of items from the PCITEM_ARRAY record */ void importArray( SequenceInputStream& rStrm ); private: std::vector< PivotCacheItem > maItems; /// All items of this list. }; struct PCFieldModel { OUString maName; /// Fixed name of the cache field. OUString maCaption; /// Caption of the cache field. OUString maPropertyName; /// OLAP property name. OUString maFormula; /// Formula of a calculated field (OOXML XML). std::unique_ptr mpFormulaTokens; /// Pre-compiled calculated field formula (BIFF12). std::vector< sal_Int8 > maRawFormula; /// Raw BIFF12 PivotParsedFormula (cce+rgce+cb+rgcb) for deferred resolution. std::vector< sal_uInt32 > maPNameFieldIndices; /// BIFF12 PNAMES: per-field cache field indices for formula refs. sal_Int32 mnNumFmtId; /// Number format for all items. sal_Int32 mnSqlType; /// Data type from ODBC data source. sal_Int32 mnHierarchy; /// Hierarchy this field is part of. sal_Int32 mnLevel; /// Hierarchy level this field is part of. sal_Int32 mnMappingCount; /// Number of property mappings. bool mbDatabaseField; /// True = field from source data; false = calculated field. bool mbServerField; /// True = ODBC server-based page field. bool mbUniqueList; /// True = list of unique ODBC items exists. bool mbMemberPropField; /// True = contains OLAP member properties. explicit PCFieldModel(); ~PCFieldModel(); }; struct PCSharedItemsModel { bool mbHasSemiMixed; /// True = has (blank|string|bool|error) item(s), maybe other types. bool mbHasNonDate; /// True = has non-date item(s), maybe date items. bool mbHasDate; /// True = has date item(s), maybe other types. bool mbHasString; /// True = has (string|bool|error) item(s), maybe other types. bool mbHasBlank; /// True = has blank item(s), maybe other types. bool mbHasMixed; /// True = has [(string|bool|error) and (number|date)] or (number and date). bool mbIsNumeric; /// True = has numeric item(s), maybe other types except date. bool mbIsInteger; /// True = has numeric item(s) with only integers, maybe other types except date. bool mbHasLongText; /// True = contains strings with >255 characters. explicit PCSharedItemsModel(); }; struct PCFieldGroupModel { css::util::DateTime maStartDate; /// Manual or calculated start date for range grouping. css::util::DateTime maEndDate; /// Manual or calculated end date for range grouping. double mfStartValue; /// Manual or calculated start value for range grouping. double mfEndValue; /// Manual or calculated end value for range grouping. double mfInterval; /// Interval for numeric range grouping. sal_Int32 mnParentField; /// Index of cache field that contains item groups based on this field. sal_Int32 mnBaseField; /// Index of cache field this grouped field is based on. sal_Int32 mnGroupBy; /// Type of numeric or date range grouping. bool mbRangeGroup; /// True = items are grouped by numeric ranges or date ranges. bool mbDateGroup; /// True = items are grouped by date ranges or by item names. bool mbAutoStart; /// True = start value for range groups is calculated from source data. bool mbAutoEnd; /// True = end value for range groups is calculated from source data. OUString msFinalGroupName ; /// Finalized group name of this field used in internal pivot table collection. explicit PCFieldGroupModel(); /** Sets the group-by value for BIFF import. */ void setBiffGroupBy( sal_uInt8 nGroupBy ); }; /** Helper struct for mapping original item names from/to group item names. */ struct PivotCacheGroupItem { OUString maOrigName; OUString maGroupName; explicit PivotCacheGroupItem( const OUString& rItemName ) : maOrigName( rItemName ), maGroupName( rItemName ) {} }; typedef ::std::vector< PivotCacheGroupItem > PivotCacheGroupItemVector; class PivotCacheField : public WorkbookHelper { public: explicit PivotCacheField( const WorkbookHelper& rHelper, bool bIsDatabaseField ); /** Imports pivot cache field settings from the cacheField element. */ void importCacheField( const AttributeList& rAttribs ); /** Imports shared items settings from the sharedItems element. */ void importSharedItems( const AttributeList& rAttribs ); /** Imports a shared item from the passed element. */ void importSharedItem( sal_Int32 nElement, const AttributeList& rAttribs ); /** Imports grouping settings from the fieldGroup element. */ void importFieldGroup( const AttributeList& rAttribs ); /** Imports numeric grouping settings from the rangePr element. */ void importRangePr( const AttributeList& rAttribs ); /** Imports an item of the mapping between group items and base items from the passed element. */ void importDiscretePrItem( sal_Int32 nElement, const AttributeList& rAttribs ); /** Imports a group item from the passed element. */ void importGroupItem( sal_Int32 nElement, const AttributeList& rAttribs ); /** Imports pivot cache field settings from the PCDFIELD record. */ void importPCDField( SequenceInputStream& rStrm ); /** Reads a PNAME record (cache field reference used in calculated field formulas). */ void importPCDPName( SequenceInputStream& rStrm ); /** Imports shared items settings from the PCDFSHAREDITEMS record. */ void importPCDFSharedItems( SequenceInputStream& rStrm ); /** Imports one or more shared items from the passed record. */ void importPCDFSharedItem( sal_Int32 nRecId, SequenceInputStream& rStrm ); /** Imports grouping settings from the PCDFIELDGROUP record. */ void importPCDFieldGroup( SequenceInputStream& rStrm ); /** Imports numeric grouping settings from the PCDFRANGEPR record. */ void importPCDFRangePr( SequenceInputStream& rStrm ); /** Imports an item of the mapping between group items and base items from the passed record. */ void importPCDFDiscretePrItem( sal_Int32 nRecId, SequenceInputStream& rStrm ); /** Imports one or more group items from the passed record. */ void importPCDFGroupItem( sal_Int32 nRecId, SequenceInputStream& rStrm ); /** Apply user Captions to imported group data */ void applyItemCaptions( const IdCaptionPairList& vCaptions ); /** Returns true, if the field is based on source data, or false if it is grouped or calculated. */ bool isDatabaseField() const { return maFieldModel.mbDatabaseField; } /** Returns true, if the field contains a list of shared items. */ bool hasSharedItems() const { return !maSharedItems.empty(); } /** Returns true, if the field contains a list of grouping items. */ bool hasGroupItems() const { return !maGroupItems.empty(); } /** Returns true, if the field has inplace numeric grouping settings. */ bool hasNumericGrouping() const { return maFieldGroupModel.mbRangeGroup && !maFieldGroupModel.mbDateGroup; } /** Returns true, if the field has inplace date grouping settings. */ bool hasDateGrouping() const { return maFieldGroupModel.mbRangeGroup && maFieldGroupModel.mbDateGroup; } /** Returns true, if the field has a parent group field that groups the items of this field. */ bool hasParentGrouping() const { return maFieldGroupModel.mnParentField >= 0; } /** Returns the name of the cache field. */ const OUString& getName() const { return maFieldModel.maName; } /** Returns the index of the parent group field that groups the items of this field. */ sal_Int32 getParentGroupField() const { return maFieldGroupModel.mnParentField; } /** Returns the index of the base field grouping is based on. */ sal_Int32 getGroupBaseField() const { return maFieldGroupModel.mnBaseField; } /** Returns the finalized group name of this field. */ const OUString& getFinalGroupName() const { return maFieldGroupModel.msFinalGroupName; } /** Set the finalized group name of this field. */ void setFinalGroupName(const OUString& rFinalGroupName) { maFieldGroupModel.msFinalGroupName = rFinalGroupName; } /** Returns the formula of the cache calculated field. */ const OUString& getFormula() const { return maFieldModel.maFormula; } /** Returns the pre-compiled calculated field token array (BIFF12 only), or nullptr. */ const ScTokenArray* getFormulaTokenArray() const { return maFieldModel.mpFormulaTokens.get(); } /** Returns the field model data (used by PivotCache for deferred BIFF12 formula resolution). */ PCFieldModel& getFieldModel() { return maFieldModel; } /** Returns the shared or group item with the specified index. */ const PivotCacheItem* getCacheItem( sal_Int32 nItemIdx ) const; /** Returns the names of all shared or group items. */ void getCacheItemNames( ::std::vector< OUString >& orItemNames ) const; /** Returns shared or group items. */ const PivotCacheItemList& getCacheItems() const; /** Creates inplace numeric grouping settings. */ void convertNumericGrouping( const rtl::Reference< ScDataPilotFieldObj >& rxDPField ) const; /** Creates inplace date grouping settings or a new date group field. */ OUString createDateGroupField( const rtl::Reference< ScDataPilotFieldObj >& rxBaseDPField ) const; /** Creates a new grouped DataPilot field and returns its name. */ OUString createParentGroupField( const rtl::Reference< ScDataPilotFieldObj >& rxBaseDPField, const PivotCacheField& rBaseCacheField, PivotCacheGroupItemVector& orItemNames ) const; /** Writes the title of the field into the passed sheet at the passed address. */ void writeSourceHeaderCell( const WorksheetHelper& rSheetHelper, sal_Int32 nCol, sal_Int32 nRow ) const; /** Writes a source field item value into the passed sheet. */ void writeSourceDataCell( const WorksheetHelper& rSheetHelper, sal_Int32 nCol, sal_Int32 nRow, const PivotCacheItem& rItem ) const; /** Reads an item from the PCRECORD record and writes it to the passed sheet. */ void importPCRecordItem( SequenceInputStream& rStrm, const WorksheetHelper& rSheetHelper, sal_Int32 nCol, sal_Int32 nRow ) const; private: /** Tries to write the passed value to the passed sheet position. */ static void writeItemToSourceDataCell( const WorksheetHelper& rSheetHelper, sal_Int32 nCol, sal_Int32 nRow, const PivotCacheItem& rItem ); /** Tries to write the value of a shared item to the passed sheet position. */ void writeSharedItemToSourceDataCell( const WorksheetHelper& rSheetHelper, sal_Int32 nCol, sal_Int32 nRow, sal_Int32 nItemIdx ) const; private: typedef ::std::vector< sal_Int32 > IndexVector; PivotCacheItemList maSharedItems; /// All shared items of this field. PivotCacheItemList maGroupItems; /// All group items of this field. IndexVector maDiscreteItems; /// Mapping between group and base items. PCFieldModel maFieldModel; /// Settings for this cache field. PCSharedItemsModel maSharedItemsModel; /// Settings for shared items. PCFieldGroupModel maFieldGroupModel; /// Settings for item grouping. }; struct PCDefinitionModel { OUString maRelId; /// Relation identifier for cache records fragment. OUString maRefreshedBy; /// Name of user who last refreshed the cache. double mfRefreshedDate; /// Date/time of last refresh. sal_Int32 mnRecords; /// Number of data records in the cache. sal_Int32 mnMissItemsLimit; /// Limit for discarding unused items. bool mbInvalid; /// True = cache needs refresh. bool mbSaveData; /// True = cached item values are present. bool mbRefreshOnLoad; /// True = try to refresh cache on load. bool mbOptimizeMemory; /// True = application may optimize memory usage. bool mbEnableRefresh; /// True = refreshing cache is enabled in UI. bool mbBackgroundQuery; /// True = application queries data asynchronously. bool mbUpgradeOnRefresh; /// True = application may upgrade cache version. bool mbTupleCache; /// True = cache stores OLAP functions. bool mbSupportSubquery; /// True = data source supports subqueries. bool mbSupportDrill; /// True = data source supports drilldown. explicit PCDefinitionModel(); }; struct PCSourceModel { sal_Int32 mnSourceType; /// Type of the source data (sheet, consolidation, scenario, external). sal_Int32 mnConnectionId; /// Connection identifier for external data source. explicit PCSourceModel(); }; struct PCWorksheetSourceModel { OUString maRelId; /// Relation identifier for an external document URL. OUString maSheet; /// Sheet name for cell range or sheet-local defined names. OUString maDefName; /// Defined name containing a cell range if present. ScRange maRange; /// Source cell range of the data. explicit PCWorksheetSourceModel(); }; class PivotCache : public WorkbookHelper { public: explicit PivotCache( const WorkbookHelper& rHelper ); /** Reads pivot cache global settings from the pivotCacheDefinition element. */ void importPivotCacheDefinition( const AttributeList& rAttribs ); /** Reads cache source settings from the cacheSource element. */ void importCacheSource( const AttributeList& rAttribs ); /** Reads sheet source settings from the worksheetSource element. */ void importWorksheetSource( const AttributeList& rAttribs, const ::oox::core::Relations& rRelations ); /** Reads pivot cache global settings from the PCDEFINITION record. */ void importPCDefinition( SequenceInputStream& rStrm ); /** Reads cache source settings from the PCDSOURCE record. */ void importPCDSource( SequenceInputStream& rStrm ); /** Reads sheet source settings from the PCDSHEETSOURCE record. */ void importPCDSheetSource( SequenceInputStream& rStrm, const ::oox::core::Relations& rRelations ); /** Creates and returns a new pivot cache field. */ PivotCacheField& createCacheField(); /** Checks validity of source data and creates a dummy data sheet for external sheet sources. */ void finalizeImport(); /** Returns true, if the pivot cache is based on a valid data source, so that pivot tables can be created based on this pivot cache. */ bool isValidDataSource() const { return mbValidSource; } /** Returns true, if the pivot cache is based on a dummy sheet created in finalizeImport. */ bool isBasedOnDummySheet() const { return mbDummySheet; } /** Returns the internal cell range the cache is based on. */ const ScRange& getSourceRange() const { return maSheetSrcModel.maRange; } /** Returns the relation identifier of the pivot cache records fragment. */ const OUString& getRecordsRelId() const { return maDefModel.maRelId; } /** Returns the cache field with the specified index. */ PivotCacheField* getCacheField( sal_Int32 nFieldIdx ); const PivotCacheField* getCacheField( sal_Int32 nFieldIdx ) const; /** Returns the source column index of the field with the passed index. */ sal_Int32 getCacheDatabaseIndex( sal_Int32 nFieldIdx ) const; /** Writes the titles of all source fields into the passed sheet. */ void writeSourceHeaderCells( const WorksheetHelper& rSheetHelper ) const; /** Writes a source field item value into the passed sheet. */ void writeSourceDataCell( const WorksheetHelper& rSheetHelper, sal_Int32 nColIdx, sal_Int32 nRowIdx, const PivotCacheItem& rItem ) const; /** Reads a PCRECORD record and writes all item values to the passed sheet. */ void importPCRecord( SequenceInputStream& rStrm, const WorksheetHelper& rSheetHelper, sal_Int32 nRowIdx ) const; /** Resolves deferred BIFF12 calculated field formulas using PNAMES data. */ void resolveCalculatedFieldFormulas(); private: /** Finalizes the pivot cache if it is based on internal sheet data. */ void finalizeInternalSheetSource(); /** Finalizes the pivot cache if it is based on sheet data of an external spreadsheet document. */ void finalizeExternalSheetSource(); /** Creates a dummy sheet that will be filled with the pivot cache data. */ void prepareSourceDataSheet(); /** Checks, if the row index has changed since last call, and initializes the sheet data buffer. */ void updateSourceDataRow( sal_Int32 nRow ) const; private: typedef RefVector< PivotCacheField > PivotCacheFieldVector; typedef ::std::vector< sal_Int32 > IndexVector; PivotCacheFieldVector maFields; /// All pivot cache fields. PivotCacheFieldVector maDatabaseFields; /// All cache fields that are based on source data. IndexVector maDatabaseIndexes; /// Database field index for all fields. PCDefinitionModel maDefModel; /// Global pivot cache settings. PCSourceModel maSourceModel; /// Pivot cache source settings. PCWorksheetSourceModel maSheetSrcModel; /// Sheet source data if cache type is sheet. ValueRangeSet maColSpans; /// Column spans used by SheetDataBuffer for optimized cell import. OUString maTargetUrl; /// URL of an external source document. mutable sal_Int32 mnCurrRow; /// Current row index in dummy sheet. bool mbValidSource; /// True = pivot cache is based on supported data source. bool mbDummySheet; /// True = pivot cache is based on a dummy sheet. }; class PivotCacheBuffer : public WorkbookHelper { public: explicit PivotCacheBuffer( const WorkbookHelper& rHelper ); /** Registers a pivot cache definition fragment. The fragment will be loaded on demand (OOXML/BIFF12 only). */ void registerPivotCacheFragment( sal_Int32 nCacheId, const OUString& rFragmentPath ); /** Imports and stores a pivot cache definition fragment on first call, returns the imported cache on subsequent calls with the same identifier. */ PivotCache* importPivotCacheFragment( sal_Int32 nCacheId ); private: /** Creates and returns a new pivot cache object with the passed identifier. */ PivotCache& createPivotCache( sal_Int32 nCacheId ); private: typedef ::std::map< sal_Int32, OUString > FragmentPathMap; typedef RefMap< sal_Int32, PivotCache > PivotCacheMap; FragmentPathMap maFragmentPaths; PivotCacheMap maCaches; std::vector< sal_Int32 > maCacheIds; }; } // namespace oox::xls /* vim:set shiftwidth=4 softtabstop=4 expandtab: */