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
NCRequestHandler Class Reference

#include <NCRequestHandler.h>

Inheritance diagram for NCRequestHandler:
Inheritance graph
Collaboration diagram for NCRequestHandler:
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
 
 NCRequestHandler (const string &name)
 
virtual bool remove_handler (const string &handler_name)
 remove the specified handler method from this request handler More...
 
virtual ~NCRequestHandler (void)
 

Static Public Member Functions

static bool get_ignore_unknown_types ()
 
static bool get_promote_byte_to_short ()
 
static bool get_show_shared_dims ()
 
static bool nc_build_das (BESDataHandlerInterface &dhi)
 
static bool nc_build_data (BESDataHandlerInterface &dhi)
 
static bool nc_build_dds (BESDataHandlerInterface &dhi)
 
static bool nc_build_dmr (BESDataHandlerInterface &dhi)
 
static bool nc_build_help (BESDataHandlerInterface &dhi)
 
static bool nc_build_version (BESDataHandlerInterface &dhi)
 

Detailed Description

Definition at line 32 of file NCRequestHandler.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

NCRequestHandler::NCRequestHandler ( const string &  name)

Definition at line 101 of file NCRequestHandler.cc.

References BESRequestHandler::add_handler(), BESDEBUG, DAP4DATA_RESPONSE, DAS_RESPONSE, DATA_RESPONSE, DDS_RESPONSE, DMR_RESPONSE, BESKeys::get_value(), HELP_RESPONSE, BESUtil::lowercase(), nc_build_das(), nc_build_data(), nc_build_dds(), nc_build_dmr(), nc_build_help(), nc_build_version(), TheBESKeys::TheKeys(), and VERS_RESPONSE.

Here is the call graph for this function:

NCRequestHandler::~NCRequestHandler ( void  )
virtual

Definition at line 167 of file NCRequestHandler.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(), ncml_module::NCMLRequestHandler::NCMLRequestHandler(), NCRequestHandler(), and W10nJsonRequestHandler::W10nJsonRequestHandler().

Here is the call graph for this function:

void BESRequestHandler::dump ( ostream &  strm) const
virtualinherited

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

Implements BESObj.

Reimplemented in DapRequestHandler, ncml_module::NCMLRequestHandler, FONcRequestHandler, FoJsonRequestHandler, W10nJsonRequestHandler, BESDapRequestHandler, CSVRequestHandler, BESAsciiRequestHandler, BESUsageRequestHandler, BESWWWRequestHandler, FONgRequestHandler, FitsRequestHandler, BESXDRequestHandler, and GatewayRequestHandler.

Definition at line 135 of file BESRequestHandler.cc.

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

Referenced by GatewayRequestHandler::dump(), BESXDRequestHandler::dump(), FONgRequestHandler::dump(), FitsRequestHandler::dump(), BESDapRequestHandler::dump(), BESUsageRequestHandler::dump(), BESWWWRequestHandler::dump(), BESAsciiRequestHandler::dump(), CSVRequestHandler::dump(), FoJsonRequestHandler::dump(), W10nJsonRequestHandler::dump(), FONcRequestHandler::dump(), ncml_module::NCMLRequestHandler::dump(), DapRequestHandler::dump(), and BESRequestHandlerList::dump().

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().

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.

static bool NCRequestHandler::get_ignore_unknown_types ( )
inlinestatic

Definition at line 58 of file NCRequestHandler.h.

Referenced by nc_read_dataset_attributes().

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

Definition at line 86 of file BESRequestHandler.h.

static bool NCRequestHandler::get_promote_byte_to_short ( )
inlinestatic

Definition at line 62 of file NCRequestHandler.h.

Referenced by NCInt16::read().

static bool NCRequestHandler::get_show_shared_dims ( )
inlinestatic

Definition at line 54 of file NCRequestHandler.h.

bool NCRequestHandler::nc_build_das ( BESDataHandlerInterface &  dhi)
static

Definition at line 171 of file NCRequestHandler.cc.

References BESContainer::access(), BESDEBUG, BESDASResponse::clear_container(), BESDataHandlerInterface::container, BESDASResponse::get_das(), BESResponseHandler::get_response_object(), BESContainer::get_symbolic_name(), nc_read_dataset_attributes(), BESDataHandlerInterface::response_handler, and BESDASResponse::set_container().

Referenced by NCRequestHandler().

Here is the call graph for this function:

bool NCRequestHandler::nc_build_data ( BESDataHandlerInterface &  dhi)
static

Definition at line 292 of file NCRequestHandler.cc.

References BESContainer::access(), BESDEBUG, BESDataDDSResponse::clear_container(), BESDataHandlerInterface::container, BESDataDDSResponse::get_ce(), BESContextManager::get_context(), BESDataDDSResponse::get_dds(), BESResponseHandler::get_response_object(), BESContainer::get_symbolic_name(), nc_read_dataset_attributes(), nc_read_dataset_variables(), BESDataHandlerInterface::response_handler, BESDapResponse::set_constraint(), BESDASResponse::set_container(), BESDataDDSResponse::set_container(), and BESContextManager::TheManager().

Referenced by NCRequestHandler().

Here is the call graph for this function:

bool NCRequestHandler::nc_build_dds ( BESDataHandlerInterface &  dhi)
static

Definition at line 213 of file NCRequestHandler.cc.

References BESContainer::access(), BESDEBUG, BESDDSResponse::clear_container(), BESDataHandlerInterface::container, BESDDSResponse::get_ce(), BESContextManager::get_context(), BESDDSResponse::get_dds(), BESResponseHandler::get_response_object(), BESContainer::get_symbolic_name(), nc_read_dataset_attributes(), nc_read_dataset_variables(), BESDataHandlerInterface::response_handler, BESDapResponse::set_constraint(), BESDASResponse::set_container(), BESDDSResponse::set_container(), and BESContextManager::TheManager().

Referenced by NCRequestHandler().

Here is the call graph for this function:

bool NCRequestHandler::nc_build_dmr ( BESDataHandlerInterface &  dhi)
static

Definition at line 363 of file NCRequestHandler.cc.

References BESContainer::access(), BESDataHandlerInterface::container, BESDMRResponse::get_dmr(), BESResponseHandler::get_response_object(), nc_read_dataset_attributes(), nc_read_dataset_variables(), BESDataHandlerInterface::response_handler, BESDapResponse::set_dap4_constraint(), and BESDapResponse::set_dap4_function().

Referenced by NCRequestHandler().

Here is the call graph for this function:

bool NCRequestHandler::nc_build_help ( BESDataHandlerInterface &  dhi)
static

Definition at line 417 of file NCRequestHandler.cc.

References BESInfo::begin_tag(), BESInfo::end_tag(), BESResponseHandler::get_response_object(), BESUtil::implode(), NC_NAME, PACKAGE_NAME, PACKAGE_VERSION, BESDataHandlerInterface::response_handler, BESServiceRegistry::services_handled(), and BESServiceRegistry::TheRegistry().

Referenced by NCRequestHandler().

Here is the call graph for this function:

bool NCRequestHandler::nc_build_version ( BESDataHandlerInterface &  dhi)
static

Definition at line 443 of file NCRequestHandler.cc.

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

Referenced by NCRequestHandler().

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: