kanzi::connect::AbstractConnectDataSource Class Reference

Implements abstract base class for data source type that is able to transform Kanzi Connect database query to data object tree. More...

#include <abstract_connect_datasource.hpp>

Inheritance diagram for kanzi::connect::AbstractConnectDataSource:

Public Member Functions
	KZ_METACLASS_END ()
void	onDataObjectChanged (RuntimeDataObjectWeakPtr runtimeObject, const DataObjectSharedPtr dataObject)
	Handler for changes coming from the DataObjects under the data source data tree.
virtual void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
void	start ()
	Starts operation.
void	stop ()
	Stops operation.
virtual	~AbstractConnectDataSource () override
	Destructor.
virtual DataObjectSharedPtr	getData () override
virtual void	loadFromKZB (Domain *domain, KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser) override
virtual void	unloadOverride ()
Public Member Functions inherited from kanzi::connect::ContentAdapterManager
void	addAdapter (ContentAdapterSharedPtr adapter)
	Adds new adapter to list of adapters, but does not set up or start it.
	ContentAdapterManager (ContextSharedPtr context, DataSource *dataSource)
	Constructor.
	ContentAdapterManager (DataSource *dataSource)
	Constructor.
virtual ContentAdapterSharedPtr	createAdapter (const string &serverName, const ContentAdapterConfigurationSharedPtr config, Domain *domain)
	Creates a standard adapter.
void	destroyAllAdapters ()
	Stops and cleans up all adapters.
ContentAdapterSharedPtr	findDynamicSource (const string &name)
	Locates a dynamic source with given name.
ContentAdapterSharedPtr	findSource (const string &name)
	Locates a source with given name.
ContentAdapterManager::AdapterContainer	getAdapters ()
	Retrieves all currently known adapters.
ContextSharedPtr	getContext () const
	Returns gateway to Kanzi Connect server.
void	initializeAllAdapters (DataObjectSharedPtr root)
	Initializes all adapters.
void	removeAdapter (ContentAdapterSharedPtr adapter)
	Removes adapter from list of adapters.
void	setContext (ContextSharedPtr context)
	Set gateway to Kanzi Connect server.
virtual ContentAdapterSharedPtr	startAdapter (const string &serverName, DataObjectSharedPtr root, const ContentAdapterConfigurationSharedPtr config)
	Instantiates and starts new adapter according to given parameters.
void	startAllAdapters ()
	Starts all adapters.
virtual void	stopAdapter (ContentAdapterSharedPtr adapter)
	Stops an existing adapter.
void	stopAllAdapters ()
	Stops all existing adapters.
virtual	~ContentAdapterManager ()=default
	dtor

Static Public Attributes
static PropertyType< string >	ServerNameProperty
static PropertyType< bool >	ServiceEnabledProperty
static PropertyType< string >	ServiceIdentifierProperty

name Name of the data source.
Constructor. Parameters domain Kanzi UI Domain.
	AbstractConnectDataSource (kanzi::Domain *domain, kanzi::string_view name)
void	onConnectionStateChanged (Connection::State state)
	Callback for connection state changes.
virtual void	onCreateAdapters ()=0
	Derived class needs to implement this in order to populate adapters for this data source.
virtual void	onReleaseAdapters ()
	Derived class needs to implement this in order to release adapters of this data source.
bool	isConnected () const
	Check if this data source is connected to server.

Additional Inherited Members
Public Types inherited from kanzi::connect::ContentAdapterManager
typedef vector< ContentAdapterSharedPtr >	AdapterContainer
Protected Attributes inherited from kanzi::connect::ContentAdapterManager
DataSource *	m_dataSource
	The instance which owns the data objects managed by content adapters.

Detailed Description

Implements abstract base class for data source type that is able to transform Kanzi Connect database query to data object tree.

Constructor & Destructor Documentation

~AbstractConnectDataSource()

virtual kanzi::connect::AbstractConnectDataSource::~AbstractConnectDataSource ( )

overridevirtual

Destructor.

AbstractConnectDataSource()

kanzi::connect::AbstractConnectDataSource::AbstractConnectDataSource ( kanzi::Domain * domain, kanzi::string_view name )

explicitprotected

Member Function Documentation

getData()

virtual DataObjectSharedPtr kanzi::connect::AbstractConnectDataSource::getData ( )

overridevirtual

See also

kanzi::DataSource

isConnected()

bool kanzi::connect::AbstractConnectDataSource::isConnected ( ) const

protected

Check if this data source is connected to server.

Returns

True, if connected to server, otherwise false.

KZ_METACLASS_END()

kanzi::connect::AbstractConnectDataSource::KZ_METACLASS_END

(

)

loadFromKZB()

virtual void kanzi::connect::AbstractConnectDataSource::loadFromKZB ( Domain * domain, KzbFile & kzbFile, ReadOnlyMemoryFile & file, KzbMemoryParser & parser )

overridevirtual

onConnectionStateChanged()

void kanzi::connect::AbstractConnectDataSource::onConnectionStateChanged ( Connection::State state )

protected

Callback for connection state changes.

Parameters

state

The new state of the connection.

onCreateAdapters()

virtual void kanzi::connect::AbstractConnectDataSource::onCreateAdapters ( )

protectedpure virtual

Derived class needs to implement this in order to populate adapters for this data source.

Implemented in kanzi::connect::KanziConnectDataSource.

onDataObjectChanged()

void kanzi::connect::AbstractConnectDataSource::onDataObjectChanged	(	RuntimeDataObjectWeakPtr	runtimeObject,
		const DataObjectSharedPtr	dataObject )

Handler for changes coming from the DataObjects under the data source data tree.

Parameters

runtimeObject	The runtime data object that is associated with changed data object
dataObject	Pointer to the data object that sent the change notification

onPropertyChanged()

virtual void kanzi::connect::AbstractConnectDataSource::onPropertyChanged ( AbstractPropertyType propertyType, PropertyNotificationReason reason )

overridevirtual

See also

PropertyObject::onPropertyChanged

onReleaseAdapters()

virtual void kanzi::connect::AbstractConnectDataSource::onReleaseAdapters ( )

inlineprotectedvirtual

Derived class needs to implement this in order to release adapters of this data source.

Reimplemented in kanzi::connect::KanziConnectDataSource.

start()

void kanzi::connect::AbstractConnectDataSource::start

(

)

Starts operation.

stop()

void kanzi::connect::AbstractConnectDataSource::stop

(

)

Stops operation.

unloadOverride()

virtual void kanzi::connect::AbstractConnectDataSource::unloadOverride ( )

virtual

Member Data Documentation

ServerNameProperty

PropertyType<string> kanzi::connect::AbstractConnectDataSource::ServerNameProperty

static

ServiceEnabledProperty

PropertyType<bool> kanzi::connect::AbstractConnectDataSource::ServiceEnabledProperty

static

ServiceIdentifierProperty

PropertyType<string> kanzi::connect::AbstractConnectDataSource::ServiceIdentifierProperty

static

---

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

• connect/kanzi_adaptation/datasource/abstract_connect_datasource.hpp