LIMA
Libre Multilingual Analyzer — C++ API
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Lima::AbstractXmlAnalysisHandler Class Referenceabstract

The AbstractAnalysisHandler class defines the callback interface: the functions that are to be defined to handle the events generated by the LIMA linguistic analyzer. More...

#include <common/Handler/AbstractXmlAnalysisHandler.h>

Inheritance diagram for Lima::AbstractXmlAnalysisHandler:
Lima::AbstractAnalysisHandler Lima::AnalysisData Lima::AbstractTextualAnalysisHandler Lima::AbstractXmlDocumentHandler 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 Lima::Handler::MultimediaDocumentHandler Lima::XmlBowDocumentHandler Lima::XmlSimpleHandler Lima::XmlSimpleStreamHandler

Public Member Functions

 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 ()
 

Detailed Description

The AbstractAnalysisHandler class defines the callback interface: the functions that are to be defined to handle the events generated by the LIMA linguistic analyzer.

The interface includes functions that are used only in the analysis of structured input

Definition at line 24 of file AbstractXmlAnalysisHandler.h.

Constructor & Destructor Documentation

◆ AbstractXmlAnalysisHandler()

Lima::AbstractXmlAnalysisHandler::AbstractXmlAnalysisHandler ( std::shared_ptr< const ShiftFrom >  shiftFrom)
inline

Definition at line 27 of file AbstractXmlAnalysisHandler.h.

◆ ~AbstractXmlAnalysisHandler()

virtual Lima::AbstractXmlAnalysisHandler::~AbstractXmlAnalysisHandler ( )
inlinevirtual

Definition at line 31 of file AbstractXmlAnalysisHandler.h.

Member Function Documentation

◆ endDocument()

virtual void Lima::AbstractXmlAnalysisHandler::endDocument ( )
pure virtual

notify the end of the document

Implemented in Lima::LinguisticProcessing::BowDocumentHandler, Lima::LinguisticProcessing::BowDocumentWriter, Lima::LinguisticProcessing::BowTextHandler, Lima::LinguisticProcessing::BowTextWriter, Lima::LinguisticProcessing::CompactFullDocumentHandler, Lima::LinguisticProcessing::FakeHandler, Lima::LinguisticProcessing::LTRTextHandler, Lima::LinguisticProcessing::MetaDataHandler, Lima::Handler::MultimediaDocumentHandler, Lima::LinguisticProcessing::SBowDocumentWriter, Lima::LinguisticProcessing::SimpleStreamHandler, Lima::XmlBowDocumentHandler, Lima::XmlSimpleHandler, Lima::XmlSimpleStreamHandler, and Lima::LinguisticProcessing::EventAnalysis::EventHandler.

◆ endNode()

virtual void Lima::AbstractXmlAnalysisHandler::endNode ( const Common::Misc::GenericDocumentProperties &  props)
pure virtual

notify the end of a hierarchyNode

Implemented in Lima::LinguisticProcessing::BowDocumentHandler, Lima::LinguisticProcessing::BowDocumentWriter, Lima::LinguisticProcessing::BowTextHandler, Lima::LinguisticProcessing::BowTextWriter, Lima::LinguisticProcessing::CompactFullDocumentHandler, Lima::LinguisticProcessing::LTRTextHandler, Lima::LinguisticProcessing::MetaDataHandler, Lima::LinguisticProcessing::SBowDocumentWriter, Lima::LinguisticProcessing::SimpleStreamHandler, Lima::LinguisticProcessing::EventAnalysis::EventHandler, Lima::Handler::MultimediaDocumentHandler, Lima::XmlBowDocumentHandler, Lima::XmlSimpleHandler, and Lima::XmlSimpleStreamHandler.

◆ handle()

virtual void Lima::AbstractXmlAnalysisHandler::handle ( const char *  buf,
int  length 
)
overridepure virtual

gives content.

Content is a serialized form of the expected resultType

Implements Lima::AbstractAnalysisHandler.

