org.griphyn.vdl.classes
Class Profile

java.lang.Object
  org.griphyn.vdl.Chimera
      org.griphyn.vdl.classes.VDL
          org.griphyn.vdl.classes.Profile

All Implemented Interfaces:

Serializable

public class Profile
extends VDL
implements Serializable

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.

Version:

$Revision: 50 $

Author:

Jens-S. V??ckler, Yong Zhao

See Also:

Serialized Form

Field Summary

private static String	c_error_message Throws this message, if neither <text> nor <use> elements are tried to be added.
private String	m_key The identifier within a namespace.
private ArrayList	m_leafList The value to above keys.
private String	m_namespace The namespace of a profile.

Constructor Summary

Profile()
Array ctor.

Profile(String namespace, String key)
Standard ctor: set up everything except a value of the ns.key pair.

Profile(String namespace, String key, Collection children)
Convenience ctor: set up the first piece of the value in one go.

Profile(String namespace, String key, Leaf firstChild)
Convenience ctor: set up the first piece of the value in one go.

Method Summary

void	addLeaf(int index, Leaf vLeaf) Accessor: Inserts a Leaf value into a specific position of the list of gathered values.
void	addLeaf(Leaf vLeaf) Accessor: Append a value fragment to this profile instance.
Enumeration	enumerateLeaf() Deprecated. Use the new Collection based interfaces
String	getKey() Accessor: Gets the key identifier for the profile.
Leaf[]	getLeaf() Deprecated. Use the new Collection based interfaces
Leaf	getLeaf(int index) Accessor: Obtains the Leaf at a certain position in the list of profile value fragments.
int	getLeafCount() Accessor: Obtains the number of profile value fragments.
List	getLeafList() Accessor: Gets an array of all values that constitute the current content.
String	getNamespace() Accessor: Gets the namespace value for the profile.
Iterator	iterateLeaf() Accessor: Enumerates the internal values that constitute the content of the Scalar element.
ListIterator	listIterateLeaf() Accessor: Enumerates the internal values that constitute the content of the Scalar element.
ListIterator	listIterateLeaf(int start) Accessor: Enumerates the internal values that constitute the content of the Scalar element.
void	removeAllLeaf() Accessor: Removes all value fragments from the profile.
Leaf	removeLeaf(int index) Accessor: Remove a single fragment from the list of value fragments.
void	setKey(String key) Accessor: Adjusts the identifier within a namespace.
void	setLeaf(Collection leaves) Accessor: Overwrites internal list with an external list representing a Scalar value.
void	setLeaf(int index, Leaf vLeaf) Accessor: Overwrites a Use or Text value fragment at a certain position in the profile value fragment list.
void	setLeaf(Leaf[] leafArray) Deprecated. Use the new Collection based interfaces
void	setNamespace(String namespace) Accessor: Adjusts a namespace value to a new state.
String	toString() Converts the profile state into textual format for human consumption.
void	toString(Writer stream) Converts the active state into something meant for human consumption.
void	toXML(Writer stream, String indent, String namespace) Dump the state of the current element as XML output.

Methods inherited from class org.griphyn.vdl.Chimera

escape, quote, toXML, toXML, writeAttribute

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

c_error_message

private static final String c_error_message

Throws this message, if neither <text> nor <use> elements are tried to be added.

See Also:

Constant Field Values

m_namespace

private String m_namespace

The namespace of a profile. All profiles must mention their namespace in order to generate acceptable behaviour.

m_key

private String m_key

The identifier within a namespace. The meaning of the key can differ between namespaces. Within the unix namespace, it is the name of an environment variable. Within the condor namespace, it is a Condor submit file key.

m_leafList

private ArrayList m_leafList

The value to above keys. Any value passed down is an arbitrary mix of the three potential Leaf types. A profile value element only allows for Text and LFN children in arbitrary number and order.

See Also:

Leaf, Text, LFN

Constructor Detail

Profile

public Profile()

Array ctor.

Profile

public Profile(String namespace,
               String key)

Standard ctor: set up everything except a value of the ns.key pair.

Parameters:

namespace - is the namespace within which to operate.

key - is an identifier unique within the namespace.

Profile

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.

key - is an identifier unique within the namespace.

firstChild - is the first fragment of the value. Only Leafs of type Use or Text are permissable.

See Also:

Leaf, Use, Text

Profile

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.

key - is an identifier unique within the namespace.

children - is a collection of fragments for the value. Only Leafs of type Filename or PseudoText are permissable.

See Also:

Leaf, Use, Text

Method Detail

addLeaf

public void addLeaf(Leaf vLeaf)
             throws IndexOutOfBoundsException,
                    IllegalArgumentException

Accessor: Append a value fragment to this profile instance.

Parameters:

vLeaf - is the fragment to add. Note that only leaf values of Use or Text are allowed.

Throws:

IndexOutOfBoundsException - if the value cannot be added.

IllegalArgumentException - if the value type is neither Use nor Text.

