dbman.h

Go to the documentation of this file.

#pragma once

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        Bert
 Date:          Sep 2016
________________________________________________________________________

-*/


#include "generalmod.h"
#include "dbkey.h"
#include "monitor.h"
#include "ptrman.h"
#include "uistring.h"
#include "ioobjctxt.h"
class DBDir;
class IOObjSelConstraints;


mExpClass(General) DBMan : public Monitorable
{ mODTextTranslationClass(DBMan);
public:

    typedef DBKey::DirID DirID;
    typedef DBKey::ObjID ObjID;

    bool                isPresent(DBKey) const;
    bool                isPresent(const char*,const char* tgname) const;
    BufferString        nameOf(DBKey) const;
    BufferString        nameFor(const char* keystr) const;

    IOObj*              get(DBKey) const;
    IOObj*              getFirst(const IOObjContext&,int* nrpresent=0) const;
    IOObj*              getFromPar(const IOPar&,const char* basekey,
                                        const IOObjContext&,bool mknew,
                                        uiString& errmsg) const;
    IOObj*              getByName(IOObjContext::StdSelType,const char* objname,
                                    const char* tgname=0) const;
    IOObj*              getByName(const IOObjContext&,const char* objnm) const;
    IOObj*              getByName(const char* objname,const char* tgname) const;

    void                getEntry(CtxtIOObj&,bool ifnewmakeittemp=false,
                                 int translidxingroup=-1);
    bool                setEntry(const IOObj&);
    bool                removeEntry(DBKey);

    ConstRefMan<DBDir>  fetchDir(DirID) const;
    ConstRefMan<DBDir>  fetchDir(IOObjContext::StdSelType) const;
    ConstRefMan<DBDir>  fetchDir(const IOObjContext&) const;
    ConstRefMan<DBDir>  fetchRootDir() const    { return rootdbdir_; }

    BufferString        survDir() const         { return survdir_; }
    BufferString        surveyName() const;
    BufferString        surveyDirectoryName() const;
    bool                isKeyString(const char*) const;

    Notifier<DBMan>     surveyToBeChanged;  
    Notifier<DBMan>     surveyChanged;      
    Notifier<DBMan>     afterSurveyChange;  
    Notifier<DBMan>     applicationClosing; 

    CNotifier<DBMan,DBKey>      entryAdded;
    CNotifier<DBMan,DBKey>      entryRemoved;
    CNotifier<DBMan,DBKey>      entryToBeRemoved;

    mExpClass(General) CustomDirData
    {
    public:

        typedef DBKey::DirNrType  DirNrType;

                        CustomDirData( DirNrType dnr, const char* dirnm,
                                        const char* desc )
                            : dirnr_(dnr)
                            , dirname_(dirnm)
                            , desc_(desc)               {}

        DirNrType       dirnr_; 
        BufferString    dirname_; 
        BufferString    desc_; 

        bool            operator ==( const CustomDirData& cdd ) const
                        { return dirnr_ == cdd.dirnr_; }
    };

    static uiRetVal     addCustomDataDir(const CustomDirData&);

private:

    BufferString        survdir_;
    DBDir*              rootdbdir_;
    ObjectSet<DBDir>    dbdirs_;
    mutable uiString    errmsg_;
    bool                surveychangeuserabort_;
    uiRetVal            surveychangeabortreason_;

                        DBMan();
                        ~DBMan();
    DBMan*              getClone() const            { return 0; }

    uiRetVal            handleNewSurvDir();
    void                leaveSurvey();
    void                readDirs();
    RefMan<DBDir>       getDBDir(DirID);
    DBDir*              gtDir(DirID) const;
    uiRetVal            setupCustomDataDirs(int);
    void                setupCustomDataDir(const CustomDirData&,uiRetVal&);
    IOObj*              crWriteIOObj(const CtxtIOObj&,DBKey,int trlidx) const;
    void                dbdirChgCB(CallBacker*);

    friend mGlobal(General) DBMan& DBM();
    friend class        GeneralModuleIniter;

    uiRetVal            setDataSource(const char*,const char*,bool);

    void                initFirst();
    uiRetVal            doReRead();

public:

    bool                isBad() const;
    uiString            errMsg() const          { return errmsg_; }
    static uiRetVal     isValidDataRoot(const char* dirnm);
    static uiRetVal     isValidSurveyDir(const char* dirnm);
    static uiRetVal     checkSurveySetupValid();
    BufferString        getDirectoryNameOf(DirID,bool fullpath) const;
    void                findTempObjs(ObjectSet<IOObj>&,
                                const IOObjSelConstraints* cnstrts=0) const;
    Notifier<DBMan>     surveyChangeOK;
    void                setSurveyChangeUserAbort();
    void                setSurveyChangeAbortReason(uiRetVal);
    void                applClosing()           { applicationClosing.trigger();}

    mDeprecated bool    permRemove( const DBKey& ky )
                        { return removeEntry(ky); }
    mDeprecated bool    commitChanges( const IOObj& ioobj )
                        { return setEntry(ioobj); }
    mDeprecated BufferString rootDir() const
                        { return survDir(); }

                        // To change to another survey, probably not your thing:
    uiRetVal            setDataSource(const char* fullpath_of_survey_dir,
                                        bool forcerefresh=false);
    uiRetVal            setDataSource(const IOPar&,bool forcerefresh=false);
    uiRetVal            reRead();

};


mGlobal(General) DBMan& DBM();