kanzi::connect::ContentProviderCollection Class Reference

A content provider type, that hosts other Content Providers. More...

#include <content_provider_collection.hpp>

Inheritance diagram for kanzi::connect::ContentProviderCollection:

Public Types
typedef vector< ContentProviderSharedPtr >	ContentProviderContainer
	Container for content providers. Used to store child providers.

Public Member Functions
void	addContentProvider (ContentProviderSharedPtr provider, bool invalidate=true)
	Adds content provider to collection.
ContentProviderContainer::const_iterator	beginProviders () const
	Allows to iterate all contained providers.
	ContentProviderCollection (WorkQueueInterface *workQueue, AbstractServiceSharedPtr owningService)
	Constructor.
ContentProviderContainer::const_iterator	endProviders () const
	Allows to iterate all contained providers.
virtual size_t	getSubProviderCount () override
virtual ContentProviderDescriptionSharedPtr	getSubProviderDescription (size_t index) override
virtual void	query (ContentQueryArgumentsSharedPtr args, ContentQuerySharedPtr contentQuery) override
void	removeContentProvider (ContentProviderSharedPtr provider, bool invalidate=true)
	Removes content provider from this collection.
virtual	~ContentProviderCollection ()
Public Member Functions inherited from kanzi::connect::ContentProvider
void	addObserver (Observer *observer)
	Adds new observer for this instance.
void	addSubscription (ContentSubscriptionSharedPtr subscription)
	Adds new subscription to this instance.
	ContentProvider (WorkQueueInterface *workQueue)
	Constructor.
	ContentProvider (WorkQueueInterface *workQueue, AbstractServiceSharedPtr owningService)
	Constructor.
vector< ContentSubscriptionSharedPtr >	getAllSubscriptions () const
	Retrieves all subscriptions for this provider.
AbstractServiceSharedPtr	getOwningService ()
	Retrieves the service this content provider is bound to.
AbstractSessionSharedPtr	getOwningSession () const
	Retrieve the session that owns this content provider.
const string &	getSchema () const
	Retrieve the Schema.
ContentSubscriptionSharedPtr	getSubscription (shared_ptr< ContentServiceConcept::Session > session) const
	Retrieves content subscription for given session.
const string &	getUri () const
	Retrieve the URI.
bool	hasSchema () const
	Determines whether this particular content provider has schema defined.
virtual void	initialize ()
	Called by the Content Service. Initializes this instance.
void	invalidate (const string &uri, int reason, int beginRow=0, int endRow=-1)
	Invalidates the content and causes subscribed clients to refresh their data completely.
void	invalidateEx (const string &uri, int reason, int beginRow=0, int endRow=-1)
	Invalidates the content and causes subscribed clients to refresh their data completely.
void	notifyChangedEx (const string &uri=string())
	Informs that specific URI is changed.
void	releaseAllSubscriptions ()
	Releases all subscriptions from this instance.
void	removeObserver (Observer *observer)
	Removes observer from this instance.
void	removeSubscription (const ContentSubscription &subscription)
	Removes subscription from this instance.
void	setOwningService (AbstractServiceSharedPtr service)
	Sets the owning service.
void	setOwningSession (AbstractSessionSharedPtr session)
	Store the owning session.
void	setSchema (const string &schema)
	Save the Schema (xml).
void	setUri (const string &uri)
	Save the URI.
virtual void	uninitialize ()
	Called by the Content Service. Un-initializes this instance.
virtual void	work ()
	Called by the Content Service. Allows this instance to perform work such as push data from external threads to content system or procedurally generate data.
virtual	~ContentProvider ()
	Destructor.

Additional Inherited Members
Protected Member Functions inherited from kanzi::connect::ContentProvider
void	notifyChanged (const string &uri=string(), bool processAsync=false)
	Allows derived classes to notify that there are changes in content.
void	notifyWork ()
	Allows derived classes to notify that there is work to be done.

Detailed Description

A content provider type, that hosts other Content Providers.

Makes it possible to attach / detach content providers in to content database. Whenever this class receives a query, it automatically propagates it to all contained Content Providers and merges their results as one.

Member Typedef Documentation

ContentProviderContainer

typedef vector<ContentProviderSharedPtr> kanzi::connect::ContentProviderCollection::ContentProviderContainer

Container for content providers. Used to store child providers.

Constructor & Destructor Documentation

ContentProviderCollection()

kanzi::connect::ContentProviderCollection::ContentProviderCollection	(	WorkQueueInterface *	workQueue,
		AbstractServiceSharedPtr	owningService )

Constructor.

~ContentProviderCollection()

virtual kanzi::connect::ContentProviderCollection::~ContentProviderCollection ( )

virtual

Member Function Documentation

addContentProvider()

void kanzi::connect::ContentProviderCollection::addContentProvider	(	ContentProviderSharedPtr	provider,
		bool	invalidate = true )

Adds content provider to collection.

Parameters

provider	Content provider to add.
invalidate	If true, invalidates the whole collection. If false, does nothing.

beginProviders()

ContentProviderContainer::const_iterator kanzi::connect::ContentProviderCollection::beginProviders

(

)

const

Allows to iterate all contained providers.

Returns

The beginning of the container.

endProviders()

ContentProviderContainer::const_iterator kanzi::connect::ContentProviderCollection::endProviders

(

)

const

Allows to iterate all contained providers.

Returns

The end of the container.

getSubProviderCount()

virtual size_t kanzi::connect::ContentProviderCollection::getSubProviderCount ( )

overridevirtual

See also

ContentProvider::getSubProviderCount

Implements kanzi::connect::ContentProvider.

getSubProviderDescription()

virtual ContentProviderDescriptionSharedPtr kanzi::connect::ContentProviderCollection::getSubProviderDescription ( size_t index )

overridevirtual

See also

ContentProvider::getSubProviderDescription

Implements kanzi::connect::ContentProvider.

query()

virtual void kanzi::connect::ContentProviderCollection::query ( ContentQueryArgumentsSharedPtr args, ContentQuerySharedPtr contentQuery )

overridevirtual

See also

ContentProvider::query

Implements kanzi::connect::ContentProvider.

removeContentProvider()

void kanzi::connect::ContentProviderCollection::removeContentProvider	(	ContentProviderSharedPtr	provider,
		bool	invalidate = true )

Removes content provider from this collection.

Parameters

provider	Content provider to remove.
invalidate	If true, invalidates the whole collection. If false, does nothing.

---

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

• content_service/content_provider_collection.hpp