See Also:

Leaf, Text, Use

addLeaf

public void addLeaf(int index,
                    Leaf vLeaf)
             throws IndexOutOfBoundsException,
                    IllegalArgumentException

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

vLeaf - is the value to append to the list. Note that only leaf values of Use or Text are allowed.

Throws:

IndexOutOfBoundsException - if the value cannot be added.

IllegalArgumentException - if the value type is neither Use nor Text.

See Also:

Text, Use

enumerateLeaf

public Enumeration enumerateLeaf()

Deprecated. Use the new Collection based interfaces

Accessor: Enumerates the internal values that constitute the content of the Profile value.

Returns:

the iterator to the value fragment list.

getLeaf

public Leaf getLeaf(int index)
             throws IndexOutOfBoundsException

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

Returns:

The Use or Text at the position.

Throws:

IndexOutOfBoundsException - if the index points to an element in the list that does not contain any elments.

See Also:

Use, Text

getLeaf

public Leaf[] getLeaf()

Deprecated. Use the new Collection based interfaces

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.

Returns:

an array with a mixture of either Text or Use values.

See Also:

Use, Text

getLeafCount

public int getLeafCount()

Accessor: Obtains the number of profile value fragments.

Returns:

number of elements that an external array needs to be sized to.

getLeafList

public List getLeafList()

Accessor: Gets an array of all values that constitute the current content. This list is read-only.

Returns:

an array with a mixture of either Text or LFN values.

See Also:

LFN, Text

getNamespace

public String getNamespace()

Accessor: Gets the namespace value for the profile.

Returns:

the currently active namespace for this instance.

See Also:

setNamespace(java.lang.String)

getKey

public String getKey()

Accessor: Gets the key identifier for the profile.

Returns:

the currently active key for this instance.

See Also:

setKey(java.lang.String)

iterateLeaf

public Iterator iterateLeaf()

Accessor: Enumerates the internal values that constitute the content of the Scalar element.

Returns:

an iterator to walk the list with.

listIterateLeaf

public ListIterator listIterateLeaf()

Accessor: Enumerates the internal values that constitute the content of the Scalar element.

Returns:

an enumeration to walk the list with.

listIterateLeaf

public ListIterator listIterateLeaf(int start)

Accessor: Enumerates the internal values that constitute the content of the Scalar element.

Parameters:

start - is the start index

Returns:

an enumeration to walk the list with.

removeAllLeaf

public void removeAllLeaf()

Accessor: Removes all value fragments from the profile.

removeLeaf

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.

Returns:

the object that was removed. The removed item is either an Use or a Text.

See Also:

Use, Text

setLeaf

public void setLeaf(int index,
                    Leaf vLeaf)
             throws IndexOutOfBoundsException,
                    IllegalArgumentException

Accessor: Overwrites a Use or Text value fragment at a certain position in the profile value fragment list.

Parameters:

index - position to overwrite an elment in.

vLeaf - is either a Use or Text object.

Throws:

IndexOutOfBoundsException - if the position pointed to is invalid.

IllegalArgumentException - if the added element is of the incorrect Leaf type.

See Also:

Use, Text

setLeaf

public void setLeaf(Leaf[] leafArray)

Deprecated. Use the new Collection based interfaces

Accessor: Overwrites internal value fragments list with an external list representing a profile value.

Parameters:

leafArray - is the external list of Text or Use objects used to overwrite things.

See Also:

Text, Use

setLeaf

public void setLeaf(Collection leaves)

Accessor: Overwrites internal list with an external list representing a Scalar value.

Parameters:

leaves - is the external list of Text or LFN objects used to overwrite things.

See Also:

Text, LFN

setNamespace

public void setNamespace(String namespace)

Accessor: Adjusts a namespace value to a new state.

Parameters:

namespace - is the new namespace to use.

See Also:

getNamespace()

setKey

public void setKey(String key)

Accessor: Adjusts the identifier within a namespace.

Parameters:

key - is the new identifier to use from now on.

See Also:

getKey()

toString

public String toString()

Converts the profile state into textual format for human consumption.

Overrides:

toString in class Chimera

Returns:

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

Converts the active state into something meant for human consumption. The method will be called when recursively traversing the instance tree.

Specified by:

toString in class Chimera

Parameters:

stream - is a stream opened and ready for writing. This can also be a string stream for efficient output.

Throws:

IOException - if something fishy happens to the stream.

toXML

public void toXML(Writer stream,
                  String indent,
                  String namespace)
           throws IOException

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.

Specified by:

toXML in class Chimera

Parameters:

stream - is a stream opened and ready for writing. This can also be a string stream for efficient output.

indent - is a String of spaces used for pretty printing. 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 nor linefeeds will be generated.

namespace - is the XML schema namespace prefix. If neither empty nor null, each element will be prefixed with this prefix, and the root element will map the XML namespace.

Throws:

IOException - if something fishy happens to the stream.

See Also:

BufferedWriter