OPeNDAP Hyrax Back End Server (BES)  Updated for version 3.8.3
Public Types | Public Member Functions | Static Public Member Functions | List of all members
ncml_module::NCMLRequestHandler Class Reference

Handler for AIS Using NCML. More...

#include <NCMLRequestHandler.h>

Inheritance diagram for ncml_module::NCMLRequestHandler:
Inheritance graph
Collaboration diagram for ncml_module::NCMLRequestHandler:
Collaboration graph

Public Types

typedef map< string, p_request_handler >::const_iterator Handler_citer
 
typedef map< string, p_request_handler >::iterator Handler_iter
 

Public Member Functions

virtual bool add_handler (const string &handler_name, p_request_handler handler_method)
 add a handler method to the request handler that knows how to fill in a specific response object More...
 
virtual void dump (ostream &strm) const
 dumps information about this object More...
 
virtual p_request_handler find_handler (const string &handler_name)
 find the method that can handle the specified response object type More...
 
virtual string get_handler_names ()
 return a comma separated list of response object types handled by this request handler More...
 
virtual const string & get_name () const
 
 NCMLRequestHandler (const string &name)
 
virtual bool remove_handler (const string &handler_name)
 remove the specified handler method from this request handler More...
 
virtual ~NCMLRequestHandler (void)
 

Static Public Member Functions

static string get_global_attributes_container_name ()
 
static bool ncml_build_das (BESDataHandlerInterface &dhi)
 
static bool ncml_build_data (BESDataHandlerInterface &dhi)
 
static bool ncml_build_dds (BESDataHandlerInterface &dhi)
 
static bool ncml_build_dmr (BESDataHandlerInterface &dhi)
 
static bool ncml_build_help (BESDataHandlerInterface &dhi)
 
static bool ncml_build_vers (BESDataHandlerInterface &dhi)
 

Detailed Description

Handler for AIS Using NCML.

Definition at line 41 of file NCMLRequestHandler.h.

Member Typedef Documentation

typedef map< string, p_request_handler >::const_iterator BESRequestHandler::Handler_citer
inherited

Definition at line 83 of file BESRequestHandler.h.

typedef map< string, p_request_handler >::iterator BESRequestHandler::Handler_iter
inherited

Definition at line 84 of file BESRequestHandler.h.

Constructor & Destructor Documentation

NCMLRequestHandler::NCMLRequestHandler ( const string &  name)

Definition at line 75 of file NCMLRequestHandler.cc.

References BESRequestHandler::add_handler(), DAP4DATA_RESPONSE, DAS_RESPONSE, DATA_RESPONSE, DDS_RESPONSE, DMR_RESPONSE, BESKeys::get_value(), HELP_RESPONSE, ncml_build_das(), ncml_build_data(), ncml_build_dds(), ncml_build_dmr(), ncml_build_help(), ncml_build_vers(), TheBESKeys::TheKeys(), and VERS_RESPONSE.

Here is the call graph for this function:

NCMLRequestHandler::~NCMLRequestHandler ( void  )
virtual

Definition at line 101 of file NCMLRequestHandler.cc.

Member Function Documentation

bool BESRequestHandler::add_handler ( const string &  handler_name,
p_request_handler  handler_method 
)
virtualinherited

add a handler method to the request handler that knows how to fill in a specific response object

Add a handler method for a specific response object to the request handler. The handler method takes a reference to a BESDataHandlerInterface and returns bool, true if the response object is filled in successfully by the method, false otherwise.

Parameters
handler_namename of the response object this method can fill in
handler_methoda function pointer to the method that can fill in the specified response object
Returns
true if the handler is added, false if it already exists
See also
BESResponseObject
BESResponseNames

Definition at line 51 of file BESRequestHandler.cc.

References BESRequestHandler::find_handler().

Referenced by BESAsciiRequestHandler::BESAsciiRequestHandler(), BESDapRequestHandler::BESDapRequestHandler(), BESUsageRequestHandler::BESUsageRequestHandler(), BESWWWRequestHandler::BESWWWRequestHandler(), BESXDRequestHandler::BESXDRequestHandler(), CSVRequestHandler::CSVRequestHandler(), DapRequestHandler::DapRequestHandler(), FFRequestHandler::FFRequestHandler(), FitsRequestHandler::FitsRequestHandler(), FoJsonRequestHandler::FoJsonRequestHandler(), FONcRequestHandler::FONcRequestHandler(), FONgRequestHandler::FONgRequestHandler(), GatewayRequestHandler::GatewayRequestHandler(), GDALRequestHandler::GDALRequestHandler(), HDF4RequestHandler::HDF4RequestHandler(), HDF5RequestHandler::HDF5RequestHandler(), NCMLRequestHandler(), NCRequestHandler::NCRequestHandler(), and W10nJsonRequestHandler::W10nJsonRequestHandler().

Here is the call graph for this function:

void NCMLRequestHandler::dump ( ostream &  strm) const
virtual

dumps information about this object

Displays the pointer value of this instance, the name of the request handler, and the names of all registered handler functions

Parameters
strmC++ i/o stream to dump the information to

Reimplemented from BESRequestHandler.

Definition at line 361 of file NCMLRequestHandler.cc.

References BESRequestHandler::dump(), BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().

Here is the call graph for this function:

p_request_handler BESRequestHandler::find_handler ( const string &  handler_name)
virtualinherited

find the method that can handle the specified response object type

