BESXMLGetDataDDXCommand Class Reference

#include <BESXMLGetDataDDXCommand.h>

Inheritance diagram for BESXMLGetDataDDXCommand:

Inheritance graph
[legend]
Collaboration diagram for BESXMLGetDataDDXCommand:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 BESXMLGetDataDDXCommand (const BESDataHandlerInterface &base_dhi)
virtual void dump (ostream &strm) const
 dumps information about this object
virtual BESDataHandlerInterfaceget_dhi ()
 returns the BESDataHandlerInterface of either a sub command, if one exists, or this command's
virtual bool has_response ()
 Has a response handler been created given the request document?
virtual void parse_request (xmlNode *node)
 parse a get dataddx command.
virtual void prep_request ()
 prepare the get dataddx command
virtual ~BESXMLGetDataDDXCommand ()

Static Public Member Functions

static void add_command (const string &cmd_str, p_xmlcmd_builder cmd)
 Add a command to the possible commands allowed by this BES.
static BESXMLCommandCommandBuilder (const BESDataHandlerInterface &base_dhi)
static bool del_command (const string &cmd_str)
 Deletes the command called cmd_str from the list of possible commands.
static p_xmlcmd_builder find_command (const string &cmd_str)
 Find the BESXMLCommand creation function with the given name.

Protected Member Functions

virtual void parse_basic_get (xmlNode *node, const string &name, const string &type, const string &value, map< string, string > &props)
virtual void set_response ()
 The request has been parsed, use the command action name to set the response handler.

Protected Attributes

BESDataHandlerInterface _dhi
string _str_cmd

Detailed Description

Definition at line 39 of file BESXMLGetDataDDXCommand.h.


Constructor & Destructor Documentation

BESXMLGetDataDDXCommand::BESXMLGetDataDDXCommand ( const BESDataHandlerInterface base_dhi  ) 

Definition at line 44 of file BESXMLGetDataDDXCommand.cc.

Referenced by CommandBuilder().

virtual BESXMLGetDataDDXCommand::~BESXMLGetDataDDXCommand (  )  [inline, virtual]

Definition at line 46 of file BESXMLGetDataDDXCommand.h.


Member Function Documentation

void BESXMLCommand::add_command ( const string &  cmd_str,
p_xmlcmd_builder  cmd 
) [static, inherited]

Add a command to the possible commands allowed by this BES.

This adds a function to parse a specific BES command within the BES request document using the given name. If a command element is found with the name cmd_str, then the XMLCommand object is created using the passed cmd object.

Parameters:
cmd_str The name of the command
cmd The function to call to create the BESXMLCommand object

Definition at line 85 of file BESXMLCommand.cc.

Referenced by BESXMLDefaultCommands::initialize(), and BESXMLDapCommandModule::initialize().

BESXMLCommand * BESXMLGetDataDDXCommand::CommandBuilder ( const BESDataHandlerInterface base_dhi  )  [static]

Reimplemented from BESXMLGetCommand.

Definition at line 162 of file BESXMLGetDataDDXCommand.cc.

References BESXMLGetDataDDXCommand().

Referenced by BESXMLDapCommandModule::initialize().

Here is the call graph for this function:

bool BESXMLCommand::del_command ( const string &  cmd_str  )  [static, inherited]

Deletes the command called cmd_str from the list of possible commands.

Parameters:
cmd_str The name of the command to remove from the list

Definition at line 96 of file BESXMLCommand.cc.

Referenced by BESXMLDefaultCommands::terminate(), and BESXMLDapCommandModule::terminate().

void BESXMLGetDataDDXCommand::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 BESXMLGetCommand.

Definition at line 152 of file BESXMLGetDataDDXCommand.cc.

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

Here is the call graph for this function:

p_xmlcmd_builder BESXMLCommand::find_command ( const string &  cmd_str  )  [static, inherited]

Find the BESXMLCommand creation function with the given name.

Parameters:
cmd_str The name of the command creation function to find

Definition at line 113 of file BESXMLCommand.cc.

Referenced by BESXMLInterface::build_data_request_plan(), and BESXMLGetCommand::parse_request().

BESDataHandlerInterface & BESXMLGetCommand::get_dhi (  )  [virtual, inherited]

returns the BESDataHandlerInterface of either a sub command, if one exists, or this command's

Returns:
BESDataHandlerInterface of sub command if it exists or this instances

Reimplemented from BESXMLCommand.

Definition at line 145 of file BESXMLGetCommand.cc.

References BESXMLCommand::_dhi, and BESXMLCommand::get_dhi().

Here is the call graph for this function:

virtual bool BESXMLGetCommand::has_response (  )  [inline, virtual, inherited]

Has a response handler been created given the request document?

Returns:
true if a response handler has been set, false otherwise

Implements BESXMLCommand.

Definition at line 57 of file BESXMLGetCommand.h.

void BESXMLGetCommand::parse_basic_get ( xmlNode *  node,
const string &  name,
const string &  type,
const string &  value,
map< string, string > &  props 
) [protected, virtual, inherited]

Definition at line 107 of file BESXMLGetCommand.cc.

References BESXMLCommand::_dhi, BESXMLCommand::_str_cmd, BESDataHandlerInterface::action, BESDEBUG, DAP2_FORMAT, BESDataHandlerInterface::data, BESUtil::lowercase(), and RETURN_CMD.

Referenced by parse_request(), and BESXMLGetCommand::parse_request().

Here is the call graph for this function:

void BESXMLGetDataDDXCommand::parse_request ( xmlNode *  node  )  [virtual]

parse a get dataddx command.

>get type="dataddx" definition="d" returnAs="name" />

Parameters:
node xml2 element node pointer

Reimplemented from BESXMLGetCommand.

Definition at line 56 of file BESXMLGetDataDDXCommand.cc.

References BESXMLCommand::_str_cmd, DATADDX_SERVICE, GET_RESPONSE, BESXMLUtils::GetFirstChild(), BESXMLUtils::GetNextChild(), BESXMLUtils::GetNodeInfo(), BESXMLGetCommand::parse_basic_get(), and BESXMLCommand::set_response().

Here is the call graph for this function:

void BESXMLGetDataDDXCommand::prep_request (  )  [virtual]

prepare the get dataddx command

set the contentStartId and mimeBoundary values in the data handler interface

Reimplemented from BESXMLGetCommand.

Definition at line 138 of file BESXMLGetDataDDXCommand.cc.

References BESXMLCommand::_dhi, BESDataHandlerInterface::data, DATADDX_BOUNDARY, DATADDX_STARTID, and BESXMLGetCommand::prep_request().

Here is the call graph for this function:

void BESXMLCommand::set_response (  )  [protected, virtual, inherited]

The request has been parsed, use the command action name to set the response handler.

Definition at line 57 of file BESXMLCommand.cc.

References BESXMLCommand::_dhi, BESXMLCommand::_str_cmd, BESDataHandlerInterface::action, BESDataHandlerInterface::data, DATA_REQUEST, BESResponseHandlerList::find_handler(), REQUEST_FROM, BESDataHandlerInterface::response_handler, SERVER_PID, BESResponseHandlerList::TheList(), and BESLog::TheLog().

Referenced by BESXMLShowErrorCommand::parse_request(), BESXMLShowCommand::parse_request(), BESXMLSetContextCommand::parse_request(), BESXMLSetContainerCommand::parse_request(), parse_request(), BESXMLGetCommand::parse_request(), BESXMLDeleteDefinitionsCommand::parse_request(), BESXMLDeleteDefinitionCommand::parse_request(), BESXMLDeleteContainersCommand::parse_request(), BESXMLDeleteContainerCommand::parse_request(), BESXMLDefineCommand::parse_request(), and BESXMLCatalogCommand::parse_request().

Here is the call graph for this function:


Member Data Documentation

BESDataHandlerInterface BESXMLCommand::_dhi [protected, inherited]

Definition at line 57 of file BESXMLCommand.h.

Referenced by BESXMLCommand::BESXMLCommand(), BESXMLGetCommand::get_dhi(), BESXMLCommand::get_dhi(), BESXMLGetCommand::parse_basic_get(), BESXMLShowErrorCommand::parse_request(), BESXMLShowCommand::parse_request(), BESXMLSetContextCommand::parse_request(), BESXMLSetContainerCommand::parse_request(), BESXMLGetCommand::parse_request(), BESXMLDeleteDefinitionsCommand::parse_request(), BESXMLDeleteDefinitionCommand::parse_request(), BESXMLDeleteContainersCommand::parse_request(), BESXMLDeleteContainerCommand::parse_request(), BESXMLDefineCommand::parse_request(), BESXMLCatalogCommand::parse_request(), prep_request(), BESXMLGetCommand::prep_request(), BESXMLDefineCommand::prep_request(), and BESXMLCommand::set_response().

string BESXMLCommand::_str_cmd [protected, inherited]

Definition at line 59 of file BESXMLCommand.h.

Referenced by BESXMLGetCommand::parse_basic_get(), BESXMLShowErrorCommand::parse_request(), BESXMLShowCommand::parse_request(), BESXMLSetContextCommand::parse_request(), BESXMLSetContainerCommand::parse_request(), parse_request(), BESXMLGetCommand::parse_request(), BESXMLDeleteDefinitionsCommand::parse_request(), BESXMLDeleteDefinitionCommand::parse_request(), BESXMLDeleteContainersCommand::parse_request(), BESXMLDeleteContainerCommand::parse_request(), BESXMLDefineCommand::parse_request(), BESXMLCatalogCommand::parse_request(), and BESXMLCommand::set_response().


The documentation for this class was generated from the following files:
Generated on Tue May 11 20:05:54 2010 for OPeNDAP Hyrax Back End Server (BES) by  doxygen 1.4.7