LIMA
Libre Multilingual Analyzer — C++ API
Loading...
Searching...
No Matches
Lima::ProcessingClientFactory Class Referenceabstract

LinguisticProcessingClientFactory is a singleton. More...

#include <common/AbstractFactoryPattern/ProcessingClientFactory.h>

Inheritance diagram for Lima::ProcessingClientFactory:
Lima::LinguisticProcessing::LinguisticProcessingClientFactory

Public Member Functions

virtual void configureClientFactory (const std::string &id, Common::XMLConfigurationFiles::XMLConfigurationFileParser &configuration, std::deque< std::string > langs=std::deque< std::string >(), std::deque< std::string > pipelines=std::deque< std::string >())=0
 configure the corresponding clientFactory so that it can create clients.
 
virtual std::shared_ptr< AbstractProcessingClient > createClient (const std::string &id) const =0
 create an Client using the appropriate registered factory.
 
std::deque< std::string > getRegisteredFactories () const
 show registered clientId
 
virtual ~ProcessingClientFactory ()
 
 ProcessingClientFactory ()
 

Detailed Description

LinguisticProcessingClientFactory is a singleton.

It allows configuration and creation of linguisticProcessing clients.

main entry point of LinguisticProcessing Component

Definition at line 29 of file ProcessingClientFactory.h.

Constructor & Destructor Documentation

◆ ~ProcessingClientFactory()

virtual Lima::ProcessingClientFactory::~ProcessingClientFactory ( )
inlinevirtual

Definition at line 64 of file ProcessingClientFactory.h.

◆ ProcessingClientFactory()

Lima::ProcessingClientFactory::ProcessingClientFactory ( )
inline

Definition at line 66 of file ProcessingClientFactory.h.

Member Function Documentation

◆ configureClientFactory()

virtual void Lima::ProcessingClientFactory::configureClientFactory ( const std::string &  id,
Common::XMLConfigurationFiles::XMLConfigurationFileParser &  configuration,
std::deque< std::string >  langs = std::deque< std::string >(),
std::deque< std::string >  pipelines = std::deque< std::string >() 
)
pure virtual

configure the corresponding clientFactory so that it can create clients.

Parameters
idIN : id of clientFactory to configure
Exceptions
LimaExceptionif clientFactory does not exist, or if an \ exception occurs during configuration.

Implemented in Lima::LinguisticProcessing::LinguisticProcessingClientFactory.

◆ createClient()

virtual std::shared_ptr< AbstractProcessingClient > Lima::ProcessingClientFactory::createClient ( const std::string &  id) const
pure virtual

create an Client using the appropriate registered factory.

Parameters
idIN : classId for the factory
Returns
Client* pointer to the created Client.\ Pointer should be deleted when no more used
Exceptions
LimaException

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

Implemented in Lima::LinguisticProcessing::LinguisticProcessingClientFactory.

◆ getRegisteredFactories()

std::deque< std::string > Lima::ProcessingClientFactory::getRegisteredFactories ( ) const

show registered clientId

Returns
list of registered clientId

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