sc/source/filter/inc/tablebuffer.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   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/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  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 .
  18  */
  19
  20 #ifndef INCLUDED_SC_SOURCE_FILTER_INC_TABLEBUFFER_HXX
  21 #define INCLUDED_SC_SOURCE_FILTER_INC_TABLEBUFFER_HXX
  22
  23 #include "autofilterbuffer.hxx"
  24 #include "tablecolumnsbuffer.hxx"
  25 #include "workbookhelper.hxx"
  26
  27 namespace oox {
  28 namespace xls {
  29
  30 struct TableModel
  31 {
  32     ScRange             maRange;            /// Original (unchecked) range of the table.
  33     OUString            maProgName;         /// Programmatical name.
  34     OUString            maDisplayName;      /// Display name.
  35     sal_Int32           mnId;               /// Unique table identifier.
  36     sal_Int32           mnType;             /// Table type (worksheet, query, etc.).
  37     sal_Int32           mnHeaderRows;       /// Number of header rows.
  38     sal_Int32           mnTotalsRows;       /// Number of totals rows.
  39
  40     explicit            TableModel();
  41 };
  42
  43 class Table : public WorkbookHelper
  44 {
  45 public:
  46     explicit            Table( const WorkbookHelper& rHelper );
  47
  48     /** Imports a table definition from the passed attributes. */
  49     void                importTable( const AttributeList& rAttribs, sal_Int16 nSheet );
  50     /** Imports a table definition from a TABLE record. */
  51     void                importTable( SequenceInputStream& rStrm, sal_Int16 nSheet );
  52     /** Creates a new auto filter and stores it internally. */
  53     AutoFilter&  createAutoFilter() { return maAutoFilters.createAutoFilter(); }
  54     /** Creates a new tableColumns handler and stores it internally. */
  55     TableColumns&  createTableColumns() { return maTableColumns.createTableColumns(); }
  56
  57     /** Creates a database range from this tables. */
  58     void                finalizeImport();
  59     void                applyAutoFilters();
  60     void                applyTableColumns();
  61
  62     /** Returns the unique table identifier. */
  63     sal_Int32    getTableId() const { return maModel.mnId; }
  64     /** Returns the token index used in API token arrays (com.sun.star.sheet.FormulaToken). */
  65     sal_Int32    getTokenIndex() const { return mnTokenIndex; }
  66     /** Returns the original display name of the table. */
  67     const OUString& getDisplayName() const { return maModel.maDisplayName; }
  68
  69     /** Returns the original (unchecked) total range of the table. */
  70     const ScRange& getOriginalRange() const { return maModel.maRange; }
  71     /** Returns the cell range of this table. */
  72     const ScRange& getRange() const { return maDestRange; }
  73     /** Returns the number of columns of this table. */
  74     SCCOL        getWidth() const { return maDestRange.aEnd.Col() - maDestRange.aStart.Col() + 1; }
  75     /** Returns the number of rows of this table. */
  76     SCROW        getHeight() const { return maDestRange.aEnd.Row() - maDestRange.aStart.Row() + 1; }
  77     /** Returns the number of header rows in the table range. */
  78     sal_Int32    getHeaderRows() const { return maModel.mnHeaderRows; }
  79     /** Returns the number of totals rows in the table range. */
  80     sal_Int32    getTotalsRows() const { return maModel.mnTotalsRows; }
  81
  82 private:
  83     TableModel          maModel;
  84     AutoFilterBuffer    maAutoFilters;      /// Filter settings for this table.
  85     TableColumnsBuffer  maTableColumns;     /// Column names of this table.
  86     OUString            maDBRangeName;      /// Name of the database range in the Calc document.
  87     ScRange             maDestRange;        /// Validated range of the table in the worksheet.
  88     sal_Int32           mnTokenIndex;       /// Token index used in API token array.
  89 };
  90
  91 typedef std::shared_ptr< Table > TableRef;
  92
  93 class TableBuffer : public WorkbookHelper
  94 {
  95 public:
  96     explicit            TableBuffer( const WorkbookHelper& rHelper );
  97
  98     /** Creates a new empty table. */
  99     Table&              createTable();
 100
 101     /** Creates database ranges from all imported tables. */
 102     void                finalizeImport();
 103     /** Applies autofilters from created database range ( requires finalizeImport to have run before being called */
 104     void                applyAutoFilters();
 105     /** Applies columns names from created database range ( requires finalizeImport to have run before being called */
 106     void                applyTableColumns();
 107     /** Returns a table by its identifier. */
 108     TableRef            getTable( sal_Int32 nTableId ) const;
 109     /** Returns a table by its display name. */
 110     TableRef            getTable( const OUString& rDispName ) const;
 111
 112 private:
 113     /** Inserts the passed table into the maps according to its identifier and name. */
 114     void                insertTableToMaps( const TableRef& rxTable );
 115
 116 private:
 117     typedef RefVector< Table >           TableVector;
 118     typedef RefMap< sal_Int32, Table >   TableIdMap;
 119     typedef RefMap< OUString, Table >    TableNameMap;
 120
 121     TableVector         maTables;
 122     TableIdMap          maIdTables;
 123     TableNameMap        maNameTables;
 124 };
 125
 126 } // namespace xls
 127 } // namespace oox
 128
 129 #endif
 130
 131 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */