|
| |
|
| org.griphyn.cPlanner.namespace.Namespace
 org.griphyn.cPlanner.namespace.Dagman
| Dagman | | public class Dagman extends Namespace (Code) | | This profile namespace is the placeholder for the keys that go into the .dag
file . Keys like RETRY that trigger retries in dagman in the event of a job
failing would go in here.
All the keys stored in it are in UPPERCASE irrespective of the case specified
by the user in the various catalogs. To specify a post script or a pre script
use POST and PRE keys.
author:
Karan Vahi
author:
Gaurang Mehta
version:
$Revision: 50 $ |
| Field Summary | |
| final public static String | JOB_KEY
The name of the key that indicates the path to the corresponding
submit file for the job. | | final public static String | NAMESPACE_NAME
The name of the namespace that this class implements. | | final public static String | OUTPUT_KEY
The name of the key that determines the file on the submit host on
which postscript is to be invoked. | | final public static String | POST_SCRIPT_ARGUMENTS_KEY
The name of the key that determines the arguments that need to be passed
to the postscript. | | final public static String | POST_SCRIPT_KEY
The name of the key that determines what post script is to be invoked
when the job completes. | | final public static String | PRE_SCRIPT_ARGUMENTS_KEY
The name of the key that determines the arguments that need to be passed
to the postscript. | | final public static String | PRE_SCRIPT_KEY
The name of the key that determines what pre script is to be invoked
when the job is run. | | final public static String | RETRY_KEY
The name of the key that determines how many times DAGMAN should be
retrying the job. | | protected String | mNamespace
The name of the implementing namespace. |
| Constructor Summary | |
| public | Dagman()
The default constructor. | | public | Dagman(Map mp)
The overloaded constructor. | | public | Dagman(Map mp, String name)
The overloaded constructor. |
| Method Summary | |
| public int | checkKey(String key, String value)
This checks whether the key passed by the user is valid in the current
namespace or not. | | public void | checkKeyInNS(PegasusProperties properties, String pool)
It puts in the namespace specific information specified in the properties
file into the namespace. | | public Object | clone()
Returns a copy of the current namespace object. | | public void | construct(String key, String value)
Constructs a new element of the format (key=value). | | public void | merge(Namespace profiles)
Merge the profiles in the namespace in a controlled manner. | | public String | namespaceName()
Returns the name of the namespace associated with the profile implementations. | | public void | setJobName(String name)
It sets the name of the job that is associated with the profiles contained
in this placeholder. | | public String | toString()
Converts the contents of the map into the string that can be put in the
Condor file for printing. | | public String | toString(String name)
Converts the contents of the map into the string that can be put in the
Condor file for printing.
Parameters:
name - the name of the condor job that contains these variables. |
| JOB_KEY | | final public static String JOB_KEY(Code) | | The name of the key that indicates the path to the corresponding
submit file for the job.
|
| NAMESPACE_NAME | | final public static String NAMESPACE_NAME(Code) | | The name of the namespace that this class implements.
|
| OUTPUT_KEY | | final public static String OUTPUT_KEY(Code) | | The name of the key that determines the file on the submit host on
which postscript is to be invoked.
|
| POST_SCRIPT_ARGUMENTS_KEY | | final public static String POST_SCRIPT_ARGUMENTS_KEY(Code) | | The name of the key that determines the arguments that need to be passed
to the postscript.
|
| POST_SCRIPT_KEY | | final public static String POST_SCRIPT_KEY(Code) | | The name of the key that determines what post script is to be invoked
when the job completes.
|
| PRE_SCRIPT_ARGUMENTS_KEY | | final public static String PRE_SCRIPT_ARGUMENTS_KEY(Code) | | The name of the key that determines the arguments that need to be passed
to the postscript.
|
| PRE_SCRIPT_KEY | | final public static String PRE_SCRIPT_KEY(Code) | | The name of the key that determines what pre script is to be invoked
when the job is run.
|
| RETRY_KEY | | final public static String RETRY_KEY(Code) | | The name of the key that determines how many times DAGMAN should be
retrying the job.
|
| Dagman | | public Dagman()(Code) | | The default constructor.
We always initialize the map, as the map is guarenteed to store at least
the postscript value for a job.
|
| Dagman | | public Dagman(Map mp)(Code) | | The overloaded constructor.
Parameters:
mp - the initial map containing the profile keys for this namespace. |
| Dagman | | public Dagman(Map mp, String name)(Code) | | The overloaded constructor.
Parameters:
mp - the initial map containing the profile keys for this namespace.
Parameters:
name - name of the job with which these profile keys are associated. |
| checkKey | | public int checkKey(String key, String value)(Code) | | This checks whether the key passed by the user is valid in the current
namespace or not. All keys are assumed valid currently.
Parameters:
key - (left hand side)
Parameters:
value - (right hand side) Namespace.VALID_KEY |
| checkKeyInNS | | public void checkKeyInNS(PegasusProperties properties, String pool)(Code) | | It puts in the namespace specific information specified in the properties
file into the namespace. The profile information is populated only if the
corresponding key does not exist in the object already.
Parameters:
properties - the PegasusProperties object containingall the properties that the user specified at variousplaces (like .chimerarc, properties file, command line).
Parameters:
pool - the pool name where the job is scheduled to run. |
| clone | | public Object clone()(Code) | | Returns a copy of the current namespace object.
the Cloned object |
| construct | | public void construct(String key, String value)(Code) | | Constructs a new element of the format (key=value).
The underlying map is allocated memory in the constructors always.
All the keys are converted to UPPER CASE before storing.
Parameters:
key - is the left-hand-side
Parameters:
value - is the right hand side |
| merge | | public void merge(Namespace profiles)(Code) | | Merge the profiles in the namespace in a controlled manner.
In case of intersection, the new profile value overrides, the existing
profile value.
Parameters:
profiles - the Namespace object containing the profiles. |
| namespaceName | | public String namespaceName()(Code) | | Returns the name of the namespace associated with the profile implementations.
the namespace name.
See Also: Dagman.NAMESPACE_NAME |
| setJobName | | public void setJobName(String name)(Code) | | It sets the name of the job that is associated with the profiles contained
in this placeholder.
Parameters:
name - name of the job with which these profile keys are associated. |
| toString | | public String toString()(Code) | | Converts the contents of the map into the string that can be put in the
Condor file for printing.
the the textual description. |
| toString | | public String toString(String name)(Code) | | Converts the contents of the map into the string that can be put in the
Condor file for printing.
Parameters:
name - the name of the condor job that contains these variables. the textual description. |
|
|
|