#include <linguisticProcessing/core/AnalysisDumpers/AbstractIEDumper.h>

Inheritance diagram for Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper:

Classes
struct	IEDumperMetaData

Public Member Functions
	AbstractIEDumper ()

virtual	~AbstractIEDumper ()

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

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

virtual bool	addEventMentionAsEntity () const


virtual void	outputGlobalHeader (std::ostream &, const std::string &="", const LimaStringText &=LimaStringText("")) const
	specific output functions to deal with actual output format these functions are called inside the process() function.

virtual void	outputGlobalFooter (std::ostream &) const

virtual void	outputEntitiesHeader (std::ostream &) const

virtual void	outputEntitiesFooter (std::ostream &) const

virtual void	outputRelationsHeader (std::ostream &) const

virtual void	outputRelationsFooter (std::ostream &) const

virtual void	outputEventsHeader (std::ostream &) const

virtual void	outputEventsFooter (std::ostream &) const

virtual void	outputEntityString (std::ostream &out, unsigned int entityId, const std::string &entityType, const std::string &entityString, const std::vector< std::pair< uint64_t, uint64_t > > &positions, const Automaton::EntityFeatures &entityFeatures, bool noNorm=false) const =0

virtual void	outputAttributesString (std::ostream &out, unsigned int entityId, std::map< std::tuple< std::size_t, std::string, std::string >, std::size_t > &mapAttributes) const =0

virtual unsigned int	outputRelationString (std::ostream &out, unsigned int relationId, const std::string &relationType, const std::string &sourceArgString, const std::string &targetArgString) const =0

virtual void	outputEventString (std::ostream &out, unsigned int eventId, unsigned int eventMentionId, const std::string &eventMentionType, const std::vector< unsigned int > &eventRoleId, const std::vector< std::string > &eventRoleType) const =0

virtual void	outputEntityNorm (std::ostream &out, unsigned int entityId, const std::string &entityNorm) const =0

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

virtual	~AbstractTextualAnalysisDumper ()

std::shared_ptr< DumperStream >	initialize (AnalysisContent &analysis) const

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

Protected Member Functions
const SemanticAnalysis::SemanticRelationAnnotation *	getSemanticRelationAnnotation (LinguisticGraphVertex v, const Common::AnnotationGraphs::AnnotationData *annotationData) const

const SpecificEntities::SpecificEntityAnnotation *	getSpecificEntityAnnotation (LinguisticGraphVertex v, const Common::AnnotationGraphs::AnnotationData *annotationData) const

bool	outputEntity (std::ostream &out, LinguisticGraphVertex v, const SpecificEntities::SpecificEntityAnnotation annot, const VertexTokenPropertyMap &tokenMap, uint64_t offset, LimaStringText originalText, std::map< std::tuple< uint64_t, uint64_t, std::string >, std::size_t > &mapEntities, std::map< std::tuple< std::size_t, std::string, std::string >, std::size_t > &mapAttributes, IEDumperMetaData metadata) const

uint	outputSemanticRelations (std::ostream &out, const Common::AnnotationGraphs::AnnotationData annotationData, const VertexTokenPropertyMap &tokenMap, std::map< std::tuple< std::uint64_t, std::uint64_t, std::string >, std::size_t > mapEntities, uint64_t offset, IEDumperMetaData metadata) const

uint	outputEventData (std::ostream &out, const EventAnalysis::EventTemplateData eventData, const Common::AnnotationGraphs::AnnotationData annotationData, const VertexTokenPropertyMap &tokenMap, std::map< std::tuple< std::uint64_t, std::uint64_t, std::string >, std::size_t > mapEntities, uint64_t offset, LimaStringText originalText, IEDumperMetaData *metadata) const

std::string	outputSemanticRelationArg (const std::string &vertexRole, const AnnotationGraphVertex &vertex, const VertexTokenPropertyMap &tokenMap, std::map< std::tuple< std::uint64_t, std::uint64_t, std::string >, std::size_t > mapEntities, const Common::AnnotationGraphs::AnnotationData *annotationData, uint64_t offset) const

