LIMA
Libre Multilingual Analyzer — C++ API
Loading...
Searching...
No Matches
Lima::InitializableObject< Base, InitializationParameters > Class Template Referenceabstract

defines an object that can be create and initialized by a SimpleFactory More...

#include <common/AbstractFactoryPattern/InitializableObject.h>

Inheritance diagram for Lima::InitializableObject< Base, InitializationParameters >:
Lima::AbstractProcessUnit< LinguisticAnalysisDumper, LinguisticAnalysisDumperInitializationParameters > Lima::AbstractProcessUnit< MediaAnalysisDumper, MediaAnalysisDumperInitializationParameters > Lima::AbstractProcessUnit< MediaProcessUnit, MediaProcessUnitInitializationParameters > Lima::AbstractProcessUnit< Base, InitializationParameters > Lima::LinguisticProcessing::LinguisticAnalysisDumper Lima::MediaAnalysisDumper Lima::MediaProcessUnit Lima::LinguisticProcessing::AbstractLinguisticLogger Lima::LinguisticProcessing::AbstractTextualAnalysisDumper Lima::LinguisticProcessing::AnalysisDumpers::AnnotationGraphXmlDumper Lima::LinguisticProcessing::AnalysisDumpers::DepTripleDumper Lima::LinguisticProcessing::AnalysisDumpers::EasyXmlDumper::EasyXmlDumper Lima::LinguisticProcessing::AnalysisDumpers::FullXmlDumper Lima::LinguisticProcessing::AnalysisDumpers::LinearTextRepresentationDumper Lima::LinguisticProcessing::AnalysisDumpers::LinearTextRepresentationLogger Lima::LinguisticProcessing::AnalysisDumpers::NullDumper Lima::LinguisticProcessing::AnalysisDumpers::posGraphXmlDumper Lima::LinguisticProcessing::AnalysisLoader Lima::LinguisticProcessing::ApplyRecognizer::ApplyRecognizer Lima::LinguisticProcessing::Compounds::AnnotDotGraphWriter Lima::LinguisticProcessing::Compounds::CompoundsBuilderFromSyntacticData Lima::LinguisticProcessing::ConlluReader::ConlluReader Lima::LinguisticProcessing::Coreferences::CorefSolver Lima::LinguisticProcessing::DeepLimaUnits::RnnDependencyParser::RnnDependencyParser Lima::LinguisticProcessing::DeepLimaUnits::RnnNER::RnnNER Lima::LinguisticProcessing::DeepLimaUnits::RnnTokenizer::RnnTokenizer Lima::LinguisticProcessing::DeepLimaUnits::RnnTokensAnalyzer::RnnTokensAnalyzer Lima::LinguisticProcessing::DotGraphWriter Lima::LinguisticProcessing::EntityTracking::EntityTracker Lima::LinguisticProcessing::EventAnalysis::EventAnalyzer Lima::LinguisticProcessing::EventAnalysis::EventDumper Lima::LinguisticProcessing::EventAnalysis::EventSegmentation Lima::LinguisticProcessing::EventAnalysis::EventTemplateMerging Lima::LinguisticProcessing::EventAnalysis::SimpleEventBuilder Lima::LinguisticProcessing::ExternalProcessUnit Lima::LinguisticProcessing::FlatTokenizer::Tokenizer Lima::LinguisticProcessing::LDetector::LangDetector Lima::LinguisticProcessing::LinguisticAnalysisStructure::ParagraphBoundariesFinder Lima::LinguisticProcessing::LinguisticAnalysisStructure::SentenceBoundariesFinder Lima::LinguisticProcessing::LinguisticAnalysisStructure::SentenceBoundariesTransfer Lima::LinguisticProcessing::MorphologicAnalysis::AbbreviationSplitAlternatives Lima::LinguisticProcessing::MorphologicAnalysis::ApproxStringMatcher Lima::LinguisticProcessing::MorphologicAnalysis::DefaultProperties Lima::LinguisticProcessing::MorphologicAnalysis::DicoConcatenatedAlternatives Lima::LinguisticProcessing::MorphologicAnalysis::EnchantSpellingAlternatives Lima::LinguisticProcessing::MorphologicAnalysis::HyphenWordAlternatives Lima::LinguisticProcessing::MorphologicAnalysis::OrthographicAlternatives Lima::LinguisticProcessing::MorphologicAnalysis::SimpleDefaultProperties Lima::LinguisticProcessing::MorphologicAnalysis::SimpleWord Lima::LinguisticProcessing::PosTagger::DummyPosTagger Lima::LinguisticProcessing::PosTagger::DynamicSvmToolPosTagger Lima::LinguisticProcessing::PosTagger::GreedyPosTagger Lima::LinguisticProcessing::PosTagger::SvmToolPosTagger Lima::LinguisticProcessing::PosTagger::ViterbiPosTagger< Cost, CostFunction > Lima::LinguisticProcessing::RegexMatching::RegexMatcher Lima::LinguisticProcessing::SemanticAnalysis::KnowledgeBasedSemanticRoleLabeler Lima::LinguisticProcessing::SpecificEntities::SpecificEntitiesCompletion Lima::LinguisticProcessing::SpecificEntities::SpecificEntitiesRecognizer Lima::LinguisticProcessing::StatusLogger Lima::LinguisticProcessing::SyntacticAnalysis::SyntacticAnalyzerDeps Lima::LinguisticProcessing::SyntacticAnalysis::SyntacticAnalyzerDepsHetero Lima::LinguisticProcessing::SyntacticAnalysis::SyntacticAnalyzerDisamb Lima::LinguisticProcessing::SyntacticAnalysis::SyntacticAnalyzerNoChains Lima::LinguisticProcessing::SyntacticAnalysis::SyntacticAnalyzerSimplify Lima::LinguisticProcessing::TextSegmentation::SentenceBoundariesUpdater::SentenceBoundariesUpdater Lima::LinguisticProcessing::WordSenseDisambiguation::WordSenseDisambiguator Lima::XmlReader::XmlDocumentParser

