bes  Updated for version 3.17.4
BESXMLInfo.h
1 // BESXMLInfo.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 BESXMLInfo_h_
34 #define BESXMLInfo_h_ 1
35 
36 #include <libxml/encoding.h>
37 #include <libxml/xmlwriter.h>
38 
39 #include "BESInfo.h"
40 
48 class BESXMLInfo : public BESInfo
49 {
50 private:
51  xmlTextWriterPtr _writer ;
52  xmlBufferPtr _doc_buf ;
53  bool _started ;
54  bool _ended ;
55  string _doc ;
56 
57  void cleanup() ;
58 protected:
59  virtual void begin_tag( const string &tag_name,
60  const string &ns,
61  const string &uri,
62  map<string,string> *attrs = 0 ) ;
63 public:
64  BESXMLInfo( ) ;
65  virtual ~BESXMLInfo() ;
66 
67  virtual void begin_response( const string &response_name,
69  virtual void end_response( ) ;
70 
71  virtual void add_tag( const string &tag_name,
72  const string &tag_data,
73  map<string,string> *attrs = 0 ) ;
74  virtual void begin_tag( const string &tag_name ,
75  map<string,string> *attrs = 0 ) ;
76  virtual void end_tag( const string &tag_name ) ;
77 
78  virtual void add_data( const string &s ) ;
79  virtual void add_space( unsigned long num_spaces ) ;
80  virtual void add_break( unsigned long num_breaks ) ;
81 
82  virtual void add_data_from_file( const string &key,
83  const string &name ) ;
84  virtual void print( ostream &strm ) ;
85  virtual void transmit( BESTransmitter *transmitter,
87 
88  virtual void dump( ostream &strm ) const ;
89 
90  static BESInfo *BuildXMLInfo( const string &info_type ) ;
91 };
92 
93 #endif // BESXMLInfo_h_
94 
virtual void dump(ostream &strm) const
dumps information about this object
Definition: BESXMLInfo.cc:555
virtual void end_response()
end the response
Definition: BESXMLInfo.cc:211
virtual void add_data_from_file(const string &key, const string &name)
add data from a file to the informational object
Definition: BESXMLInfo.cc:501
virtual void end_tag(const string &tag_name)
end a tagged part of the informational response
Definition: BESXMLInfo.cc:423
virtual void print(ostream &strm)
print the information from this informational object to the specified stream
Definition: BESXMLInfo.cc:538
virtual void begin_response(const string &response_name, BESDataHandlerInterface &dhi)
begin the informational response
Definition: BESXMLInfo.cc:99
BESXMLInfo()
constructs an informational response object as an xml document
Definition: BESXMLInfo.cc:49
informational response object
Definition: BESInfo.h:68
represents an xml formatted response object
Definition: BESXMLInfo.h:48
virtual void add_space(unsigned long num_spaces)
add a space to the informational response
Definition: BESXMLInfo.cc:461
virtual void add_break(unsigned long num_breaks)
add a line break to the information
Definition: BESXMLInfo.cc:476
virtual void begin_tag(const string &tag_name, const string &ns, const string &uri, map< string, string > *attrs=0)
begin a tagged part of the information, information to follow
Definition: BESXMLInfo.cc:356
Structure storing information used by the BES to handle the request.
virtual void add_tag(const string &tag_name, const string &tag_data, map< string, string > *attrs=0)
add tagged information to the inforamtional response
Definition: BESXMLInfo.cc:275
virtual void transmit(BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
transmit the text information as text
Definition: BESXMLInfo.cc:522
virtual void add_data(const string &s)
add data to this informational object. If buffering is not set then the information is output directl...
Definition: BESXMLInfo.cc:487