ullanguagedatasource.h

#ifndef ULLANGUAGEDATASOURCE_H
#define ULLANGUAGEDATASOURCE_H

#include "uldatasource.h"
#include "ulverbmodel.h"
#include "ulinflectionrule.h"
#include "ultaggingrule.h"
#include "ulfrequency.h"

class ULLanguageDataSource : public ULDataSource
{
public:
    virtual ~ULLanguageDataSource() {}

    // Required ULDataSource interfaces.
    virtual ULError attach(const ULString& dataSourceIdentifier) = 0;
    virtual ULError detach() = 0;
    virtual ULError load() = 0;
    virtual ULError close() = 0;
    virtual ULString getDataSourceIdentifier() = 0;
    virtual ULDataSourceVersion getVersion() = 0;

    // Extracting data from the language data source.

    virtual const ULLanguage& getLanguage() = 0;

    virtual ULError getWords(const ULString& root, ULList<ULDerivation>& wordList, bool filterResults=false) = 0;

    virtual ULError getVerbs(const ULString& infinitive, ULList<ULDerivation>& verbList, bool filterResults=false) = 0;

    virtual ULError getNouns(const ULString& text, ULList<ULDerivation>& nounList) = 0;

    virtual ULError getVerbModel(uluint32 verbClassID, ULVerbModel& model) = 0;

    virtual ULError getMatchingRoots(const ULString& prefix, uluint32 maxMatches, ULList<ULString>& rootList) = 0;

    virtual ULError getMatchingNouns(const ULString& prefix, uluint32 maxMatches, ULList<ULString>& nounList) = 0;

    virtual ULError getMatchingInfinitives(const ULString& prefix, uluint32 maxMatches, ULList<ULString>& infinitiveList) = 0;

    virtual ULError getMatchingInfinitives(const ULString& prefix, uluint32 maxMatches, ULList<ULDerivation>& infinitiveList) = 0;

    virtual ULError getVerbFormTypes(const ULDerivation& verb, ULList<ULPartOfSpeech>& verbFormTypes) = 0;
    
    virtual ULError getTenses(const ULDerivation& v, ULList<ULTense>& tenseList, bool includeParticiples=false) = 0;

    virtual ULError getTensesForClass(uluint32 classID, ULList<ULTense>& tenseList, bool includeParticiples=false) = 0;

    virtual ULError getAllTenses(ULList<ULTense>& tenseList, bool includeParticiples=false) = 0;

    virtual ULError getPersons(const ULDerivation& v, ULTense tense, ULList<ULPerson>& personList) = 0;

    virtual ULError getPersonsForClass(const ULDerivation& v, uluint32 classID, ULTense tense, ULList<ULPerson>& personList) = 0;

    virtual ULError getAllTaggingRules(ULList<ULTaggingRule>& ruleList) = 0;

    virtual ULError getFeatureNameList(ULList<ULString>& featureNameList) = 0;

    virtual ULError getInflectionRules(const ULDerivation& derivation,
                                       const ULPartOfSpeech& targetPartOfSpeech,
                                       ULList<ULInflectionRule>& ruleList) = 0;

    virtual ULError getInflectionRulesForDissection(const ULDerivation& derivation, ULList<ULInflectionRule>& ruleList) = 0;
    
    virtual ULError getSuccessors(const ULInflectionRule& rule, ULList<ULInflectionRule>& successorList) = 0;
    
    virtual ULError getPredecessors(const ULInflectionRule& rule, ULList<ULInflectionRule>& predecessorList) = 0;
    
    virtual bool hasStopWord(const ULString& word) = 0;

    virtual ULError getClosedClassWordForPartOfSpeech(const ULPartOfSpeech& partOfSpeech, ULList<ULDerivation>& wordList) = 0;
    
    virtual ULError getFrequencies(const ULString& word, ULList<ULFrequency>& frequencyList) = 0;
};

#endif