Implemented in Lima::LinguisticProcessing::BowDocumentHandler, Lima::LinguisticProcessing::BowDocumentWriter, Lima::LinguisticProcessing::BowTextHandler, Lima::LinguisticProcessing::BowTextWriter, Lima::LinguisticProcessing::CompactFullDocumentHandler, Lima::LinguisticProcessing::FakeHandler, Lima::LinguisticProcessing::LTRTextHandler, Lima::LinguisticProcessing::MetaDataHandler, Lima::Handler::MultimediaDocumentHandler, Lima::LinguisticProcessing::SBowDocumentWriter, Lima::LinguisticProcessing::SimpleStreamHandler, Lima::XmlBowDocumentHandler, Lima::XmlSimpleHandler, Lima::XmlSimpleStreamHandler, and Lima::LinguisticProcessing::EventAnalysis::EventHandler.

◆ setOut()

virtual void Lima::AbstractXmlAnalysisHandler::setOut ( std::ostream *  out)
pure virtual

set the output stream.

Implementations can be empty if the handler should not write its output to a stream

Implemented in Lima::LinguisticProcessing::LTRTextHandler, Lima::LinguisticProcessing::BowDocumentHandler, Lima::LinguisticProcessing::BowTextHandler, Lima::LinguisticProcessing::BowTextWriter, Lima::LinguisticProcessing::MetaDataHandler, Lima::Handler::MultimediaDocumentHandler, Lima::LinguisticProcessing::SBowDocumentWriter, Lima::LinguisticProcessing::SimpleStreamHandler, Lima::XmlBowDocumentHandler, Lima::XmlSimpleHandler, Lima::XmlSimpleStreamHandler, and Lima::LinguisticProcessing::EventAnalysis::EventHandler.

◆ shiftFrom()

std::shared_ptr< const ShiftFrom > Lima::AbstractXmlAnalysisHandler::shiftFrom ( ) const
inline

Definition at line 51 of file AbstractXmlAnalysisHandler.h.

◆ startDocument()

virtual void Lima::AbstractXmlAnalysisHandler::startDocument ( const Common::Misc::GenericDocumentProperties &  props)
pure virtual

notify the start of a new document, and give its properties

Implemented in Lima::LinguisticProcessing::LTRTextHandler, Lima::LinguisticProcessing::MetaDataHandler, Lima::LinguisticProcessing::BowDocumentHandler, Lima::LinguisticProcessing::BowDocumentWriter, Lima::LinguisticProcessing::BowTextHandler, Lima::LinguisticProcessing::BowTextWriter, Lima::LinguisticProcessing::CompactFullDocumentHandler, Lima::LinguisticProcessing::FakeHandler, Lima::LinguisticProcessing::SBowDocumentWriter, Lima::LinguisticProcessing::SimpleStreamHandler, Lima::LinguisticProcessing::EventAnalysis::EventHandler, Lima::Handler::MultimediaDocumentHandler, Lima::XmlBowDocumentHandler, Lima::XmlSimpleHandler, and Lima::XmlSimpleStreamHandler.

◆ startNode()

virtual void Lima::AbstractXmlAnalysisHandler::startNode ( const std::string &  elementName,
bool  forIndexing 
)
pure virtual

notify the start of a new hierarchyNode

Implemented in Lima::LinguisticProcessing::BowDocumentHandler, Lima::LinguisticProcessing::BowDocumentWriter, Lima::LinguisticProcessing::BowTextHandler, Lima::LinguisticProcessing::BowTextWriter, Lima::LinguisticProcessing::CompactFullDocumentHandler, Lima::LinguisticProcessing::LTRTextHandler, Lima::LinguisticProcessing::MetaDataHandler, Lima::Handler::MultimediaDocumentHandler, Lima::LinguisticProcessing::SBowDocumentWriter, Lima::LinguisticProcessing::SimpleStreamHandler, Lima::XmlBowDocumentHandler, Lima::XmlSimpleHandler, Lima::XmlSimpleStreamHandler, and Lima::LinguisticProcessing::EventAnalysis::EventHandler.

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