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

Manipulation de media ; separation du contenu et de la structure. More...

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

Inheritance diagram for Lima::XmlSimpleStreamHandler:
Lima::LinguisticProcessing::SimpleStreamHandler Lima::AbstractXmlDocumentHandler Lima::AbstractTextualAnalysisHandler Lima::StructureHandler Lima::AbstractXmlAnalysisHandler Lima::AbstractProcessingClientHandler Lima::ContentHandler< Common::Misc::GenericDocumentProperties > Lima::ContentHandler< std::vector< float > > Lima::LinguisticProcessing::AbstractResource Lima::AbstractXmlAnalysisHandler Lima::AbstractAnalysisHandler Lima::LinguisticProcessing::AbstractResourceBase Lima::InitializableObject< AbstractResource, ResourceInitializationParameters > Lima::AbstractAnalysisHandler Lima::AnalysisData Lima::AnalysisData

Public Member Functions

 XmlSimpleStreamHandler (std::shared_ptr< const ShiftFrom > shiftFrom)
 
 ~XmlSimpleStreamHandler ()
 
void startDocument (const Lima::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
 
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 Lima::Common::Misc::GenericDocumentProperties &props) override
 notify the end of a hierarchyNode
 
void setOut (std::ostream *out) override
 set the output stream.
 
- Public Member Functions inherited from Lima::LinguisticProcessing::SimpleStreamHandler
 SimpleStreamHandler ()
 
virtual ~SimpleStreamHandler ()
 
- 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 ()
 
- Public Member Functions inherited from Lima::AbstractXmlDocumentHandler
 AbstractXmlDocumentHandler (std::shared_ptr< const ShiftFrom > shiftFrom)
 
virtual ~AbstractXmlDocumentHandler ()
 
NODE_ID get_parentlastOpenedNode () const
 
void set_parentlastOpenedNode (NODE_ID nodeId)
 
void set_lastNodeId (NODE_ID NID)
 
NODE_ID get_lastNodeId () const
 
std::string get_lastUri () const
 
void set_lastUri (std::string uri)
 
void set_lang (std::string lang)
 
std::string get_lang () const
 
virtual void startAnalysis (const std::string &bloc_type)
 
- Public Member Functions inherited from Lima::StructureHandler
 StructureHandler ()
 
virtual ~StructureHandler ()
 
Structure * get_Structures ()
 Récupérer toutes les structures du handler.
 
void set_Structures (Structure *structures)
 Insérer une structure dans le handler.
 
Node * get_Node (CONTENT_ID)
 Récupérer un noeud du handler.
 
void add_Node (const Node &node)
 
STRUCT_ID get_LastStructureId ()
 Accesseur de lastStructureId.
 
void set_LastStructureId (STRUCT_ID)
 
CONTENT_ID get_LastContentId ()
 
void set_LastContentId (CONTENT_ID)
 
void resetStructure ()
 
- Public Member Functions inherited from Lima::AbstractProcessingClientHandler
virtual ~AbstractProcessingClientHandler ()
 
virtual void setAnalysisClient (const std::string &clientId, std::shared_ptr< AbstractProcessingClient > client)
 
virtual std::shared_ptr< AbstractProcessingClient > getAnalysisClient (const std::string &clientId)
 
virtual std::map< std::string, std::shared_ptr< AbstractProcessingClient > > getAnalysisClients () const
 
virtual void setAnalysisClients (std::map< std::string, std::shared_ptr< AbstractProcessingClient > > clients)
 
virtual void handleProc (const std::string &tagName, const std::string &content, const std::map< std::string, std::string > &metaData, const std::string &pipeline, const std::map< std::string, AbstractAnalysisHandler * > &handlers=std::map< std::string, AbstractAnalysisHandler * >(), const std::set< std::string > &inactiveUnits=std::set< std::string >())
 
- Public Member Functions inherited from Lima::ContentHandler< Common::Misc::GenericDocumentProperties >
 ContentHandler ()
 
virtual ~ContentHandler ()
 
void addContent (CONTENT_ID ContentId, Common::Misc::GenericDocumentProperties datas)
 Ajouter un contenu au handler.
 
void setContents (const std::map< CONTENT_ID, Common::Misc::GenericDocumentProperties > contents)
 
Common::Misc::GenericDocumentProperties * getContent (CONTENT_ID ContentId)
 Récupérer un contenu du handler.
 
