kanzi::connect::KanziConnectDataSource Class Reference

A class that implements data source that is able to load content from Kanzi Connect server. More...

#include <kanzi_connect_datasource.hpp>

Inheritance diagram for kanzi::connect::KanziConnectDataSource:

Public Member Functions
	KZ_METACLASS_END ()
virtual	~KanziConnectDataSource () override
Public Member Functions inherited from kanzi::connect::AbstractConnectDataSource
	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 Member Functions
static KanziConnectDataSourceSharedPtr	create (Domain *domain, string_view name)
	Creates new instance of Kanzi Connect DataSource.
static void	takeDataSnapshot (Domain *domain, const string &uri, string &schema, string &data)
	Takes data snapshot as XML document.

Static Public Attributes
static PropertyType< string >	XmlDeclarationProperty
static PropertyType< string >	XmlFilenameProperty
	Property that defines the file path for the configuration file.
Static Public Attributes inherited from kanzi::connect::AbstractConnectDataSource
static PropertyType< string >	ServerNameProperty
static PropertyType< bool >	ServiceEnabledProperty
static PropertyType< string >	ServiceIdentifierProperty

Protected Member Functions
	KanziConnectDataSource (Domain *domain, string_view name)
virtual void	onCreateAdapters () override
	See AbstractConnectDataSource::onCreateAdapters.
void	onFileModified (string_view filename)
	Callback for change in configuration file.
virtual void	onReleaseAdapters () override
	See AbstractConnectDataSource::onReleaseAdapters.
Protected Member Functions inherited from kanzi::connect::AbstractConnectDataSource
	AbstractConnectDataSource (kanzi::Domain *domain, kanzi::string_view name)
void	onConnectionStateChanged (Connection::State state)
	Callback for connection state changes.
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

A class that implements data source that is able to load content from Kanzi Connect server.

The class can be configured with XML file, that describes the data tree and source tables and columns in the database.

See example of data.xml file below.

<root>
    <source uri="service://com.rightware.service_name/content_path" name="data_object_name">
        <field column="column_name" type="int" name="data_object_name"/>
    </source>
    <source uri="service://com.rightware.service_name" name="data_object_name">
        <field column="column_name" type="int" name="data_object_name"/>
    </source>
    <source uri="content://com.rightware.content/contacts" name="contacts">
        <field column="contact_id" type="int" name="id"/>
        <field column="contact_firstname" type="string" name="firstname"/>
        <field column="contact_lastname" type="string" name="lastname"/>
        <field column="contact_phone" type="string" name="phone"/>
    </source>
    <source uri="service://com.rightware.media" name="media_state">
        <field column="current_track_id" type="int" name="current_track"/>
    </source>
</root>

Constructor & Destructor Documentation

~KanziConnectDataSource()

virtual kanzi::connect::KanziConnectDataSource::~KanziConnectDataSource ( )

overridevirtual

KanziConnectDataSource()

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

explicitprotected

Parameters

domain	UI domain.
name	Name of the new data source.

Member Function Documentation

create()

static KanziConnectDataSourceSharedPtr kanzi::connect::KanziConnectDataSource::create ( Domain * domain, string_view name )

static

Creates new instance of Kanzi Connect DataSource.

Parameters

domain	UI domain.
name	Name of the new data source.

Returns

New data source instance.

KZ_METACLASS_END()

kanzi::connect::KanziConnectDataSource::KZ_METACLASS_END

(

)

onCreateAdapters()

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

overrideprotectedvirtual

See AbstractConnectDataSource::onCreateAdapters.

Implements kanzi::connect::AbstractConnectDataSource.

onFileModified()

void kanzi::connect::KanziConnectDataSource::onFileModified ( string_view filename )

protected

Callback for change in configuration file.

Parameters

filename

File name of the configuration file.

onReleaseAdapters()

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

overrideprotectedvirtual

See AbstractConnectDataSource::onReleaseAdapters.

Reimplemented from kanzi::connect::AbstractConnectDataSource.

takeDataSnapshot()

static void kanzi::connect::KanziConnectDataSource::takeDataSnapshot ( Domain * domain, const string & uri, string & schema, string & data )

static

Takes data snapshot as XML document.

Parameters

domain	UI domain where to operate
uri	the URI for the datasource object to snapshot. E.g. kzb://ivi/Data Sources/ConnectServices
schema	on return holds the data configuration file
data	on return holds a snapshot of current data.

Member Data Documentation

XmlDeclarationProperty

PropertyType<string> kanzi::connect::KanziConnectDataSource::XmlDeclarationProperty

static

XmlFilenameProperty

PropertyType<string> kanzi::connect::KanziConnectDataSource::XmlFilenameProperty

static

Property that defines the file path for the configuration file.

---

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

• connect/kanzi_adaptation/datasource/kanzi_connect_datasource.hpp