LIMA
Libre Multilingual Analyzer — C++ API
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Public Attributes | Protected Attributes | List of all members
Lima::XmlReader::AbstractXmlReaderClient Class Referenceabstract

interface publique au client d'analyse de fichier XML More...

#include <linguisticProcessing/client/xmlreader/AbstractXmlReaderClient.h>

Inheritance diagram for Lima::XmlReader::AbstractXmlReaderClient:
Lima::AbstractProcessingClient Lima::XmlReader::CoreXmlReaderClient

Classes

struct  DocPropertyPublicInfo
 Store a subset of document property attributes extracted from configuration, for the purpose of public exposition (introspection) of the document analysis capacities. More...
 

Public Types

using DocPropertyPublicInfoMap = std::map< std::string, DocPropertyPublicInfo >
 Store the association of a document property name and its subset of attributes.
 

Public Member Functions

virtual ~AbstractXmlReaderClient ()
 define a virtual destructor to ensure concrete client destructors to be called
 
virtual std::shared_ptr< AnalysisContent > analyze (const std::string &content, const std::map< std::string, std::string > &metaData, const std::string &pipeline, const std::map< std::string, Lima::AbstractAnalysisHandler * > &handlers=std::map< std::string, Lima::AbstractAnalysisHandler * >(), const std::set< std::string > &inactiveUnits=std::set< std::string >()) const override=0
 Analyse un fichier XML.
 
virtual void setAnalysisHandler (const std::string &handlerId, Lima::AbstractAnalysisHandler *handler)=0
 
virtual void releaseAnalysisHandler (const std::string &handlerId)=0
 deletes the analysis handler with the given id and removes it
 
void setMapTagMedia (const std::map< std::string, std::string > &Ids)
 
void setDefaultMedia (const std::string &media)
 
void setDocumentPropertyConfiguration (Lima::Common::XMLConfigurationFiles::XMLConfigurationFileParser *configuration)
 Extract from configuration the subset of document property attributes from both standard-properties-list and extended-properties-list.
 
void getDocumentPropertyConfiguration (DocPropertyPublicInfoMap &standardPrprtyInfos, DocPropertyPublicInfoMap &extendedPrprtyInfos) const
 Retrieve the document property attributes for both standard and extended properties-list.
 
- Public Member Functions inherited from Lima::AbstractProcessingClient
virtual ~AbstractProcessingClient ()
 Define the destructor virtual to ensure concrete client destructors to be called.
 

Public Attributes

Lima::AbstractProcessingClientHandler m_processingClientHandler
 

Protected Attributes

std::map< std::string, std::string > m_mapTagMedia
 
std::string m_defaultMedia
 
DocPropertyPublicInfoMap m_standardPrprtyInfos
 
DocPropertyPublicInfoMap m_extendedPrprtyInfos
 

Detailed Description

interface publique au client d'analyse de fichier XML

Definition at line 26 of file AbstractXmlReaderClient.h.

Member Typedef Documentation

◆ DocPropertyPublicInfoMap

using Lima::XmlReader::AbstractXmlReaderClient::DocPropertyPublicInfoMap = std::map< std::string, DocPropertyPublicInfo >

Store the association of a document property name and its subset of attributes.

Note
Type alias (C++11) is far better than typedef

Definition at line 69 of file AbstractXmlReaderClient.h.

Constructor & Destructor Documentation

◆ ~AbstractXmlReaderClient()

virtual Lima::XmlReader::AbstractXmlReaderClient::~AbstractXmlReaderClient ( )
inlinevirtual

define a virtual destructor to ensure concrete client destructors to be called

Definition at line 31 of file AbstractXmlReaderClient.h.

Member Function Documentation

◆ analyze()

virtual std::shared_ptr< AnalysisContent > Lima::XmlReader::AbstractXmlReaderClient::analyze ( const std::string &  content,
const std::map< std::string, std::string > &  metaData,
const std::string &  pipeline,
const std::map< std::string, Lima::AbstractAnalysisHandler * > &  handlers = std::map< std::string, Lima::AbstractAnalysisHandler * >(),
const std::set< std::string > &  inactiveUnits = std::set< std::string >() 
) const
overridepure virtual

Analyse un fichier XML.

Parameters
textle texte (xml) a analyser
metaDataTODO decrire
pipelineTODO decrire
resultTypeTODO decrire
inactiveUnitsTODO decrire

Implements Lima::AbstractProcessingClient.

Implemented in Lima::XmlReader::CoreXmlReaderClient.

◆ getDocumentPropertyConfiguration()

void Lima::XmlReader::AbstractXmlReaderClient::getDocumentPropertyConfiguration ( DocPropertyPublicInfoMap &  standardPrprtyInfos,
DocPropertyPublicInfoMap &  extendedPrprtyInfos 
) const
inline

Retrieve the document property attributes for both standard and extended properties-list.

Definition at line 79 of file AbstractXmlReaderClient.h.

◆ releaseAnalysisHandler()

virtual void Lima::XmlReader::AbstractXmlReaderClient::releaseAnalysisHandler ( const std::string &  handlerId)
pure virtual

deletes the analysis handler with the given id and removes it

Implemented in Lima::XmlReader::CoreXmlReaderClient.

◆ setAnalysisHandler()

virtual void Lima::XmlReader::AbstractXmlReaderClient::setAnalysisHandler ( const std::string &  handlerId,
Lima::AbstractAnalysisHandler *  handler 
)
pure virtual

Implemented in Lima::XmlReader::CoreXmlReaderClient.

◆ setDefaultMedia()

void Lima::XmlReader::AbstractXmlReaderClient::setDefaultMedia ( const std::string &  media)
inline

Definition at line 55 of file AbstractXmlReaderClient.h.

◆ setDocumentPropertyConfiguration()

void Lima::XmlReader::AbstractXmlReaderClient::setDocumentPropertyConfiguration ( Lima::Common::XMLConfigurationFiles::XMLConfigurationFileParser *  configuration)

Extract from configuration the subset of document property attributes from both standard-properties-list and extended-properties-list.

See configuration at lp-structuredXmlreaderclient . documentXMLParser

Definition at line 21 of file AbstractXmlReaderClient.cpp.

◆ setMapTagMedia()

void Lima::XmlReader::AbstractXmlReaderClient::setMapTagMedia ( const std::map< std::string, std::string > &  Ids)
inline

Definition at line 51 of file AbstractXmlReaderClient.h.

Member Data Documentation

◆ m_defaultMedia

std::string Lima::XmlReader::AbstractXmlReaderClient::m_defaultMedia
protected

Definition at line 96 of file AbstractXmlReaderClient.h.

◆ m_extendedPrprtyInfos

DocPropertyPublicInfoMap Lima::XmlReader::AbstractXmlReaderClient::m_extendedPrprtyInfos
protected

Definition at line 102 of file AbstractXmlReaderClient.h.

◆ m_mapTagMedia

std::map<std::string, std::string> Lima::XmlReader::AbstractXmlReaderClient::m_mapTagMedia
protected

Definition at line 92 of file AbstractXmlReaderClient.h.

◆ m_processingClientHandler

Lima::AbstractProcessingClientHandler Lima::XmlReader::AbstractXmlReaderClient::m_processingClientHandler

Definition at line 87 of file AbstractXmlReaderClient.h.

◆ m_standardPrprtyInfos

DocPropertyPublicInfoMap Lima::XmlReader::AbstractXmlReaderClient::m_standardPrprtyInfos
protected

Definition at line 99 of file AbstractXmlReaderClient.h.

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