#include <BESDDXResponseHandler.h>
Public Member Functions | |
BESDDXResponseHandler (const string &name) | |
virtual | ~BESDDXResponseHandler (void) |
virtual void | execute (BESDataHandlerInterface &dhi) |
executes the command 'get ddx for <def_name>;' | |
virtual void | transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi) |
transmit the response object built by the execute command | |
virtual void | dump (ostream &strm) const |
dumps information about this object | |
virtual BESResponseObject * | get_response_object () |
return the current response object | |
virtual BESResponseObject * | set_response_object (BESResponseObject *o) |
replaces the current response object with the specified one, returning the current response object | |
virtual string | get_name () const |
return the name of this response object | |
Static Public Member Functions | |
static BESResponseHandler * | DDXResponseBuilder (const string &name) |
Protected Attributes | |
string | _response_name |
BESResponseObject * | _response |
A request 'get ddx for <def_name>;' will be handled by this response handler. Given a definition name it determines what containers are to be used to build the OPeNDAP DDX response object that includes attribute information found in a DAS object and data definitions found in a DDS object. It also knows how to transmit the DDX response object using the specified transmitter object in the transmit method.
DDS
Definition at line 53 of file BESDDXResponseHandler.h.
BESDDXResponseHandler::BESDDXResponseHandler | ( | const string & | name | ) |
BESDDXResponseHandler::~BESDDXResponseHandler | ( | void | ) | [virtual] |
Definition at line 47 of file BESDDXResponseHandler.cc.
void BESDDXResponseHandler::execute | ( | BESDataHandlerInterface & | dhi | ) | [virtual] |
executes the command 'get ddx for <def_name>;'
For each container in the specified defnition go to the request handler for that container and have it first add to the OPeNDAP DDS response object. Oncew the DDS object has been filled in, repeat the process but this time for the OPeNDAP DAS response object. Then add the attributes from the DAS object to the DDS object.
dhi | structure that holds request and response information |
BESHandlerException | if there is a problem building the response object | |
BESResponseException | upon fatal error building the response object |
Implements BESResponseHandler.
Definition at line 70 of file BESDDXResponseHandler.cc.
References BESResponseHandler::_response, BESResponseHandler::_response_name, _BESDataHandlerInterface::action, _BESDataHandlerInterface::action_name, BESDEBUG, DAS_RESPONSE, DDS_RESPONSE, DDX_RESPONSE, DDX_RESPONSE_STR, BESRequestHandlerList::execute_each(), and BESRequestHandlerList::TheList().
void BESDDXResponseHandler::transmit | ( | BESTransmitter * | transmitter, | |
BESDataHandlerInterface & | dhi | |||
) | [virtual] |
transmit the response object built by the execute command
If a response object was built then transmit it using the send_ddx method on the specified transmitter object.
transmitter | object that knows how to transmit specific basic types | |
dhi | structure that holds the request and response information |
DAS
Implements BESResponseHandler.
Definition at line 123 of file BESDDXResponseHandler.cc.
References BESResponseHandler::_response, DDX_TRANSMITTER, and BESTransmitter::send_response().
void BESDDXResponseHandler::dump | ( | ostream & | strm | ) | const [virtual] |
dumps information about this object
Displays the pointer value of this instance
strm | C++ i/o stream to dump the information to |
Reimplemented from BESResponseHandler.
Definition at line 138 of file BESDDXResponseHandler.cc.
References BESResponseHandler::dump(), BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().
BESResponseHandler * BESDDXResponseHandler::DDXResponseBuilder | ( | const string & | name | ) | [static] |
Definition at line 148 of file BESDDXResponseHandler.cc.
References BESDDXResponseHandler().
Referenced by BESDapModule::initialize().
BESResponseObject * BESResponseHandler::get_response_object | ( | ) | [virtual, inherited] |
return the current response object
Returns the current response object, null if one has not yet been created. The response handler maintains ownership of the response object.
Definition at line 53 of file BESResponseHandler.cc.
References BESResponseHandler::_response.
Referenced by TestRequestHandler::cdf_build_help(), BESDapRequestHandler::dap_build_help(), BESDapRequestHandler::dap_build_version(), OPENDAP_CLASSRequestHandler::OPENDAP_TYPE_build_help(), and OPENDAP_CLASSRequestHandler::OPENDAP_TYPE_build_vers().
BESResponseObject * BESResponseHandler::set_response_object | ( | BESResponseObject * | o | ) | [virtual, inherited] |
replaces the current response object with the specified one, returning the current response object
This method is used to replace the response object with a new one, for example if during aggregation a new response object is built from the current response object.
The caller of set_response_object now owns the returned response object. The new response object is now owned by the response object.
o | new response object used to replace the current one |
Definition at line 59 of file BESResponseHandler.cc.
References BESResponseHandler::_response.
virtual string BESResponseHandler::get_name | ( | ) | const [inline, virtual, inherited] |
return the name of this response object
This name is used to determine which response handler can handle a requested responose, such as das, dds, ddx, tab, info, version, help, etc...
Definition at line 156 of file BESResponseHandler.h.
References BESResponseHandler::_response_name.
Referenced by resplistT::run().
string BESResponseHandler::_response_name [protected, inherited] |
Definition at line 84 of file BESResponseHandler.h.
Referenced by BESResponseHandler::dump(), execute(), and BESResponseHandler::get_name().
BESResponseObject* BESResponseHandler::_response [protected, inherited] |
Definition at line 85 of file BESResponseHandler.h.
Referenced by BESResponseHandler::dump(), OPENDAP_RESPONSEResponseHandler::execute(), BESVersionResponseHandler::execute(), BESStreamResponseHandler::execute(), BESStatusResponseHandler::execute(), BESShowDefsResponseHandler::execute(), BESShowContextResponseHandler::execute(), BESShowContainersResponseHandler::execute(), BESSetContextResponseHandler::execute(), BESSetContainerResponseHandler::execute(), BESProcIdResponseHandler::execute(), BESKeysResponseHandler::execute(), BESHelpResponseHandler::execute(), BESDelDefsResponseHandler::execute(), BESDelDefResponseHandler::execute(), BESDelContainersResponseHandler::execute(), BESDelContainerResponseHandler::execute(), BESDefineResponseHandler::execute(), execute(), BESDDSResponseHandler::execute(), BESDataResponseHandler::execute(), BESDASResponseHandler::execute(), BESCatalogResponseHandler::execute(), BESResponseHandler::get_response_object(), BESResponseHandler::set_response_object(), OPENDAP_RESPONSEResponseHandler::transmit(), BESVersionResponseHandler::transmit(), BESStatusResponseHandler::transmit(), BESShowDefsResponseHandler::transmit(), BESShowContextResponseHandler::transmit(), BESShowContainersResponseHandler::transmit(), BESSetContextResponseHandler::transmit(), BESSetContainerResponseHandler::transmit(), BESProcIdResponseHandler::transmit(), BESKeysResponseHandler::transmit(), BESHelpResponseHandler::transmit(), BESDelDefsResponseHandler::transmit(), BESDelDefResponseHandler::transmit(), BESDelContainersResponseHandler::transmit(), BESDelContainerResponseHandler::transmit(), BESDefineResponseHandler::transmit(), transmit(), BESDDSResponseHandler::transmit(), BESDataResponseHandler::transmit(), BESDASResponseHandler::transmit(), BESCatalogResponseHandler::transmit(), and BESResponseHandler::~BESResponseHandler().