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

defines callback interface More...

#include <linguisticProcessing/client/AnalysisHandlers/AbstractTextualAnalysisHandler.h>

Inheritance diagram for Lima::AbstractTextualAnalysisHandler:
Lima::LinguisticProcessing::AbstractResource Lima::AbstractXmlAnalysisHandler Lima::LinguisticProcessing::AbstractResourceBase Lima::InitializableObject< AbstractResource, ResourceInitializationParameters > Lima::AbstractAnalysisHandler Lima::AnalysisData Lima::LinguisticProcessing::BowDocumentHandler Lima::LinguisticProcessing::BowDocumentWriter Lima::LinguisticProcessing::BowTextHandler Lima::LinguisticProcessing::BowTextWriter Lima::LinguisticProcessing::CompactFullDocumentHandler Lima::LinguisticProcessing::EventAnalysis::EventHandler Lima::LinguisticProcessing::FakeHandler Lima::LinguisticProcessing::LTRTextHandler Lima::LinguisticProcessing::MetaDataHandler Lima::LinguisticProcessing::SBowDocumentWriter Lima::LinguisticProcessing::SimpleStreamHandler

Public Member Functions

 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 ()
 
virtual void startDocument (const Common::Misc::GenericDocumentProperties &props)=0
 notify the start of a new document, and give its properties
 
virtual void endDocument ()=0
 notify the end of the document
 
virtual void handle (const char *buf, int length) override=0
 gives content.
 
virtual void startNode (const std::string &elementName, bool forIndexing)=0
 notify the start of a new hierarchyNode
 
virtual void endNode (const Common::Misc::GenericDocumentProperties &props)=0
 notify the end of a hierarchyNode
 
virtual void setOut (std::ostream *out)=0
 set the output stream.
 
std::shared_ptr< const ShiftFrom > shiftFrom () const
 
- Public Member Functions inherited from Lima::AbstractAnalysisHandler
virtual ~AbstractAnalysisHandler ()
 
virtual void startAnalysis ()=0
 function called by the LIMA analyzer on start of a new document
 
virtual void endAnalysis ()=0
 function called by the LIMA analyzer on the end of a text part that is to be analyzed
 
- 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

defines callback interface

Definition at line 28 of file AbstractTextualAnalysisHandler.h.

Constructor & Destructor Documentation

◆ AbstractTextualAnalysisHandler()

Lima::AbstractTextualAnalysisHandler::AbstractTextualAnalysisHandler ( )
inline

Definition at line 34 of file AbstractTextualAnalysisHandler.h.

◆ ~AbstractTextualAnalysisHandler()

Lima::AbstractTextualAnalysisHandler::~AbstractTextualAnalysisHandler ( )
virtual

Definition at line 19 of file AbstractTextualAnalysisHandler.cpp.

Member Function Documentation

◆ init()

void Lima::AbstractTextualAnalysisHandler::init ( Common::XMLConfigurationFiles::GroupConfigurationStructure &  unitConfiguration,
Manager *  manager 
)
overridevirtual

initialize with parameters from configuration file.

Parameters
unitConfiguration@IN : <group> tag in xml configuration file that contains parameters to initialize the object.
manager@IN : manager that asked for initialization and carries init params Use it to initialize other objects of same kind.
Exceptions
InvalidConfigurationwhen parameters are invalids.

Definition at line 23 of file AbstractTextualAnalysisHandler.cpp.

◆ setSuffix()

virtual void Lima::AbstractTextualAnalysisHandler::setSuffix ( const std::string &  suffix)
inlinevirtual

Definition at line 52 of file AbstractTextualAnalysisHandler.h.

◆ suffix()

virtual const std::string & Lima::AbstractTextualAnalysisHandler::suffix ( ) const
inlinevirtual

Definition at line 51 of file AbstractTextualAnalysisHandler.h.


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