BESDDXResponseHandler Class Reference

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

#include <BESDDXResponseHandler.h>

Inheritance diagram for BESDDXResponseHandler:

Inheritance graph
[legend]
Collaboration diagram for BESDDXResponseHandler:

Collaboration graph
[legend]

List of all members.

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 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 string get_name () const
 return the name of this response object

Static Public Member Functions

static BESResponseHandlerDDXResponseBuilder (const string &name)

Protected Attributes

string _response_name
BESResponseObject_response


Detailed Description

response handler that builds an OPeNDAP DDX object

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.

See also:
DAS

DDS

BESContainer

BESDefine

BESTransmitter


Constructor & Destructor Documentation

BESDDXResponseHandler::BESDDXResponseHandler ( const string &  name  ) 

Referenced by DDXResponseBuilder().

BESDDXResponseHandler::~BESDDXResponseHandler ( void   )  [virtual]


Member Function Documentation

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.

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

BESDDSResponse

BESDASResponse

BESRequestHandlerList

Implements BESResponseHandler.

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

Here is the call graph for this function:

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.

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.

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

Here is the call graph for this function:

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

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

Here is the call graph for this function:

BESResponseHandler * BESDDXResponseHandler::DDXResponseBuilder ( const string &  name  )  [static]

References BESDDXResponseHandler().

Referenced by BESDapModule::initialize().

Here is the call graph for this function:

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

References BESResponseHandler::_response.

Referenced by BESDapRequestHandler::dap_build_help(), and BESDapRequestHandler::dap_build_version().

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

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

Returns:
response name

References BESResponseHandler::_response_name.


Member Data Documentation

string BESResponseHandler::_response_name [protected, inherited]

Referenced by BESResponseHandler::dump(), BESVersionResponseHandler::execute(), BESStreamResponseHandler::execute(), BESStatusResponseHandler::execute(), BESShowDefsResponseHandler::execute(), BESShowContextResponseHandler::execute(), BESShowContainersResponseHandler::execute(), BESSetContextResponseHandler::execute(), BESSetContainerResponseHandler::execute(), BESProcIdResponseHandler::execute(), BESHelpResponseHandler::execute(), BESDelDefsResponseHandler::execute(), BESDelDefResponseHandler::execute(), BESDelContainersResponseHandler::execute(), BESDelContainerResponseHandler::execute(), BESDefineResponseHandler::execute(), execute(), BESDDSResponseHandler::execute(), BESDataResponseHandler::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(), BESProcIdResponseHandler::transmit(), BESHelpResponseHandler::transmit(), BESDelDefsResponseHandler::transmit(), BESDelDefResponseHandler::transmit(), BESDelContainersResponseHandler::transmit(), BESDelContainerResponseHandler::transmit(), BESDefineResponseHandler::transmit(), transmit(), BESDDSResponseHandler::transmit(), BESDataResponseHandler::transmit(), BESDASResponseHandler::transmit(), BESConfigResponseHandler::transmit(), BESCatalogResponseHandler::transmit(), and BESResponseHandler::~BESResponseHandler().


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

Generated on Thu Sep 11 07:58:37 2008 for OPeNDAP Back End Server (BES) by  doxygen 1.5.6