#include <BESContainerStorageVolatile.h>
Public Types | |
typedef map< string, BESContainer * > ::const_iterator | Container_citer |
typedef map< string, BESContainer * >::iterator | Container_iter |
Public Member Functions | |
BESContainerStorageVolatile (const string &n) | |
create an instance of this persistent store with the given name. | |
virtual | ~BESContainerStorageVolatile () |
virtual BESContainer * | look_for (const string &sym_name) |
looks for the specified container using the symbolic name passed | |
virtual void | add_container (const string &sym_name, const string &real_name, const string &type) |
add a file container to the volatile list. The container's realname represents the path to a data file in the file system. | |
virtual bool | del_container (const string &s_name) |
removes a container with the given symbolic name from the list and deletes it. | |
virtual bool | del_containers () |
removes all container | |
virtual void | show_containers (BESInfo &info) |
show information for each container in this persistent store | |
virtual void | dump (ostream &strm) const |
dumps information about this object | |
virtual const string & | get_name () const |
retrieve the name of this persistent store | |
Protected Member Functions | |
virtual void | add_container (BESContainer *c) |
add the passed container to the list of containers in volatile storage | |
Protected Attributes | |
string | _root_dir |
bool | _follow_sym_links |
string | _my_name |
This implementation of BESContainerStorage stores volatile containers in memory for the duration of this process. A list of containers is stored in the object. The look_for method simply looks for the specified symbolic name in the list of containers and returns if a match is found. Containers can be added to this instance as long as the symbolic name doesn't already exist.
typedef map< string, BESContainer * >::const_iterator BESContainerStorageVolatile::Container_citer |
typedef map< string, BESContainer * >::iterator BESContainerStorageVolatile::Container_iter |
BESContainerStorageVolatile::BESContainerStorageVolatile | ( | const string & | n | ) |
create an instance of this persistent store with the given name.
Creates an instances of BESContainerStorageVolatile with the given name.
n | name of this persistent store |
References _follow_sym_links, _root_dir, BESKeys::get_key(), BESUtil::lowercase(), and TheBESKeys::TheKeys().
BESContainerStorageVolatile::~BESContainerStorageVolatile | ( | ) | [virtual] |
void BESContainerStorageVolatile::add_container | ( | BESContainer * | c | ) | [protected, virtual] |
add the passed container to the list of containers in volatile storage
This method adds the passed container to the list of volatile containers. The passed container is owned by the list if added and should not be deleted by the caller.
If a container with the symbolic name of the passed container is already in the list then an exception is thrown.
c | container to add to the list |
BESContainerStorageExcpetion | if the passed container is null | |
BESContainerStorageExcpetion | if no type is specified in the passed container | |
BESContainerStorageExcpetion | if a container with the passed symbolic name already exists. |
References BESContainer::get_container_type(), and BESContainer::get_symbolic_name().
Referenced by BESContainerStorageCatalog::add_container().
BESContainer * BESContainerStorageVolatile::look_for | ( | const string & | sym_name | ) | [virtual] |
looks for the specified container using the symbolic name passed
If a match is made with the symbolic name then the stored container is duplicated and returned to the user. If not, 0 is returned.
sym_name | symbolic name of the container to look for |
Implements BESContainerStorage.
References BESContainer::ptr_duplicate().
void BESContainerStorageVolatile::add_container | ( | const string & | sym_name, | |
const string & | real_name, | |||
const string & | type | |||
) | [virtual] |
add a file container to the volatile list. The container's realname represents the path to a data file in the file system.
If a container other than a BESFileContainer is to be added to the list then a derived class of BESContainerStorageVolatile should call the protected add_container method that takes an already built container. This method adds a container represented by a data file.
sym_name | symbolic name of the container being created | |
real_name | real name of the container | |
type | type of data represented by this container |
BESInternalError | if no type is specified | |
BESInternalError | if a container with the passed symbolic name already exists. |
Implements BESContainerStorage.
Reimplemented in BESContainerStorageCatalog.
References _follow_sym_links, _root_dir, and BESUtil::check_path().
bool BESContainerStorageVolatile::del_container | ( | const string & | s_name | ) | [virtual] |
removes a container with the given symbolic name from the list and deletes it.
s_name | symbolic name for the container |
Implements BESContainerStorage.
bool BESContainerStorageVolatile::del_containers | ( | ) | [virtual] |
removes all container
This method removes all containers from the persistent store. It does not delete the real data behind the container.
Implements BESContainerStorage.
Referenced by ~BESContainerStorageVolatile().
void BESContainerStorageVolatile::show_containers | ( | BESInfo & | info | ) | [virtual] |
show information for each container in this persistent store
For each container in this persistent store, add infomation about each of those containers. The information added to the information object includes a line for each container within this persistent store which includes the symbolic name, the real name, and the data type, separated by commas.
In the case of this persistent store information from each container added to the volatile list is added to the information object.
info | object to store the container and persistent store information |
Implements BESContainerStorage.
References BESInfo::add_tag(), BESInfo::begin_tag(), BESInfo::end_tag(), BESContainer::get_container_type(), BESContainerStorage::get_name(), BESContainer::get_real_name(), and BESContainer::get_symbolic_name().
void BESContainerStorageVolatile::dump | ( | ostream & | strm | ) | const [virtual] |
dumps information about this object
Displays the pointer value of this instance along with information about the containers stored in this volatile list.
strm | C++ i/o stream to dump the information to |
Implements BESContainerStorage.
Reimplemented in BESContainerStorageCatalog.
References BESContainer::dump(), BESContainerStorage::get_name(), BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().
virtual const string& BESContainerStorage::get_name | ( | ) | const [inline, virtual, inherited] |
retrieve the name of this persistent store
References BESContainerStorage::_my_name.
Referenced by BESContainerStorageList::add_persistence(), dump(), BESContainerStorageFile::dump(), BESContainerStorageCatalog::dump(), show_containers(), and BESContainerStorageFile::show_containers().
string BESContainerStorageVolatile::_root_dir [protected] |
bool BESContainerStorageVolatile::_follow_sym_links [protected] |
string BESContainerStorage::_my_name [protected, inherited] |
Referenced by BESContainerStorage::get_name().