void	computePositions (std::vector< std::pair< uint64_t, uint64_t > > &positions, LimaString &stringForm, uint64_t pos, uint64_t len) const

void	adjustPosition (std::uint64_t &position, uint64_t offset=0) const

void	adjustPositions (std::vector< std::pair< uint64_t, uint64_t > > &positions, uint64_t offset=0) const

Protected Attributes
MediaId	m_language

std::string	m_graph

bool	m_followGraph

std::set< std::string >	m_domains

std::set< std::string >	m_ignore

std::deque< std::string >	m_attributes

bool	m_all_attributes

std::map< std::string, std::shared_ptr< EventAnalysis::EventTemplateDefinitionResource > >	m_templateDefinitions

std::set< std::string >	m_templateNames

OffsetMapping *	m_offsetMapping

bool	m_outputGroups

int	m_posOffset

Protected Attributes inherited from Lima::LinguisticProcessing::AbstractTextualAnalysisDumper
MediaId	m_language

std::ostream *	m_out

std::string	m_handlerName

std::string	m_outputFile

std::string	m_outputSuffix

bool	m_stripInputSuffix

bool	m_append

QString	m_temporaryFileMetadata

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

Additional Inherited Members
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.

Detailed Description

Definition at line 24 of file AbstractIEDumper.h.

Constructor & Destructor Documentation

◆ AbstractIEDumper()

Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::AbstractIEDumper ( )

Definition at line 89 of file AbstractIEDumper.cpp.

◆ ~AbstractIEDumper()

Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::~AbstractIEDumper ( )

virtual

Definition at line 108 of file AbstractIEDumper.cpp.

Member Function Documentation

◆ addEventMentionAsEntity()

virtual bool Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::addEventMentionAsEntity ( ) const

inlinevirtual

Reimplemented in Lima::LinguisticProcessing::AnalysisDumpers::BratDumper, Lima::LinguisticProcessing::AnalysisDumpers::BratJSONDumper, and Lima::LinguisticProcessing::AnalysisDumpers::XmlIEDumper.

Definition at line 86 of file AbstractIEDumper.h.

◆ adjustPosition()

void Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::adjustPosition	(	std::uint64_t &	position,
		uint64_t	offset = `0`
	)		const

protected

Definition at line 1013 of file AbstractIEDumper.cpp.

◆ adjustPositions()

void Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::adjustPositions	(	std::vector< std::pair< uint64_t, uint64_t > > &	positions,
		uint64_t	offset = `0`
	)		const

protected

Definition at line 1027 of file AbstractIEDumper.cpp.

◆ computePositions()

void Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::computePositions	(	std::vector< std::pair< uint64_t, uint64_t > > &	positions,
		LimaString &	stringForm,
		uint64_t	pos,
		uint64_t	len
	)		const

protected

Definition at line 647 of file AbstractIEDumper.cpp.

◆ getSemanticRelationAnnotation()

const SemanticAnalysis::SemanticRelationAnnotation * Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::getSemanticRelationAnnotation	(	LinguisticGraphVertex	v,
		const Common::AnnotationGraphs::AnnotationData *	annotationData
	)		const

protected

Definition at line 985 of file AbstractIEDumper.cpp.

◆ getSpecificEntityAnnotation()

const SpecificEntityAnnotation * Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::getSpecificEntityAnnotation	(	LinguisticGraphVertex	v,
		const Common::AnnotationGraphs::AnnotationData *	annotationData
	)		const

protected

Definition at line 818 of file AbstractIEDumper.cpp.

◆ init()

void Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::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.

Reimplemented from Lima::LinguisticProcessing::AbstractTextualAnalysisDumper.