Public Types

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

 InitializableObject ()
 
 InitializableObject (const InitializableObject &object)
 
InitializableObject & operator= (const InitializableObject &object)
 
virtual ~InitializableObject ()
 
virtual void init (Common::XMLConfigurationFiles::GroupConfigurationStructure &unitConfiguration, Manager *manager)=0
 initialize with parameters from configuration file.
 
const std::string & getId () const
 get the object id
 
void setId (const std::string &id)
 set the object id
 

Protected Attributes

std::string m_id
 

Detailed Description

template<typename Base, typename InitializationParameters = NoParameters>
class Lima::InitializableObject< Base, InitializationParameters >

defines an object that can be create and initialized by a SimpleFactory

Author
Benoit Mathieu mathi.nosp@m.eub@.nosp@m.zoe.c.nosp@m.ea.f.nosp@m.r
Parameters
Basemust be an InitializableObject, is a base Type.
InitializationParametersparameters that object can use at initialization. \ this parameters are available through the associated Manager
See also
Manager

Definition at line 30 of file InitializableObject.h.

Member Typedef Documentation

◆ Factory

template<typename Base , typename InitializationParameters = NoParameters>
typedef InitializableObjectFactory<Base> Lima::InitializableObject< Base, InitializationParameters >::Factory

Factory is the type of the Factory associated to the initializableObject.

This type is an instanciation of InitializableObjectFactory template with the parameter Base.

defines associated Factory

Definition at line 53 of file InitializableObject.h.

◆ Manager

template<typename Base , typename InitializationParameters = NoParameters>
typedef InitializableObjectManager<Base,InitializationParameters> Lima::InitializableObject< Base, InitializationParameters >::Manager

Manager is the type of the Manager associated to the initializableObject.

This type is an instanciation of InitializableObjectManager template with same template parameters as InitializableObject. The manager is responsible for creating and manager objects of type specified by the Base template parameters.

defines associated Manager

