Grid Application Toolkit A simple API for Grid Applications

Menu Home API-Specification API-Overview Status C Reference Manual Download Java Java-Reference General GridLab - WP-1 Links

resources::SoftwareResourceDescription Class Reference An instance of this class is a description of a software resource, which may be required by a hardware or software component. More... Inheritance diagram for resources::SoftwareResourceDescription: [legend]Collaboration diagram for resources::SoftwareResourceDescription: [legend]List of all members. Public Methods   SoftwareResourceDescription (Map softwareResourceDescription, List softwareResourceDescriptions, List hardwareResourceDescriptions)   Constructs a SoftwareResourceDescription associated with the passed objects:. boolean  equals (Object object)   Tests this SoftwareResourceDescription for equality with the passed Object. Map  getDescription ()   Gets the SoftwareResourceDescription associated with this instance. void  setDescription (Map softwareResourceDescription)   Sets the SoftwareResourceDescription associated with this instance. void  addResourceAttribute (String name, Object value)   Adds the name/value pair to the java.util.Map of name/value pairs which describe the "parent" software component. void  removeResourceAttribute (String name)   Removes the name/value pair with the passed name from the java.util.Map of name/value pairs which describe the "parent" software component. void  addResourceDescription (ResourceDescription hardwareResourceDescription)   Adds the passed HardwareResourceDescription to the java.util.List of HardwareResourceDescriptions which describe this SoftwareResourceDescription. void  removeResourceDescription (ResourceDescription hardwareResourceDescription) throws NoSuchElementException   Removes the passed HardwareResourceDescription from the java.util.List of HardwareResourceDescriptions which describe this SoftwareResourceDescription. void  setHardwareResourceDescriptions (List hardwareResourceDescriptions)   Sets the java.util.List of HardwareResourceDescriptions which describe this SoftwareResourceDescription to the passed java.util.List. List  getHardwareResourceDescriptions ()   Gets the java.util.List of HardwareResourceDescriptions which describe this SoftwareResourceDescription. void  addSoftwareResourceDescription (SoftwareResourceDescription softwareResourceDescription)   Adds the passed SoftwareResourceDescription to the java.util.List of SoftwareResourceDescriptions which describe this SoftwareResourceDescription. void  removeSoftwareResourceDescription (SoftwareResourceDescription softwareResourceDescription)   Removes the passed SoftwareResourceDescription from the java.util.List of SoftwareResourceDescriptions which describe this SoftwareResourceDescription. void  setSoftwareResourceDescriptions (List softwareResourceDescriptions)   Sets the java.util.List of SoftwareResourceDescriptions which describe this SoftwareResourceDescription to the passed java.util.List. List  getSoftwareResourceDescriptions ()   Gets the java.util.List of SoftwareResourceDescriptions which describe this SoftwareResourceDescription. Private Attributes Map  softwareResourceDescription = null   This member variable holds the Map which describes the "parent" software component. List  softwareResourceDescriptions = null   This member variable holds a List of SoftwareResourceDescription's describing each of which describes a software component upon which the "parent" software component depends. List  hardwareResourceDescriptions = null   This member variable holds a List of HardwareResourceDescription's describing each of which describes a hardware component upon which the "parent" software component depends. Detailed Description An instance of this class is a description of a software resource, which may be required by a hardware or software component. It does not describe the application itself, the SoftwareDescription is used for that. To clarify this concept, let us give various examples. A software library is described by a SoftwareResourceDescription; a helper application is described by a SoftwareResourceDescription; a plugin is described a SoftwareResourceDescription... However, a piece of hardware is not described by a SoftwareResourceDescription. Software is generally useless without hardware. For example, a software driver without the appropriate Disk drive is all but useless. Similarly, software often depends upon other software. For example, having a Photoshop without any plugins is not of much use. Hence, in describing a software component one needs to also describe the software and hardware that this software component requires. This is reflected in the fact that a SoftwareResourceDescription contains in addition to a "parent" description of a software component a list of HardwareResourceDescriptions, each element of which describes a hardware component upon which the parent software component depends, and a list of SoftwareResourceDescriptions, each element of which describes a software component upon which the parent software component depends. Hence, the entire structure is recursive. To construct an instance of a SoftwareResourceDescription one requires three quantities: A map which contains a set of name/value pairs, detailed later, which describe a software resource. A list of SoftwareResourceDescription instances each of which describes a software resource upon which the parent software resource depends. A list of HardwareResourceDescription instances each of which describes a hardware resource upon which the parent software resource depends. The GAT-API defines a minimum set of supported name/value pairs which can be included in the map used to construct a SoftwareResourceDescription instance. This minimum set of name/value pairs MUST be supported by any implementation of the GAT-API. This minimum set of supported name/values is given in the table <TABLE border="2" frame="box" rules="groups" summary="Minimum set of supported name/value pairs"> <COLGROUP align="left"> <COLGROUP align="center"> <COLGROUP align="left" > <THEAD valign="top"> <TH>Name <TH>Type <TH>Description <TBODY> os.name java.lang.String The os name as returned from uname -s os.type java.lang.String The os type as returned from uname -p os.version java.lang.String The os version as returned from uname -v os.release java.lang.String The os release as returned from uname -r </TBODY> Definition at line 80 of file SoftwareResourceDescription.java. Constructor & Destructor Documentation resources::SoftwareResourceDescription::SoftwareResourceDescription (  Map    softwareResourceDescription, List    softwareResourceDescriptions, List    hardwareResourceDescriptions )  [inline]   Constructs a SoftwareResourceDescription associated with the passed objects:. SoftwareResourceDescription --- A java.util.Map, which describes the "parent" software component. SoftwareResourceDescriptions --- A java.util.List, which is a list of SoftwareResourceDescriptions each of which describes a software component upon which the "parent" software component depends. HardwareResourceDescriptions --- A java.util.List, which is a list of HardwareResourceDescriptions each of which describes a hardware component upon which the "parent" software component depends. Parameters: softwareResourceDescription  A java.util.Map, which describes the "parent" software component. softwareResourceDescriptions  A java.util.List, which is a list of SoftwareResourceDescriptions each of which describes a software component upon which the "parent" software component depends. hardwareResourceDescriptions  A java.util.List, which is a list of HardwareResourceDescriptions each of which describes a hardware component upon which the "parent" software component depends. Definition at line 127 of file SoftwareResourceDescription.java. References resources::SoftwareResourceDescription::hardwareResourceDescriptions, resources::SoftwareResourceDescription::softwareResourceDescription, and resources::SoftwareResourceDescription::softwareResourceDescriptions. Member Function Documentation boolean resources::SoftwareResourceDescription::equals (  Object    object )  [inline]   Tests this SoftwareResourceDescription for equality with the passed Object. If the given object is not a SoftwareResourceDescription, then this method immediately returns false. If the passed object is a SoftwareResourceDescription, then it is deemed equal if it has an equivalent SoftwareResourceDescription, as determined by the Equals method on java.util.Map, and an equivalent SoftwareResourceDescriptions, as determined by the Equals method on java.util.List, and an equivalent HardwareResourceDescriptions, as determined by the Equals method on java.util.List. Parameters: object  The Object to test for equality Returns: A boolean indicating equality Definition at line 152 of file SoftwareResourceDescription.java. References resources::SoftwareResourceDescription::hardwareResourceDescriptions, resources::SoftwareResourceDescription::softwareResourceDescription, and resources::SoftwareResourceDescription::softwareResourceDescriptions. Map resources::SoftwareResourceDescription::getDescription (    )  [inline]   Gets the SoftwareResourceDescription associated with this instance. Returns: A java.util.Map, the SoftwareResourceDescription associated with this instance Definition at line 179 of file SoftwareResourceDescription.java. References resources::SoftwareResourceDescription::softwareResourceDescription. void resources::SoftwareResourceDescription::setDescription (  Map    softwareResourceDescription )  [inline]   Sets the SoftwareResourceDescription associated with this instance. Parameters: The  new java.util.Map, the SoftwareResourceDescription associated with this instance Definition at line 190 of file SoftwareResourceDescription.java. References resources::SoftwareResourceDescription::softwareResourceDescription. void resources::SoftwareResourceDescription::addResourceAttribute (  String    name, Object    value )  [inline]   Adds the name/value pair to the java.util.Map of name/value pairs which describe the "parent" software component. Parameters: name  The Name, a java.lang.String, to add to the name/value pairs which describe the "parent" software component. value  The Value, an Object, to add to the name/value pairs which describe the "parent" software component. Definition at line 205 of file SoftwareResourceDescription.java. References resources::SoftwareResourceDescription::softwareResourceDescription. void resources::SoftwareResourceDescription::removeResourceAttribute (  String    name )  [inline]   Removes the name/value pair with the passed name from the java.util.Map of name/value pairs which describe the "parent" software component. Parameters: name  The Name, a java.lang.String, to of the name/value pair to remove from the name/value pairs which describe the "parent" software component. Definition at line 218 of file SoftwareResourceDescription.java. References resources::SoftwareResourceDescription::softwareResourceDescription. void resources::SoftwareResourceDescription::addResourceDescription (  ResourceDescription    hardwareResourceDescription )  [inline]   Adds the passed HardwareResourceDescription to the java.util.List of HardwareResourceDescriptions which describe this SoftwareResourceDescription. Parameters: hardwareResourceDescription  The HardwareResourceDescription to add to the java.util.List of HardwareResourceDescriptions which describe this SoftwareResourceDescription. Definition at line 232 of file SoftwareResourceDescription.java. References resources::SoftwareResourceDescription::hardwareResourceDescriptions. void resources::SoftwareResourceDescription::removeResourceDescription (  ResourceDescription    hardwareResourceDescription )  throws NoSuchElementException [inline]   Removes the passed HardwareResourceDescription from the java.util.List of HardwareResourceDescriptions which describe this SoftwareResourceDescription. Parameters: hardwareResourceDescription  The HardwareResourceDescription to remove from the java.util.List of HardwareResourceDescriptions which describe this SoftwareResourceDescription. Definition at line 247 of file SoftwareResourceDescription.java. References resources::SoftwareResourceDescription::hardwareResourceDescriptions. void resources::SoftwareResourceDescription::setHardwareResourceDescriptions (  List    hardwareResourceDescriptions )  [inline]   Sets the java.util.List of HardwareResourceDescriptions which describe this SoftwareResourceDescription to the passed java.util.List. Parameters: hardwareResourceDescriptions  The new java.util.List of HardwareResourceDescriptions which describe this SoftwareResourceDescription. Definition at line 261 of file SoftwareResourceDescription.java. References resources::SoftwareResourceDescription::hardwareResourceDescriptions. List resources::SoftwareResourceDescription::getHardwareResourceDescriptions (    )  [inline]   Gets the java.util.List of HardwareResourceDescriptions which describe this SoftwareResourceDescription. Returns: The java.util.List of HardwareResourceDescriptions which describe this SoftwareResourceDescription. Definition at line 273 of file SoftwareResourceDescription.java. References resources::SoftwareResourceDescription::hardwareResourceDescriptions. void resources::SoftwareResourceDescription::addSoftwareResourceDescription (  SoftwareResourceDescription    softwareResourceDescription )  [inline]   Adds the passed SoftwareResourceDescription to the java.util.List of SoftwareResourceDescriptions which describe this SoftwareResourceDescription. Parameters: softwareResourceDescription  The SoftwareResourceDescription to add to the java.util.List of SoftwareResourceDescriptions which describe this SoftwareResourceDescription. Definition at line 287 of file SoftwareResourceDescription.java. References resources::SoftwareResourceDescription::softwareResourceDescription, and resources::SoftwareResourceDescription::softwareResourceDescriptions. void resources::SoftwareResourceDescription::removeSoftwareResourceDescription (  SoftwareResourceDescription    softwareResourceDescription )  [inline]   Removes the passed SoftwareResourceDescription from the java.util.List of SoftwareResourceDescriptions which describe this SoftwareResourceDescription. Parameters: softwareResourceDescription  The SoftwareResourceDescription to remove from the java.util.List of SoftwareResourceDescriptions which describe this SoftwareResourceDescription. Definition at line 302 of file SoftwareResourceDescription.java. References resources::SoftwareResourceDescription::softwareResourceDescription, and resources::SoftwareResourceDescription::softwareResourceDescriptions. void resources::SoftwareResourceDescription::setSoftwareResourceDescriptions (  List    softwareResourceDescriptions )  [inline]   Sets the java.util.List of SoftwareResourceDescriptions which describe this SoftwareResourceDescription to the passed java.util.List. Parameters: softwareResourceDescriptions  The new java.util.List of SoftwareResourceDescriptions which describe this SoftwareResourceDescription. Definition at line 315 of file SoftwareResourceDescription.java. References resources::SoftwareResourceDescription::softwareResourceDescriptions. List resources::SoftwareResourceDescription::getSoftwareResourceDescriptions (    )  [inline]   Gets the java.util.List of SoftwareResourceDescriptions which describe this SoftwareResourceDescription. Returns: The java.util.List of SoftwareResourceDescriptions which describe this SoftwareResourceDescription. Definition at line 327 of file SoftwareResourceDescription.java. References resources::SoftwareResourceDescription::softwareResourceDescriptions. Member Data Documentation Map resources::SoftwareResourceDescription::softwareResourceDescription = null [private]   This member variable holds the Map which describes the "parent" software component. Definition at line 86 of file SoftwareResourceDescription.java. Referenced by resources::SoftwareResourceDescription::addResourceAttribute(), resources::SoftwareResourceDescription::addSoftwareResourceDescription(), resources::SoftwareResourceDescription::equals(), resources::SoftwareResourceDescription::getDescription(), resources::SoftwareResourceDescription::removeResourceAttribute(), resources::SoftwareResourceDescription::removeSoftwareResourceDescription(), resources::SoftwareResourceDescription::setDescription(), and resources::SoftwareResourceDescription::SoftwareResourceDescription(). List resources::SoftwareResourceDescription::softwareResourceDescriptions = null [private]   This member variable holds a List of SoftwareResourceDescription's describing each of which describes a software component upon which the "parent" software component depends. Definition at line 93 of file SoftwareResourceDescription.java. Referenced by resources::SoftwareResourceDescription::addSoftwareResourceDescription(), resources::SoftwareResourceDescription::equals(), resources::SoftwareResourceDescription::getSoftwareResourceDescriptions(), resources::SoftwareResourceDescription::removeSoftwareResourceDescription(), resources::SoftwareResourceDescription::setSoftwareResourceDescriptions(), and resources::SoftwareResourceDescription::SoftwareResourceDescription(). List resources::SoftwareResourceDescription::hardwareResourceDescriptions = null [private]   This member variable holds a List of HardwareResourceDescription's describing each of which describes a hardware component upon which the "parent" software component depends. Definition at line 100 of file SoftwareResourceDescription.java. Referenced by resources::SoftwareResourceDescription::addResourceDescription(), resources::SoftwareResourceDescription::equals(), resources::SoftwareResourceDescription::getHardwareResourceDescriptions(), resources::SoftwareResourceDescription::removeResourceDescription(), resources::SoftwareResourceDescription::setHardwareResourceDescriptions(), and resources::SoftwareResourceDescription::SoftwareResourceDescription(). The documentation for this class was generated from the following file: SoftwareResourceDescription.java