Resource Class Reference

Associate a rule with an ancillary resource. More...

#include <Resource.h>

Collaboration diagram for Resource:

Collaboration graph
[legend]
List of all members.

Public Types

 fallback
 overwrite
 replace
enum  rule { overwrite, replace, fallback }
 How are ancillary resources used. More...

Public Member Functions

virtual Resource::rule get_rule () const
virtual string get_url () const
 Resource (const string &u, const string &r) throw (Error)
 Resource (const string &u, const rule &r)
 Resource (const string &u)
 Resource ()
virtual void set_rule (const Resource::rule &r)
virtual void set_url (const string &u)
virtual ~Resource ()

Friends

ostream & operator<< (ostream &os, const Resource &r)

Detailed Description

Bind an ancillary resource with the rule that should be used when combining it with a primary resource. Ancillary resources are always specified using URLs. If an ancillary resource is a local file, use file:// URLs.

Note that operator<< is defined for Resource as a function.

Author:
James Gallagher <jgallagher@opendap.org>

Definition at line 47 of file Resource.h.


Member Enumeration Documentation

enum Resource::rule

The AIS uses this enumeration to describe how a given ancillary should be merged into a primary data source.

Author:
James Gallagher <jgallagher@opendap.org>
Enumerator:
overwrite 
replace 
fallback 

Definition at line 68 of file Resource.h.


Constructor & Destructor Documentation

Resource::Resource (  )  [inline]

Build a Resource with a null URL and set the combination rule to the default.

Definition at line 72 of file Resource.h.

Resource::Resource ( const string &  u  )  [inline]

Build a resource. Set the combination rule to the default value, which is overwrite.

Parameters:
u The ancillary resource URL.

Definition at line 78 of file Resource.h.

Resource::Resource ( const string &  u,
const rule r 
) [inline]

Build a Resource.

Parameters:
u The ancillary resource URL.
r The combination rule.

Definition at line 84 of file Resource.h.

Resource::Resource ( const string &  u,
const string &  r 
) throw (Error) [inline]

Build a Resource.

Note: If this is used in a callback, make sure to check the value of r before calling this constructor. Exceptions thrown within callbacks are not portable. Valid values are "overwrite", "replace" and "fallback". The constructor accepts "default" as a synonym for "overwrite".

Parameters:
u The ancillary resource URL.
r The name of the combination rule.

Definition at line 97 of file Resource.h.

References fallback, overwrite, and replace.

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

Definition at line 109 of file Resource.h.


Member Function Documentation

virtual Resource::rule Resource::get_rule (  )  const [inline, virtual]

Return combination rule for this resource.

Definition at line 126 of file Resource.h.

virtual string Resource::get_url (  )  const [inline, virtual]

Return the resource URL.

Definition at line 113 of file Resource.h.

virtual void Resource::set_rule ( const Resource::rule r  )  [inline, virtual]

Set the resource's combination rule.

Parameters:
r The combination rule.

Definition at line 133 of file Resource.h.

virtual void Resource::set_url ( const string &  u  )  [inline, virtual]

Set the resource URL.

Parameters:
u The resource's URL.

Definition at line 120 of file Resource.h.


Friends And Related Function Documentation

ostream& operator<< ( ostream &  os,
const Resource r 
) [friend]

Output the XML fragment for a Resource. This function is a friend of the Resource class.

See also:
Resource.

Definition at line 42 of file AISResources.cc.


The documentation for this class was generated from the following file:
Generated on Wed Jun 27 12:58:19 2007 for libdap++ by  doxygen 1.4.7