XmlReaderClientFactory is a singleton. More...

#include <linguisticProcessing/client/xmlreader/XmlReaderClientFactory.h>

Inheritance diagram for Lima::XmlReader::XmlReaderClientFactory:

Public Member Functions
void	configureClientFactory (const std::string &id, Lima::Common::XMLConfigurationFiles::XMLConfigurationFileParser &configuration, const std::string &defaultMedia, const std::deque< std::string > &medias_to_load=std::deque< std::string >(), const std::deque< std::string > &pipelines=std::deque< std::string >())
	configure the corresponding clientFactory so that it can create clients.

std::shared_ptr< AbstractXmlReaderClient >	createClient (const std::string &id) const
	create an Client using the appropriate registered factory.

std::deque< std::string >	getRegisteredFactories () const
	show registered clientId

virtual	~XmlReaderClientFactory ()

Public Member Functions inherited from Lima::Singleton< XmlReaderClientFactory >
	Singleton ()=default

virtual	~Singleton ()=default

Friends
class	Lima::Singleton< XmlReaderClientFactory >

Additional Inherited Members
Static Public Member Functions inherited from Lima::Singleton< XmlReaderClientFactory >
static const XmlReaderClientFactory &	single ()
	const singleton accessor

static const XmlReaderClientFactory *	psingle ()

static XmlReaderClientFactory &	changeable ()
	singleton accessor

static XmlReaderClientFactory *	pchangeable ()

Detailed Description

XmlReaderClientFactory is a singleton.

It allows configuration and creation of linguisticProcessing clients.

main entry point of XmlReader Component

Definition at line 33 of file XmlReaderClientFactory.h.

Constructor & Destructor Documentation

◆ ~XmlReaderClientFactory()

virtual Lima::XmlReader::XmlReaderClientFactory::~XmlReaderClientFactory ( )

inlinevirtual

Definition at line 70 of file XmlReaderClientFactory.h.

Member Function Documentation

◆ configureClientFactory()

void Lima::XmlReader::XmlReaderClientFactory::configureClientFactory	(	const std::string &	id,
		Lima::Common::XMLConfigurationFiles::XMLConfigurationFileParser &	configuration,
		const std::string &	defaultMedia,
		const std::deque< std::string > &	medias_to_load = `std::deque<std::string>()`,
		const std::deque< std::string > &	pipelines = `std::deque<std::string>()`
	)

configure the corresponding clientFactory so that it can create clients.

Parameters

id	IN : id of clientFactory to configure
configuration	fichier de configuration, comportant un <module name="lp-structuredXmlreaderclient">
media_to_load
pipelines

Exceptions

Lima::LimaException if clientFactory does not exist, or if an exception occurs during configuration.
All the processors in 'availableMediaAndFactories' (cf. config file) are created, but only those in media_to_load are configured (i.e their resources are loaded)

Definition at line 21 of file XmlReaderClientFactory.cpp.

◆ createClient()

std::shared_ptr< AbstractXmlReaderClient > Lima::XmlReader::XmlReaderClientFactory::createClient ( const std::string & id ) const

create an Client using the appropriate registered factory.

Parameters

id	IN : classId for the factory

Returns: Client* pointer to the created Client. Pointer should be deleted when no more used

Exceptions

Lima::LimaException

ClientFactory must have been configured before this method is called Use configureClientFactory() method to configure.

Definition at line 164 of file XmlReaderClientFactory.cpp.

◆ getRegisteredFactories()

std::deque< std::string > Lima::XmlReader::XmlReaderClientFactory::getRegisteredFactories ( ) const

show registered clientId

Returns: list of registered clientId

Definition at line 182 of file XmlReaderClientFactory.cpp.

Friends And Related Symbol Documentation

◆ Lima::Singleton< XmlReaderClientFactory >

friend class Lima::Singleton< XmlReaderClientFactory >

friend