LIMA
Libre Multilingual Analyzer — C++ API
Loading...
Searching...
No Matches
Lima::LinguisticProcessing::AnalysisDict::EnhancedAnalysisDictionary Class Reference

#include <linguisticProcessing/core/AnalysisDict/EnhancedAnalysisDictionary.h>

Inheritance diagram for Lima::LinguisticProcessing::AnalysisDict::EnhancedAnalysisDictionary:
Lima::LinguisticProcessing::AnalysisDict::AbstractAnalysisDictionary Lima::LinguisticProcessing::AbstractResource Lima::LinguisticProcessing::AbstractResourceBase Lima::InitializableObject< AbstractResource, ResourceInitializationParameters >

Public Member Functions

 EnhancedAnalysisDictionary (const QString &dataFilePath=QString())
 
 EnhancedAnalysisDictionary (FsaStringsPool *sp, std::shared_ptr< Lima::Common::AbstractAccessByString > access, const std::string &dataFile)
 
virtual ~EnhancedAnalysisDictionary ()
 
virtual void init (Common::XMLConfigurationFiles::GroupConfigurationStructure &unitConfiguration, Manager *manager) override
 
virtual DictionaryEntry getEntry (const Lima::LimaString &word) const override
 get dictionary entry for a word
 
virtual DictionaryEntry getEntry (const StringsPoolIndex wordId) const override
 get dictionary entry for a word
 
virtual DictionaryEntry getEntry (const StringsPoolIndex wordId, const Lima::LimaString &word) const override
 
virtual std::pair< DictionarySubWordIterator, DictionarySubWordIterator > getSubWordEntries (const int offset, const LimaString &key) const override
 Returns subwords entries.
 
virtual std::pair< DictionarySuperWordIterator, DictionarySuperWordIterator > getSuperWordEntries (const LimaString &key) const override
 return superword entries A superword entry is an entry that begins with the given key
 
virtual uint64_t getSize () const override
 return number of keys in dictionary
 
DictionaryEntry getEntryData (const StringsPoolIndex entryId) const
 
- Public Member Functions inherited from Lima::LinguisticProcessing::AnalysisDict::AbstractAnalysisDictionary
 AbstractAnalysisDictionary (QObject *parent=nullptr)
 
virtual ~AbstractAnalysisDictionary ()
 
- 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
 

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

Author
Benoit Mathieu

Definition at line 27 of file EnhancedAnalysisDictionary.h.

Constructor & Destructor Documentation

◆ EnhancedAnalysisDictionary() [1/2]

Lima::LinguisticProcessing::AnalysisDict::EnhancedAnalysisDictionary::EnhancedAnalysisDictionary ( const QString &  dataFilePath = QString())

Definition at line 86 of file EnhancedAnalysisDictionary.cpp.

◆ EnhancedAnalysisDictionary() [2/2]

Lima::LinguisticProcessing::AnalysisDict::EnhancedAnalysisDictionary::EnhancedAnalysisDictionary ( FsaStringsPool *  sp,
std::shared_ptr< Lima::Common::AbstractAccessByString >  access,
const std::string &  dataFile 
)

Definition at line 105 of file EnhancedAnalysisDictionary.cpp.

◆ ~EnhancedAnalysisDictionary()

Lima::LinguisticProcessing::AnalysisDict::EnhancedAnalysisDictionary::~EnhancedAnalysisDictionary ( )
virtual

Definition at line 123 of file EnhancedAnalysisDictionary.cpp.

Member Function Documentation

◆ getEntry() [1/3]

DictionaryEntry Lima::LinguisticProcessing::AnalysisDict::EnhancedAnalysisDictionary::getEntry ( const Lima::LimaString &  word) const
overridevirtual

get dictionary entry for a word

Parameters
wordword to search
Returns
AbstractDictionaryEntry* corresponding to word
Return values
0if no available entry
pointerto AbstractDictionaryEntry*. WARNING : must be deleted when no more used.

Implements Lima::LinguisticProcessing::AnalysisDict::AbstractAnalysisDictionary.

Definition at line 211 of file EnhancedAnalysisDictionary.cpp.

◆ getEntry() [2/3]

DictionaryEntry Lima::LinguisticProcessing::AnalysisDict::EnhancedAnalysisDictionary::getEntry ( const StringsPoolIndex  wordId) const
overridevirtual

get dictionary entry for a word

Parameters
wordIdstring pool Id of word to search
Returns
AbstractDictionaryEntry* corresponding to word
Return values
0if no available entry
pointerto AbstractDictionaryEntry*. WARNING : must be deleted when no more used.

Implements Lima::LinguisticProcessing::AnalysisDict::AbstractAnalysisDictionary.

Definition at line 216 of file EnhancedAnalysisDictionary.cpp.

◆ getEntry() [3/3]

DictionaryEntry Lima::LinguisticProcessing::AnalysisDict::EnhancedAnalysisDictionary::getEntry ( const StringsPoolIndex  wordId,
const Lima::LimaString &  word 
) const
overridevirtual

◆ getEntryData()

DictionaryEntry Lima::LinguisticProcessing::AnalysisDict::EnhancedAnalysisDictionary::getEntryData ( const StringsPoolIndex  entryId) const

Definition at line 223 of file EnhancedAnalysisDictionary.cpp.

◆ getSize()

uint64_t Lima::LinguisticProcessing::AnalysisDict::EnhancedAnalysisDictionary::getSize ( ) const
overridevirtual

return number of keys in dictionary

Returns
number of keys.

Implements Lima::LinguisticProcessing::AnalysisDict::AbstractAnalysisDictionary.

Definition at line 199 of file EnhancedAnalysisDictionary.cpp.

◆ getSubWordEntries()

std::pair< DictionarySubWordIterator, DictionarySubWordIterator > Lima::LinguisticProcessing::AnalysisDict::EnhancedAnalysisDictionary::getSubWordEntries ( const int  offset,
const LimaString &  key 
) const
overridevirtual

Returns subwords entries.

Warning : Since all strings are stored as keys in dictionary, the subword entries function may returns substrings which have empty dictionary entry. Program which use this function should take care of it.

Parameters
offset
key
Returns
subword iterators

Implements Lima::LinguisticProcessing::AnalysisDict::AbstractAnalysisDictionary.

Definition at line 283 of file EnhancedAnalysisDictionary.cpp.

◆ getSuperWordEntries()

std::pair< DictionarySuperWordIterator, DictionarySuperWordIterator > Lima::LinguisticProcessing::AnalysisDict::EnhancedAnalysisDictionary::getSuperWordEntries ( const LimaString &  key) const
overridevirtual

return superword entries A superword entry is an entry that begins with the given key

Implements Lima::LinguisticProcessing::AnalysisDict::AbstractAnalysisDictionary.

Definition at line 293 of file EnhancedAnalysisDictionary.cpp.

◆ init()

void Lima::LinguisticProcessing::AnalysisDict::EnhancedAnalysisDictionary::init ( Common::XMLConfigurationFiles::GroupConfigurationStructure &  unitConfiguration,
Manager *  manager 
)
overridevirtual

Definition at line 128 of file EnhancedAnalysisDictionary.cpp.


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