StRoot: StDbLib/StDbConfigNode.hh Source File

00001 /***************************************************************************
00002  *
00003  * $Id: StDbConfigNode.hh,v 1.17 2011/11/28 17:03:08 dmitry Exp $
00004  *
00005  * Author: R. Jeff Porter
00006  ***************************************************************************
00007  *
00008  * Description:  Node (directory) & db handle to hold list of dbtables
00009  *               Now (Dec2000) pure-virtual for hiding db & table (stl) part
00010  *              
00011  ***************************************************************************
00012  *
00013  * $Log: StDbConfigNode.hh,v $
00014  * Revision 1.17  2011/11/28 17:03:08  dmitry
00015  * dbv override support in StDbLib,StDbBroker,St_db_Maker
00016  *
00017  * Revision 1.16  2001/01/22 18:37:52  porter
00018  * Update of code needed in next year running. This update has little
00019  * effect on the interface (only 1 method has been changed in the interface).
00020  * Code also preserves backwards compatibility so that old versions of
00021  * StDbLib can read new table structures.
00022  *  -Important features:
00023  *    a. more efficient low-level table structure (see StDbSql.cc)
00024  *    b. more flexible indexing for new systems (see StDbElememtIndex.cc)
00025  *    c. environment variable override KEYS for each database
00026  *    d. StMessage support & clock-time logging diagnostics
00027  *  -Cosmetic features
00028  *    e. hid stl behind interfaces (see new *Impl.* files) to again allow rootcint access
00029  *    f. removed codes that have been obsolete for awhile (e.g. db factories)
00030  *       & renamed some classes for clarity (e.g. tableQuery became StDataBaseI
00031  *       and mysqlAccessor became StDbSql)
00032  *
00033  * Revision 1.15  2000/04/25 18:26:02  porter
00034  * added flavor & production time as settable query fields in
00035  * table &/or node. Associated SQL updated in mysqlAccessor.
00036  * Flavor key supports "+" as an OR symbol.
00037  *
00038  * Revision 1.14  2000/03/28 17:03:18  porter
00039  * Several upgrades:
00040  * 1. configuration by timestamp for Conditions
00041  * 2. query by whereClause made more systematic
00042  * 3. conflict between db-stored comments & number lists resolved
00043  * 4. ensure endtime is correct for certain query falures
00044  * 5. dbstl.h->handles ObjectSpace & RogueWave difference (Online vs Offline)
00045  *
00046  * Revision 1.13  2000/01/27 05:54:33  porter
00047  * Updated for compiling on CC5 + HPUX-aCC + KCC (when flags are reset)
00048  * Fixed reConnect()+transaction model mismatch
00049  * added some in-code comments
00050  *
00051  * Revision 1.12  2000/01/19 20:20:05  porter
00052  * - finished transaction model needed by online
00053  * - fixed CC5 compile problem in StDbNodeInfo.cc
00054  * - replace TableIter class by StDbTableIter to prevent name problems
00055  *
00056  * Revision 1.11  2000/01/14 14:50:52  porter
00057  * expanded use of verbose mode & fixed inconsistency in
00058  * StDbNodeInfo::getElementID
00059  *
00060  * Revision 1.10  2000/01/10 20:37:53  porter
00061  * expanded functionality based on planned additions or feedback from Online work.
00062  * update includes:
00063  *      1. basis for real transaction model with roll-back
00064  *      2. limited SQL access via the manager for run-log & tagDb
00065  *      3. balance obtained between enumerated & string access to databases
00066  *      4. 3-levels of diagnostic output: Quiet, Normal, Verbose
00067  *      5. restructured Node model for better XML support
00068  *
00069  * Revision 1.9  1999/12/28 21:31:41  porter
00070  * added 'using std::vector' and 'using std::list' for Solaris CC5 compilation.
00071  * Also fixed some warnings arising from the CC5 compiles
00072  *
00073  * Revision 1.8  1999/12/03 22:24:01  porter
00074  * expanded functionality used by online, fixed bug in
00075  * mysqlAccessor::getElementID(char*), & update StDbDataSet to
00076  * conform to changes in Xml reader & writer
00077  *
00078  * Revision 1.7  1999/10/19 14:30:38  porter
00079  * modifications relevant to use with StDbBroker and future merging with
00080  * "params" database structure + some docs + suppressing diagnostics messages
00081  *
00082  * Revision 1.6  1999/09/30 02:06:03  porter
00083  * add StDbTime to better handle timestamps, modify SQL content (mysqlAccessor)
00084  * allow multiple rows (StDbTable), & Added the comment sections at top of
00085  * each header and src file
00086  *
00087  **************************************************************************/
00088 #ifndef STDBCONFIGNODE_HH
00089 #define STDBCONFIGNODE_HH
00090 
00091 #include "StDbNode.hh"
00092 #include "StDbTableIter.hh"
00093 
00094 class dbEnvList;
00095 class StDbElementIndex;
00096 class StDbTable;
00097 
00098 #ifdef __ROOT_
00099 #include "TROOT.h"
00100 #endif
00101 
00102 class StDbConfigNode : public StDbNode {
00103 
00104 protected:
00105 
00106  StDbConfigNode* mfirstChildNode;
00107  StDbConfigNode* mnextNode;
00108  StDbConfigNode* mparentNode;
00109   
00110  bool            mhasData;
00111  int             mbranchID;
00112  bool            misDbNode;
00113  void            zeroNodes();
00114 
00115 public:
00116 
00117    StDbConfigNode( StDbConfigNode* parent, 
00118                    const char* nodeName, const char* configName);
00119    StDbConfigNode( StDbConfigNode* parent, StDbNode& node); 
00120    StDbConfigNode( StDbType type,  StDbDomain domain,  
00121                    const char* nodeName, const char* configName="none");
00122    virtual ~StDbConfigNode(); 
00123   
00124   // node & tree operations
00125    void            setNextNode(StDbConfigNode* node); 
00126    void            setParentNode(StDbConfigNode* node); 
00127    void            setFirstChildNode(StDbConfigNode* node); 
00128    virtual void    setChildNode(StDbConfigNode* node); 
00129    void            appendNode(StDbConfigNode* node); 
00130    StDbConfigNode* getNextNode();
00131    StDbConfigNode* getParentNode(); 
00132    StDbConfigNode* getFirstChildNode(); 
00133    void            deleteTree();
00134    virtual void    addChildren(dbEnvList* elist) = 0;
00135    void            deleteChildren();
00136 
00137   // check container status
00138    bool   hasChildren();
00139    bool   hasData();
00140    int    getBranchID();
00141    void   setBranchID(int branchID);
00142    void   setIsDbNode(bool isDbNode);
00143    bool   isDbNode();
00144    void   printTree(int depth);
00145 
00146   // DB & Table Index operations
00147    virtual void  resetConfig(const char* config, int opt=0)                 =0;
00148    virtual int   buildTree(int opt=0)                                       =0;
00149    virtual StDbElementIndex*  getElementIndex()                             =0;
00150    virtual void  setElementIndexInfo(const char* indexName, int indexID)    =0;
00151    virtual void  getElementIndexInfo(char*& indexname, int& indexID)        =0;
00152    virtual int   getNumIndeces() const                                      =0;
00153 
00154   // Table operations --> pure virtual for db & stl dependencies 
00155    virtual StDbTable*     addDbTable(const char* tableName, 
00156                                      const char* version="default")         =0;
00157    virtual StDbTable*     addTable  (const char* tableName, 
00158                                      const char* version="default")         =0;
00159    virtual StDbTable*     addTable(StDbNode* node)                          =0;
00160    virtual StDbTable*     findTable(const char* name, const char* sPath="/")=0;
00161    virtual StDbTable*     findLocalTable(const char* name)                  =0;
00162    virtual void           removeTable(StDbTable* table)                     =0;
00163    virtual StDbTableIter* getStDbTableIter()                                =0;
00164    virtual bool           compareTables(StDbTable* tab1, StDbTable* tab2)   =0;
00165    virtual void           printTables(int depth)                            =0;
00166    virtual void           printNumberStats()                                =0;
00167    virtual void getNumberStats(unsigned int& nNodes, 
00168                                unsigned int& ntables, 
00169                                unsigned int& numBytes)                      =0;
00170 
00171   // set the table flavors in full sub-tree or local list
00172    virtual void           setTablesFlavor(const char* flavor)               =0;
00173    virtual void           setTablesProdTime(unsigned int ptime)             =0;
00174    virtual void           setTablesProdTimeOverride(unsigned int ptime, char* dbType = 0, char* dbDomain = 0)             =0;
00175    void  setFlavor(const char* flavor);
00176    void  setProdTime(unsigned int ptime);
00177    void  setProdTimeOverride(unsigned int ptime, char* dbType = 0, char* dbDomain = 0);
00178 
00179   // More node operations
00180    StDbConfigNode* findConfigNode(StDbType t, StDbDomain d, const char* sPath);
00181    StDbConfigNode* findConfigNode(StDbType t, StDbDomain d);
00182    StDbConfigNode* findConfigNode(const char* sPath);
00183    StDbConfigNode* findChildConfigNode(const char* nodeName);
00184 #ifdef __ROOT__
00185   ClassDef(StDbConfigNode,0)
00186 #endif
00187 
00188 }; 
00189 
00190 inline void StDbConfigNode::setNextNode(StDbConfigNode* node){ mnextNode=node;}
00191 inline StDbConfigNode* StDbConfigNode::getNextNode()   { return mnextNode; };
00192 inline StDbConfigNode* StDbConfigNode::getParentNode() { return mparentNode; };
00193 inline StDbConfigNode* StDbConfigNode::getFirstChildNode(){ return mfirstChildNode; };
00194 inline bool StDbConfigNode::hasData(){ return mhasData;};
00195 inline int  StDbConfigNode::getBranchID() { return mbranchID; };
00196 inline void StDbConfigNode::setBranchID(int branchID) { mbranchID=branchID; };
00197 inline void StDbConfigNode::setIsDbNode(bool isDbNode){misDbNode=isDbNode; };
00198 inline bool StDbConfigNode::isDbNode() { return misDbNode; };
00199 inline bool StDbConfigNode::hasChildren(){return (mfirstChildNode) ? true : false; };
00200 
00201 #endif
00202 
00203 
00204 
00205 
00206