Definition at line 45 of file InitializableObject.h.

Constructor & Destructor Documentation

◆ InitializableObject() [1/2]

template<typename Base , typename InitializationParameters = NoParameters>
Lima::InitializableObject< Base, InitializationParameters >::InitializableObject ( )
inline

Definition at line 33 of file InitializableObject.h.

◆ InitializableObject() [2/2]

template<typename Base , typename InitializationParameters = NoParameters>
Lima::InitializableObject< Base, InitializationParameters >::InitializableObject ( const InitializableObject< Base, InitializationParameters > &  object)
inline

Definition at line 34 of file InitializableObject.h.

◆ ~InitializableObject()

template<typename Base , typename InitializationParameters = NoParameters>
virtual Lima::InitializableObject< Base, InitializationParameters >::~InitializableObject ( )
inlinevirtual

Definition at line 55 of file InitializableObject.h.

Member Function Documentation

◆ getId()

template<typename Base , typename InitializationParameters = NoParameters>
const std::string & Lima::InitializableObject< Base, InitializationParameters >::getId ( ) const
inline

get the object id

Returns
the object id

Definition at line 73 of file InitializableObject.h.

◆ init()

template<typename Base , typename InitializationParameters = NoParameters>
virtual void Lima::InitializableObject< Base, InitializationParameters >::init ( Common::XMLConfigurationFiles::GroupConfigurationStructure &  unitConfiguration,
Manager *  manager 
)
pure virtual

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
InvalidConfigurationwhen parameters are invalids.

Implemented in Lima::LinguisticProcessing::PosTagger::TrigramMatrix, Lima::LinguisticProcessing::PosTagger::BigramMatrix, Lima::LinguisticProcessing::LinguisticAnalysisStructure::SentenceBoundariesXmlLogger, Lima::LinguisticProcessing::MorphologicAnalysis::DicoConcatenatedAlternatives, Lima::LinguisticProcessing::MorphologicAnalysis::OrthographicAlternatives, Lima::LinguisticProcessing::SpecificEntities::SpecificEntitiesCompletion, Lima::LinguisticProcessing::SpecificEntities::SpecificEntitiesRecognizer, Lima::LinguisticProcessing::AbstractLinguisticLogger, Lima::LinguisticProcessing::AnalysisDict::FsaAccessResource, Lima::LinguisticProcessing::AnalysisDict::FsaRwAccessResource, Lima::LinguisticProcessing::AnalysisDumpers::AbstractIEDumper, Lima::LinguisticProcessing::AnalysisDumpers::AnnotationGraphXmlDumper, Lima::LinguisticProcessing::AnalysisDumpers::BowDumper, Lima::LinguisticProcessing::AnalysisDumpers::BratDumper, Lima::LinguisticProcessing::AnalysisDumpers::BratJSONDumper, Lima::LinguisticProcessing::Compounds::CompoundsXmlLogger, Lima::LinguisticProcessing::AnalysisDumpers::DepTripleDumper, Lima::LinguisticProcessing::SyntacticAnalysis::DepTripletLogger, Lima::LinguisticProcessing::AnalysisDumpers::EasyXmlDumper::EasyXmlDumper, Lima::LinguisticProcessing::AnalysisDumpers::FullXmlDumper, Lima::LinguisticProcessing::AnalysisDumpers::GenericXmlDumper, Lima::LinguisticProcessing::AnalysisDumpers::LinearTextRepresentationDumper, Lima::LinguisticProcessing::AnalysisDumpers::LinearTextRepresentationLogger, Lima::LinguisticProcessing::AnalysisDumpers::NullDumper, Lima::LinguisticProcessing::AnalysisDumpers::posGraphXmlDumper, Lima::LinguisticProcessing::AnalysisDumpers::SimpleXmlDumper, Lima::LinguisticProcessing::AnalysisDumpers::TextDumper, Lima::LinguisticProcessing::AnalysisDumpers::TextFeaturesDumper, Lima::LinguisticProcessing::AnalysisDumpers::XmlIEDumper, Lima::LinguisticProcessing::ApplyRecognizer::ApplyRecognizer, Lima::LinguisticProcessing::ApplyRecognizer::RecognizerResultLogger, Lima::LinguisticProcessing::MorphologicAnalysis::ApproxStringMatcher, Lima::LinguisticProcessing::MorphologicAnalysis::NameIndexResource, Lima::LinguisticProcessing::Automaton::Recognizer, Lima::LinguisticProcessing::Compounds::AnnotDotGraphWriter, Lima::LinguisticProcessing::Compounds::CompoundsBuilderFromSyntacticData, Lima::LinguisticProcessing::Coreferences::CorefSolver, Lima::LinguisticProcessing::Coreferences::CorefSolvingNormalizedXmlLogger, Lima::LinguisticProcessing::Coreferences::CorefSolvingXmlLogger, Lima::LinguisticProcessing::EntityTracking::EntityTracker, Lima::LinguisticProcessing::EntityTracking::EntityTrackerXmlLogger, Lima::LinguisticProcessing::EventAnalysis::EventAnalyzer, Lima::LinguisticProcessing::EventAnalysis::EventDataDumper, Lima::LinguisticProcessing::EventAnalysis::EventDumper, Lima::LinguisticProcessing::EventAnalysis::EventSegmentation, Lima::LinguisticProcessing::EventAnalysis::EventTemplateDataDumper, Lima::LinguisticProcessing::EventAnalysis::EventTemplateDataXmlLogger, Lima::LinguisticProcessing::EventAnalysis::EventTemplateFilling, Lima::LinguisticProcessing::EventAnalysis::EventTemplateMerging, Lima::LinguisticProcessing::EventAnalysis::SimpleEventBuilder, Lima::LinguisticProcessing::FlatTokenizer::Tokenizer, Lima::LinguisticProcessing::LDetector::LangDetector, Lima::LinguisticProcessing::AbstractTextualAnalysisDumper, Lima::LinguisticProcessing::AnalysisLoader, Lima::LinguisticProcessing::ExternalProcessUnit, Lima::LinguisticProcessing::LinguisticAnalysisStructure::FullTokenXmlLogger, Lima::LinguisticProcessing::MetaDataDumper, Lima::LinguisticProcessing::StatusLogger, Lima::LinguisticProcessing::MorphologicAnalysis::AbbreviationSplitAlternatives, Lima::LinguisticProcessing::MorphologicAnalysis::DefaultProperties, Lima::LinguisticProcessing::MorphologicAnalysis::EnchantSpellingAlternatives, Lima::LinguisticProcessing::MorphologicAnalysis::HyphenWordAlternatives, Lima::LinguisticProcessing::MorphologicAnalysis::SimpleDefaultProperties, Lima::LinguisticProcessing::MorphologicAnalysis::SimpleWord, Lima::LinguisticProcessing::MorphologicAnalysis::UnknownWordLogger, Lima::LinguisticProcessing::PosTagger::DisambiguatedGraphXmlLogger, Lima::LinguisticProcessing::PosTagger::DisambiguationLogger, Lima::LinguisticProcessing::DotGraphWriter, Lima::LinguisticProcessing::PosTagger::DummyPosTagger, Lima::LinguisticProcessing::PosTagger::DynamicSvmToolPosTagger, Lima::LinguisticProcessing::PosTagger::GreedyPosTagger, Lima::LinguisticProcessing::PosTagger::SvmToolPosTagger, Lima::LinguisticProcessing::PosTagger::ViterbiPosTagger< Cost, CostFunction >, Lima::LinguisticProcessing::RegexMatching::RegexMatcher, Lima::LinguisticProcessing::AnalysisDumpers::ConllDumper, Lima::LinguisticProcessing::SemanticAnalysis::KnowledgeBasedSemanticRoleLabeler, Lima::LinguisticProcessing::SemanticAnalysis::SemanticRelationsXmlLogger, Lima::LinguisticProcessing::SemanticAnalysis::SemanticRoleLabelingLoader, Lima::LinguisticProcessing::SpecificEntities::SpecificEntitiesLoader, Lima::LinguisticProcessing::SpecificEntities::SpecificEntitiesXmlLogger, Lima::LinguisticProcessing::SyntacticAnalysis::DebugSyntacticAnalysisLogger, Lima::LinguisticProcessing::SyntacticAnalysis::DotDependencyGraphWriter, Lima::LinguisticProcessing::SyntacticAnalysis::SyntacticAnalysisXmlLogger, Lima::LinguisticProcessing::SyntacticAnalysis::SyntacticAnalyzerDeps, Lima::LinguisticProcessing::SyntacticAnalysis::SyntacticAnalyzerDisamb, Lima::LinguisticProcessing::SyntacticAnalysis::SyntacticAnalyzerDepsHetero, Lima::LinguisticProcessing::SyntacticAnalysis::SyntacticAnalyzerNoChains, Lima::LinguisticProcessing::SyntacticAnalysis::SyntacticAnalyzerSimplify, Lima::LinguisticProcessing::SyntacticAnalysis::SyntacticRelationsLogger, Lima::LinguisticProcessing::LinguisticAnalysisStructure::ParagraphBoundariesFinder, Lima::LinguisticProcessing::SegmentationDataXmlLogger, Lima::LinguisticProcessing::SegmentationResultsLoader, Lima::LinguisticProcessing::AnalysisDumpers::SegmentFeaturesDumper, Lima::LinguisticProcessing::LinguisticAnalysisStructure::SentenceBoundariesFinder, Lima::LinguisticProcessing::LinguisticAnalysisStructure::SentenceBoundariesTransfer, Lima::LinguisticProcessing::TextSegmentation::SentenceBoundariesUpdater::SentenceBoundariesUpdater, Lima::LinguisticProcessing::LinguisticAnalysisStructure::SentenceBoundariesXmlLogger, Lima::LinguisticProcessing::WordSenseDisambiguation::WordSenseDisambiguator, Lima::LinguisticProcessing::WordSenseDisambiguation::WordSenseXmlLogger, Lima::MediaAnalysisDumper, Lima::MediaProcessUnit, Lima::LinguisticProcessing::AnalysisDict::AbstractRwAccessResource, Lima::LinguisticProcessing::AnalysisDict::AbstractAccessResource, Lima::LinguisticProcessing::AbstractResource, Lima::LinguisticProcessing::LinguisticAnalysisDumper, Lima::XmlReader::XmlDocumentParser, Lima::LinguisticProcessing::ConlluReader::ConlluReader, Lima::LinguisticProcessing::DeepLimaUnits::RnnDependencyParser::RnnDependencyParser, Lima::LinguisticProcessing::DeepLimaUnits::RnnNER::RnnNER, Lima::LinguisticProcessing::DeepLimaUnits::RnnTokenizer::RnnTokenizer, Lima::LinguisticProcessing::DeepLimaUnits::RnnTokensAnalyzer::RnnTokensAnalyzer, Lima::LinguisticProcessing::EventAnalysis::EventXmlLogger, and Lima::DocumentsReader::AbstractReaderResource.

◆ operator=()

template<typename Base , typename InitializationParameters = NoParameters>
InitializableObject & Lima::InitializableObject< Base, InitializationParameters >::operator= ( const InitializableObject< Base, InitializationParameters > &  object)
inline

Definition at line 35 of file InitializableObject.h.

◆ setId()

template<typename Base , typename InitializationParameters = NoParameters>
void Lima::InitializableObject< Base, InitializationParameters >::setId ( const std::string &  id)
inline

set the object id

Parameters
idobject id

Definition at line 79 of file InitializableObject.h.

Member Data Documentation

◆ m_id

template<typename Base , typename InitializationParameters = NoParameters>
std::string Lima::InitializableObject< Base, InitializationParameters >::m_id
protected

Definition at line 82 of file InitializableObject.h.


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