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

#include <linguisticProcessing/core/EventAnalysis/EventHandler.h>

Inheritance diagram for Lima::LinguisticProcessing::EventAnalysis::EventHandler:
Lima::AbstractTextualAnalysisHandler Lima::LinguisticProcessing::AbstractResource Lima::AbstractXmlAnalysisHandler Lima::LinguisticProcessing::AbstractResourceBase Lima::InitializableObject< AbstractResource, ResourceInitializationParameters > Lima::AbstractAnalysisHandler Lima::AnalysisData

Public Member Functions

 EventHandler (std::ostream *out)
 
 EventHandler ()
 
virtual ~EventHandler ()
 
void startDocument (const Common::Misc::GenericDocumentProperties &props) override
 notify the start of a new document
 
void endDocument () override
 notify the end of the document
 
void endAnalysis () override
 function called by the LIMA analyzer on the end of a text part that is to be analyzed
 
void startAnalysis () override
 function called by the LIMA analyzer on start of a new document
 
Events & getEvents ()
 
void handle (const char *buf, int length) override
 gives content.
 
void startNode (const std::string &elementName, bool forIndexing) override
 notify the start of a new hierarchyNode
 
void endNode (const Common::Misc::GenericDocumentProperties &props) override
 notify the end of a hierarchyNode
 
virtual void setOut (std::ostream *out) override
 set the output stream.
 
- Public Member Functions inherited from Lima::AbstractTextualAnalysisHandler
 AbstractTextualAnalysisHandler ()
 
virtual ~AbstractTextualAnalysisHandler ()
 
virtual void init (Common::XMLConfigurationFiles::GroupConfigurationStructure &unitConfiguration, Manager *manager) override
 initialize with parameters from configuration file.
 
virtual const std::string & suffix () const
 
virtual void setSuffix (const std::string &suffix)
 
- Public Member Functions inherited from Lima::LinguisticProcessing::AbstractResource
 AbstractResource (QObject *parent=0)
 
virtual ~AbstractResource ()
 
 AbstractResource (const AbstractResource &)
 
virtual void init (Common::XMLConfigurationFiles::GroupConfigurationStructure &unitConfiguration, Manager *manager) override=0
 initialize with parameters from configuration file.
 
- Public Member Functions inherited from Lima::LinguisticProcessing::AbstractResourceBase
 AbstractResourceBase (QObject *parent=0)
 
virtual ~AbstractResourceBase ()
 
 AbstractResourceBase (const AbstractResourceBase &)
 
QString getResourceFileName (const QString &paramName)
 
- Public Member Functions inherited from Lima::InitializableObject< AbstractResource, ResourceInitializationParameters >
 InitializableObject ()
 
 InitializableObject (const InitializableObject &object)
 
InitializableObject & operator= (const InitializableObject &object)
 
virtual ~InitializableObject ()
 
const std::string & getId () const
 get the object id
 
void setId (const std::string &id)
 set the object id
 
- Public Member Functions inherited from Lima::AbstractXmlAnalysisHandler
 AbstractXmlAnalysisHandler (std::shared_ptr< const ShiftFrom > shiftFrom)
 
virtual ~AbstractXmlAnalysisHandler ()
 
std::shared_ptr< const ShiftFrom > shiftFrom () const
 
- Public Member Functions inherited from Lima::AbstractAnalysisHandler
virtual ~AbstractAnalysisHandler ()
 
- Public Member Functions inherited from Lima::AnalysisData
virtual ~AnalysisData ()
 

Additional Inherited Members

- Public Types inherited from Lima::InitializableObject< AbstractResource, ResourceInitializationParameters >
typedef InitializableObjectManager< AbstractResource, ResourceInitializationParameters > Manager
 Manager is the type of the Manager associated to the initializableObject.
 
typedef InitializableObjectFactory< AbstractResource > Factory
 Factory is the type of the Factory associated to the initializableObject.
 
- Signals inherited from Lima::LinguisticProcessing::AbstractResourceBase
void resourceFileChanged (const QString &path)
 Signal triggered whenever one of the registered files changes on disk.
 
