interface for analysis dictionary More...

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

Inheritance diagram for Lima::LinguisticProcessing::AnalysisDict::AbstractAnalysisDictionary:

Public Member Functions
	AbstractAnalysisDictionary (QObject *parent=nullptr)

virtual	~AbstractAnalysisDictionary ()

virtual DictionaryEntry	getEntry (const Lima::LimaString &word) const =0
	get dictionary entry for a word

virtual DictionaryEntry	getEntry (const StringsPoolIndex wordId) const =0
	get dictionary entry for a word

virtual DictionaryEntry	getEntry (const StringsPoolIndex wordId, const Lima::LimaString &word) const =0

virtual std::pair< DictionarySubWordIterator, DictionarySubWordIterator >	getSubWordEntries (const int offset, const LimaString &key) const =0
	return subword entries A subword entry is a word in the key string that begin at the given offset.

virtual std::pair< DictionarySuperWordIterator, DictionarySuperWordIterator >	getSuperWordEntries (const LimaString &key) const =0
	return superword entries A superword entry is an entry that begins with the given key

virtual uint64_t	getSize () const =0
	return number of keys in dictionary

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

interface for analysis dictionary

Definition at line 33 of file AbstractAnalysisDictionary.h.

Constructor & Destructor Documentation

◆ AbstractAnalysisDictionary()

Lima::LinguisticProcessing::AnalysisDict::AbstractAnalysisDictionary::AbstractAnalysisDictionary ( QObject * parent = nullptr )

Definition at line 19 of file AbstractAnalysisDictionary.cpp.

◆ ~AbstractAnalysisDictionary()

Lima::LinguisticProcessing::AnalysisDict::AbstractAnalysisDictionary::~AbstractAnalysisDictionary ( )

virtual

Definition at line 24 of file AbstractAnalysisDictionary.cpp.

Member Function Documentation

◆ getEntry() [1/3]

virtual DictionaryEntry Lima::LinguisticProcessing::AnalysisDict::AbstractAnalysisDictionary::getEntry ( const Lima::LimaString & word ) const

pure virtual

get dictionary entry for a word

Parameters

word	word to search

Returns: AbstractDictionaryEntry* corresponding to word

Return values

0	if no available entry
pointer	to AbstractDictionaryEntry*. WARNING : must be deleted when no more used.

Implemented in Lima::LinguisticProcessing::AnalysisDict::EnhancedAnalysisDictionary, and Lima::LinguisticProcessing::AnalysisDict::MultiLevelAnalysisDictionary.

◆ getEntry() [2/3]

virtual DictionaryEntry Lima::LinguisticProcessing::AnalysisDict::AbstractAnalysisDictionary::getEntry ( const StringsPoolIndex wordId ) const

pure virtual

get dictionary entry for a word

Parameters

wordId string pool Id of word to search

Returns: AbstractDictionaryEntry* corresponding to word

Return values

0	if no available entry
pointer	to AbstractDictionaryEntry*. WARNING : must be deleted when no more used.

Implemented in Lima::LinguisticProcessing::AnalysisDict::EnhancedAnalysisDictionary, and Lima::LinguisticProcessing::AnalysisDict::MultiLevelAnalysisDictionary.

◆ getEntry() [3/3]

virtual DictionaryEntry Lima::LinguisticProcessing::AnalysisDict::AbstractAnalysisDictionary::getEntry	(	const StringsPoolIndex	wordId,
		const Lima::LimaString &	word
	)		const

pure virtual

Implemented in Lima::LinguisticProcessing::AnalysisDict::EnhancedAnalysisDictionary, and Lima::LinguisticProcessing::AnalysisDict::MultiLevelAnalysisDictionary.

◆ getSize()

virtual uint64_t Lima::LinguisticProcessing::AnalysisDict::AbstractAnalysisDictionary::getSize ( ) const

pure virtual

return number of keys in dictionary

Returns: number of keys.

Implemented in Lima::LinguisticProcessing::AnalysisDict::EnhancedAnalysisDictionary, and Lima::LinguisticProcessing::AnalysisDict::MultiLevelAnalysisDictionary.

◆ getSubWordEntries()

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

pure virtual

return subword entries A subword entry is a word in the key string that begin at the given offset.

Parameters

offset	offset from which to start searching entry
key	string in which searching for word.

Returns: subword iterator pair

Implemented in Lima::LinguisticProcessing::AnalysisDict::EnhancedAnalysisDictionary, and Lima::LinguisticProcessing::AnalysisDict::MultiLevelAnalysisDictionary.

◆ getSuperWordEntries()

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

pure virtual

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

Implemented in Lima::LinguisticProcessing::AnalysisDict::EnhancedAnalysisDictionary, and Lima::LinguisticProcessing::AnalysisDict::MultiLevelAnalysisDictionary.

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

lima_linguisticprocessing/src/linguisticProcessing/core/AnalysisDict/AbstractAnalysisDictionary.h
lima_linguisticprocessing/src/linguisticProcessing/core/AnalysisDict/AbstractAnalysisDictionary.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AbstractAnalysisDictionary()

◆ ~AbstractAnalysisDictionary()

Member Function Documentation

◆ getEntry() [1/3]

◆ getEntry() [2/3]

◆ getEntry() [3/3]

◆ getSize()

◆ getSubWordEntries()

◆ getSuperWordEntries()