org.glite.jdl

Class JobAd

java.lang.Object

org.glite.jdl.Ad

org.glite.jdl.JobAd

Direct Known Subclasses:

ParametricAd

public class JobAd
extends Ad

Provides a representation of the job description in the JDL language and the functions for building and manipulating it. Basically the JDL is the Condor ClassAd language, so it is legitimate the direct use of the Condor API library for creating, modifying, deleting a job description. However the JobAd class extends the ClassAd class of the Condor ClassAd library additionally providing some helper methods that ease the construction of job descriptions being fully compliant to WP1 WMS specification.

Version:

0.1

Author:

Alessandro Maraschini

Field Summary

Fields inherited from class org.glite.jdl.Ad

jobAd, TYPE_AD, TYPE_BOOL, TYPE_EXPRESSION, TYPE_INTEGER, TYPE_REAL, TYPE_STRING, TYPE_UNKNOWN

Constructor Summary

Constructors

Constructor and Description
JobAd() Default Constructor Instantiates an empty JobAd object
JobAd(condor.classad.RecordExpr ad) Instantiates a JobAd object from the given recordExpr
JobAd(String ad) Constructor from String: parse the string and create a JobAd

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttribute(String attrName, Ad attrValue) Allow adding a value to an already set attribute of the JobAd instance (i.e.
void	addAttribute(String attrName, boolean attrValue) Allow adding a value to an already set attribute of the JobAd instance (i.e.
void	addAttribute(String attrName, double attrValue) Allow adding a value to an already set attribute of the JobAd instance (i.e.
void	addAttribute(String attrName, int attrValue) Allow adding a value to an already set attribute of the JobAd instance (i.e.
void	addAttribute(String attrName, String attrValue) Allow adding a value to an already set attribute of the JobAd instance (i.e.
void	checkAll() Check the JobAd instance for both syntax and semanthic errors.
void	checkAll(String[] attributes) Check the JobAd instance for both syntax and semanthic errors
void	clear() Reset the JobAd Instance.
Object	clone() Copy all the attributes of the instance into a new JobAd
JobAd	copy(condor.classad.RecordExpr source) Make a deep copy of the JobAd instance
condor.classad.RecordExpr	copyAd() Copy the attributes of the classAd into a new Record Expression
void	delAttribute(String attrName) Delete an Attribute.
String	getAttributeExpr(String attrName) Retreive the value of the specified Expression attribute as a string
boolean	getBoolean(String attrName) Retrieve the value of the specified attribute, only if it is of non-list type
double	getDouble(String attrName) Retrieve the value of the specified attribute, only if it is of non-list type
int	getInt(String attrName) Retrieve the value of the specified attribute, only if it is of non-list type
JobAd	getJobAdValue(String attrName) Retreive the JobAd value of the specified attribute
String	getString(String attrName) Retrieve the value of the specified attribute, only if it is of non-list type
boolean	hasAttribute(String attrName, String attrValue) Check wheater an atribute has the value between its values.
boolean	hasAttribute(String attrName, String attrValue, boolean unsensitive) Check wheater an atribute has the value between its values.
void	setAttribute(String attrName, boolean attrValue) Add The specified String Attribute to the jdl istance
void	setAttribute(String attrName, double attrValue) Add The specified String Attribute to the jdl istance
void	setAttribute(String attrName, condor.classad.Expr attrValue) Add The specified Expression Attribute to the jdl istance
void	setAttribute(String attrName, int attrValue) Add The specified Integer Attribute to the jdl istance
void	setAttribute(String attrName, String attrValue) Add The specified String Attribute to the jdl istance
void	setAttributeExpr(String attrName, String attrValue) Add The specified Expression Attribute to the jdl istance
void	setDefaultRank(String attrValue) Rank default attribute initialisation
void	setDefaultRequirements(String attrValue) Requirements default attribute initialisation
void	setLocalAccess(boolean lookInto) If JobAd is used inside an applet, it is impossible to look into the local hard-disk by default this parameter is set to TRUE
void	setSchema(JobAdSchema schema) Set the JobAd checking attributes utilised schema (Default Schema: Glue)
void	toFile(String filePath) Print the JobAd instance into the specified file, with its multi-lines representation
String	toLines() Convert the JobAd Instance into its String representation, one line per attribute, multi line for listed attribute active This method is the same as toString ( true , true )
String	toString() Convert the JobAd Instance into a sinlge-line String representation
String	toString(boolean multiLines, boolean multiLists) Convert the JobAd Instance into its String representation, one line per attribute, multi line for listed attribute active
String	toSubmissionString() Perform a check over the JobAd instance and if possible convert it into its String representation as it would be ready for a submission

Methods inherited from class org.glite.jdl.Ad

appendValue, attributes, copy, fromFile, fromRecord, fromString, getAd, getAdValue, getBooleanValue, getConstant, getDoubleValue, getIntValue, getStringValue, getType, getValue, hasAttribute, isSet, lookup, setAttribute, size

Methods inherited from class java.lang.Object

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

Constructor Detail

JobAd

public JobAd()

Default Constructor Instantiates an empty JobAd object

JobAd

public JobAd(String ad)
      throws ParseException,
             JobAdException

Constructor from String: parse the string and create a JobAd

Parameters:

ad - the JDL string to be parsed

Throws:

ParseException

JobAdException

JobAd

public JobAd(condor.classad.RecordExpr ad)
      throws JobAdException

Instantiates a JobAd object from the given recordExpr

Parameters:

ad - classAd Expression representing the Ad

Throws:

ParseException - The Classad has JDL syntax error. Unable to build a valid Ad

JobAdException - One or more attributes contain syntax error(s)

Method Detail

copy

public JobAd copy(condor.classad.RecordExpr source)
           throws JobAdException

Make a deep copy of the JobAd instance

Parameters:

source - the expression to copy from

Throws:

JobAdException

clone

public Object clone()

Copy all the attributes of the instance into a new JobAd

Overrides:

clone in class Ad

Returns:

a new JobAd with a copy of all the attributes contained in the current JobAd instance

copyAd

public condor.classad.RecordExpr copyAd()

Copy the attributes of the classAd into a new Record Expression

Returns:

the condor Excpression representing the Ad instance

hasAttribute

public boolean hasAttribute(String attrName,
                   String attrValue)

Check wheater an atribute has the value between its values. The search is

Parameters:

attrName - the name of the attribute to be checked

attrValue - the String value to search for. The case of the seek is unsensitive

Returns:

true if the specified value is present, false otherwise (also when the attribute is no set)

hasAttribute

public boolean hasAttribute(String attrName,
                   String attrValue,
                   boolean unsensitive)

Check wheater an atribute has the value between its values. The search is

Parameters:

attrName - the name of the attribute to be checked

attrValue - the String value to search for

determine - wheater the case of the value should be sensitive or unsensitive

Returns:

true if the specified value is present, false otherwise (also when the attribute is no set)

toLines

public String toLines()

Convert the JobAd Instance into its String representation, one line per attribute, multi line for listed attribute active This method is the same as toString ( true , true )

Returns:

The JobAd representation into multi line

See Also:

toSubmissionString(), toString()

toString

public String toString(boolean multiLines,
              boolean multiLists)

Convert the JobAd Instance into its String representation, one line per attribute, multi line for listed attribute active

Overrides:

toString in class Ad

Parameters:

multiLines - one-attribute per line representation enablng

multiLists - list attributes splitted into multi line representation enablng

See Also:

toSubmissionString(), toString()

toSubmissionString

public String toSubmissionString()
                          throws JobAdException

Perform a check over the JobAd instance and if possible convert it into its String representation as it would be ready for a submission

Throws:

JobAdException - - one or more values do not match with jobad semantic rule

See Also:

toString(), toLines()

toString

public String toString()

Convert the JobAd Instance into a sinlge-line String representation

Overrides:

toString in class Ad

See Also:

toSubmissionString(), toLines()

toFile

public void toFile(String filePath)
            throws Exception

Print the JobAd instance into the specified file, with its multi-lines representation

Parameters:

filePath - where to write the JobAd

Throws:

IOException - - if unable to write the specified file

Exception

See Also:

toLines()

setLocalAccess

public void setLocalAccess(boolean lookInto)

If JobAd is used inside an applet, it is impossible to look into the local hard-disk by default this parameter is set to TRUE

Parameters:

lookInto - allow all the check methods to access to the local hard disk (true) or skip the check (false)

setAttribute

public void setAttribute(String attrName,
                condor.classad.Expr attrValue)
                  throws InvalidAttributeValueException,
                         IllegalArgumentException

Add The specified Expression Attribute to the jdl istance

Overrides:

setAttribute in class Ad

Parameters:

attrName - - The Name of the attribute to be added

attrValue - - The Expression of the value to be added

Throws:

IllegalArgumentException - The type of value is not allowed for the specified attribute name

InvalidAttributeValueException - The value has not the right format for the specified attribute

setAttributeExpr

public void setAttributeExpr(String attrName,
                    String attrValue)
                      throws IllegalArgumentException,
                             InvalidAttributeValueException

Add The specified Expression Attribute to the jdl istance

Parameters:

attrName - - The Name of the attribute to be added

attrValue - - The value of the attribute to be added

Throws:

IllegalArgumentException - - The type of value is not allowed for the specified attribute name

InvalidAttributeValueException - - the value has not the right format for the specifiedattribute

setAttribute

public void setAttribute(String attrName,
                int attrValue)
                  throws IllegalArgumentException,
                         InvalidAttributeValueException

Add The specified Integer Attribute to the jdl istance

Overrides:

setAttribute in class Ad

Parameters:

attrName - - The Name of the attribute to be added

attrValue - - The value of the attribute to be added

Throws:

IllegalArgumentException - - The type of value is not allowed for the specified attribute name

InvalidAttributeValueException - - The specified value is out of limits for the specified attribute

setAttribute

public void setAttribute(String attrName,
                String attrValue)
                  throws IllegalArgumentException,
                         InvalidAttributeValueException

Add The specified String Attribute to the jdl istance

Overrides:

setAttribute in class Ad

Parameters:

attrName - - The Name of the attribute to be added

attrValue - - The value of the attribute to be added

Throws:

IllegalArgumentException - - The type of value is not allowed for the specified attribute name

InvalidAttributeValueException - - the value has not the right format for the specified attribute

setAttribute

public void setAttribute(String attrName,
                double attrValue)
                  throws IllegalArgumentException,
                         InvalidAttributeValueException

Add The specified String Attribute to the jdl istance

Overrides:

setAttribute in class Ad

Parameters:

attrName - - The Name of the attribute to be added

attrValue - - The value of the attribute to be added

Throws:

IllegalArgumentException- - The attribute attrName had been

InvalidAttributeValueException - - the value is out of limits for the specified attribute

IllegalArgumentException

setAttribute

public void setAttribute(String attrName,
                boolean attrValue)
                  throws IllegalArgumentException,
                         InvalidAttributeValueException

Add The specified String Attribute to the jdl istance

Overrides:

setAttribute in class Ad

Parameters:

attrName - - The Name of the attribute to be added

attrValue - - The value of the attribute to be added

Throws:

IllegalArgumentException- - The attribute attrName had been already set

InvalidAttributeValueException - - A value has not the right type for an attribute

IllegalArgumentException

addAttribute

public void addAttribute(String attrName,
                Ad attrValue)
                  throws IllegalArgumentException,
                         InvalidAttributeValueException

Allow adding a value to an already set attribute of the JobAd instance (i.e. it transforms it in a list attribute). if used on a non-set attribute the corresponding setAttribute method is automatically called.

Overrides:

addAttribute in class Ad

Parameters:

attrName - a String representing the attribute name

attrValue - - The value of the attribute to be added

Throws:

IllegalArgumentException- - The specified value is not allowed for the attribute

InvalidAttributeValueException - - A value has not the right type for an attribute

IllegalArgumentException

addAttribute

public void addAttribute(String attrName,
                int attrValue)
                  throws IllegalArgumentException,
                         InvalidAttributeValueException

Allow adding a value to an already set attribute of the JobAd instance (i.e. it transforms it in a list attribute). if used on a non-set attribute the corresponding setAttribute method is automatically called.

Overrides:

addAttribute in class Ad

Parameters:

attrName - a String representing the attribute name

attrValue - - The value of the attribute to be added

Throws:

IllegalArgumentException- - The specified value is not allowed for the attribute

InvalidAttributeValueException - - A value has not the right type for an attribute

IllegalArgumentException

addAttribute

public void addAttribute(String attrName,
                double attrValue)
                  throws IllegalArgumentException,
                         InvalidAttributeValueException

Allow adding a value to an already set attribute of the JobAd instance (i.e. it transforms it in a list attribute). if used on a non-set attribute the corresponding setAttribute method is automatically called.

Overrides:

addAttribute in class Ad

Parameters:

attrName - a String representing the attribute name

attrValue - - The value of the attribute to be added

Throws:

IllegalArgumentException- - The specified value is not allowed for the attribute

InvalidAttributeValueException - - the has not the right format for the attribute

IllegalArgumentException

addAttribute

public void addAttribute(String attrName,
                boolean attrValue)
                  throws IllegalArgumentException,
                         InvalidAttributeValueException

Allow adding a value to an already set attribute of the JobAd instance (i.e. it transforms it in a list attribute). if used on a non-set attribute the corresponding setAttribute method is automatically called.

Overrides:

addAttribute in class Ad

Parameters:

attrName - a String representing the attribute name

attrValue - - The value of the attribute to be added

Throws:

IllegalArgumentException- - The specified value is not allowed for the attribute

InvalidAttributeValueException - - the value has not the right format for the attribute

IllegalArgumentException

addAttribute

public void addAttribute(String attrName,
                String attrValue)
                  throws IllegalArgumentException,
                         InvalidAttributeValueException

Allow adding a value to an already set attribute of the JobAd instance (i.e. it transforms it in a list attribute). if used on a non-set attribute the corresponding setAttribute method is automatically called.

Overrides:

addAttribute in class Ad

Parameters:

attrName - a String representing the attribute name

attrValue - - The value of the attribute to be added

Throws:

IllegalArgumentException - The specified type is not allowed for the attribute value

InvalidAttributeValueException - The value has not the right format for the attribute

getAttributeExpr

public String getAttributeExpr(String attrName)
                        throws Exception

Retreive the value of the specified Expression attribute as a string

Parameters:

attrName - The name of the attribute name to be retrieved

Returns:

the String representng the value of the specified attribute

Throws:

InvalidAttributeValueException - - Not an Expression value is allowed for the specified attribute

NoSuchFieldException - - The attribute is not present in the JobAd

Exception

getJobAdValue

public JobAd getJobAdValue(String attrName)
                    throws NoSuchFieldException,
                           IllegalArgumentException,
                           JobAdException

Retreive the JobAd value of the specified attribute

Parameters:

attrName - The name of the attribute name to be retrieved

Returns:

a Vector cantaining the values listed in the specified attribute , (1-size Vector if the attribute has a single value)

Throws:

nvalidAttributeValueException - The specified attribute is of list type

IllegalArgumentException - - The type of retrieved value is not allowed for the specified attribute name

NoSuchFieldException - - The requested attribute has not been set yet

JobAdException

getString

public String getString(String attrName)
                 throws NoSuchFieldException,
                        IllegalArgumentException,
                        InvalidAttributeValueException

Retrieve the value of the specified attribute, only if it is of non-list type

Parameters:

attrName - The name of the attribute to be retrieved

Returns:

the value of the specified aqttribute as in the JobAd

Throws:

nvalidAttributeValueException - The specified attribute is of list type

IllegalArgumentException - - The type of retrieved value is not allowed for the specified attribute name

NoSuchFieldException - - The requested attribute has not been set yet

InvalidAttributeValueException

See Also:

Ad.getStringValue(java.lang.String)

getInt

public int getInt(String attrName)
           throws NoSuchFieldException,
                  IllegalArgumentException,
                  InvalidAttributeValueException

Retrieve the value of the specified attribute, only if it is of non-list type

Parameters:

attrName - The name of the attribute to be retrieved

Returns:

the int value found inside the JobAd

Throws:

InvalidAttributeValueException - The specified attribute is of list type

IllegalArgumentException - - The type of retrieved value is not allowed for the specified attribute name

NoSuchFieldException - - The requested attribute has not been set yet

See Also:

Ad.getIntValue(java.lang.String)

getBoolean

public boolean getBoolean(String attrName)
                   throws NoSuchFieldException,
                          IllegalArgumentException,
                          InvalidAttributeValueException

Retrieve the value of the specified attribute, only if it is of non-list type

Parameters:

attrName - The name of the attribute to be retrieved

Returns:

the boolean value found inside the JobAd

Throws:

InvalidAttributeValueException - The specified attribute is of list type

IllegalArgumentException - - The type of retrieved value is not allowed for the specified attribute name

NoSuchFieldException - - The requested attribute has not been set yet

See Also:

Ad.getBooleanValue(java.lang.String)

getDouble

public double getDouble(String attrName)
                 throws NoSuchFieldException,
                        IllegalArgumentException,
                        InvalidAttributeValueException

Retrieve the value of the specified attribute, only if it is of non-list type

Parameters:

attrName - The name of the attribute to be retrieved

Returns:

the double value of the specified aqttribute as in the JobAd

Throws:

InvalidAttributeValueException - The specified attribute is of list type

IllegalArgumentException - - The type of retrieved value is not allowed for the specified attribute name

NoSuchFieldException - - The requested attribute has not been set yet

See Also:

Ad.getDoubleValue(java.lang.String)

delAttribute

public void delAttribute(String attrName)
                  throws NoSuchFieldException

Delete an Attribute. It fails if the attribute doesn't exist

Overrides:

delAttribute in class Ad

Parameters:

attrName - The name of the attibute to be deleted

Throws:

NoSuchFieldException - - The attribute has not been set yet

clear

public void clear()

Reset the JobAd Instance. All the previous existing attributes will be deleted

Overrides:

clear in class Ad

checkAll

public void checkAll()
              throws JobAdException

Check the JobAd instance for both syntax and semanthic errors. all attribute will be checked

Throws:

IllegalArgumentException - - A value is not of the right type/format/value for an attribute name in the JobAd

NoSuchFieldException - - Unable to find a JobAd mandatory attribute/value

JobAdException - - one or more values do not match with jobad semantic rule

See Also:

checkAll( String[] )

checkAll

public void checkAll(String[] attributes)
              throws JobAdException

Check the JobAd instance for both syntax and semanthic errors

Parameters:

attributes - specify attributes to be checked

Throws:

IllegalArgumentException - - A value is not of the right type/format/value for an attribute name in the JobAd

NoSuchFieldException - - Unable to find a JobAd mandatory attribute/value

JobAdException - - one or more values do not match with jobad semantic rule

See Also:

checkAll( )

setSchema

public void setSchema(JobAdSchema schema)

Set the JobAd checking attributes utilised schema (Default Schema: Glue)

setDefaultRank

public void setDefaultRank(String attrValue)

Rank default attribute initialisation

setDefaultRequirements

public void setDefaultRequirements(String attrValue)

Requirements default attribute initialisation