Reimplemented in Lima::LinguisticProcessing::AnalysisDumpers::BratDumper, Lima::LinguisticProcessing::AnalysisDumpers::BratJSONDumper, and Lima::LinguisticProcessing::AnalysisDumpers::XmlIEDumper.

Definition at line 111 of file AbstractIEDumper.cpp.

◆ outputAttributesString()

virtual void Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::outputAttributesString	(	std::ostream &	out,
		unsigned int	entityId,
		std::map< std::tuple< std::size_t, std::string, std::string >, std::size_t > &	mapAttributes
	)		const

pure virtual

Implemented in Lima::LinguisticProcessing::AnalysisDumpers::BratDumper, Lima::LinguisticProcessing::AnalysisDumpers::BratJSONDumper, and Lima::LinguisticProcessing::AnalysisDumpers::XmlIEDumper.

◆ outputEntitiesFooter()

virtual void Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::outputEntitiesFooter ( std::ostream & ) const

inlinevirtual

Reimplemented in Lima::LinguisticProcessing::AnalysisDumpers::BratJSONDumper, and Lima::LinguisticProcessing::AnalysisDumpers::XmlIEDumper.

Definition at line 46 of file AbstractIEDumper.h.

◆ outputEntitiesHeader()

virtual void Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::outputEntitiesHeader ( std::ostream & ) const

inlinevirtual

Reimplemented in Lima::LinguisticProcessing::AnalysisDumpers::BratJSONDumper, and Lima::LinguisticProcessing::AnalysisDumpers::XmlIEDumper.

Definition at line 45 of file AbstractIEDumper.h.

◆ outputEntity()

bool Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::outputEntity	(	std::ostream &	out,
		LinguisticGraphVertex	v,
		const SpecificEntities::SpecificEntityAnnotation *	annot,
		const VertexTokenPropertyMap &	tokenMap,
		uint64_t	offset,
		LimaStringText	originalText,
		std::map< std::tuple< uint64_t, uint64_t, std::string >, std::size_t > &	mapEntities,
		std::map< std::tuple< std::size_t, std::string, std::string >, std::size_t > &	mapAttributes,
		IEDumperMetaData *	metadata
	)		const

protected

Definition at line 707 of file AbstractIEDumper.cpp.

◆ outputEntityNorm()

virtual void Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::outputEntityNorm	(	std::ostream &	out,
		unsigned int	entityId,
		const std::string &	entityNorm
	)		const

pure virtual

Implemented in Lima::LinguisticProcessing::AnalysisDumpers::BratDumper, Lima::LinguisticProcessing::AnalysisDumpers::BratJSONDumper, and Lima::LinguisticProcessing::AnalysisDumpers::XmlIEDumper.

◆ outputEntityString()

virtual void Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::outputEntityString	(	std::ostream &	out,
		unsigned int	entityId,
		const std::string &	entityType,
		const std::string &	entityString,
		const std::vector< std::pair< uint64_t, uint64_t > > &	positions,
		const Automaton::EntityFeatures &	entityFeatures,
		bool	noNorm = `false`
	)		const

pure virtual

Implemented in Lima::LinguisticProcessing::AnalysisDumpers::BratDumper, Lima::LinguisticProcessing::AnalysisDumpers::BratJSONDumper, and Lima::LinguisticProcessing::AnalysisDumpers::XmlIEDumper.

◆ outputEventData()

uint Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::outputEventData	(	std::ostream &	out,
		const EventAnalysis::EventTemplateData *	eventData,
		const Common::AnnotationGraphs::AnnotationData *	annotationData,
		const VertexTokenPropertyMap &	tokenMap,
		std::map< std::tuple< std::uint64_t, std::uint64_t, std::string >, std::size_t >	mapEntities,
		uint64_t	offset,
		LimaStringText	originalText,
		IEDumperMetaData *	metadata
	)		const

protected

Definition at line 506 of file AbstractIEDumper.cpp.

◆ outputEventsFooter()

virtual void Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::outputEventsFooter ( std::ostream & ) const

