BESDASResponseHandler Class Reference

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

#include <BESDASResponseHandler.h>

Inheritance diagram for BESDASResponseHandler:

Inheritance graph
[legend]
Collaboration diagram for BESDASResponseHandler:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 BESDASResponseHandler (const string &name)
virtual ~BESDASResponseHandler (void)
virtual void execute (BESDataHandlerInterface &dhi)
 executes the command 'get das for <def_name>;' by executing the request for each container in the specified defnition.
virtual void transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi)
 transmit the response object built by the execute command using the specified transmitter object
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 BESResponseHandlerDASResponseBuilder (const string &name)

Protected Attributes

string _response_name
BESResponseObject_response

Detailed Description

response handler that builds an OPeNDAP DAS response object

A request 'get das 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 DAS response object. It then transmits the DAS object using the method send_das on the speicifed transmitter object.

See also:
DAS

BESContainer

BESTransmitter

Definition at line 50 of file BESDASResponseHandler.h.


Constructor & Destructor Documentation

BESDASResponseHandler::BESDASResponseHandler ( const string &  name  ) 

Definition at line 39 of file BESDASResponseHandler.cc.

Referenced by DASResponseBuilder().

BESDASResponseHandler::~BESDASResponseHandler ( void   )  [virtual]

Definition at line 44 of file BESDASResponseHandler.cc.


Member Function Documentation

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

executes the command 'get das for <def_name>;' by executing the request for each container in the specified defnition.

For each container in the specified defnition go to the request handler for that container and have it add to the OPeNDAP DAS response object. The DAS response object is built within this method and passed to the request handler list.

Parameters:
dhi structure that holds request and response information
Exceptions:
BESHandlerException if there is a problem building the response object
BESResponseException upon fatal error building the response object
See also:
_BESDataHandlerInterface

BESDASResponse

BESRequestHandlerList

Implements BESResponseHandler.

Definition at line 66 of file BESDASResponseHandler.cc.

References BESResponseHandler::_response, _BESDataHandlerInterface::action_name, DAS_RESPONSE_STR, BESRequestHandlerList::execute_each(), and BESRequestHandlerList::TheList().

Here is the call graph for this function:

void BESDASResponseHandler::transmit ( BESTransmitter transmitter,
BESDataHandlerInterface dhi 
) [virtual]

transmit the response object built by the execute command using the specified transmitter object

If a response object was built then transmit it using the send_das method on the transmitter object.

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

BESTransmitter

_BESDataHandlerInterface

Implements BESResponseHandler.

Definition at line 87 of file BESDASResponseHandler.cc.

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

Here is the call graph for this function:

void BESDASResponseHandler::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 103 of file BESDASResponseHandler.cc.

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

Here is the call graph for this function:

BESResponseHandler * BESDASResponseHandler::DASResponseBuilder ( const string &  name  )  [static]

Definition at line 113 of file BESDASResponseHandler.cc.

References BESDASResponseHandler().

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

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.

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.

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.

Referenced by resplistT::run().


Member Data Documentation

string BESResponseHandler::_response_name [protected, inherited]

Definition at line 84 of file BESResponseHandler.h.

Referenced by BESResponseHandler::dump(), BESDDXResponseHandler::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(), BESDDXResponseHandler::execute(), BESDDSResponseHandler::execute(), BESDataResponseHandler::execute(), 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(), BESDDXResponseHandler::transmit(), BESDDSResponseHandler::transmit(), BESDataResponseHandler::transmit(), transmit(), BESCatalogResponseHandler::transmit(), and BESResponseHandler::~BESResponseHandler().


The documentation for this class was generated from the following files:
Generated on Fri Nov 30 12:11:27 2007 for OPeNDAP Back End Server (BES) by  doxygen 1.5.1