Find the method that can handle the specified response object type. The response object type is the same as the handler name.

Parameters
handler_namename of the method that can fill in the response object type
Returns
the method that can fill in the specified response object type
See also
BESResponseObject
BESResponseNames

Definition at line 93 of file BESRequestHandler.cc.

Referenced by BESRequestHandler::add_handler(), BESRequestHandlerList::execute_all(), and BESRequestHandlerList::execute_current().

static string ncml_module::NCMLRequestHandler::get_global_attributes_container_name ( )
inlinestatic

Definition at line 66 of file NCMLRequestHandler.h.

Referenced by ncml_build_das(), and ncml_build_dds().

string BESRequestHandler::get_handler_names ( )
virtualinherited

return a comma separated list of response object types handled by this request handler

Returns
the comma separated list of response object types
See also
BESResponseObject
BESResponseNames

Definition at line 112 of file BESRequestHandler.cc.

virtual const string& BESRequestHandler::get_name ( ) const
inlinevirtualinherited

Definition at line 86 of file BESRequestHandler.h.

bool NCMLRequestHandler::ncml_build_das ( BESDataHandlerInterface &  dhi)
static

Definition at line 156 of file NCMLRequestHandler.cc.

References BESContainer::access(), BESDEBUG, BESDataHandlerInterface::container, BESDASResponse::get_das(), get_global_attributes_container_name(), BESResponseHandler::get_response_object(), ncml_module::NCMLUtil::getDDSFromEitherResponse(), ncml_module::NCMLUtil::hackGlobalAttributesForDAP2(), ncml_module::NCMLParser::parse(), ncml_module::NCMLUtil::populateDASFromDDS(), BESDataHandlerInterface::response_handler, and VALID_PTR.

Referenced by NCMLRequestHandler().

Here is the call graph for this function:

bool NCMLRequestHandler::ncml_build_data ( BESDataHandlerInterface &  dhi)
static

Definition at line 238 of file NCMLRequestHandler.cc.

References BESContainer::access(), BESDataHandlerInterface::container, BESDataHandlerInterface::data, BESContainer::get_constraint(), BESResponseHandler::get_response_object(), ncml_module::NCMLUtil::getDDSFromEitherResponse(), NCML_ASSERT_MSG, ncml_module::NCMLParser::parseInto(), POST_CONSTRAINT, BESDataHandlerInterface::response_handler, and VALID_PTR.

Referenced by NCMLRequestHandler().

Here is the call graph for this function:

bool NCMLRequestHandler::ncml_build_dds ( BESDataHandlerInterface &  dhi)
static

Definition at line 191 of file NCMLRequestHandler.cc.

References BESContainer::access(), BESDataHandlerInterface::container, ncml_module::NCMLUtil::copyVariablesAndAttributesInto(), BESDataHandlerInterface::data, BESContainer::get_constraint(), BESDDSResponse::get_dds(), get_global_attributes_container_name(), BESResponseHandler::get_response_object(), ncml_module::NCMLUtil::getDDSFromEitherResponse(), ncml_module::NCMLUtil::hackGlobalAttributesForDAP2(), ncml_module::NCMLParser::parse(), POST_CONSTRAINT, BESDataHandlerInterface::response_handler, and VALID_PTR.

Referenced by NCMLRequestHandler().

Here is the call graph for this function:

bool NCMLRequestHandler::ncml_build_dmr ( BESDataHandlerInterface &  dhi)
static

Definition at line 270 of file NCMLRequestHandler.cc.

References BESContainer::access(), BESDataHandlerInterface::container, BESDMRResponse::get_dmr(), BESResponseHandler::get_response_object(), ncml_module::NCMLUtil::getDDSFromEitherResponse(), ncml_module::NCMLParser::parse(), BESDataHandlerInterface::response_handler, BESDapResponse::set_dap4_constraint(), BESDapResponse::set_dap4_function(), and VALID_PTR.

Referenced by NCMLRequestHandler().

Here is the call graph for this function:

bool NCMLRequestHandler::ncml_build_help ( BESDataHandlerInterface &  dhi)
static

Definition at line 333 of file NCMLRequestHandler.cc.

References BESInfo::add_data(), BESInfo::begin_tag(), ncml_module::ModuleConstants::DOC_WIKI_URL, BESInfo::end_tag(), BESResponseHandler::get_response_object(), BESUtil::implode(), ncml_module::ModuleConstants::NCML_NAME, PACKAGE_NAME, PACKAGE_VERSION, BESDataHandlerInterface::response_handler, BESServiceRegistry::services_handled(), and BESServiceRegistry::TheRegistry().

Referenced by NCMLRequestHandler().

Here is the call graph for this function:

bool NCMLRequestHandler::ncml_build_vers ( BESDataHandlerInterface &  dhi)
static

Definition at line 322 of file NCMLRequestHandler.cc.

References BESVersionInfo::add_module(), BESResponseHandler::get_response_object(), PACKAGE_NAME, PACKAGE_VERSION, and BESDataHandlerInterface::response_handler.

Referenced by NCMLRequestHandler().

Here is the call graph for this function:

bool BESRequestHandler::remove_handler ( const string &  handler_name)
virtualinherited

remove the specified handler method from this request handler

Parameters
handler_namename of the method to be removed, same as the name of the response object
Returns
true if successfully removed, false if not found
See also
BESResponseNames

Definition at line 70 of file BESRequestHandler.cc.

The documentation for this class was generated from the following files: