BESContainerStorage Class Reference

provides persistent storage for data storage information represented by a container. More...

#include <BESContainerStorage.h>

Inheritance diagram for BESContainerStorage:

Inheritance graph
[legend]
Collaboration diagram for BESContainerStorage:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual void add_container (const string &sym_name, const string &real_name, const string &type)=0
 adds a container with the provided information
 BESContainerStorage (const string &name)
 create an instance of BESContainerStorage with the give name.
virtual bool del_container (const string &s_name)=0
 removes a container with the given symbolic name
virtual bool del_containers ()=0
 removes all container
virtual void dump (ostream &strm) const =0
 Displays debug information about this object.
virtual const string & get_name () const
 retrieve the name of this persistent store
virtual BESContainerlook_for (const string &sym_name)=0
 looks for a container in this persistent store
virtual void show_containers (BESInfo &info)=0
 show the containers stored in this persistent store
virtual ~BESContainerStorage ()

Protected Member Functions

virtual void show_container (const string &sym_name, const string &real_name, const string &type, BESInfo &info)
 add information for a container to the informational response object

Protected Attributes

string _my_name

Detailed Description

provides persistent storage for data storage information represented by a container.

An implementation of the abstract interface BESContainerStorage provides storage for information about accessing data of different date types. The information is represented by a symbolic name. A user can request a symbolic name that represents a certain container.

For example, a symbolic name 'nc1' could represent the netcdf file /usr/apache/htdocs/netcdf/datfile01.cdf.

An instance of a derived implementation has a name associated with it, in case that there are multiple ways in which the information can be stored. For example, the main persistent storage for containers could be a mysql database, but a user could store temporary information in different files. If the user wishes to remove one of these persistence stores they would request that a named BESContainerStorage object be removed from the list.

See also:
BESContainer

BESContainerStorageList

Definition at line 67 of file BESContainerStorage.h.


Constructor & Destructor Documentation

BESContainerStorage::BESContainerStorage ( const string &  name  )  [inline]

create an instance of BESContainerStorage with the give name.

Parameters:
name name of this persistence store

Definition at line 82 of file BESContainerStorage.h.

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

Definition at line 85 of file BESContainerStorage.h.


Member Function Documentation

virtual void BESContainerStorage::add_container ( const string &  sym_name,
const string &  real_name,
const string &  type 
) [pure virtual]

adds a container with the provided information

This method adds a container to the persistence store with the specified information.

Parameters:
sym_name symbolic name for the container
real_name real name for the container
type type of data represented by this container

Implemented in BESContainerStorageCatalog, BESContainerStorageFile, and BESContainerStorageVolatile.

Referenced by BESSetContainerResponseHandler::execute().

virtual bool BESContainerStorage::del_container ( const string &  s_name  )  [pure virtual]

removes a container with the given symbolic name

This method removes a container to the persistence store with the given symbolic name. It deletes the container.

Parameters:
s_name symbolic name for the container
Returns:
true if successfully removed and false otherwise

Implemented in BESContainerStorageFile, and BESContainerStorageVolatile.

Referenced by BESSetContainerResponseHandler::execute(), and BESDelContainerResponseHandler::execute().

virtual bool BESContainerStorage::del_containers (  )  [pure virtual]

removes all container

This method removes all containers from the persistent store. It does not delete the real data behind the container.

Returns:
true if successfully removed and false otherwise

Implemented in BESContainerStorageFile, and BESContainerStorageVolatile.

Referenced by BESDelContainersResponseHandler::execute().

virtual void BESContainerStorage::dump ( ostream &  strm  )  const [pure virtual]

Displays debug information about this object.

Parameters:
strm output stream to use to dump the contents of this object

Implements BESObj.

Implemented in BESContainerStorageCatalog, BESContainerStorageFile, and BESContainerStorageVolatile.

virtual const string& BESContainerStorage::get_name (  )  const [inline, virtual]

retrieve the name of this persistent store

Returns:
name of this persistent store.

Definition at line 91 of file BESContainerStorage.h.

References _my_name.

Referenced by BESContainerStorageList::add_persistence(), BESContainerStorageVolatile::dump(), BESContainerStorageFile::dump(), BESContainerStorageCatalog::dump(), and BESContainerStorageVolatile::show_containers().

virtual BESContainer* BESContainerStorage::look_for ( const string &  sym_name  )  [pure virtual]

looks for a container in this persistent store

This method looks for a container with the given symbolic name.

Parameters:
sym_name The symbolic name of the container to look for
Returns:
If sym_name is found, the BESContainer instance representing that symbolic name, else NULL is returned.

Implemented in BESContainerStorageFile, and BESContainerStorageVolatile.

void BESContainerStorage::show_container ( const string &  sym_name,
const string &  real_name,
const string &  type,
BESInfo info 
) [protected, virtual]

add information for a container to the informational response object

Parameters:
sym_name symbolic name of the container to add
real_name real name, e.g. file name, of the container to add
type data type of the container
info The BES information object to add container information to
See also:
BESInfo

Definition at line 45 of file BESContainerStorage.cc.

References BESInfo::add_tag().

Referenced by BESContainerStorageVolatile::show_containers(), and BESContainerStorageFile::show_containers().

Here is the call graph for this function:

virtual void BESContainerStorage::show_containers ( BESInfo info  )  [pure virtual]

show the containers stored in this persistent store

Add information to the passed information object about each of the containers stored within this persistent store. The information added to the passed information objects includes the name of this persistent store on the first line followed by the symbolic name, real name and data type for each container, one per line.

Parameters:
info information object to store the information in

Implemented in BESContainerStorageFile, and BESContainerStorageVolatile.


Member Data Documentation

string BESContainerStorage::_my_name [protected]

Definition at line 70 of file BESContainerStorage.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Thu Sep 16 15:22:54 2010 for OPeNDAP Hyrax Back End Server (BES) by  doxygen 1.4.7