LIMA
Libre Multilingual Analyzer — C++ API
Loading...
Searching...
No Matches
Lima::LinguisticProcessing::CoreLinguisticProcessingClient Class Reference

#include <linguisticProcessing/core/CoreLinguisticProcessingClient.h>

Inheritance diagram for Lima::LinguisticProcessing::CoreLinguisticProcessingClient:
Lima::LinguisticProcessing::AbstractLinguisticProcessingClient Lima::AbstractProcessingClient

Public Member Functions

 CoreLinguisticProcessingClient ()
 
virtual ~CoreLinguisticProcessingClient ()
 
std::shared_ptr< AnalysisContent > analyze (const QString &texte, const std::map< std::string, std::string > &metaData, const std::string &pipeline, const std::map< std::string, AbstractAnalysisHandler * > &handlers, const std::set< std::string > &inactiveUnits=std::set< std::string >()) const override
 This function runs the linguistic analysis on a simple text, specifying the language, the pipeline and the expected resultType.
 
std::shared_ptr< AnalysisContent > analyze (const std::string &texte, const std::map< std::string, std::string > &metaData, const std::string &pipeline, const std::map< std::string, AbstractAnalysisHandler * > &handlers, const std::set< std::string > &inactiveUnits=std::set< std::string >()) const override
 This function is the same as the previous one but takes a text in UTF-8 format.
 
- Public Member Functions inherited from Lima::LinguisticProcessing::AbstractLinguisticProcessingClient
virtual ~AbstractLinguisticProcessingClient ()
 define a virtual destructor to ensure concrete client destructors to be called
 
- Public Member Functions inherited from Lima::AbstractProcessingClient
virtual ~AbstractProcessingClient ()
 Define the destructor virtual to ensure concrete client destructors to be called.
 

Detailed Description

Author
Benoit Mathieu

Definition at line 25 of file CoreLinguisticProcessingClient.h.

Constructor & Destructor Documentation

◆ CoreLinguisticProcessingClient()

Lima::LinguisticProcessing::CoreLinguisticProcessingClient::CoreLinguisticProcessingClient ( )

Definition at line 52 of file CoreLinguisticProcessingClient.cpp.

◆ ~CoreLinguisticProcessingClient()

Lima::LinguisticProcessing::CoreLinguisticProcessingClient::~CoreLinguisticProcessingClient ( )
virtual

Definition at line 58 of file CoreLinguisticProcessingClient.cpp.

Member Function Documentation

◆ analyze() [1/2]

std::shared_ptr< AnalysisContent > Lima::LinguisticProcessing::CoreLinguisticProcessingClient::analyze ( const QString &  text,
const std::map< std::string, std::string > &  metaData,
const std::string &  pipeline,
const std::map< std::string, AbstractAnalysisHandler * > &  handlers,
const std::set< std::string > &  inactiveUnits = std::set< std::string >() 
) const
overridevirtual

This function runs the linguistic analysis on a simple text, specifying the language, the pipeline and the expected resultType.

Parameters
textthe text to analyze in LimaString format (LimaString format is an internal UTF16 format, functions to convert from UTF8 to/from LimaString are available in Lima::Common::Misc)
metaDatasome metadata used by the analyzer: the minimal metadata required is
  • 'FileName' : filename (used to generate file log names)
  • 'Lang' : language as string in a 3-letter format (following the ISO 639-2 code): 'fre','eng',...
pipelinethe name of the analysis pipeline to use (an analysis pipeline is a chain of processUnit). Possible pipelines are defined in the lima-analysis.xml configuration file. Their implementations are defined in the language-specific configuration files lima-lp-xxx.xml (where xxx is the 3-letter code of the language). The pipeline must have been configured in the configuration of the LinguisticProcessingClientFactory.

Implements Lima::LinguisticProcessing::AbstractLinguisticProcessingClient.

Definition at line 77 of file CoreLinguisticProcessingClient.cpp.

◆ analyze() [2/2]

std::shared_ptr< AnalysisContent > Lima::LinguisticProcessing::CoreLinguisticProcessingClient::analyze ( const std::string &  text,
const std::map< std::string, std::string > &  metaData,
const std::string &  pipeline,
const std::map< std::string, AbstractAnalysisHandler * > &  handlers,
const std::set< std::string > &  inactiveUnits = std::set< std::string >() 
) const
overridevirtual

This function is the same as the previous one but takes a text in UTF-8 format.

Implements Lima::LinguisticProcessing::AbstractLinguisticProcessingClient.

Definition at line 64 of file CoreLinguisticProcessingClient.cpp.


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