BESDefineResponseHandler Class Reference

response handler that creates a definition given container names and optionally constraints and attributes for each of those containers. More...

#include <BESDefineResponseHandler.h>

Inheritance diagram for BESDefineResponseHandler:

Inheritance graph
[legend]
Collaboration diagram for BESDefineResponseHandler:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 BESDefineResponseHandler (const string &name)
virtual ~BESDefineResponseHandler (void)
virtual void execute (BESDataHandlerInterface &dhi)
 executes the command to create a new definition.
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 BESResponseHandlerDefineResponseBuilder (const string &name)

Protected Attributes

string _response_name
BESResponseObject_response


Detailed Description

response handler that creates a definition given container names and optionally constraints and attributes for each of those containers.

A request looks like:

define <def_name> as <container_list>

  [where <container_x>.constraint="<constraint>"]

  [,<container_x>.attributes="<attrs>"]

  [aggregate by "&lt;aggregation_command&gt;"];

where container_list is a list of containers representing points of data, such as a file. For each container in the container_list the user can specify a constraint and a list of attributes. You need not specify a constraint for a given container or a list of attributes. If just specifying a constraint then leave out the attributes. If just specifying a list of attributes then leave out the constraint. For example:

define d1 as container_1,container_2

  where container_1.constraint="constraint1"

  ,container_2.constraint="constraint2"

  ,container_2.attributes="attr1,attr2";

It adds the new definition to the list. If a definition already exists in the list with the given name then it is removed first and the new one is added. The definition is currently available through the life of the server process and is not persistent.

See also:
BESDefine

DefintionStorageList

BESContainer

BESTransmitter


Constructor & Destructor Documentation

BESDefineResponseHandler::BESDefineResponseHandler ( const string &  name  ) 

Referenced by DefineResponseBuilder().

BESDefineResponseHandler::~BESDefineResponseHandler ( void   )  [virtual]


Member Function Documentation

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

executes the command to create a new definition.

A BESDefine object is created and added to the list of definitions. If a definition already exists with the given name then it is removed and the new one added.

The BESDefine object is created using the containers, constraints, attribute lists and aggregation command parsed in the parse method.

The response object built for this command is a BESInfo response object. It will contain one of two possible responses:

Successfully added definition <def_name>

Successfully replaced definition <def_name>

If the keyword SILENT is set within the data handler interface then no information is added.

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

BESInfo

BESDefine

DefintionStorageList

Implements BESResponseHandler.

References BESResponseHandler::_response, _BESDataHandlerInterface::action_name, BESDefine::add_container(), BESDefinitionStorage::add_definition(), AGG_CMD, AGG_HANDLER, _BESDataHandlerInterface::container, _BESDataHandlerInterface::data, DEF_NAME, DEFINE_RESPONSE_STR, BESDefinitionStorage::del_definition(), BESDefinitionStorageList::find_persistence(), _BESDataHandlerInterface::first_container(), _BESDataHandlerInterface::next_container(), PERSISTENCE_VOLATILE, BESDefine::set_agg_cmd(), BESDefine::set_agg_handler(), STORE_NAME, and BESDefinitionStorageList::TheList().

Here is the call graph for this function:

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

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

A BESInfo response object was built in the exeucte command to inform the user whether the definition was successfully added or replaced. The method send_text is called on the BESTransmitter 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 BESDefineResponseHandler::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 * BESDefineResponseHandler::DefineResponseBuilder ( const string &  name  )  [static]

References BESDefineResponseHandler().

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(), BESSetContainerResponseHandler::execute(), BESProcIdResponseHandler::execute(), BESHelpResponseHandler::execute(), BESDelDefsResponseHandler::execute(), BESDelDefResponseHandler::execute(), BESDelContainersResponseHandler::execute(), BESDelContainerResponseHandler::execute(), 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(), BESSetContainerResponseHandler::transmit(), BESProcIdResponseHandler::transmit(), BESHelpResponseHandler::transmit(), BESDelDefsResponseHandler::transmit(), BESDelDefResponseHandler::transmit(), BESDelContainersResponseHandler::transmit(), BESDelContainerResponseHandler::transmit(), 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:15 2008 for OPeNDAP Back End Server (BES) by  doxygen 1.5.6