ulfactory.h

#ifndef ULFACTORY_H
#define ULFACTORY_H

#include "ulstring.h"
#include "ulerror.h"
#include "ullock.h"
#include "ulcollator.h"
#include "ulstemmer.h"
#include "uldefiner.h"
#include "ulpartofspeechtagger.h"
#include "ulpluralizer.h"
#include "ulsingularizer.h"
#include "ulconjugator.h"
#include "uldictionary.h"
#include "ulconfiguration.h"
#include "ulnumbertranslator.h"

typedef ULLanguageDataSource * ULLanguageDataSourcePtr;
typedef ULDictionaryDataSource * ULDictionaryDataSourcePtr;

class ULFactory : public ULLockable
{
public:
    static ULFactory *createFactory(const ULString& id);
    
    ULFactory();
    virtual ~ULFactory();

    virtual void clear();

    void setFactoryID(const ULString& id);
    const ULString& getFactoryID();

    virtual void freeInessentialMemory();

    virtual ULError addLanguageDataSource(const ULString& fileIdentifier, bool loadImmediately=false, ULLanguageDataSource **dataSource=NULL) = 0;

    virtual ULError addDictionaryDataSource(const ULString& fileIdentifier, bool loadImmediately=false, ULDictionaryDataSource **dataSource=NULL) = 0;

    virtual ULLock *createLock() = 0;

    virtual ULError getAvailableLanguages(ULList<ULLanguage>& languageList);
    
    virtual ULError getAvailableLanguages(ULList<ULLanguageDataSource *>& ldsList);
    
    virtual ULError getAvailableDictionaries(ULList<ULDictionaryDescriptor>& dictionaryList);
    
    virtual ULError getAvailableDictionaries(ULList<ULDictionaryDataSource *>& ddsList);
    
    virtual ULError getAvailableServices(ULList<ULServiceDescriptor>& serviceList) = 0;

    virtual ULError getLanguageDataSources(const ULLanguage& language, ULList<ULLanguageDataSource *>& ldsList);

    virtual ULError getDictionaryDataSources(const ULLanguage& lang1, const ULLanguage& lang2, ULList<ULDictionaryDataSource *>& ddsList);
    
    virtual ULError getDictionaryDataSources(const ULLanguage& lang, ULList<ULDictionaryDataSource *>& ddsList);
    
    virtual ULError getDictionaryDataSources(const ULDictionaryDescriptor& descriptor, ULList<ULDictionaryDataSource *>& ddsList);
    
    virtual ULCollator *getCollator(const ULLanguage& language) = 0;

    virtual ULStemmer *getStemmer(ULLanguageDataSource *languageDataSource, ULDictionaryDataSource *dictionaryDataSource) = 0;
    
    virtual ULStemmer *getStemmer(const ULLanguage& stemmingLanguage, const ULLanguage& translationLanguage) = 0;

    virtual ULPartOfSpeechTagger *getPartOfSpeechTagger(ULLanguageDataSource *languageDataSource, ULDictionaryDataSource *dictionaryDataSource) = 0;

    virtual ULPartOfSpeechTagger *getPartOfSpeechTagger(const ULLanguage& taggingLanguage, const ULLanguage& translationLanguage) = 0;

    virtual ULPluralizer *getPluralizer(ULLanguageDataSource *languageDataSource, ULDictionaryDataSource *dictionaryDataSource) = 0;

    virtual ULPluralizer *getPluralizer(const ULLanguage& pluralizerLanguage, const ULLanguage& translationLanguage) = 0;

    virtual ULSingularizer *getSingularizer(ULLanguageDataSource *languageDataSource, ULDictionaryDataSource *dictionaryDataSource) = 0;

    virtual ULSingularizer *getSingularizer(const ULLanguage& singularizerLanguage, const ULLanguage& translationLanguage) = 0;

    virtual ULConjugator *getConjugator(ULLanguageDataSource *languageDataSource, ULDictionaryDataSource *dictionaryDataSource) = 0;

    virtual ULConjugator *getConjugator(const ULLanguage& conjugationLanguage, const ULLanguage& translationLanguage) = 0;

    virtual ULDefiner *getDefiner(ULDictionaryDataSource *dictionaryDataSource, ULLanguageDataSource *firstLanguageDataSource, ULLanguageDataSource *secondLanguageDataSource) = 0;
    
    virtual ULDefiner *getDefiner(const ULLanguage& language1, const ULLanguage& language2) = 0;

    virtual ULInflector *getInflector(ULLanguageDataSource *languageDataSource, ULDictionaryDataSource *dictionaryDataSource) = 0;
    
    virtual ULInflector *getInflector(const ULLanguage& inflectionLanguage, const ULLanguage& translationLanguage) = 0;

    virtual ULDissector *getDissector(ULLanguageDataSource *languageDataSource, ULDictionaryDataSource *dictionaryDataSource) = 0;

    virtual ULDissector *getDissector(const ULLanguage& dissectionLanguage, const ULLanguage& translationLanguage) = 0;

    virtual ULNumberTranslator *getNumberTranslator(const ULLanguage& language) = 0;

protected:
    ULString factoryID;
    ULConfiguration configuration;
    ULList<ULWorker *> workers;
    ULList<ULLanguageDataSource *> languageDataSources;
    ULList<ULDictionaryDataSource *> dictionaryDataSources;
    ULList<ULCollator *> collators;

    ULWorker *findWorker(ULServiceDescriptor descriptor);
    ULError findLanguageDataSources(const ULLanguage& language, ULList<ULLanguageDataSource *>& ldsList);
    ULError findDictionaryDataSources(const ULDictionaryDescriptor& descriptor, ULList<ULDictionaryDataSource *>& ddsList);
    ULError findDictionaryDataSources(const ULLanguage& lang1, const ULLanguage& lang2, ULList<ULDictionaryDataSource *>& ddsList);
    ULError findDictionaryDataSources(const ULLanguage& lang, ULList<ULDictionaryDataSource *>& ddsList);

    ULLanguageDataSource *findLanguageDataSource(const ULString& fileIdentifier);
    ULDictionaryDataSource *findDictionaryDataSource(const ULString& fileIdentifier);
};

#endif