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