BESFileContainer Class Reference

Holds real data, container type and constraint for symbolic name read from persistence. More...

#include <BESFileContainer.h>

Inheritance diagram for BESFileContainer:

Inheritance graph
[legend]
Collaboration diagram for BESFileContainer:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 BESFileContainer (const string &sym_name, const string &real_name, const string &type)
 construct a container representing a file
 BESFileContainer (const BESFileContainer &copy_from)
 make a copy of the container
virtual ~BESFileContainer ()
virtual BESContainerptr_duplicate ()
 duplicate this instances of BESFileContainer
virtual string access ()
 returns the name of a file to access for this container, uncompressing if neccessary.
virtual bool release ()
 release the file
virtual void dump (ostream &strm) const
 Displays debug information about this object.
void set_constraint (const string &s)
 set the constraint for this container
void set_real_name (const string &real_name)
 set the real name for this container, such as a file name if reading a data file.
void set_container_type (const string &type)
 set the type of data that this container represents, such as cedar or netcdf.
void set_attributes (const string &attrs)
 set desired attributes for this container
string get_real_name () const
 retreive the real name for this container, such as a file name.
string get_constraint () const
 retrieve the constraint expression for this container
string get_symbolic_name () const
 retrieve the symbolic name for this container
string get_container_type () const
 retrieve the type of data this container holds, such as cedar or netcdf.
string get_attributes () const
 retrieve the attributes desired from this container

Protected Member Functions

virtual void _duplicate (BESContainer &copy_to)
 duplicate this instance into the passed container

Detailed Description

Holds real data, container type and constraint for symbolic name read from persistence.

A symbolic name is a name that represents a certain set of data, usually a file, and the type of data, such as cedar, netcdf, hdf, etc... Associated with this symbolic name during run time is the constraint associated with the name.

The symbolic name is looked up in persistence, such as a MySQL database, a file, or even in memory. The information retrieved from the persistent source is saved in the BESFileContainer and is used to execute the request from the client.

See also:
BESFileContainerStorage


Constructor & Destructor Documentation

BESFileContainer::BESFileContainer ( const string &  sym_name,
const string &  real_name,
const string &  type 
)

construct a container representing a file

Parameters:
sym_name symbolic name of the container
real_name real name of the container, a file name in this case
type type of the data represented in the file

BESFileContainer::BESFileContainer ( const BESFileContainer copy_from  ) 

make a copy of the container

Parameters:
copy_from The container to copy

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


Member Function Documentation

void BESFileContainer::_duplicate ( BESContainer copy_to  )  [protected, virtual]

duplicate this instance into the passed container

Parameters:
copy_to The container to copy this instance into

Reimplemented from BESContainer.

string BESFileContainer::access (  )  [virtual]

returns the name of a file to access for this container, uncompressing if neccessary.

Returns:
name of file to access

Implements BESContainer.

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

Displays debug information about this object.

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

Reimplemented from BESContainer.

string BESContainer::get_attributes (  )  const [inline, inherited]

retrieve the attributes desired from this container

Returns:
attributes desired from this container

string BESContainer::get_constraint (  )  const [inline, inherited]

retrieve the constraint expression for this container

Returns:
constraint expression for this execution for the symbolic name

string BESContainer::get_container_type (  )  const [inline, inherited]

retrieve the type of data this container holds, such as cedar or netcdf.

Returns:
type of data this container represents, such as cedar or netcdf

string BESContainer::get_real_name (  )  const [inline, inherited]

retreive the real name for this container, such as a file name.

Returns:
real name, such as file name

string BESContainer::get_symbolic_name (  )  const [inline, inherited]

retrieve the symbolic name for this container

Returns:
symbolic name for this container

BESContainer * BESFileContainer::ptr_duplicate (  )  [virtual]

duplicate this instances of BESFileContainer

Returns:
a copy of this instance

Implements BESContainer.

bool BESFileContainer::release (  )  [virtual]

release the file

If the file was cached (uncompressed) then we need to release the lock on the cached entry

Returns:
if successfully released, returns true, otherwise returns false

Implements BESContainer.

void BESContainer::set_attributes ( const string &  attrs  )  [inline, inherited]

set desired attributes for this container

Parameters:
attrs attributes desired to access for this container

void BESContainer::set_constraint ( const string &  s  )  [inline, inherited]

set the constraint for this container

Parameters:
s constraint

void BESContainer::set_container_type ( const string &  type  )  [inline, inherited]

set the type of data that this container represents, such as cedar or netcdf.

Parameters:
type type of data, such as cedar or netcdf

void BESContainer::set_real_name ( const string &  real_name  )  [inline, inherited]

set the real name for this container, such as a file name if reading a data file.

Parameters:
real_name real name, such as the file name


The documentation for this class was generated from the following files:
Generated on Fri Apr 11 15:15:14 2008 for OPeNDAP Back End Server (BES) by  doxygen 1.4.7