LibreOffice Module sc (master)  1
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
sc::ExternalDataSource Class Reference

#include <datamapper.hxx>

Collaboration diagram for sc::ExternalDataSource:
[legend]

Public Member Functions

 ExternalDataSource (const OUString &rURL, const OUString &rProvider, ScDocument *pDoc)
 
void setUpdateFrequency (double nUpdateFrequency)
 
void setID (const OUString &rID)
 
void setURL (const OUString &rURL)
 
void setProvider (const OUString &rProvider)
 
void setXMLImportParam (const ScOrcusImportXMLParam &rParam)
 
const OUString & getURL () const
 
const OUString & getProvider () const
 
const OUString & getID () const
 
const ScOrcusImportXMLParamgetXMLImportParam () const
 
OUString getDBName () const
 
void setDBData (const OUString &rDBName)
 
ScDBDataManagergetDBManager ()
 
void refresh (ScDocument *pDoc, bool bDeterministic=false)
 
void AddDataTransformation (const std::shared_ptr< sc::DataTransformation > &mpDataTransformation)
 
const std::vector< std::shared_ptr< sc::DataTransformation > > & getDataTransformation () const
 

Static Public Member Functions

static double getUpdateFrequency ()
 

Private Attributes

OUString maURL
 The URL for the external data provider. More...
 
OUString maProvider
 The data provider is a unique identifier that will allow to identify and instantiate the required data provider. More...
 
OUString maID
 The ID allows the same data provider to support different data streams. More...
 
ScOrcusImportXMLParam maParam
 
std::shared_ptr< DataProvidermpDataProvider
 
std::shared_ptr< ScDBDataManagermpDBDataManager
 
std::vector< std::shared_ptr< sc::DataTransformation > > maDataTransformations
 
ScDocumentmpDoc
 

Detailed Description

Definition at line 29 of file datamapper.hxx.

Constructor & Destructor Documentation

sc::ExternalDataSource::ExternalDataSource ( const OUString &  rURL,
const OUString &  rProvider,
ScDocument pDoc 
)

Definition at line 65 of file dataprovider.cxx.

Member Function Documentation

void sc::ExternalDataSource::AddDataTransformation ( const std::shared_ptr< sc::DataTransformation > &  mpDataTransformation)

Definition at line 169 of file dataprovider.cxx.

References maDataTransformations.

Referenced by ScDataProviderDlg::import().

const std::vector< std::shared_ptr< sc::DataTransformation > > & sc::ExternalDataSource::getDataTransformation ( ) const
ScDBDataManager * sc::ExternalDataSource::getDBManager ( )
OUString sc::ExternalDataSource::getDBName ( ) const

Definition at line 116 of file dataprovider.cxx.

References ScDBData::GetName(), and mpDBDataManager.

Referenced by ScDataProviderDlg::import().

const OUString & sc::ExternalDataSource::getID ( ) const
const OUString & sc::ExternalDataSource::getProvider ( ) const

Definition at line 101 of file dataprovider.cxx.

References maProvider.

Referenced by sc::DataProviderFactory::getDataProvider().

double sc::ExternalDataSource::getUpdateFrequency ( )
static

Definition at line 139 of file dataprovider.cxx.

Referenced by ScXMLExport::WriteExternalDataMapping().

const OUString & sc::ExternalDataSource::getURL ( ) const
const ScOrcusImportXMLParam & sc::ExternalDataSource::getXMLImportParam ( ) const

Definition at line 111 of file dataprovider.cxx.

References maParam.

Referenced by sc::XMLDataProvider::Import().

void sc::ExternalDataSource::refresh ( ScDocument pDoc,
bool  bDeterministic = false 
)
void sc::ExternalDataSource::setDBData ( const OUString &  rDBName)

Definition at line 127 of file dataprovider.cxx.

References mpDBDataManager, and mpDoc.

Referenced by ScDataProviderDlg::import(), and ScXMLMappingContext::ScXMLMappingContext().

void sc::ExternalDataSource::setID ( const OUString &  rID)
void sc::ExternalDataSource::setProvider ( const OUString &  rProvider)

Definition at line 90 of file dataprovider.cxx.

References maProvider, and mpDataProvider.

void sc::ExternalDataSource::setUpdateFrequency ( double  nUpdateFrequency)
void sc::ExternalDataSource::setURL ( const OUString &  rURL)

Definition at line 85 of file dataprovider.cxx.

References maURL.

void sc::ExternalDataSource::setXMLImportParam ( const ScOrcusImportXMLParam rParam)

Definition at line 78 of file dataprovider.cxx.

References maParam.

Member Data Documentation

std::vector<std::shared_ptr<sc::DataTransformation> > sc::ExternalDataSource::maDataTransformations
private

Definition at line 70 of file datamapper.hxx.

Referenced by AddDataTransformation(), and getDataTransformation().

OUString sc::ExternalDataSource::maID
private

The ID allows the same data provider to support different data streams.

A data provider may decide to ignore the ID string.

Definition at line 63 of file datamapper.hxx.

Referenced by getID(), and setID().

ScOrcusImportXMLParam sc::ExternalDataSource::maParam
private

Definition at line 65 of file datamapper.hxx.

Referenced by getXMLImportParam(), and setXMLImportParam().

OUString sc::ExternalDataSource::maProvider
private

The data provider is a unique identifier that will allow to identify and instantiate the required data provider.

Examples for the internal data providers are:

org.libreoffice.dataprovider.calc.csv org.libreoffice.dataprovider.calc.json

Only internal data providers should use the: "org.libreoffice.dataprovider prefix".

Definition at line 55 of file datamapper.hxx.

Referenced by getProvider(), and setProvider().

OUString sc::ExternalDataSource::maURL
private

The URL for the external data provider.

The URL will be passed to the data provider together with the ID.

A data provider may decide to ignore the URL string.

Definition at line 40 of file datamapper.hxx.

Referenced by getURL(), and setURL().

std::shared_ptr<DataProvider> sc::ExternalDataSource::mpDataProvider
private

Definition at line 67 of file datamapper.hxx.

Referenced by refresh(), and setProvider().

std::shared_ptr<ScDBDataManager> sc::ExternalDataSource::mpDBDataManager
private

Definition at line 68 of file datamapper.hxx.

Referenced by getDBManager(), getDBName(), refresh(), and setDBData().

ScDocument* sc::ExternalDataSource::mpDoc
private

Definition at line 72 of file datamapper.hxx.

Referenced by setDBData().


The documentation for this class was generated from the following files: