org.gridbus.broker.plan
Class ParameterProcessor

java.lang.Object
  org.gridbus.broker.plan.ParameterProcessor

public class ParameterProcessor

extends java.lang.Object

This class will extract all the information regarding Parameters from the XML file. It is actually meant to replace RunFile.java.

Author:

Ding Choon Hoong (chd@students.cs.mu.oz.au)

Constructor Summary

ParameterProcessor()
Default constructor for this class

ParameterProcessor(org.dom4j.Element fragmentElement)
Sets up the parameter processor with the input element object

Method Summary

java.lang.Object	extractParameter() Extracts and returns the parameters in the xml file as objects
java.util.Collection	getDataFileList()
java.util.Hashtable	getDataHostTable()
java.lang.String	pointsInteger(java.lang.String from, java.lang.String to, java.lang.String points) Returns a string listing out the job parameters in case of a range within an interval
ListVariable	processGridfile_list(org.dom4j.Element fragmentElement, java.lang.String varName, java.lang.String variableType) This function is meant for Dynamic Parameters.
ListVariable	processRange(org.dom4j.Element fragmentElement, java.lang.String varName, java.lang.String rangeVarType) Processes a listvariable tag and returns a ListVariable object
ListVariable	processSelect_anyof(org.dom4j.Element fragmentElement, java.lang.String varName, java.lang.String listType) Processes a 'any-of' tag and returns a ListVariable object
SingleVariable	processSingle(org.dom4j.Element fragmentElement, java.lang.String varName, java.lang.String singleVarType) Processes a singlevariable tag and returns a SingleVariable object
void	setDataFileList(java.util.Collection dataFileList)
void	setDataHostTable(java.util.Hashtable dataHostTable)
java.lang.String	stepInteger(java.lang.String from, java.lang.String to, java.lang.String step) Returns a string listing out the job parameters, in case of a range with a step between each value

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParameterProcessor

public ParameterProcessor()

Default constructor for this class

ParameterProcessor

public ParameterProcessor(org.dom4j.Element fragmentElement)

Sets up the parameter processor with the input element object

Parameters:

fragmentElement -

Method Detail

extractParameter

public java.lang.Object extractParameter()

Extracts and returns the parameters in the xml file as objects

Returns:

parameters

stepInteger

public java.lang.String stepInteger(java.lang.String from,
                                    java.lang.String to,
                                    java.lang.String step)

Returns a string listing out the job parameters, in case of a range with a step between each value

Parameters:

from -

to -

step -

Returns:

a string listing out the job parameters

pointsInteger

public java.lang.String pointsInteger(java.lang.String from,
                                      java.lang.String to,
                                      java.lang.String points)

Returns a string listing out the job parameters in case of a range within an interval

Parameters:

from -

to -

points -

Returns:

a string listing out the job parameters

processSingle

public SingleVariable processSingle(org.dom4j.Element fragmentElement,
                                    java.lang.String varName,
                                    java.lang.String singleVarType)

Processes a singlevariable tag and returns a SingleVariable object

Parameters:

fragmentElement -

varName -

singleVarType -

Returns:

single variable object

processRange

public ListVariable processRange(org.dom4j.Element fragmentElement,
                                 java.lang.String varName,
                                 java.lang.String rangeVarType)

Processes a listvariable tag and returns a ListVariable object

Parameters:

fragmentElement -

varName -

rangeVarType -

Returns:

variable list

processSelect_anyof

public ListVariable processSelect_anyof(org.dom4j.Element fragmentElement,
                                        java.lang.String varName,
                                        java.lang.String listType)

Processes a 'any-of' tag and returns a ListVariable object

Parameters:

fragmentElement -

varName -

listType -

Returns:

variable list

processGridfile_list

public ListVariable processGridfile_list(org.dom4j.Element fragmentElement,
                                         java.lang.String varName,
                                         java.lang.String variableType)

This function is meant for Dynamic Parameters. Users will have to write their own class, that extends this ParameterProcessor class. This function will use reflection to invoke that class based on the variable name. A standard method (i.e. fixed method name) must be defined in that class to do the processing of the Gridfile parameter.

Parameters:

fragmentElement -

varName -

variableType -

Returns:

ListVariable

getDataFileList

public java.util.Collection getDataFileList()

Returns:

Returns the dataFileList.

setDataFileList

public void setDataFileList(java.util.Collection dataFileList)

Parameters:

dataFileList - The dataFileList to set.

getDataHostTable

public java.util.Hashtable getDataHostTable()

Returns:

Returns the dataHostTable.

setDataHostTable

public void setDataHostTable(java.util.Hashtable dataHostTable)

Parameters:

dataHostTable - The dataHostTable to set.