sc/source/core/inc/doubleref.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 SC_DOUBLEREF_HXX
  21 #define SC_DOUBLEREF_HXX
  22
  23 #include "address.hxx"
  24 #include "types.hxx"
  25
  26 class ScDocument;
  27 struct ScDBQueryParamBase;
  28 struct ScQueryParamBase;
  29
  30 // ============================================================================
  31
  32 /**
  33  * Base class for abstracting range data backends for database functions.
  34  */
  35 class ScDBRangeBase
  36 {
  37 public:
  38     enum RefType { INTERNAL, EXTERNAL }; // TODO: We may not need this after all... (kohei)
  39
  40     virtual ~ScDBRangeBase() = 0;
  41
  42     bool fillQueryEntries(ScQueryParamBase* pParam, const ScDBRangeBase* pDBRef) const;
  43
  44     virtual SCCOL getColSize() const = 0;
  45     virtual SCROW getRowSize() const = 0;
  46     virtual SCSIZE getVisibleDataCellCount() const = 0;
  47
  48     /**
  49      * Get a string value of a specified cell position.  Note that the
  50      * position of the upper left cell of the range is always (0, 0) even if
  51      * the reference type is of internal range.
  52      *
  53      * @param nCol column position (0 to column size-1)
  54      * @param nRow row position (0 to row size-1)
  55      */
  56     virtual OUString getString(SCCOL nCol, SCROW nRow) const = 0;
  57
  58     virtual SCCOL getFirstFieldColumn() const = 0;
  59
  60     /**
  61      * Get a <i>0-based</i> column index that corresponds with the passed field
  62      * index.  Note that the field index passed as the 1st parameter is
  63      * <i>1-based.</i>
  64      *
  65      * @param nIndex 1-based field index.
  66      *
  67      * @return 0-based column index
  68      */
  69     virtual SCCOL findFieldColumn(SCCOL nIndex) const = 0;
  70     virtual SCCOL findFieldColumn(const OUString& rStr, sal_uInt16* pErr = NULL) const = 0;
  71     virtual ScDBQueryParamBase* createQueryParam(const ScDBRangeBase* pQueryRef) const = 0;
  72     virtual bool isRangeEqual(const ScRange& rRange) const = 0;
  73
  74 protected:
  75     ScDBRangeBase(ScDocument* pDoc, RefType eType);
  76     ScDocument* getDoc() const;
  77
  78     /**
  79      * Populate query options that are always the same for all database
  80      * queries.
  81      */
  82     static void fillQueryOptions(ScQueryParamBase* pParam);
  83
  84 private:
  85     ScDBRangeBase(); // disabled
  86
  87     ScDocument* mpDoc;
  88     RefType meType;
  89 };
  90
  91 // ============================================================================
  92
  93 class ScDBInternalRange : public ScDBRangeBase
  94 {
  95 public:
  96     explicit ScDBInternalRange(ScDocument* pDoc, const ScRange& rRange);
  97     virtual ~ScDBInternalRange();
  98
  99     const ScRange& getRange() const;
 100
 101     virtual SCCOL getColSize() const;
 102     virtual SCROW getRowSize() const;
 103     virtual SCSIZE getVisibleDataCellCount() const;
 104
 105     /**
 106      * Get a string value of a specified cell position.  Note that the
 107      * position of the upper left cell of the range is always (0, 0) even if
 108      * the reference type is of internal range.
 109      *
 110      * @param nCol column position (0 to column size-1)
 111      * @param nRow row position (0 to row size-1)
 112      */
 113     virtual OUString getString(SCCOL nCol, SCROW nRow) const;
 114
 115     virtual SCCOL getFirstFieldColumn() const;
 116     /**
 117      * Get a <i>0-based</i> column index that corresponds with the passed field
 118      * index.  Note that the field index passed as the 1st parameter is
 119      * <i>1-based.</i>
 120      *
 121      * @param nIndex 1-based field index.
 122      *
 123      * @return 0-based column index
 124      */
 125     virtual SCCOL findFieldColumn(SCCOL nIndex) const;
 126     virtual SCCOL findFieldColumn(const OUString& rStr, sal_uInt16* pErr = NULL) const;
 127     virtual ScDBQueryParamBase* createQueryParam(const ScDBRangeBase* pQueryRef) const;
 128     virtual bool isRangeEqual(const ScRange& rRange) const;
 129
 130 private:
 131     ScRange maRange;
 132 };
 133
 134 // ============================================================================
 135
 136 class ScDBExternalRange : public ScDBRangeBase
 137 {
 138 public:
 139     explicit ScDBExternalRange(ScDocument* pDoc, const ScMatrixRef& pMat);
 140     virtual ~ScDBExternalRange();
 141
 142     virtual SCCOL getColSize() const;
 143     virtual SCROW getRowSize() const;
 144     virtual SCSIZE getVisibleDataCellCount() const;
 145
 146     /**
 147      * Get a string value of a specified cell position.  Note that the
 148      * position of the upper left cell of the range is always (0, 0) even if
 149      * the reference type is of internal range.
 150      *
 151      * @param nCol column position (0 to column size-1)
 152      * @param nRow row position (0 to row size-1)
 153      */
 154     virtual OUString getString(SCCOL nCol, SCROW nRow) const;
 155
 156     virtual SCCOL getFirstFieldColumn() const;
 157
 158     /**
 159      * Get a <i>0-based</i> column index that corresponds with the passed field
 160      * index.  Note that the field index passed as the 1st parameter is
 161      * <i>1-based.</i>
 162      *
 163      * @param nIndex 1-based field index.
 164      *
 165      * @return 0-based column index
 166      */
 167     virtual SCCOL findFieldColumn(SCCOL nIndex) const;
 168     virtual SCCOL findFieldColumn(const OUString& rStr, sal_uInt16* pErr = NULL) const;
 169     virtual ScDBQueryParamBase* createQueryParam(const ScDBRangeBase* pQueryRef) const;
 170     virtual bool isRangeEqual(const ScRange& rRange) const;
 171
 172 private:
 173     const ScMatrixRef mpMatrix;
 174     SCCOL mnCols;
 175     SCROW mnRows;
 176 };
 177
 178 #endif
 179
 180 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */