te::da::DataSourceCapabilities Class Reference

A class that represents the known capabilities of a specific data source, i.e. this class informs all information about what the data source can perform. Here you will find if the data source implementation supports primary keys, foreign keys, if it can be used in a thread environment and much more information. More...

#include <DataSourceCapabilities.h>

Public Member Functions

void addSpecificCapability (const std::string &key, const std::string &value)
 
 DataSourceCapabilities ()
 Constructor. More...
 
te::common::AccessPolicy getAccessPolicy () const
 
const DataSetCapabilitiesgetDataSetCapabilities () const
 
const DataSetTypeCapabilitiesgetDataSetTypeCapabilities () const
 
const DataTypeCapabilitiesgetDataTypeCapabilities () const
 
const QueryCapabilitiesgetQueryCapabilities () const
 
const std::map< std::string, std::string > & getSpecificCapabilities () const
 
void setAccessPolicy (const te::common::AccessPolicy &accessPolicy)
 
void setDataSetCapabilities (const DataSetCapabilities &capabilities)
 
void setDataSetTypeCapabilities (const DataSetTypeCapabilities &capabilities)
 
void setDataTypeCapabilities (const DataTypeCapabilities &capabilities)
 
void setQueryCapabilities (const QueryCapabilities &capabilities)
 
void setSupportAll ()
 
void setSupportBatchExecutorAPI (const bool &support)
 
void setSupportDataSetPesistenceAPI (const bool &support)
 
void setSupportDataSetTypePesistenceAPI (const bool &support)
 
void setSupportPreparedQueryAPI (const bool &support)
 
void setSupportTransactions (const bool &support)
 
bool supportsBatchExecutorAPI () const
 
bool supportsDataSetPesistenceAPI () const
 
bool supportsDataSetTypePesistenceAPI () const
 
bool supportsPreparedQueryAPI () const
 
bool supportsTransactions () const
 
 ~DataSourceCapabilities ()
 Destructor. More...
 

Private Attributes

te::common::AccessPolicy m_accessPolicy
 A value that indicates the data source access policy. More...
 
DataSetCapabilities m_dataSetCapabilities
 The DataSet Capabilities. More...
 
DataSetTypeCapabilities m_dataSetTypeCapabilities
 The DataSetType Capabilities. More...
 
DataTypeCapabilities m_dataTypeCapabilities
 The DataType Capabilities. More...
 
QueryCapabilities m_queryCapabilities
 The Query Capabilities. More...
 
std::map< std::string, std::string > m_specificCapabilities
 A list of key-value-pairs that data source driver can supply with specifics capabilities. More...
 
bool m_supportBatchExecutorAPI
 A flag that indicates if the data source supports the BatchExecutor API. More...
 
bool m_supportDataSetPesistenceAPI
 A flag that indicates if the data source supports the DataSetPersistence API. More...
 
bool m_supportDataSetTypePesistenceAPI
 A flag that indicates if the data source supports the DataSetTypePersistence API. More...
 
bool m_supportPreparedQueryAPI
 A flag that indicates if the data source supports the PreparedQuery API. More...
 
bool m_supportTransactions
 A flag that indicates if the data source supports ACID transactions. More...
 

Detailed Description

A class that represents the known capabilities of a specific data source, i.e. this class informs all information about what the data source can perform. Here you will find if the data source implementation supports primary keys, foreign keys, if it can be used in a thread environment and much more information.

Definition at line 55 of file DataSourceCapabilities.h.

Constructor & Destructor Documentation

te::da::DataSourceCapabilities::DataSourceCapabilities ( )

Constructor.

Definition at line 29 of file DataSourceCapabilities.cpp.

References ~DataSourceCapabilities().

te::da::DataSourceCapabilities::~DataSourceCapabilities ( )
default

Destructor.

Referenced by DataSourceCapabilities().

Member Function Documentation

void te::da::DataSourceCapabilities::addSpecificCapability ( const std::string &  key,
const std::string &  value 
)
te::common::AccessPolicy te::da::DataSourceCapabilities::getAccessPolicy ( ) const

Definition at line 41 of file DataSourceCapabilities.cpp.

References m_accessPolicy.

Referenced by PrintDataSourceCapabilities().

const te::da::DataSetTypeCapabilities & te::da::DataSourceCapabilities::getDataSetTypeCapabilities ( ) const

Definition at line 111 of file DataSourceCapabilities.cpp.

References m_dataSetTypeCapabilities.

Referenced by PrintDataSourceCapabilities().

const std::map< std::string, std::string > & te::da::DataSourceCapabilities::getSpecificCapabilities ( ) const

Definition at line 141 of file DataSourceCapabilities.cpp.

References m_specificCapabilities.

void te::da::DataSourceCapabilities::setAccessPolicy ( const te::common::AccessPolicy accessPolicy)
void te::da::DataSourceCapabilities::setDataSetCapabilities ( const DataSetCapabilities capabilities)
void te::da::DataSourceCapabilities::setDataSetTypeCapabilities ( const DataSetTypeCapabilities capabilities)
void te::da::DataSourceCapabilities::setDataTypeCapabilities ( const DataTypeCapabilities capabilities)
void te::da::DataSourceCapabilities::setQueryCapabilities ( const QueryCapabilities capabilities)
void te::da::DataSourceCapabilities::setSupportBatchExecutorAPI ( const bool support)

Definition at line 96 of file DataSourceCapabilities.cpp.

References m_supportBatchExecutorAPI.

Referenced by te::serialize::xml::Read().

void te::da::DataSourceCapabilities::setSupportDataSetPesistenceAPI ( const bool support)
void te::da::DataSourceCapabilities::setSupportDataSetTypePesistenceAPI ( const bool support)
void te::da::DataSourceCapabilities::setSupportPreparedQueryAPI ( const bool support)

Definition at line 86 of file DataSourceCapabilities.cpp.

References m_supportPreparedQueryAPI.

Referenced by te::serialize::xml::Read().

void te::da::DataSourceCapabilities::setSupportTransactions ( const bool support)
bool te::da::DataSourceCapabilities::supportsBatchExecutorAPI ( ) const

Definition at line 91 of file DataSourceCapabilities.cpp.

References m_supportBatchExecutorAPI.

Referenced by PrintDataSourceCapabilities().

bool te::da::DataSourceCapabilities::supportsDataSetPesistenceAPI ( ) const

Definition at line 61 of file DataSourceCapabilities.cpp.

References m_supportDataSetPesistenceAPI.

Referenced by PrintDataSourceCapabilities().

bool te::da::DataSourceCapabilities::supportsDataSetTypePesistenceAPI ( ) const

Definition at line 71 of file DataSourceCapabilities.cpp.

References m_supportDataSetTypePesistenceAPI.

Referenced by PrintDataSourceCapabilities().

bool te::da::DataSourceCapabilities::supportsTransactions ( ) const

Definition at line 51 of file DataSourceCapabilities.cpp.

References m_supportTransactions.

Referenced by PrintDataSourceCapabilities().

Member Data Documentation

te::common::AccessPolicy te::da::DataSourceCapabilities::m_accessPolicy
private

A value that indicates the data source access policy.

Definition at line 115 of file DataSourceCapabilities.h.

Referenced by getAccessPolicy(), and setAccessPolicy().

DataSetCapabilities te::da::DataSourceCapabilities::m_dataSetCapabilities
private

The DataSet Capabilities.

Definition at line 124 of file DataSourceCapabilities.h.

Referenced by getDataSetCapabilities(), and setDataSetCapabilities().

DataSetTypeCapabilities te::da::DataSourceCapabilities::m_dataSetTypeCapabilities
private

The DataSetType Capabilities.

Definition at line 123 of file DataSourceCapabilities.h.

Referenced by getDataSetTypeCapabilities(), and setDataSetTypeCapabilities().

DataTypeCapabilities te::da::DataSourceCapabilities::m_dataTypeCapabilities
private

The DataType Capabilities.

Definition at line 122 of file DataSourceCapabilities.h.

Referenced by getDataTypeCapabilities(), and setDataTypeCapabilities().

QueryCapabilities te::da::DataSourceCapabilities::m_queryCapabilities
private

The Query Capabilities.

Definition at line 125 of file DataSourceCapabilities.h.

Referenced by getQueryCapabilities(), and setQueryCapabilities().

std::map<std::string, std::string> te::da::DataSourceCapabilities::m_specificCapabilities
private

A list of key-value-pairs that data source driver can supply with specifics capabilities.

Definition at line 127 of file DataSourceCapabilities.h.

Referenced by addSpecificCapability(), and getSpecificCapabilities().

bool te::da::DataSourceCapabilities::m_supportBatchExecutorAPI
private

A flag that indicates if the data source supports the BatchExecutor API.

Definition at line 120 of file DataSourceCapabilities.h.

Referenced by setSupportAll(), setSupportBatchExecutorAPI(), and supportsBatchExecutorAPI().

bool te::da::DataSourceCapabilities::m_supportDataSetPesistenceAPI
private

A flag that indicates if the data source supports the DataSetPersistence API.

Definition at line 117 of file DataSourceCapabilities.h.

Referenced by setSupportAll(), setSupportDataSetPesistenceAPI(), and supportsDataSetPesistenceAPI().

bool te::da::DataSourceCapabilities::m_supportDataSetTypePesistenceAPI
private

A flag that indicates if the data source supports the DataSetTypePersistence API.

Definition at line 118 of file DataSourceCapabilities.h.

Referenced by setSupportAll(), setSupportDataSetTypePesistenceAPI(), and supportsDataSetTypePesistenceAPI().

bool te::da::DataSourceCapabilities::m_supportPreparedQueryAPI
private

A flag that indicates if the data source supports the PreparedQuery API.

Definition at line 119 of file DataSourceCapabilities.h.

Referenced by setSupportAll(), setSupportPreparedQueryAPI(), and supportsPreparedQueryAPI().

bool te::da::DataSourceCapabilities::m_supportTransactions
private

A flag that indicates if the data source supports ACID transactions.

Definition at line 116 of file DataSourceCapabilities.h.

Referenced by setSupportAll(), setSupportTransactions(), and supportsTransactions().


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