const std::map< CONTENT_ID, Common::Misc::GenericDocumentProperties > & getContents () const
 Récupérer tous les contenus du handler.
 
void resetHandler ()
 Effacer les contenus du handler.
 
- Public Member Functions inherited from Lima::ContentHandler< std::vector< float > >
 ContentHandler ()
 
virtual ~ContentHandler ()
 
void addContent (CONTENT_ID ContentId, std::vector< float > datas)
 Ajouter un contenu au handler.
 
void setContents (const std::map< CONTENT_ID, std::vector< float > > contents)
 
std::vector< float > * getContent (CONTENT_ID ContentId)
 Récupérer un contenu du handler.
 
const std::map< CONTENT_ID, std::vector< float > > & getContents () const
 Récupérer tous les contenus du handler.
 
void resetHandler ()
 Effacer les contenus du handler.
 

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.
 
- Public Attributes inherited from Lima::AbstractXmlDocumentHandler
std::vector< NODE_ID > m_openedNodes
 
std::vector< NODE_ID >::iterator m_lastOpenedNode
 
NODE_ID m_parentlastOpenedNode
 
NODE_ID m_lastNode
 
std::map< std::string, std::string > m_metadata
 
- 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

Manipulation de media ; separation du contenu et de la structure.

Definition at line 16 of file XmlSimpleStreamHandler.h.

Constructor & Destructor Documentation

◆ XmlSimpleStreamHandler()

Lima::XmlSimpleStreamHandler::XmlSimpleStreamHandler ( std::shared_ptr< const ShiftFrom >  shiftFrom)

Definition at line 12 of file XmlSimpleStreamHandler.cpp.

◆ ~XmlSimpleStreamHandler()

Lima::XmlSimpleStreamHandler::~XmlSimpleStreamHandler ( )

Definition at line 17 of file XmlSimpleStreamHandler.cpp.

Member Function Documentation

◆ endAnalysis()

void Lima::XmlSimpleStreamHandler::endAnalysis ( )
overridevirtual

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

Reimplemented from Lima::LinguisticProcessing::SimpleStreamHandler.

Definition at line 30 of file XmlSimpleStreamHandler.cpp.

◆ endDocument()

void Lima::XmlSimpleStreamHandler::endDocument ( )
overridevirtual

notify the end of the document

Reimplemented from Lima::LinguisticProcessing::SimpleStreamHandler.

Definition at line 26 of file XmlSimpleStreamHandler.cpp.

◆ endNode()

void Lima::XmlSimpleStreamHandler::endNode ( const Lima::Common::Misc::GenericDocumentProperties &  props)
overridevirtual

notify the end of a hierarchyNode

Reimplemented from Lima::LinguisticProcessing::SimpleStreamHandler.

Definition at line 49 of file XmlSimpleStreamHandler.cpp.

◆ handle()

void Lima::XmlSimpleStreamHandler::handle ( const char *  buf,
int  length 
)
overridevirtual

gives content.

Content is a serialized form of the expected resultType

Reimplemented from Lima::LinguisticProcessing::SimpleStreamHandler.

Definition at line 39 of file XmlSimpleStreamHandler.cpp.

◆ setOut()

void Lima::XmlSimpleStreamHandler::setOut ( std::ostream *  out)
overridevirtual

set the output stream.

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

Reimplemented from Lima::LinguisticProcessing::SimpleStreamHandler.

Definition at line 53 of file XmlSimpleStreamHandler.cpp.

◆ startAnalysis()

void Lima::XmlSimpleStreamHandler::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

Reimplemented from Lima::LinguisticProcessing::SimpleStreamHandler.

Definition at line 34 of file XmlSimpleStreamHandler.cpp.

◆ startDocument()

void Lima::XmlSimpleStreamHandler::startDocument ( const Lima::Common::Misc::GenericDocumentProperties &  props)
overridevirtual

notify the start of a new document

Reimplemented from Lima::LinguisticProcessing::SimpleStreamHandler.

Definition at line 21 of file XmlSimpleStreamHandler.cpp.

◆ startNode()

void Lima::XmlSimpleStreamHandler::startNode ( const std::string &  elementName,
bool  forIndexing 
)
overridevirtual

notify the start of a new hierarchyNode

Reimplemented from Lima::LinguisticProcessing::SimpleStreamHandler.

Definition at line 44 of file XmlSimpleStreamHandler.cpp.


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