#include <BESDefineResponseHandler.h>
Inheritance diagram for BESDefineResponseHandler:
Public Member Functions | |
BESDefineResponseHandler (const string &name) | |
virtual void | dump (ostream &strm) const |
dumps information about this object | |
virtual void | execute (BESDataHandlerInterface &dhi) |
executes the command to create a new definition. | |
virtual string | get_name () const |
return the name of this response object | |
virtual BESResponseObject * | get_response_object () |
return the current response object | |
virtual BESResponseObject * | set_response_object (BESResponseObject *o) |
replaces the current response object with the specified one, returning the current response object | |
virtual void | transmit (BESTransmitter *transmitter, BESDataHandlerInterface &dhi) |
transmit the response object built by the execute command using the specified transmitter object | |
virtual | ~BESDefineResponseHandler (void) |
Static Public Member Functions | |
static BESResponseHandler * | DefineResponseBuilder (const string &name) |
Protected Attributes | |
BESResponseObject * | _response |
string | _response_name |
A request looks like:
define <def_name> as <container_list>
[where <container_x>.constraint="<constraint>"]
[,<container_x>.attributes="<attrs>"]
[aggregate by "<aggregation_command>"];
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.
DefintionStorageList
Definition at line 76 of file BESDefineResponseHandler.h.
BESDefineResponseHandler::BESDefineResponseHandler | ( | const string & | name | ) |
BESDefineResponseHandler::~BESDefineResponseHandler | ( | void | ) | [virtual] |
Definition at line 51 of file BESDefineResponseHandler.cc.
BESResponseHandler * BESDefineResponseHandler::DefineResponseBuilder | ( | const string & | name | ) | [static] |
Definition at line 167 of file BESDefineResponseHandler.cc.
References BESDefineResponseHandler().
Referenced by BESDefaultModule::initialize().
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
strm | C++ i/o stream to dump the information to |
Reimplemented from BESResponseHandler.
Definition at line 157 of file BESDefineResponseHandler.cc.
References BESResponseHandler::dump(), BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().
Here is the call graph for this function:
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.
dhi | structure that holds request and response information |
BESSyntaxUserError | if the store name specified does not exist |
DefintionStorageList
Implements BESResponseHandler.
Definition at line 82 of file BESDefineResponseHandler.cc.
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:
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...
Definition at line 156 of file BESResponseHandler.h.
References BESResponseHandler::_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.
Definition at line 53 of file BESResponseHandler.cc.
References BESResponseHandler::_response.
Referenced by CSVRequestHandler::csv_build_das(), CSVRequestHandler::csv_build_data(), CSVRequestHandler::csv_build_dds(), CSVRequestHandler::csv_build_help(), CSVRequestHandler::csv_build_vers(), BESDapRequestHandler::dap_build_help(), BESDapRequestHandler::dap_build_version(), and BESDataHandlerInterface::get_response_object().
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.
o | new response object used to replace the current one |
Definition at line 59 of file BESResponseHandler.cc.
References BESResponseHandler::_response.
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.
transmitter | object that knows how to transmit specific basic types | |
dhi | structure that holds the request and response information |
Implements BESResponseHandler.
Definition at line 135 of file BESDefineResponseHandler.cc.
References BESResponseHandler::_response, and BESInfo::transmit().
Here is the call graph for this function:
BESResponseObject* BESResponseHandler::_response [protected, inherited] |
Definition at line 85 of file BESResponseHandler.h.
Referenced by BESResponseHandler::dump(), BESVersionResponseHandler::execute(), BESStreamResponseHandler::execute(), BESStatusResponseHandler::execute(), BESShowDefsResponseHandler::execute(), BESShowContextResponseHandler::execute(), BESShowContainersResponseHandler::execute(), BESSetContextResponseHandler::execute(), BESSetContainerResponseHandler::execute(), BESServicesResponseHandler::execute(), BESProcIdResponseHandler::execute(), BESHelpResponseHandler::execute(), BESDelDefsResponseHandler::execute(), BESDelDefResponseHandler::execute(), BESDelContainersResponseHandler::execute(), BESDelContainerResponseHandler::execute(), execute(), BESDDXResponseHandler::execute(), BESDDSResponseHandler::execute(), BESDataResponseHandler::execute(), BESDataDDXResponseHandler::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(), BESServicesResponseHandler::transmit(), BESProcIdResponseHandler::transmit(), BESHelpResponseHandler::transmit(), BESDelDefsResponseHandler::transmit(), BESDelDefResponseHandler::transmit(), BESDelContainersResponseHandler::transmit(), BESDelContainerResponseHandler::transmit(), transmit(), BESDDXResponseHandler::transmit(), BESDDSResponseHandler::transmit(), BESDataResponseHandler::transmit(), BESDataDDXResponseHandler::transmit(), BESDASResponseHandler::transmit(), BESConfigResponseHandler::transmit(), BESCatalogResponseHandler::transmit(), and BESResponseHandler::~BESResponseHandler().
string BESResponseHandler::_response_name [protected, inherited] |
Definition at line 84 of file BESResponseHandler.h.
Referenced by BESResponseHandler::dump(), BESDDXResponseHandler::execute(), BESDataDDXResponseHandler::execute(), and BESResponseHandler::get_name().