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