BESSetContainerResponseHandler Class Reference

response handler that creates a container given the symbolic name, real name, and data type. More...

#include <BESSetContainerResponseHandler.h>

Inheritance diagram for BESSetContainerResponseHandler:

Inheritance graph
[legend]
Collaboration diagram for BESSetContainerResponseHandler:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 BESSetContainerResponseHandler (const string &name)
virtual ~BESSetContainerResponseHandler (void)
virtual void execute (BESDataHandlerInterface &dhi)
 executes the command to create a new container or replaces an already existing container based on the provided symbolic name.
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 BESResponseHandlerSetContainerResponseBuilder (const string &name)

Protected Attributes

string _response_name
BESResponseObject_response


Detailed Description

response handler that creates a container given the symbolic name, real name, and data type.

This request handler creates a new container, or replaces an already existing container in the specified container storage given the symbolic name, real name (in most cases a file name), and the type of data represented by the real name (e.g. netcdf, cedar, cdf, hdf, etc...) The request has the syntax:

set container in <store_name> values <sym_name>,<real_name>,<data_type>;

It returns whether the container was created or replaces successfully in an informational response object and transmits that response object.

See also:
BESResponseObject

BESContainer

BESTransmitter


Constructor & Destructor Documentation

BESSetContainerResponseHandler::BESSetContainerResponseHandler ( const string &  name  ) 

BESSetContainerResponseHandler::~BESSetContainerResponseHandler ( void   )  [virtual]


Member Function Documentation

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

executes the command to create a new container or replaces an already existing container based on the provided symbolic name.

The symbolic name is first looked up in the specified container storage object, volatile if no container storage name is specified. If the symbolic name already exists (the container already exists) then the already existing container is removed and the new one added using the given real name (usually a file name) and the type of data represented by this container (e.g. cedar, cdf, netcdf, hdf, etc...)

An informational response object BESInfo is created to hold whether or not the container was successfully added/replaced. Possible responses are:

Successfully added container "&lt;sym_name&gt;" in container storage "&lt;store_name&gt;"

Successfully replaced container "&lt;sym_name&gt;" in container storage "&lt;store_name&gt;"

Unable to add container "&lt;sym_name&gt;" to container storage "&lt;store_name&gt;"

Unable to add container "&lt;sym_name&gt;" to container storage "&lt;store_name&gt;"

Container storage "&lt;store_name&gt;" does not exist

Parameters:
dhi structure that holds request and response information
Exceptions:
BESSyntaxUserError if the specified store name does not exist
See also:
_BESDataHandlerInterface

BESInfo

BESContainerStorageList

BESContainerStorage

BESContainer

Implements BESResponseHandler.

References BESResponseHandler::_response, _BESDataHandlerInterface::action_name, BESContainerStorage::add_container(), CONTAINER_TYPE, _BESDataHandlerInterface::data, BESContainerStorage::del_container(), BESContainerStorageList::find_persistence(), REAL_NAME, SETCONTAINER_STR, STORE_NAME, SYMBOLIC_NAME, and BESContainerStorageList::TheList().

Here is the call graph for this function:

void BESSetContainerResponseHandler::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 using 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:
BESInfo

BESTransmitter

_BESDataHandlerInterface

Implements BESResponseHandler.

References BESResponseHandler::_response, and BESInfo::transmit().

Here is the call graph for this function:

void BESSetContainerResponseHandler::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 * BESSetContainerResponseHandler::SetContainerResponseBuilder ( const string &  name  )  [static]

References BESSetContainerResponseHandler().

Referenced by BESDefaultModule::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(), execute(), BESProcIdResponseHandler::execute(), BESHelpResponseHandler::execute(), BESDelDefsResponseHandler::execute(), BESDelDefResponseHandler::execute(), BESDelContainersResponseHandler::execute(), BESDelContainerResponseHandler::execute(), BESDefineResponseHandler::execute(), BESDDXResponseHandler::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(), transmit(), BESProcIdResponseHandler::transmit(), BESHelpResponseHandler::transmit(), BESDelDefsResponseHandler::transmit(), BESDelDefResponseHandler::transmit(), BESDelContainersResponseHandler::transmit(), BESDelContainerResponseHandler::transmit(), BESDefineResponseHandler::transmit(), BESDDXResponseHandler::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:57:38 2008 for OPeNDAP Back End Server (BES) by  doxygen 1.5.6