| org.griphyn.vdl.classes.VDL
 org.griphyn.vdl.classes.Profile
| Profile | | public class Profile extends VDL implements Serializable(Code) | | A Profile captures scheduler system and application
environment specific stuff in a uniform fashion. Each profile
declaration assigns a value to a key within a namespace. As of
this writing, valid namespaces are
- vds
- Virtual Data System specific material, currently empty.
- condor
- If the job runs in using the
Condor scheduler,
certain items like the "universe" or "requirments" can be set.
Please note that currently the universe is provided as a hint
to the
Transformation itself.
- dagman
- The job graph will usually be run by Condor DAGMan. Some issues,
e.g. the number of retries, are specific to DAGMan and not Condor.
- env
- The Unix environment variables that are required for the job.
- hints
- A new section collecting various hints that are passed between
planners.
In the future, more namespaces may be added.
author:
Jens-S. Vöckler
author:
Yong Zhao
version:
$Revision: 50 $ |
| Constructor Summary | |
| public | Profile()
Array ctor. | | public | Profile(String namespace, String key)
Standard ctor: set up everything except a value of the ns.key pair. | | public | Profile(String namespace, String key, Leaf firstChild)
Convenience ctor: set up the first piece of the value in one go.
Parameters:
namespace - is the namespace within which to operate.
Parameters:
key - is an identifier unique within the namespace.
Parameters:
firstChild - is the first fragment of the value. | | public | Profile(String namespace, String key, Collection children)
Convenience ctor: set up the first piece of the value in one go.
Parameters:
namespace - is the namespace within which to operate.
Parameters:
key - is an identifier unique within the namespace.
Parameters:
children - is a collection of fragments for the value. |
| Method Summary | |
| public void | addLeaf(Leaf vLeaf)
Accessor: Append a value fragment to this profile instance.
Parameters:
vLeaf - is the fragment to add. | | public void | addLeaf(int index, Leaf vLeaf)
Accessor: Inserts a Leaf value into a specific position
of the list of gathered values.
Parameters:
index - is the position to insert the item into
Parameters:
vLeaf - is the value to append to the list. | | public Enumeration | enumerateLeaf()
Accessor: Enumerates the internal values that constitute the content
of the Profile value. | | public String | getKey()
Accessor: Gets the key identifier for the profile. | | public Leaf | getLeaf(int index)
Accessor: Obtains the Leaf at a certain position in the
list of profile value fragments. | | public Leaf[] | getLeaf()
Accessor: Gets an array of all values that constitute the current
value content of a profile. | | public int | getLeafCount()
Accessor: Obtains the number of profile value fragments. | | public java.util.List | getLeafList()
Accessor: Gets an array of all values that constitute the current
content. | | public String | getNamespace()
Accessor: Gets the namespace value for the profile. | | public Iterator | iterateLeaf()
Accessor: Enumerates the internal values that constitute the content
of the Scalar element. | | public ListIterator | listIterateLeaf()
Accessor: Enumerates the internal values that constitute the content
of the Scalar element. | | public ListIterator | listIterateLeaf(int start)
Accessor: Enumerates the internal values that constitute the content
of the Scalar element. | | public void | removeAllLeaf()
Accessor: Removes all value fragments from the profile. | | public Leaf | removeLeaf(int index)
Accessor: Remove a single fragment from the list of value fragments.
Parameters:
index - is the position at which an element is to be removed. | | public void | setKey(String key)
Accessor: Adjusts the identifier within a namespace.
Parameters:
key - is the new identifier to use from now on. | | public void | setLeaf(int index, Leaf vLeaf)
Accessor: Overwrites a Use or Text value
fragment at a certain position in the profile value fragment list. | | public void | setLeaf(Leaf[] leafArray)
Accessor: Overwrites internal value fragments list with an external
list representing a profile value. | | public void | setLeaf(Collection leaves)
Accessor: Overwrites internal list with an external list representing
a Scalar value. | | public void | setNamespace(String namespace)
Accessor: Adjusts a namespace value to a new state. | | public String | toString()
Converts the profile state into textual format for human consumption. | | public void | toString(Writer stream)
Converts the active state into something meant for human consumption.
The method will be called when recursively traversing the instance
tree. | | public void | toXML(Writer stream, String indent, String namespace)
Dump the state of the current element as XML output. |
| Profile | | public Profile()(Code) | | Array ctor.
|
| Profile | | public Profile(String namespace, String key)(Code) | | Standard ctor: set up everything except a value of the ns.key pair.
Parameters:
namespace - is the namespace within which to operate.
Parameters:
key - is an identifier unique within the namespace. |
| Profile | | public Profile(String namespace, String key, Leaf firstChild)(Code) | | Convenience ctor: set up the first piece of the value in one go.
Parameters:
namespace - is the namespace within which to operate.
Parameters:
key - is an identifier unique within the namespace.
Parameters:
firstChild - is the first fragment of the value. OnlyLeafs of type Use or Textare permissable.
See Also: Leaf
See Also: Use
See Also: Text |
| Profile | | public Profile(String namespace, String key, Collection children)(Code) | | Convenience ctor: set up the first piece of the value in one go.
Parameters:
namespace - is the namespace within which to operate.
Parameters:
key - is an identifier unique within the namespace.
Parameters:
children - is a collection of fragments for the value. OnlyLeafs of type Filename orPseudoText are permissable.
See Also: Leaf
See Also: Use
See Also: Text
See Also: |
| enumerateLeaf | | public Enumeration enumerateLeaf()(Code) | | Accessor: Enumerates the internal values that constitute the content
of the Profile value.
the iterator to the value fragment list. |
| getLeaf | | public Leaf getLeaf(int index) throws IndexOutOfBoundsException(Code) | | Accessor: Obtains the Leaf at a certain position in the
list of profile value fragments.
Parameters:
index - is the position in the list to obtain a value from The Use or Text at the position.
throws:
IndexOutOfBoundsException - if the index points to an elementin the list that does not contain any elments.
See Also: Use
See Also: Text |
| getLeaf | | public Leaf[] getLeaf()(Code) | | Accessor: Gets an array of all values that constitute the current
value content of a profile. This array is a copy to avoid
write-through modifications.
an array with a mixture of either Text orUse values.
See Also: Use
See Also: Text
See Also: |
| getLeafCount | | public int getLeafCount()(Code) | | Accessor: Obtains the number of profile value fragments.
number of elements that an external array needs to be sized to. |
| getLeafList | | public java.util.List getLeafList()(Code) | | Accessor: Gets an array of all values that constitute the current
content. This list is read-only.
an array with a mixture of either Text orLFN values.
See Also: LFN
See Also: Text |
| iterateLeaf | | public Iterator iterateLeaf()(Code) | | Accessor: Enumerates the internal values that constitute the content
of the Scalar element.
an iterator to walk the list with. |
| listIterateLeaf | | public ListIterator listIterateLeaf()(Code) | | Accessor: Enumerates the internal values that constitute the content
of the Scalar element.
an enumeration to walk the list with. |
| listIterateLeaf | | public ListIterator listIterateLeaf(int start)(Code) | | Accessor: Enumerates the internal values that constitute the content
of the Scalar element.
Parameters:
start - is the start index an enumeration to walk the list with. |
| removeAllLeaf | | public void removeAllLeaf()(Code) | | Accessor: Removes all value fragments from the profile.
|
| removeLeaf | | public Leaf removeLeaf(int index)(Code) | | Accessor: Remove a single fragment from the list of value fragments.
Parameters:
index - is the position at which an element is to be removed. the object that was removed. The removed item is either anUse or a Text.
See Also: Use
See Also: Text |
| setKey | | public void setKey(String key)(Code) | | Accessor: Adjusts the identifier within a namespace.
Parameters:
key - is the new identifier to use from now on.
See Also: Profile.getKey() |
| setLeaf | | public void setLeaf(Leaf[] leafArray)(Code) | | Accessor: Overwrites internal value fragments list with an external
list representing a profile value.
Parameters:
leafArray - is the external list of Text orUse objects used to overwrite things.
See Also: Text
See Also: Use |
| setLeaf | | public void setLeaf(Collection leaves)(Code) | | Accessor: Overwrites internal list with an external list representing
a Scalar value.
Parameters:
leaves - is the external list of Text orLFN objects used to overwrite things.
See Also: Text
See Also: LFN |
| setNamespace | | public void setNamespace(String namespace)(Code) | | Accessor: Adjusts a namespace value to a new state.
Parameters:
namespace - is the new namespace to use.
See Also: Profile.getNamespace() |
| toString | | public String toString()(Code) | | Converts the profile state into textual format for human consumption.
a textual description of the element and its sub-classes.Be advised that these strings might become large. |
| toString | | public void toString(Writer stream) throws IOException(Code) | | Converts the active state into something meant for human consumption.
The method will be called when recursively traversing the instance
tree.
Parameters:
stream - is a stream opened and ready for writing. This can alsobe a string stream for efficient output.
exception:
IOException - if something fishy happens to the stream. |
| toXML | | public void toXML(Writer stream, String indent, String namespace) throws IOException(Code) | | Dump the state of the current element as XML output. This function
traverses all sibling classes as necessary, and converts the data
into pretty-printed XML output. The stream interface should be able
to handle large output efficiently, if you use a buffered writer.
Parameters:
stream - is a stream opened and ready for writing. This can alsobe a string stream for efficient output.
Parameters:
indent - is a String of spaces used for prettyprinting. The initial amount of spaces should be an empty string.The parameter is used internally for the recursive traversal.If a null value is specified, no indentation norlinefeeds will be generated.
Parameters:
namespace - is the XML schema namespace prefix. If neitherempty nor null, each element will be prefixed with this prefix,and the root element will map the XML namespace.
exception:
IOException - if something fishy happens to the stream. |
|
|