diff options
Diffstat (limited to 'sc/source/filter/inc/pivottablebuffer.hxx')
| -rw-r--r-- | sc/source/filter/inc/pivottablebuffer.hxx | 404 |
1 files changed, 404 insertions, 0 deletions
diff --git a/sc/source/filter/inc/pivottablebuffer.hxx b/sc/source/filter/inc/pivottablebuffer.hxx new file mode 100644 index 000000000..7b7f22320 --- /dev/null +++ b/sc/source/filter/inc/pivottablebuffer.hxx @@ -0,0 +1,404 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice 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 "pivotcachebuffer.hxx" +#include "stylesbuffer.hxx" + +namespace com::sun::star { + namespace sheet { class XDataPilotDescriptor; } + namespace sheet { class XDataPilotField; } +} + +class ScDPObject; + +namespace oox::xls { + +class PivotTable; + +struct PTFieldItemModel +{ + sal_Int32 mnCacheItem; /// Index to shared item in pivot cache. + sal_Int32 mnType; /// Type of the item. + OUString msCaption; /// User caption of the item + bool mbShowDetails; /// True = show item details (items of child fields). + bool mbHidden; /// True = item is hidden. + + explicit PTFieldItemModel(); + + /** Sets item type for BIFF import. */ + void setBiffType( sal_uInt16 nType ); +}; + +struct PTFieldModel +{ + sal_Int32 mnAxis; /// Axis this field is assigned to (none, row, column, page). + sal_Int32 mnNumFmtId; /// Number format for field items. + sal_Int32 mnAutoShowItems; /// Number of items (or percent/sum) to be shown in auto show filter. + sal_Int32 mnAutoShowRankBy; /// Index of the data field auto show filter is based on. + sal_Int32 mnSortType; /// Autosorting type. + sal_Int32 mnSortRefField; /// Reference field for autosorting. + sal_Int32 mnSortRefItem; /// Item in reference field for autosorting. + bool mbDataField; /// True = field appears in data area. + bool mbDefaultSubtotal; /// True = show default subtotals. + bool mbSumSubtotal; /// True = show sum subtotals. + bool mbCountASubtotal; /// True = show count all subtotals. + bool mbAverageSubtotal; /// True = show average subtotals. + bool mbMaxSubtotal; /// True = show maximum subtotals. + bool mbMinSubtotal; /// True = show minimum subtotals. + bool mbProductSubtotal; /// True = show product subtotals. + bool mbCountSubtotal; /// True = show count numbers subtotals. + bool mbStdDevSubtotal; /// True = show standard deviation subtotals. + bool mbStdDevPSubtotal; /// True = show standard deviation of population subtotals. + bool mbVarSubtotal; /// True = show variance subtotals. + bool mbVarPSubtotal; /// True = show variance of population subtotals. + bool mbShowAll; /// True = show items without data. + bool mbOutline; /// True = show in outline view, false = show in tabular view. + bool mbSubtotalTop; /// True = show subtotals on top of items in outline or compact mode. + bool mbInsertBlankRow; /// True = insert blank rows after items. + bool mbInsertPageBreak; /// True = insert page breaks after items. + bool mbAutoShow; /// True = auto show (top 10) filter enabled. + bool mbTopAutoShow; /// True = auto show filter shows top entries, false = bottom. + bool mbMultiPageItems; /// True = multiple items selectable in page dimension. + + explicit PTFieldModel(); + + /** Sets axis type for BIFF import. */ + void setBiffAxis( sal_uInt8 nAxisFlags ); +}; + +struct PTPageFieldModel +{ + OUString maName; /// Unique name of the page field. + sal_Int32 mnField; /// Base pivot field. + sal_Int32 mnItem; /// Index of field item that is shown by the page field. + + explicit PTPageFieldModel(); +}; + +struct PTDataFieldModel +{ + OUString maName; /// Name of the data field. + sal_Int32 mnField; /// Base pivot field. + sal_Int32 mnSubtotal; /// Subtotal aggregation function. + sal_Int32 mnShowDataAs; /// Show data as, based on another field. + sal_Int32 mnBaseField; /// Base field for 'show data as'. + sal_Int32 mnBaseItem; /// Base item for 'show data as'. + sal_Int32 mnNumFmtId; /// Number format for the result. + + explicit PTDataFieldModel(); + + /** Sets the subtotal aggregation function for BIFF import. */ + void setBiffSubtotal( sal_Int32 nSubtotal ); + /** Sets the 'show data as' type for BIFF import. */ + void setBiffShowDataAs( sal_Int32 nShowDataAs ); +}; + +class PivotTableField : public WorkbookHelper +{ +public: + explicit PivotTableField( PivotTable& rPivotTable, sal_Int32 nFieldIndex ); + + /** Imports pivot field settings from the pivotField element. */ + void importPivotField( const AttributeList& rAttribs ); + /** Imports settings of an item in this pivot field from the item element. */ + void importItem( const AttributeList& rAttribs ); + /** Imports pivot field reference settings from the reference element. */ + void importReference( const AttributeList& rAttribs ); + /** Imports pivot field item reference settings from the x element. */ + void importReferenceItem( const AttributeList& rAttribs ); + + /** Imports pivot field settings from the PTFIELD record. */ + void importPTField( SequenceInputStream& rStrm ); + /** Imports settings of an item in this pivot field from the PTFITEM record. */ + void importPTFItem( SequenceInputStream& rStrm ); + /** Imports pivot field reference settings from the PTREFERENCE record. */ + void importPTReference( SequenceInputStream& rStrm ); + /** Imports pivot field item reference settings from the PTREFERENCEITEM record. */ + void importPTReferenceItem( SequenceInputStream& rStrm ); + + /** Finalizes the field after import, creates grouping and other settings. */ + void finalizeImport( + const css::uno::Reference< css::sheet::XDataPilotDescriptor >& rxDPDesc ); + /** Finalizes the grouped date field after import. */ + void finalizeDateGroupingImport( + const css::uno::Reference< css::sheet::XDataPilotField >& rxBaseDPField, + sal_Int32 nBaseFieldIdx ); + /** Finalizes the grouped field after import. */ + void finalizeParentGroupingImport( + const css::uno::Reference< css::sheet::XDataPilotField >& rxBaseDPField, + const PivotCacheField& rBaseCacheField, + PivotCacheGroupItemVector& orItemNames ); + void finalizeImportBasedOnCache( + const css::uno::Reference< css::sheet::XDataPilotDescriptor >& rxDPDesc); + + /** Returns the name of the DataPilot field in the fields collection. */ + const OUString& getDPFieldName() const { return maDPFieldName; } + + /** Converts dimension and other settings for a row field. */ + void convertRowField(); + /** Converts dimension and other settings for a column field. */ + void convertColField(); + /** Converts dimension and other settings for a hidden field. */ + void convertHiddenField(); + /** Converts dimension and other settings for a page field */ + void convertPageField( const PTPageFieldModel& rPageField ); + /** Converts dimension and other settings for a data field. */ + void convertDataField( const PTDataFieldModel& rDataField ); + +private: + /** Converts dimension and other settings for row, column, page, or hidden fields. */ + css::uno::Reference< css::sheet::XDataPilotField > + convertRowColPageField( sal_Int32 nAxis ); + +private: + typedef ::std::vector< PTFieldItemModel > ItemModelVector; + + PivotTable& mrPivotTable; /// The parent pivot table object. + ItemModelVector maItems; /// All items of this field. + PTFieldModel maModel; /// Pivot field settings. + OUString maDPFieldName; /// Name of the field in DataPilot field collection. + sal_Int32 mnFieldIndex; /// Zero-based index of this field. +}; + +struct PTFilterModel +{ + OUString maName; /// Name of the field filter. + OUString maDescription; /// Description of the field filter. + OUString maStrValue1; /// First string value for label filter. + OUString maStrValue2; /// Second string value for label filter. + double mfValue; /// Number of items or percent or sum to be shown. + sal_Int32 mnField; /// Base pivot field. + sal_Int32 mnMemPropField; /// Member property field. + sal_Int32 mnType; /// Filter type. + sal_Int32 mnEvalOrder; /// Evaluation order index. + sal_Int32 mnId; /// Unique identifier. + sal_Int32 mnMeasureField; /// Data field for filter calculation. + sal_Int32 mnMeasureHier; /// Hierarchy for filter calculation. + bool mbTopFilter; /// True = filter shows top entries, false = bottom. + + explicit PTFilterModel(); +}; + +class PivotTableFilter : public WorkbookHelper +{ +public: + explicit PivotTableFilter( const PivotTable& rPivotTable ); + + /** Reads the settings of a field filter from the filter element. */ + void importFilter( const AttributeList& rAttribs ); + /** Reads additional settings of a field filter from the top10 element. */ + void importTop10( const AttributeList& rAttribs ); + + /** Reads the settings of a field filter from the PTFILTER record. */ + void importPTFilter( SequenceInputStream& rStrm ); + /** Reads additional settings of a field filter from the TOP10FILTER record. */ + void importTop10Filter( SequenceInputStream& rStrm ); + + /** Applies the filter to the associated pivot table field if possible. */ + void finalizeImport(); + +private: + const PivotTable& mrPivotTable; + PTFilterModel maModel; +}; + +struct PTDefinitionModel : public AutoFormatModel +{ + OUString maName; + OUString maDataCaption; + OUString maGrandTotalCaption; + OUString maRowHeaderCaption; + OUString maColHeaderCaption; + OUString maErrorCaption; + OUString maMissingCaption; + OUString maPageStyle; + OUString maPivotTableStyle; + OUString maVacatedStyle; + OUString maTag; + sal_Int32 mnCacheId; + sal_Int32 mnDataPosition; + sal_Int32 mnPageWrap; + sal_Int32 mnIndent; + sal_Int32 mnChartFormat; + bool mbDataOnRows; + bool mbShowError; + bool mbShowMissing; + bool mbShowItems; + bool mbDisableFieldList; + bool mbShowCalcMembers; + bool mbVisualTotals; + bool mbShowDrill; + bool mbPrintDrill; + bool mbEnableDrill; + bool mbPreserveFormatting; + bool mbUseAutoFormat; + bool mbPageOverThenDown; + bool mbSubtotalHiddenItems; + bool mbRowGrandTotals; + bool mbColGrandTotals; + bool mbFieldPrintTitles; + bool mbItemPrintTitles; + bool mbMergeItem; + bool mbShowEmptyRow; + bool mbShowEmptyCol; + bool mbShowHeaders; + bool mbFieldListSortAsc; + bool mbCustomListSort; + + explicit PTDefinitionModel(); +}; + +struct PTLocationModel +{ + ScRange maRange; /// Target cell range for the pivot table. + sal_Int32 mnFirstHeaderRow; /// First row of header cells (relative in pivot table). + sal_Int32 mnFirstDataRow; /// First row of data cells (relative in pivot table). + sal_Int32 mnFirstDataCol; /// First column of data cells (relative in pivot table). + sal_Int32 mnRowPageCount; /// Number of rows in page filter area. + sal_Int32 mnColPageCount; /// Number of columns in page filter area. + + explicit PTLocationModel(); +}; + +class PivotTable : public WorkbookHelper +{ +public: + explicit PivotTable( const WorkbookHelper& rHelper ); + + /** Reads global pivot table settings from the pivotTableDefinition element. */ + void importPivotTableDefinition( const AttributeList& rAttribs ); + /** Reads the location of the pivot table from the location element. */ + void importLocation( const AttributeList& rAttribs, sal_Int16 nSheet ); + /** Reads the index of a field located in the row dimension. */ + void importRowField( const AttributeList& rAttribs ); + /** Reads the index of a field located in the column dimension. */ + void importColField( const AttributeList& rAttribs ); + /** Reads the settings of a field located in the page dimension from the pageField element. */ + void importPageField( const AttributeList& rAttribs ); + /** Reads the settings of a field located in the data dimension from the dataField element. */ + void importDataField( const AttributeList& rAttribs ); + /** Puts the attributes to the named grab bag value. */ + void putToInteropGrabBag(const OUString& sName, const AttributeList& rAttribs); + + /** Reads global pivot table settings from the PTDEFINITION record. */ + void importPTDefinition( SequenceInputStream& rStrm ); + /** Reads the location of the pivot table from the PTLOCATION record. */ + void importPTLocation( SequenceInputStream& rStrm, sal_Int16 nSheet ); + /** Reads the indexes of all fields located in the row dimension from a PTROWFIELDS record. */ + void importPTRowFields( SequenceInputStream& rStrm ); + /** Reads the indexes of all fields located in the column dimension from a PTCOLFIELDS record. */ + void importPTColFields( SequenceInputStream& rStrm ); + /** Reads the settings of a field located in the page dimension from the PTPAGEFIELD record. */ + void importPTPageField( SequenceInputStream& rStrm ); + /** Reads the settings of a field located in the data dimension from the PTDATAFIELD record. */ + void importPTDataField( SequenceInputStream& rStrm ); + + /** Creates and returns a new pivot table field. */ + PivotTableField& createTableField(); + /** Creates and returns a new pivot table filter. */ + PivotTableFilter& createTableFilter(); + /** Inserts the pivot table into the sheet. */ + void finalizeImport(); + /** Finalizes all fields, finds field names and creates grouping fields. */ + void finalizeFieldsImport(); + /** Creates all date group fields for the specified cache field after import. */ + void finalizeDateGroupingImport( + const css::uno::Reference< css::sheet::XDataPilotField >& rxBaseDPField, + sal_Int32 nBaseFieldIdx ); + /** Creates all grouped fields for the specified cache field after import. */ + void finalizeParentGroupingImport( + const css::uno::Reference< css::sheet::XDataPilotField >& rxBaseDPField, + const PivotCacheField& rBaseCacheField, + PivotCacheGroupItemVector& orItemNames ); + + /** Returns the associated data pilot field for the specified pivot table field. */ + css::uno::Reference< css::sheet::XDataPilotField > + getDataPilotField( const OUString& rFieldName ) const; + /** Returns the associated data pilot field for the specified pivot table field. */ + css::uno::Reference< css::sheet::XDataPilotField > + getDataPilotField( sal_Int32 nFieldIdx ) const; + /** Returns the data layout field used to store all data fields in row/col dimension. */ + css::uno::Reference< css::sheet::XDataPilotField > + getDataLayoutField() const; + + /** Returns the cache field with the specified index. */ + PivotCacheField* getCacheField( sal_Int32 nFieldIdx ); + const PivotCacheField* getCacheField( sal_Int32 nFieldIdx ) const; + /** Returns the base cache field of the data field item with the specified index. */ + const PivotCacheField* getCacheFieldOfDataField( sal_Int32 nDataItemIdx ) const; + /** Returns the source column index of the pivot field with the passed index, or -1. */ + sal_Int32 getCacheDatabaseIndex( sal_Int32 nFieldIdx ) const; + + ScDPObject* getDPObject() { return mpDPObject; } + +private: + typedef RefVector< PivotTableField > PivotTableFieldVector; + typedef RefVector< PivotTableFilter > PivotTableFilterVector; + typedef ::std::vector< sal_Int32 > IndexVector; + typedef ::std::vector< PTPageFieldModel > PageFieldVector; + typedef ::std::vector< PTDataFieldModel > DataFieldVector; + +private: + /** Returns a pivot table field by its index. */ + PivotTableField* getTableField( sal_Int32 nFieldIdx ); + + /** Reads a field index for the row or column dimension. */ + static void importField( IndexVector& orFields, const AttributeList& rAttribs ); + /** Reads an array of field indexes for the row or column dimension. */ + static void importFields( IndexVector& orFields, SequenceInputStream& rStrm ); + +private: + ScDPObject* mpDPObject; + PivotTableFieldVector maFields; /// All pivot table fields. + PivotTableField maDataField; /// Data layout field. + IndexVector maRowFields; /// Indexes to fields in row dimension. + IndexVector maColFields; /// Indexes to fields in column dimension. + PageFieldVector maPageFields; /// Settings for all fields in page dimension. + DataFieldVector maDataFields; /// Settings for all fields in data area. + PivotTableFilterVector maFilters; /// All field filters. + PTDefinitionModel maDefModel; /// Global pivot table settings. + PTLocationModel maLocationModel; /// Location settings of the pivot table. + PivotCache* mpPivotCache; /// The pivot cache this table is based on. + css::uno::Reference< css::sheet::XDataPilotDescriptor > + mxDPDescriptor; /// Descriptor of the DataPilot object. + std::map<OUString, css::uno::Any> maInteropGrabBag; + +}; + +class PivotTableBuffer : public WorkbookHelper +{ +public: + explicit PivotTableBuffer( const WorkbookHelper& rHelper ); + + /** Creates and returns a new pivot table. */ + PivotTable& createPivotTable(); + + /** Inserts all pivot tables into the sheet. */ + void finalizeImport(); + +private: + typedef RefVector< PivotTable > PivotTableVector; + PivotTableVector maTables; +}; + +} // namespace oox::xls + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |