Configuration for the content adapter, defines the data model of the data object tree and source of the data in content system. More...

#include <content_adapter_configuration.hpp>

Classes
class	Field
	Describes a single column in database. More...

Public Types
enum	Type { Single, List }
	Type of content adapter. More...

Public Member Functions
	ContentAdapterConfiguration ()
	Constructor. More...

bool	fillOverrideValues (ContentAdapterConfiguration &overriderConf)
	Override this objects contents from another configuration. More...

Field *	getField (const string &fieldName)
	Finds the given field within the configuration. More...

bool	isRuntimeData () const
	Is this object a runtime data object. More...

Public Attributes
int	m_creditReturnInterval

int	m_credits

string	m_dataObjectName
	Name of the root data object. More...

string	m_dynamicSourceName
	if this is dynamic service holds the name More...

vector< Field >	m_fields
	Columns to read from the table. More...

string	m_filter
	Where clause for filtering output rows. More...

size_t	m_limitCount
	Output row count. More...

size_t	m_limitIndex
	Output row index. More...

RuntimeDataObjectSharedPtr	m_runtimeObject

bool	m_singleShot
	If true, stops content subscription after first result. More...

string	m_sort
	Order by clause for sorting output rows. More...

size_t	m_subscriptionBlockSize
	Size of subscription block. How many rows are loaded simultaneously. More...

Type	m_type
	Type of the adapter. More...

string	m_uri
	Name of the database table. More...

Detailed Description

Configuration for the content adapter, defines the data model of the data object tree and source of the data in content system.

Member Enumeration Documentation

◆ Type

enum kanzi::connect::ContentAdapterConfiguration::Type

Type of content adapter.

Enumerator
Single	Content adapter translates only single rows.
List	Content adapter translates lists of id's that are separated by ';'.

Constructor & Destructor Documentation

◆ ContentAdapterConfiguration()

kanzi::connect::ContentAdapterConfiguration::ContentAdapterConfiguration ( )

Constructor.

Member Function Documentation

◆ fillOverrideValues()

bool kanzi::connect::ContentAdapterConfiguration::fillOverrideValues ( ContentAdapterConfiguration & overriderConf )

Override this objects contents from another configuration.

Parameters

overriderConf instance whose values are used to override, if it contains new fields they are move copied

Returns: True if no errors when overriding

◆ getField()

Field* kanzi::connect::ContentAdapterConfiguration::getField ( const string & fieldName )

Finds the given field within the configuration.

Parameters

fieldName identifies the field by its name

Returns: Pointer to the field, null pointer if not found

◆ isRuntimeData()

bool kanzi::connect::ContentAdapterConfiguration::isRuntimeData ( ) const

inline

Is this object a runtime data object.

Returns: true if runtime data.

Member Data Documentation

◆ m_creditReturnInterval

int kanzi::connect::ContentAdapterConfiguration::m_creditReturnInterval

◆ m_credits

int kanzi::connect::ContentAdapterConfiguration::m_credits

◆ m_dataObjectName

string kanzi::connect::ContentAdapterConfiguration::m_dataObjectName

Name of the root data object.

◆ m_dynamicSourceName

string kanzi::connect::ContentAdapterConfiguration::m_dynamicSourceName

if this is dynamic service holds the name

◆ m_fields

vector<Field> kanzi::connect::ContentAdapterConfiguration::m_fields

Columns to read from the table.

◆ m_filter

string kanzi::connect::ContentAdapterConfiguration::m_filter

Where clause for filtering output rows.

◆ m_limitCount

size_t kanzi::connect::ContentAdapterConfiguration::m_limitCount

Output row count.

◆ m_limitIndex

size_t kanzi::connect::ContentAdapterConfiguration::m_limitIndex

Output row index.

◆ m_runtimeObject

RuntimeDataObjectSharedPtr kanzi::connect::ContentAdapterConfiguration::m_runtimeObject

◆ m_singleShot

bool kanzi::connect::ContentAdapterConfiguration::m_singleShot

If true, stops content subscription after first result.

◆ m_sort

string kanzi::connect::ContentAdapterConfiguration::m_sort

Order by clause for sorting output rows.

◆ m_subscriptionBlockSize

size_t kanzi::connect::ContentAdapterConfiguration::m_subscriptionBlockSize

Size of subscription block. How many rows are loaded simultaneously.

◆ m_type

Type kanzi::connect::ContentAdapterConfiguration::m_type

Type of the adapter.

◆ m_uri

string kanzi::connect::ContentAdapterConfiguration::m_uri

Name of the database table.

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

connect/kanzi_adaptation/datasource/content_adapter_configuration.hpp

Classes

Public Types

Public Member Functions

Public Attributes