inlinevirtual

Reimplemented in Lima::LinguisticProcessing::AnalysisDumpers::BratJSONDumper, and Lima::LinguisticProcessing::AnalysisDumpers::XmlIEDumper.

Definition at line 50 of file AbstractIEDumper.h.

◆ outputEventsHeader()

virtual void Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::outputEventsHeader ( std::ostream & ) const

inlinevirtual

Reimplemented in Lima::LinguisticProcessing::AnalysisDumpers::BratJSONDumper, and Lima::LinguisticProcessing::AnalysisDumpers::XmlIEDumper.

Definition at line 49 of file AbstractIEDumper.h.

◆ outputEventString()

virtual void Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::outputEventString	(	std::ostream &	out,
		unsigned int	eventId,
		unsigned int	eventMentionId,
		const std::string &	eventMentionType,
		const std::vector< unsigned int > &	eventRoleId,
		const std::vector< std::string > &	eventRoleType
	)		const

pure virtual

Implemented in Lima::LinguisticProcessing::AnalysisDumpers::BratDumper, Lima::LinguisticProcessing::AnalysisDumpers::BratJSONDumper, and Lima::LinguisticProcessing::AnalysisDumpers::XmlIEDumper.

◆ outputGlobalFooter()

virtual void Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::outputGlobalFooter ( std::ostream & ) const

inlinevirtual

Reimplemented in Lima::LinguisticProcessing::AnalysisDumpers::BratJSONDumper, and Lima::LinguisticProcessing::AnalysisDumpers::XmlIEDumper.

Definition at line 44 of file AbstractIEDumper.h.

◆ outputGlobalHeader()

virtual void Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::outputGlobalHeader	(	std::ostream &	,
		const std::string &	= `""`,
		const LimaStringText &	= `LimaStringText("")`
	)		const

inlinevirtual

specific output functions to deal with actual output format these functions are called inside the process() function.

Reimplemented in Lima::LinguisticProcessing::AnalysisDumpers::XmlIEDumper, and Lima::LinguisticProcessing::AnalysisDumpers::BratJSONDumper.

Definition at line 42 of file AbstractIEDumper.h.

◆ outputRelationsFooter()

virtual void Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::outputRelationsFooter ( std::ostream & ) const

inlinevirtual

Reimplemented in Lima::LinguisticProcessing::AnalysisDumpers::BratJSONDumper, and Lima::LinguisticProcessing::AnalysisDumpers::XmlIEDumper.

Definition at line 48 of file AbstractIEDumper.h.

◆ outputRelationsHeader()

virtual void Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::outputRelationsHeader ( std::ostream & ) const

inlinevirtual

Reimplemented in Lima::LinguisticProcessing::AnalysisDumpers::BratJSONDumper, and Lima::LinguisticProcessing::AnalysisDumpers::XmlIEDumper.

Definition at line 47 of file AbstractIEDumper.h.

◆ outputRelationString()

virtual unsigned int Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::outputRelationString	(	std::ostream &	out,
		unsigned int	relationId,
		const std::string &	relationType,
		const std::string &	sourceArgString,
		const std::string &	targetArgString
	)		const

pure virtual

Implemented in Lima::LinguisticProcessing::AnalysisDumpers::BratDumper, Lima::LinguisticProcessing::AnalysisDumpers::BratJSONDumper, and Lima::LinguisticProcessing::AnalysisDumpers::XmlIEDumper.

◆ outputSemanticRelationArg()

std::string Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::outputSemanticRelationArg	(	const std::string &	vertexRole,
		const AnnotationGraphVertex &	vertex,
		const VertexTokenPropertyMap &	tokenMap,
		std::map< std::tuple< std::uint64_t, std::uint64_t, std::string >, std::size_t >	mapEntities,
		const Common::AnnotationGraphs::AnnotationData *	annotationData,
		uint64_t	offset
	)		const

protected

Definition at line 871 of file AbstractIEDumper.cpp.