- Protected Member Functions inherited from Lima::LinguisticProcessing::AbstractResourceBase
LimaFileSystemWatcher & resourceFileWatcher ()
 Accessor to the file watcher used to register resource files to be watched for changes.
 
- Protected Attributes inherited from Lima::LinguisticProcessing::AbstractResourceBase
AbstractResourceBasePrivate * m_d
 
- Protected Attributes inherited from Lima::InitializableObject< AbstractResource, ResourceInitializationParameters >
std::string m_id
 

Detailed Description

Author
Faiza GARA

Definition at line 33 of file EventHandler.h.

Constructor & Destructor Documentation

◆ EventHandler() [1/2]

Lima::LinguisticProcessing::EventAnalysis::EventHandler::EventHandler ( std::ostream *  out)

Definition at line 27 of file EventHandler.cpp.

◆ EventHandler() [2/2]

Lima::LinguisticProcessing::EventAnalysis::EventHandler::EventHandler ( )

Definition at line 33 of file EventHandler.cpp.

◆ ~EventHandler()

Lima::LinguisticProcessing::EventAnalysis::EventHandler::~EventHandler ( )
virtual

Definition at line 38 of file EventHandler.cpp.

Member Function Documentation

◆ endAnalysis()

void Lima::LinguisticProcessing::EventAnalysis::EventHandler::endAnalysis ( )
overridevirtual

function called by the LIMA analyzer on the end of a text part that is to be analyzed

Implements Lima::AbstractAnalysisHandler.

Definition at line 62 of file EventHandler.cpp.

◆ endDocument()

void Lima::LinguisticProcessing::EventAnalysis::EventHandler::endDocument ( )
overridevirtual

notify the end of the document

Implements Lima::AbstractXmlAnalysisHandler.

Definition at line 59 of file EventHandler.cpp.

◆ endNode()

void Lima::LinguisticProcessing::EventAnalysis::EventHandler::endNode ( const Common::Misc::GenericDocumentProperties &  props)
overridevirtual

notify the end of a hierarchyNode

Implements Lima::AbstractXmlAnalysisHandler.

Definition at line 107 of file EventHandler.cpp.

◆ getEvents()

Events & Lima::LinguisticProcessing::EventAnalysis::EventHandler::getEvents ( )

Definition at line 44 of file EventHandler.cpp.

◆ handle()

void Lima::LinguisticProcessing::EventAnalysis::EventHandler::handle ( const char *  buf,
int  length 
)
overridevirtual

gives content.

Content is a serialized form of the expected resultType

Implements Lima::AbstractXmlAnalysisHandler.

Definition at line 94 of file EventHandler.cpp.

◆ setOut()

void Lima::LinguisticProcessing::EventAnalysis::EventHandler::setOut ( std::ostream *  out)
overridevirtual

set the output stream.

Implements Lima::AbstractXmlAnalysisHandler.

Definition at line 49 of file EventHandler.cpp.

◆ startAnalysis()

void Lima::LinguisticProcessing::EventAnalysis::EventHandler::startAnalysis ( )
overridevirtual

function called by the LIMA analyzer on start of a new document

Parameters
propsthe document properties, which can contain some metadata that are automatically generated by the analyzer (such as language, date of analysis etc), and some metadata that are directly extracted from the document to analyze, in case of the analysis of an XML documents (in this case, the configuration of the analysis indicates in which tags the information can be found) function called by the LIMA analyzer on start at end of a document function called by the LIMA analyzer on the start of a text part that is to be analyzed

Implements Lima::AbstractAnalysisHandler.

Definition at line 72 of file EventHandler.cpp.

◆ startDocument()

void Lima::LinguisticProcessing::EventAnalysis::EventHandler::startDocument ( const Common::Misc::GenericDocumentProperties &  props)
overridevirtual

notify the start of a new document

Implements Lima::AbstractXmlAnalysisHandler.

Definition at line 54 of file EventHandler.cpp.

◆ startNode()

void Lima::LinguisticProcessing::EventAnalysis::EventHandler::startNode ( const std::string &  elementName,
bool  forIndexing 
)
overridevirtual

notify the start of a new hierarchyNode

Implements Lima::AbstractXmlAnalysisHandler.

Definition at line 101 of file EventHandler.cpp.


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