org.griphyn.cPlanner.classes
Class PlannerMetrics

java.lang.Object
  org.griphyn.cPlanner.classes.Data
      org.griphyn.cPlanner.classes.PlannerMetrics

All Implemented Interfaces:

Cloneable

public class PlannerMetrics
extends Data

A Data class containing the metrics about the planning instance.

Version:

$Revision: 319 $

Author:

Karan Vahi

Field Summary

private String	mBaseSubmitDirectory The base submit directory where the files are being created.
private String	mDAXPath The path to the DAX that was planned by the workflow.
private Date	mEndTime The end time for the planning.
private String	mPropertiesPath The pointer to the properties file that was used.
private String	mRelativeSubmitDirectory The relative submit directory for this run.
private Date	mStartTime The start time for hte planning.
private String	mUser The user who planned the workflow.
private String	mVOGroup The VOGroup to which the user belonged to.
private WorkflowMetrics	mWFMetrics The metrics about the workflow.

Fields inherited from class org.griphyn.cPlanner.classes.Data

mLogger, mLogMsg

Constructor Summary

PlannerMetrics()
The default metrics.

Method Summary

protected void	append(StringBuffer buffer, String key, String value) Appends a key=value pair to the StringBuffer.
Object	clone() Returns the clone of the object.
String	getBaseSubmitDirectory() Returns the path to the base submit directory.
String	getDAX() Sets the path to the DAX.
Date	getEndTime() Returns the end time for the planning operation.
String	getProperties() Returns the path to the properties file for the run.
String	getRelativeSubmitDirectory() Returns the path to the relative submit directory.
Date	getStartTime() Returns the start time for the planning operation.
String	getVOGroup() Returns the VO Group.
WorkflowMetrics	getWorkflowMetrics() Returns the workflow metrics.
void	setBaseSubmitDirectory(String base) Sets the path to the base submit directory.
void	setDAX(String path) Sets the path to the DAX.
void	setEndTime(Date end) Set the end time for the planning operation.
void	setProperties(String path) Sets the path to the properties file for the run.
void	setRelativeSubmitDirectory(String relative) Sets the path to the submit directory relative to the base.
void	setStartTime(Date start) Set the start time for the planning operation.
String	setUser() Returns the username.
void	setUser(String user) Sets the user.
void	setVOGroup(String group) Sets the vo group
void	setWorkflowMetrics(WorkflowMetrics metrics) Sets the workflow metrics.
String	toString() Returns a textual description of the object.

Methods inherited from class org.griphyn.cPlanner.classes.Data

setToString, vectorToString

Methods inherited from class java.lang.Object

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

Field Detail

mBaseSubmitDirectory

private String mBaseSubmitDirectory

The base submit directory where the files are being created.

mRelativeSubmitDirectory

private String mRelativeSubmitDirectory

The relative submit directory for this run.

mDAXPath

private String mDAXPath

The path to the DAX that was planned by the workflow.

mPropertiesPath

private String mPropertiesPath

The pointer to the properties file that was used.

mUser

private String mUser

The user who planned the workflow.

mVOGroup

private String mVOGroup

The VOGroup to which the user belonged to.

mWFMetrics

private WorkflowMetrics mWFMetrics

The metrics about the workflow.

mStartTime

private Date mStartTime

The start time for hte planning.

mEndTime

private Date mEndTime

The end time for the planning.

Constructor Detail

PlannerMetrics

public PlannerMetrics()

The default metrics.

Method Detail

getWorkflowMetrics

public WorkflowMetrics getWorkflowMetrics()

Returns the workflow metrics.

Returns:

the workflow metrics.

setWorkflowMetrics

public void setWorkflowMetrics(WorkflowMetrics metrics)

Sets the workflow metrics.

Parameters:

metrics - the workflow metrics.

setUser

public String setUser()

Returns the username.

Returns:

the user.

setUser

public void setUser(String user)

Sets the user.

Parameters:

user - the user.

setVOGroup

public void setVOGroup(String group)

Sets the vo group

Parameters:

group - the vo group.

getVOGroup

public String getVOGroup()

Returns the VO Group.

Returns:

the VO Group to which the user belongs

setProperties

public void setProperties(String path)

Sets the path to the properties file for the run.

Parameters:

path - the path to the properties file.

getProperties

public String getProperties()

Returns the path to the properties file for the run.

Returns:

the path to the properties file.

setBaseSubmitDirectory

public void setBaseSubmitDirectory(String base)

Sets the path to the base submit directory.

Parameters:

base - the path to the base submit directory.

getBaseSubmitDirectory

public String getBaseSubmitDirectory()

Returns the path to the base submit directory.

Returns:

the path to the base submit directory.

setRelativeSubmitDirectory

public void setRelativeSubmitDirectory(String relative)

Sets the path to the submit directory relative to the base.

Parameters:

relative - the relative path from the base submit directory.

getRelativeSubmitDirectory

public String getRelativeSubmitDirectory()

Returns the path to the relative submit directory.

Returns:

the path to the relative submit directory.

setDAX

public void setDAX(String path)

Sets the path to the DAX.

Parameters:

path - the path to the DAX file.

getDAX

public String getDAX()

Sets the path to the DAX.

Returns:

the path to the DAX file.

setStartTime

public void setStartTime(Date start)

Set the start time for the planning operation.

Parameters:

start - the start time.

getStartTime

public Date getStartTime()

Returns the start time for the planning operation.

Returns:

the start time.

setEndTime

public void setEndTime(Date end)

Set the end time for the planning operation.

Parameters:

end - the end time.

getEndTime

public Date getEndTime()

Returns the end time for the planning operation.

Returns:

the end time.

toString

public String toString()

Returns a textual description of the object.

Specified by:

toString in class Data

Returns:

Object

append

protected void append(StringBuffer buffer,
                      String key,
                      String value)

Appends a key=value pair to the StringBuffer.

Parameters:

buffer - the StringBuffer that is to be appended to.

key - the key.

value - the value.

clone

public Object clone()

Returns the clone of the object.

Overrides:

clone in class Object

Returns:

the clone