bes  Updated for version 3.17.0
BESCatalogList.h
1 // BESCatalogList.h
2 
3 // This file is part of bes, A C++ back-end server implementation framework
4 // for the OPeNDAP Data Access Protocol.
5 
6 // Copyright (c) 2004-2009 University Corporation for Atmospheric Research
7 // Author: Patrick West <pwest@ucar.edu> and Jose Garcia <jgarcia@ucar.edu>
8 //
9 // This library is free software; you can redistribute it and/or
10 // modify it under the terms of the GNU Lesser General Public
11 // License as published by the Free Software Foundation; either
12 // version 2.1 of the License, or (at your option) any later version.
13 //
14 // This library is distributed in the hope that it will be useful,
15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 // Lesser General Public License for more details.
18 //
19 // You should have received a copy of the GNU Lesser General Public
20 // License along with this library; if not, write to the Free Software
21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 //
23 // You can contact University Corporation for Atmospheric Research at
24 // 3080 Center Green Drive, Boulder, CO 80301
25 
26 // (c) COPYRIGHT University Corporation for Atmospheric Research 2004-2005
27 // Please read the full copyright statement in the file COPYRIGHT_UCAR.
28 //
29 // Authors:
30 // pwest Patrick West <pwest@ucar.edu>
31 // jgarcia Jose Garcia <jgarcia@ucar.edu>
32 
33 #ifndef BESCatalogList_h_
34 #define BESCatalogList_h_ 1
35 
36 #include <map>
37 #include <string>
38 
39 using std::map ;
40 using std::string ;
41 
42 #include "BESObj.h"
43 #include "BESDataHandlerInterface.h"
44 
45 class BESCatalog ;
46 class BESCatalogEntry ;
47 
48 #define BES_DEFAULT_CATALOG "catalog"
49 
70 class BESCatalogList : public BESObj
71 {
72 private:
73  map<string, BESCatalog *> _catalogs ;
74  string _default_catalog ;
75  static BESCatalogList * _instance ;
76 
77  static void initialize_instance();
78  static void delete_instance();
79 
80  virtual ~BESCatalogList();
81 
82  friend class BESCatalogListUnitTest;
83 
84 protected:
86 
87 
88 public:
89  typedef map<string,BESCatalog *>::iterator catalog_iter ;
90  typedef map<string,BESCatalog *>::const_iterator catalog_citer ;
91 
92  static BESCatalogList * TheCatalogList() ;
93 
94 
95  virtual int num_catalogs() { return _catalogs.size() ; }
96  virtual string default_catalog() { return _default_catalog ; }
97 
98  virtual bool add_catalog( BESCatalog *catalog ) ;
99  virtual bool ref_catalog( const string &catalog_name ) ;
100  virtual bool deref_catalog( const string &catalog_name );
101  virtual BESCatalog * find_catalog( const string &catalog_name ) ;
103  BESCatalogEntry *entry,
104  bool show_default = true ) ;
105 
106  virtual catalog_iter first_catalog() { return _catalogs.begin() ; }
107  virtual catalog_iter end_catalog() { return _catalogs.end() ; }
108 
109  virtual void dump( ostream &strm ) const ;
110 
111 } ;
112 
113 #endif // BESCatalogList_h_
114 
virtual BESCatalog * find_catalog(const string &catalog_name)
find the catalog in the list with the specified name
virtual bool add_catalog(BESCatalog *catalog)
adds the speciifed catalog to the list
virtual BESCatalogEntry * show_catalogs(BESDataHandlerInterface &dhi, BESCatalogEntry *entry, bool show_default=true)
show the list of catalogs
Base object for bes objects.
Definition: BESObj.h:52
virtual bool ref_catalog(const string &catalog_name)
reference the specified catalog
List of all registered catalogs.
virtual void dump(ostream &strm) const
dumps information about this object
virtual bool deref_catalog(const string &catalog_name)
de-reference the specified catalog and remove from list if no longer referenced
BESCatalogList()
construct a catalog list
abstract base class catalog object. Derived classes know how to show nodes and leaves in a catalog...
Definition: BESCatalog.h:47
Structure storing information used by the BES to handle the request.
static BESCatalogList * TheCatalogList()
returns the singleton BESCatalogList instance. The pthreads library insures that only one instance ca...