GridLab
Grid Application Toolkit

A simple API for Grid Applications 		GAT
Menu


Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members  

advert::AdvertService Class Reference

Inheritance diagram for advert::AdvertService:

Inheritance graph
[legend]
Collaboration diagram for advert::AdvertService:

Collaboration graph
[legend]
List of all members.

Public Methods

 AdvertService (GATContext gatContext)
 Create an instance of the AdvertService.

 AdvertService (GATContext gatContext, Preferences preferences)
 Create an instance of the AdvertService using the provided preference.

void add (Advertisable advert, Map metaData, String path)
 Add an Advertizable instance and related meta data to the GATAdvertService, at path (absolute or relative to PWD).

void delete (String path) throws NoSuchElementException
 Remove an Advertizable instance and related meta data from the GATAdvertService, at path (absolute or relative to PWD).

Map getMetaData (String path) throws NoSuchElementException
String[] find (Map metaData)
 Query the GATAdvertService for entries matching the specified set of meta data.

void setPWD (String path)
 Specify the element of the GATAdvertService namespace to be used as reference for relative paths.

String getPWD ()
 Returns the current element of the GATAdvertService namespace used as reference for relative paths.

void addMetricListener (MetricListener metricListener, Metric metric) throws RemoteException
void removeMetricListener (MetricListener metricListener, Metric metric) throws RemoteException
List getMetrics () throws RemoteException

Detailed Description

Author:
rob
The GATAdvertService allows GATAdvertisable instances to get published to and queried in an advert directory. Such an advert directory is a meta data directory with an hierarchical namespace attached.

Definition at line 25 of file AdvertService.java.

Constructor & Destructor Documentation

advert::AdvertService::AdvertService (  GATContext    gatContext )  [inline]
 

Create an instance of the AdvertService.

Parameters:
gatContext  The context to use.

Definition at line 31 of file AdvertService.java.

advert::AdvertService::AdvertService (  GATContext    gatContext,
Preferences    preferences
)  [inline]
 

Create an instance of the AdvertService using the provided preference.

Parameters:
gatContext  The context to use.
preferences  The user preferences.

Definition at line 40 of file AdvertService.java.

Member Function Documentation

void advert::AdvertService::add (  Advertisable    advert,
Map    metaData,
String    path
)  [inline]
 

Add an Advertizable instance and related meta data to the GATAdvertService, at path (absolute or relative to PWD).

If an GATAdvertService entry exists at the specified path, that entry gets overwritten, and a warning is issued.

Parameters:
Advert  instance to be entered into the GATAdvertService.
metaData  Meta data to be associated with the passed GATAdvertiseable.
path  Path (either absolute or relative to PWD) of the new entry.

Definition at line 54 of file AdvertService.java.

References org::gridlab::gat::resources::Advertisable.

void advert::AdvertService::delete (  String    path )  throws NoSuchElementException [inline]
 

Remove an Advertizable instance and related meta data from the GATAdvertService, at path (absolute or relative to PWD).

If

Parameters:
path  Path (either absolute or relative to PWD) of the entry to be deleted.
Exceptions:
NoSuchElementException  The path is incorrect.

Definition at line 65 of file AdvertService.java.

Map advert::AdvertService::getMetaData (  String    path )  throws NoSuchElementException [inline]
 

Parameters:
path  Path (either absolute or relative to PWD) of the entry.
Returns:
A map containing the metadata.
Exceptions:
NoSuchElementException  The path is incorrect.

Definition at line 74 of file AdvertService.java.

String [] advert::AdvertService::find (  Map    metaData )  [inline]
 

Query the GATAdvertService for entries matching the specified set of meta data.

The returned paths can be destroyed at any time.

Parameters:
metaData  Meta data describing the entries to be searched for.
Returns:
Paths, each pointing to a matching entry. If no mathces are found, null is returned.

Definition at line 85 of file AdvertService.java.

void advert::AdvertService::setPWD (  String    path )  [inline]
 

Specify the element of the GATAdvertService namespace to be used as reference for relative paths.

Parameters:
path  New absolute or relative reference path.

Definition at line 94 of file AdvertService.java.

String advert::AdvertService::getPWD (    )  [inline]
 

Returns the current element of the GATAdvertService namespace used as reference for relative paths.

Returns:
Absolute reference path.

Definition at line 103 of file AdvertService.java.

void advert::AdvertService::addMetricListener (  MetricListener    metricListener,
Metric    metric
)  throws RemoteException [inline]
 

Definition at line 107 of file AdvertService.java.

void advert::AdvertService::removeMetricListener (  MetricListener    metricListener,
Metric    metric
)  throws RemoteException [inline]
 

Definition at line 112 of file AdvertService.java.

List advert::AdvertService::getMetrics (    )  throws RemoteException [inline]
 

Definition at line 117 of file AdvertService.java.

The documentation for this class was generated from the following file: