|
| |
|
| java.lang.Object
 org.griphyn.cPlanner.classes.WorkDir
| WorkDir | | public class WorkDir (Code) | | This is a data class that is used to store information about the scratch
work directory or the execution mount point on the remote pool.
The various attributes that can be associated with the work directory
displayed in the following table.
| Attribute Name | Attribute Description |
|---|
| path |
the absolute path on the remote site to the work directory. |
|---|
| total size |
the total scratch space available under the work directory. |
|---|
| free size |
the free space available under the work directory. |
|---|
author:
Gaurang Mehta gmehta@isi.edu
author:
Karan Vahi vahi@isi.edu
version:
$Revision: 109 $ |
| Field Summary | |
| final public static int | FREE_SIZE
The constant to be passed to the accessor functions to get or set the
free space available. | | final public static int | TOTAL_SIZE
The constant to be passed to the accessor functions to get or set the
total space available. | | final public static int | WORKDIR
The constant to be passed to the accessor functions to get or set the
path to the work directory. | | final public static String[] | WORKDIRINFO
Array storing the names of the attributes that are stored with the
work directory. |
| Constructor Summary | |
| public | WorkDir()
The default constructor. |
| Method Summary | |
| public String | getInfo(int key)
Returns the attribute value of a particular attribute of the work
directory.
Parameters:
key - the key/attribute name. | | public void | setInfo(int key, String value)
Sets an attribute associated with the work directory. | | public String | toMultiLine()
Returns the textual description of the contents of WorkDir
object in the multiline format. | | public String | toString()
Returns the textual description of the contents of WorkDir
object. | | public String | toXML()
Returns the XML description of the contents of WorkDir
object. |
| FREE_SIZE | | final public static int FREE_SIZE(Code) | | The constant to be passed to the accessor functions to get or set the
free space available.
|
| TOTAL_SIZE | | final public static int TOTAL_SIZE(Code) | | The constant to be passed to the accessor functions to get or set the
total space available.
|
| WORKDIR | | final public static int WORKDIR(Code) | | The constant to be passed to the accessor functions to get or set the
path to the work directory.
|
| WORKDIRINFO | | final public static String[] WORKDIRINFO(Code) | | Array storing the names of the attributes that are stored with the
work directory.
|
| WorkDir | | public WorkDir()(Code) | | The default constructor. Sets all the variables to null.
|
| getInfo | | public String getInfo(int key)(Code) | | Returns the attribute value of a particular attribute of the work
directory.
Parameters:
key - the key/attribute name. the attribute value
throws:
RuntimeException - if illegal key defined. |
| setInfo | | public void setInfo(int key, String value) throws RuntimeException(Code) | | Sets an attribute associated with the work directory.
Parameters:
key - the attribute key, which is one of the predefined keys.
Parameters:
value - value of the attribute.
throws:
Exception - if illegal key defined. |
| toMultiLine | | public String toMultiLine()(Code) | | Returns the textual description of the contents of WorkDir
object in the multiline format.
the textual description in multiline format. |
| toString | | public String toString()(Code) | | Returns the textual description of the contents of WorkDir
object.
the textual description. |
| toXML | | public String toXML()(Code) | | Returns the XML description of the contents of WorkDir
object.
the xml description. |
|
|
|