This class is a process units that dumps to file a dependency graph in the GraphViz dot file format. More...

#include <linguisticProcessing/core/SyntacticAnalysis/DotDependencyGraphWriter.h>

Inheritance diagram for Lima::LinguisticProcessing::SyntacticAnalysis::DotDependencyGraphWriter:

Public Types
enum	DependencyGraphOutputMode { SentenceBySentence , FullGraph }
	This enum defines the output modes. More...

Public Types inherited from Lima::InitializableObject< Base, InitializationParameters >
typedef InitializableObjectManager< Base, InitializationParameters >	Manager
	Manager is the type of the Manager associated to the initializableObject.

typedef InitializableObjectFactory< Base >	Factory
	Factory is the type of the Factory associated to the initializableObject.

Public Member Functions
	DotDependencyGraphWriter ()

virtual	~DotDependencyGraphWriter ()

void	init (Common::XMLConfigurationFiles::GroupConfigurationStructure &unitConfiguration, Manager *manager) override
	initialize with parameters from configuration file.

LimaStatusCode	process (AnalysisContent &analysis) const override
	Process on data in analysisContent.

Public Member Functions inherited from Lima::LinguisticProcessing::DotGraphWriter
	DotGraphWriter ()

virtual	~DotGraphWriter ()=default

void	init (Common::XMLConfigurationFiles::GroupConfigurationStructure &unitConfiguration, Manager *manager) override
	initialize with parameters from configuration file.

LimaStatusCode	process (AnalysisContent &analysis) const override
	Process on data in analysisContent.

Public Member Functions inherited from Lima::InitializableObject< Base, InitializationParameters >
	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

Additional Inherited Members
Protected Attributes inherited from Lima::LinguisticProcessing::DotGraphWriter
std::string	m_outputSuffix

MediaId	m_language

std::shared_ptr< Lima::LinguisticProcessing::PosTagger::TrigramMatrix >	m_trigramMatrix

std::shared_ptr< Lima::LinguisticProcessing::PosTagger::BigramMatrix >	m_bigramMatrix

std::deque< std::string >	m_vertexDisplay

std::string	m_graphId

std::map< std::string, std::string >	m_graphDotOptions

std::map< std::string, std::string >	m_nodeDotOptions

std::map< std::string, std::string >	m_edgeDotOptions

Protected Attributes inherited from Lima::InitializableObject< Base, InitializationParameters >
std::string	m_id

Detailed Description

This class is a process units that dumps to file a dependency graph in the GraphViz dot file format.

Definition at line 51 of file DotDependencyGraphWriter.h.

Member Enumeration Documentation

◆ DependencyGraphOutputMode

enum Lima::LinguisticProcessing::SyntacticAnalysis::DotDependencyGraphWriter::DependencyGraphOutputMode

This enum defines the output modes.

The values are read in the outputMode parameter of the writer config group in the configuration file. Possible values are FullGraph to display all the analyzed text graph in one graph file and SentenceBySentence to display each sentence in a separate graph file.

Enumerator
SentenceBySentence
FullGraph

Definition at line 60 of file DotDependencyGraphWriter.h.

Constructor & Destructor Documentation

◆ DotDependencyGraphWriter()

Lima::LinguisticProcessing::SyntacticAnalysis::DotDependencyGraphWriter::DotDependencyGraphWriter ( )

Definition at line 51 of file DotDependencyGraphWriter.cpp.

◆ ~DotDependencyGraphWriter()

Lima::LinguisticProcessing::SyntacticAnalysis::DotDependencyGraphWriter::~DotDependencyGraphWriter ( )

virtual

Definition at line 55 of file DotDependencyGraphWriter.cpp.

Member Function Documentation

◆ init()

void Lima::LinguisticProcessing::SyntacticAnalysis::DotDependencyGraphWriter::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

InvalidConfiguration when parameters are invalids.

Implements Lima::MediaProcessUnit.

Definition at line 58 of file DotDependencyGraphWriter.cpp.

◆ process()

LimaStatusCode Lima::LinguisticProcessing::SyntacticAnalysis::DotDependencyGraphWriter::process ( AnalysisContent & analysis ) const

overridevirtual

Process on data in analysisContent.

This method should not return any exception

Parameters

analysis AnalysisContent object on which to process

Exceptions

UndefinedMethod if this method hasn't been specialized

Implements Lima::MediaProcessUnit.

Definition at line 119 of file DotDependencyGraphWriter.cpp.

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

lima_linguisticprocessing/src/linguisticProcessing/core/SyntacticAnalysis/DotDependencyGraphWriter.h
lima_linguisticprocessing/src/linguisticProcessing/core/SyntacticAnalysis/DotDependencyGraphWriter.cpp

Public Types

Public Member Functions

Additional Inherited Members