BowTextHandler is a handler for BoW documents that gives access to the resulting BoWText through an accessor. More...

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

Inheritance diagram for Lima::LinguisticProcessing::BowTextHandler:

Public Member Functions
	BowTextHandler ()

virtual	~BowTextHandler ()

virtual void	endAnalysis () override
	function called by the LIMA analyzer on the end of a text part that is to be analyzed

virtual void	endDocument () override
	notify the end of the document

virtual void	handle (const char *buf, int length) override
	gives content.

virtual void	startAnalysis () override
	function called by the LIMA analyzer on start of a new document

virtual void	startDocument (const Common::Misc::GenericDocumentProperties &props) override
	notify the start of a new document, and give its properties

virtual void	startNode (const std::string &elementName, bool forIndexing) override
	notify the start of a new hierarchyNode

virtual void	endNode (const Common::Misc::GenericDocumentProperties &props) override
	notify the end of a hierarchyNode

Common::BagOfWords::BoWText &	getBowText ()

void	set_filePath (std::string path)

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

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::ContentHandler< Common::BagOfWords::BoWText >
	ContentHandler ()

virtual	~ContentHandler ()

void	addContent (CONTENT_ID ContentId, Common::BagOfWords::BoWText datas)
	Ajouter un contenu au handler.

void	setContents (const std::map< CONTENT_ID, Common::BagOfWords::BoWText > contents)

Common::BagOfWords::BoWText *	getContent (CONTENT_ID ContentId)
	Récupérer un contenu du handler.

const std::map< CONTENT_ID, Common::BagOfWords::BoWText > &	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.

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

BowTextHandler is a handler for BoW documents that gives access to the resulting BoWText through an accessor.

Author: Benoit Mathieu

Definition at line 30 of file BowTextHandler.h.

Constructor & Destructor Documentation

◆ BowTextHandler()

Lima::LinguisticProcessing::BowTextHandler::BowTextHandler ( )

Definition at line 23 of file BowTextHandler.cpp.

◆ ~BowTextHandler()

Lima::LinguisticProcessing::BowTextHandler::~BowTextHandler ( )

virtual

Definition at line 29 of file BowTextHandler.cpp.

Member Function Documentation

◆ endAnalysis()

void Lima::LinguisticProcessing::BowTextHandler::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 45 of file BowTextHandler.cpp.

◆ endDocument()

void Lima::LinguisticProcessing::BowTextHandler::endDocument ( )

overridevirtual

notify the end of the document

Implements Lima::AbstractXmlAnalysisHandler.

Definition at line 101 of file BowTextHandler.cpp.

◆ endNode()

void Lima::LinguisticProcessing::BowTextHandler::endNode ( const Common::Misc::GenericDocumentProperties & props )

overridevirtual

notify the end of a hierarchyNode

Implements Lima::AbstractXmlAnalysisHandler.

Definition at line 113 of file BowTextHandler.cpp.

◆ getBowText()

Common::BagOfWords::BoWText & Lima::LinguisticProcessing::BowTextHandler::getBowText ( )

Definition at line 39 of file BowTextHandler.cpp.

◆ handle()

void Lima::LinguisticProcessing::BowTextHandler::handle	(	const char *	buf,
		int	length
	)

overridevirtual

gives content.

Content is a serialized form of the expected resultType

Implements Lima::AbstractXmlAnalysisHandler.

Definition at line 96 of file BowTextHandler.cpp.

◆ set_filePath()

void Lima::LinguisticProcessing::BowTextHandler::set_filePath ( std::string path )

inline

Definition at line 48 of file BowTextHandler.h.

◆ setOut()

virtual void Lima::LinguisticProcessing::BowTextHandler::setOut ( std::ostream * out )

inlineoverridevirtual

set the output stream.

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

Implements Lima::AbstractXmlAnalysisHandler.

Definition at line 49 of file BowTextHandler.h.

◆ startAnalysis()

void Lima::LinguisticProcessing::BowTextHandler::startAnalysis ( )

overridevirtual

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

Parameters

props the 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 75 of file BowTextHandler.cpp.

◆ startDocument()

void Lima::LinguisticProcessing::BowTextHandler::startDocument ( const Common::Misc::GenericDocumentProperties & props )

overridevirtual

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

Implements Lima::AbstractXmlAnalysisHandler.

Definition at line 105 of file BowTextHandler.cpp.

◆ startNode()

void Lima::LinguisticProcessing::BowTextHandler::startNode	(	const std::string &	elementName,
		bool	forIndexing
	)

overridevirtual

notify the start of a new hierarchyNode

Implements Lima::AbstractXmlAnalysisHandler.

Definition at line 109 of file BowTextHandler.cpp.

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

lima_linguisticprocessing/src/linguisticProcessing/client/AnalysisHandlers/BowTextHandler.h
lima_linguisticprocessing/src/linguisticProcessing/client/AnalysisHandlers/BowTextHandler.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BowTextHandler()

◆ ~BowTextHandler()

Member Function Documentation

◆ endAnalysis()

◆ endDocument()

◆ endNode()

◆ getBowText()

◆ handle()

◆ set_filePath()

◆ setOut()

◆ startAnalysis()

◆ startDocument()

◆ startNode()