| java.lang.Object
 org.griphyn.cPlanner.classes.PoolConfig
| PoolConfig | | public class PoolConfig (Code) | | A data class to store information about the various remote sites.
author:
Gaurang Mehta
author:
Karan Vahi
version:
$Revision: 50 $
See Also: SiteInfo |
| Constructor Summary | |
| public | PoolConfig()
The default constructor. |
| Method Summary | |
| public void | add(String id, SiteInfo site)
Adds a SiteInfo object to the container. | | public void | add(PoolConfig sites)
Adds all the sites in a controlled fashion, to the existing map containing
information about the sites. | | public void | add(PoolConfig sites, boolean overwrite)
Adds all the sites in a controlled fashion, to the existing map containing
information about the sites.
Parameters:
sites - a map indexed by siteid. | | public boolean | contains(String id)
Returns a boolean indicating if an entry for a Site with a particular id
exists or not.
Parameters:
id - the id of the site, usually the name of the site. | | public SiteInfo | get(String siteID)
Retrives the information about a site.
Parameters:
siteID - the id of the site, usually the name of the site. | | public Map | getSites()
Returns information about all the sites.
a Map indexed by the site id (name of the site). | | public String | toMultiLine()
Returns the textual description of the contents of PoolConfig
object in the multiline format. | | public String | toXML()
Returns the XML description of the contents of PoolConfig
object. |
| PoolConfig | | public PoolConfig()(Code) | | The default constructor.
|
| add | | public void add(String id, SiteInfo site)(Code) | | Adds a SiteInfo object to the container. If an entry already exists with
the same SiteID, it is overwritten.
Parameters:
id - the id of the site, usually the name of the site.
Parameters:
site - the SiteInfo object containing the informationabout the site. |
| add | | public void add(PoolConfig sites)(Code) | | Adds all the sites in a controlled fashion, to the existing map containing
information about the sites. If an information about a site already
exists, it is overwritten.
Parameters:
sites - a map indexed by siteid. Each value is a SiteInfo object. |
| add | | public void add(PoolConfig sites, boolean overwrite)(Code) | | Adds all the sites in a controlled fashion, to the existing map containing
information about the sites.
Parameters:
sites - a map indexed by siteid. Each value is a SiteInfo object.
Parameters:
overwrite - resolves intersections, in case of a site already exists.If true, the orginal site information is overwritten withthe new one. If false original site information remains. |
| contains | | public boolean contains(String id)(Code) | | Returns a boolean indicating if an entry for a Site with a particular id
exists or not.
Parameters:
id - the id of the site, usually the name of the site. true if entry for the site exists, else false. |
| get | | public SiteInfo get(String siteID)(Code) | | Retrives the information about a site.
Parameters:
siteID - the id of the site, usually the name of the site. SiteInfo containing the site layout,else null in case of site not existing. |
| getSites | | public Map getSites()(Code) | | Returns information about all the sites.
a Map indexed by the site id (name of the site). Each value is aSiteInfo object. |
| toMultiLine | | public String toMultiLine()(Code) | | Returns the textual description of the contents of PoolConfig
object in the multiline format.
the textual description in multiline format. |
| toXML | | public String toXML()(Code) | | Returns the XML description of the contents of PoolConfig
object.
the xml description. |
|
|