sc/inc/datamapper.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
  10 #ifndef INCLUDED_SC_INC_EXTERNALDATAMAPPER_HXX
  11 #define INCLUDED_SC_INC_EXTERNALDATAMAPPER_HXX
  12
  13 #include <vector>
  14
  15 #include "scdllapi.h"
  16
  17 #include <rtl/ustring.hxx>
  18
  19 class ScDocument;
  20 class ScDBData;
  21
  22 namespace sc {
  23
  24 class ScDBDataManager;
  25 class DataProvider;
  26 class ScDBDataManager;
  27 class DataTransformation;
  28
  29 class SC_DLLPUBLIC ExternalDataSource
  30 {
  31 private:
  32
  33     /**
  34      * The URL for the external data provider. The URL
  35      * will be passed to the data provider together with
  36      * the ID.
  37      *
  38      * A data provider may decide to ignore the URL string.
  39      */
  40     OUString maURL;
  41
  42     /**
  43      * The data provider is a unique identifier that will
  44      * allow to identify and instantiate the required data
  45      * provider.
  46      *
  47      * Examples for the internal data providers are:
  48      *
  49      * org.libreoffice.dataprovider.calc.csv
  50      * org.libreoffice.dataprovider.calc.json
  51      *
  52      * Only internal data providers should use the:
  53      * "org.libreoffice.dataprovider prefix".
  54      */
  55     OUString maProvider;
  56
  57     /**
  58      * The ID allows the same data provider to support different
  59      * data streams.
  60      *
  61      * A data provider may decide to ignore the ID string.
  62      */
  63     OUString maID;
  64
  65     double mnUpdateFrequency;
  66
  67     std::shared_ptr<DataProvider> mpDataProvider;
  68     std::shared_ptr<ScDBDataManager> mpDBDataManager;
  69
  70     std::vector<std::shared_ptr<sc::DataTransformation>> maDataTransformations;
  71
  72     ScDocument* mpDoc;
  73
  74 public:
  75
  76     ExternalDataSource(const OUString& rURL,
  77             const OUString& rProvider, ScDocument* pDoc);
  78
  79     ~ExternalDataSource();
  80
  81     void setUpdateFrequency(double nUpdateFrequency);
  82
  83     void setID(const OUString& rID);
  84     void setURL(const OUString& rURL);
  85     void setProvider(const OUString& rProvider);
  86
  87     const OUString& getURL() const;
  88     const OUString& getProvider() const;
  89     const OUString& getID() const;
  90     double getUpdateFrequency() const;
  91     OUString getDBName() const;
  92     void setDBData(const ScDBData* pDBData);
  93     ScDBDataManager* getDBManager();
  94
  95     void refresh(ScDocument* pDoc, bool bDeterministic = false);
  96
  97     void AddDataTransformation(std::shared_ptr<sc::DataTransformation> mpDataTransformation);
  98     const std::vector<std::shared_ptr<sc::DataTransformation>>& getDataTransformation() const;
  99 };
 100
 101 class SC_DLLPUBLIC ExternalDataMapper
 102 {
 103     //ScDocument* mpDoc;
 104     std::vector<ExternalDataSource> maDataSources;
 105
 106 public:
 107     ExternalDataMapper(ScDocument* pDoc);
 108
 109     ~ExternalDataMapper();
 110
 111     void insertDataSource(const ExternalDataSource& rSource);
 112
 113     const std::vector<ExternalDataSource>& getDataSources() const;
 114     std::vector<ExternalDataSource>& getDataSources();
 115 };
 116
 117 }
 118
 119 #endif
 120
 121 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */