BESDataDDXResponseHandler Class Reference

response handler that builds an OPeNDAP DDX object More...

#include <BESDataDDXResponseHandler.h>

Inheritance diagram for BESDataDDXResponseHandler:

Inheritance graph
[legend]
Collaboration diagram for BESDataDDXResponseHandler:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 BESDataDDXResponseHandler (const string &name)
virtual void dump (ostream &strm) const
 dumps information about this object
virtual void execute (BESDataHandlerInterface &dhi)
 executes the command 'get ddx for def_name;'
virtual string get_name () const
 return the name of this response object
virtual BESResponseObjectget_response_object ()
 return the current response object
virtual BESResponseObjectset_response_object (BESResponseObject *o)
 replaces the current response object with the specified one, returning the current response object
virtual void transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
 transmit the response object built by the execute command
virtual ~BESDataDDXResponseHandler (void)

Static Public Member Functions

static BESResponseHandlerDataDDXResponseBuilder (const string &name)

Protected Attributes

BESResponseObject_response
string _response_name

Detailed Description

response handler that builds an OPeNDAP DDX object

A request 'get dataddx 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.

See also:
DDX

BESContainer

BESDefine

BESTransmitter

Definition at line 52 of file BESDataDDXResponseHandler.h.


Constructor & Destructor Documentation

BESDataDDXResponseHandler::BESDataDDXResponseHandler ( const string &  name  ) 

Definition at line 41 of file BESDataDDXResponseHandler.cc.

Referenced by DataDDXResponseBuilder().

BESDataDDXResponseHandler::~BESDataDDXResponseHandler ( void   )  [virtual]

Definition at line 46 of file BESDataDDXResponseHandler.cc.


Member Function Documentation

BESResponseHandler * BESDataDDXResponseHandler::DataDDXResponseBuilder ( const string &  name  )  [static]

Definition at line 134 of file BESDataDDXResponseHandler.cc.

References BESDataDDXResponseHandler().

Referenced by BESDapModule::initialize().

Here is the call graph for this function:

void BESDataDDXResponseHandler::dump ( ostream &  strm  )  const [virtual]

dumps information about this object

Displays the pointer value of this instance

Parameters:
strm C++ i/o stream to dump the information to

Reimplemented from BESResponseHandler.

Definition at line 124 of file BESDataDDXResponseHandler.cc.

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

Here is the call graph for this function:

void BESDataDDXResponseHandler::execute ( BESDataHandlerInterface dhi  )  [virtual]

executes the command 'get ddx for def_name;'

For each container in the specified definition go to the request handler for that container and have it first add to the OPeNDAP DDS response object. Once 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.

Parameters:
dhi structure that holds request and response information
See also:
BESDataHandlerInterface

BESDDSResponse

BESDASResponse

BESRequestHandlerList

Implements BESResponseHandler.

Definition at line 65 of file BESDataDDXResponseHandler.cc.

References BESResponseHandler::_response, BESResponseHandler::_response_name, BESDataHandlerInterface::action, BESDataHandlerInterface::action_name, BESDEBUG, DATA_RESPONSE, DATADDX_RESPONSE, DATADDX_RESPONSE_STR, BESRequestHandlerList::execute_each(), BESDapResponse::get_dap_client_protocol(), BESDapResponse::get_request_xml_base(), and BESRequestHandlerList::TheList().

Here is the call graph for this function:

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

Returns:
response name

Definition at line 156 of file BESResponseHandler.h.

References BESResponseHandler::_response_name.

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.

Returns:
current response object
See also:
BESResponseObject

Definition at line 53 of file BESResponseHandler.cc.

References BESResponseHandler::_response.

Referenced by CSVRequestHandler::csv_build_das(), CSVRequestHandler::csv_build_data(), CSVRequestHandler::csv_build_dds(), CSVRequestHandler::csv_build_help(), CSVRequestHandler::csv_build_vers(), BESDapRequestHandler::dap_build_help(), BESDapRequestHandler::dap_build_version(), and BESDataHandlerInterface::get_response_object().

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.

Parameters:
o new response object used to replace the current one
Returns:
the response object being replaced
See also:
BESResponseObject

Definition at line 59 of file BESResponseHandler.cc.

References BESResponseHandler::_response.

void BESDataDDXResponseHandler::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.

Parameters:
transmitter object that knows how to transmit specific basic types
dhi structure that holds the request and response information
See also:
DDS

DAS

BESTransmitter

BESDataHandlerInterface

Implements BESResponseHandler.

Definition at line 108 of file BESDataDDXResponseHandler.cc.

References BESResponseHandler::_response, DATADDX_SERVICE, and BESTransmitter::send_response().

Here is the call graph for this function:


Member Data Documentation

BESResponseObject* BESResponseHandler::_response [protected, inherited]

Definition at line 85 of file BESResponseHandler.h.

Referenced by BESResponseHandler::dump(), BESVersionResponseHandler::execute(), BESStreamResponseHandler::execute(), BESStatusResponseHandler::execute(), BESShowDefsResponseHandler::execute(), BESShowContextResponseHandler::execute(), BESShowContainersResponseHandler::execute(), BESSetContextResponseHandler::execute(), BESSetContainerResponseHandler::execute(), BESServicesResponseHandler::execute(), BESProcIdResponseHandler::execute(), BESHelpResponseHandler::execute(), BESDelDefsResponseHandler::execute(), BESDelDefResponseHandler::execute(), BESDelContainersResponseHandler::execute(), BESDelContainerResponseHandler::execute(), BESDefineResponseHandler::execute(), BESDDXResponseHandler::execute(), BESDDSResponseHandler::execute(), BESDataResponseHandler::execute(), execute(), BESDASResponseHandler::execute(), BESConfigResponseHandler::execute(), BESCatalogResponseHandler::execute(), BESResponseHandler::get_response_object(), BESResponseHandler::set_response_object(), BESVersionResponseHandler::transmit(), BESStatusResponseHandler::transmit(), BESShowDefsResponseHandler::transmit(), BESShowContextResponseHandler::transmit(), BESShowContainersResponseHandler::transmit(), BESSetContextResponseHandler::transmit(), BESSetContainerResponseHandler::transmit(), BESServicesResponseHandler::transmit(), BESProcIdResponseHandler::transmit(), BESHelpResponseHandler::transmit(), BESDelDefsResponseHandler::transmit(), BESDelDefResponseHandler::transmit(), BESDelContainersResponseHandler::transmit(), BESDelContainerResponseHandler::transmit(), BESDefineResponseHandler::transmit(), BESDDXResponseHandler::transmit(), BESDDSResponseHandler::transmit(), BESDataResponseHandler::transmit(), transmit(), BESDASResponseHandler::transmit(), BESConfigResponseHandler::transmit(), BESCatalogResponseHandler::transmit(), and BESResponseHandler::~BESResponseHandler().

string BESResponseHandler::_response_name [protected, inherited]

Definition at line 84 of file BESResponseHandler.h.

Referenced by BESResponseHandler::dump(), BESDDXResponseHandler::execute(), execute(), and BESResponseHandler::get_name().


The documentation for this class was generated from the following files:
Generated on Tue May 11 20:04:34 2010 for OPeNDAP Hyrax Back End Server (BES) by  doxygen 1.4.7