BESCatalogResponseHandler Class Reference

response handler that returns nodes or leaves within the catalog either at the root or at a specified node. More...

#include <BESCatalogResponseHandler.h>

Inheritance diagram for BESCatalogResponseHandler:

Inheritance graph
[legend]
Collaboration diagram for BESCatalogResponseHandler:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 BESCatalogResponseHandler (const string &name)
virtual ~BESCatalogResponseHandler (void)
virtual void execute (BESDataHandlerInterface &dhi)
 executes the command 'show catalog|leaves [for <node>];' by returning nodes or leaves at the top level or at the specified node.
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 BESResponseHandlerCatalogResponseBuilder (const string &name)

Protected Attributes

string _response_name
BESResponseObject_response

Detailed Description

response handler that returns nodes or leaves within the catalog either at the root or at a specified node.

A request 'show catalog [for <node>];' or 'show leaves for <node>; will be handled by this response handler. It returns nodes or leaves either at the root level if no node is specified in the request, or the nodes or leaves under the specified node.

See also:
BESResponseObject

BESContainer

BESTransmitter


Constructor & Destructor Documentation

BESCatalogResponseHandler::BESCatalogResponseHandler ( const string &  name  ) 

BESCatalogResponseHandler::~BESCatalogResponseHandler ( void   )  [virtual]


Member Function Documentation

BESResponseHandler * BESCatalogResponseHandler::CatalogResponseBuilder ( const string &  name  )  [static]

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

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

executes the command 'show catalog|leaves [for <node>];' by returning nodes or leaves at the top level or at the specified node.

The response object BESInfo is created to store the information.

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

BESInfo

BESRequestHandlerList

Implements BESResponseHandler.

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

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

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

void BESCatalogResponseHandler::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 as text

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

BESTransmitter

_BESDataHandlerInterface

Implements BESResponseHandler.


Member Data Documentation

BESResponseObject* BESResponseHandler::_response [protected, inherited]

string BESResponseHandler::_response_name [protected, inherited]


The documentation for this class was generated from the following files:
Generated on Wed Nov 21 12:19:48 2007 for OPeNDAP Back End Server (BES) by  doxygen 1.4.7