◆ outputSemanticRelations()

uint Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::outputSemanticRelations	(	std::ostream &	out,
		const Common::AnnotationGraphs::AnnotationData *	annotationData,
		const VertexTokenPropertyMap &	tokenMap,
		std::map< std::tuple< std::uint64_t, std::uint64_t, std::string >, std::size_t >	mapEntities,
		uint64_t	offset,
		IEDumperMetaData *	metadata
	)		const

protected

Definition at line 935 of file AbstractIEDumper.cpp.

◆ process()

LimaStatusCode Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::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

map< tuple< pos, len, entityType > , entityId >

map< tuple< entityId, featName, featValue > , featId >

Implements Lima::LinguisticProcessing::AbstractTextualAnalysisDumper.

Definition at line 250 of file AbstractIEDumper.cpp.

Member Data Documentation

◆ m_all_attributes

bool Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::m_all_attributes

protected

Definition at line 95 of file AbstractIEDumper.h.

◆ m_attributes

std::deque< std::string > Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::m_attributes

protected

Definition at line 94 of file AbstractIEDumper.h.

◆ m_domains

std::set< std::string > Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::m_domains

protected

Definition at line 92 of file AbstractIEDumper.h.

◆ m_followGraph

bool Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::m_followGraph

protected

Definition at line 91 of file AbstractIEDumper.h.

◆ m_graph

std::string Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::m_graph

protected

Definition at line 90 of file AbstractIEDumper.h.

◆ m_ignore

std::set< std::string > Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::m_ignore

protected

Definition at line 93 of file AbstractIEDumper.h.

◆ m_language

MediaId Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::m_language

protected

Definition at line 89 of file AbstractIEDumper.h.

◆ m_offsetMapping

OffsetMapping* Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::m_offsetMapping

mutableprotected

Definition at line 100 of file AbstractIEDumper.h.

◆ m_outputGroups

bool Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::m_outputGroups

protected

Definition at line 101 of file AbstractIEDumper.h.

◆ m_posOffset

int Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::m_posOffset

protected

Definition at line 102 of file AbstractIEDumper.h.

◆ m_templateDefinitions

std::map<std::string, std::shared_ptr<EventAnalysis::EventTemplateDefinitionResource> > Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::m_templateDefinitions

protected

Definition at line 96 of file AbstractIEDumper.h.

◆ m_templateNames

std::set<std::string> Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper::m_templateNames

protected

Definition at line 97 of file AbstractIEDumper.h.

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

lima_linguisticprocessing/src/linguisticProcessing/core/AnalysisDumpers/AbstractIEDumper.h
lima_linguisticprocessing/src/linguisticProcessing/core/AnalysisDumpers/AbstractIEDumper.cpp

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AbstractIEDumper()

◆ ~AbstractIEDumper()

Member Function Documentation

◆ addEventMentionAsEntity()

◆ adjustPosition()

◆ adjustPositions()

◆ computePositions()

◆ getSemanticRelationAnnotation()

◆ getSpecificEntityAnnotation()

◆ init()

◆ outputAttributesString()

◆ outputEntitiesFooter()

◆ outputEntitiesHeader()

◆ outputEntity()

◆ outputEntityNorm()

◆ outputEntityString()

◆ outputEventData()

◆ outputEventsFooter()

◆ outputEventsHeader()

◆ outputEventString()

◆ outputGlobalFooter()

◆ outputGlobalHeader()

◆ outputRelationsFooter()

◆ outputRelationsHeader()

◆ outputRelationString()

◆ outputSemanticRelationArg()

◆ outputSemanticRelations()

◆ process()

Member Data Documentation

◆ m_all_attributes

◆ m_attributes

◆ m_domains

◆ m_followGraph

◆ m_graph

◆ m_ignore

◆ m_language

◆ m_offsetMapping

◆ m_outputGroups

◆ m_posOffset

◆ m_templateDefinitions

◆ m_templateNames