edu.sdsc.inca.depot.persistent
Class Report

java.lang.Object
  edu.sdsc.inca.depot.persistent.PersistentObject
      edu.sdsc.inca.depot.persistent.Report

public class Report
extends PersistentObject

This class represents the output from a Single Reporter.

Author:

Cathie Olschanowsky

Field Summary

Fields inherited from class edu.sdsc.inca.depot.persistent.PersistentObject

DB_EMPTY_STRING, MAX_DB_LONG_STRING_LENGTH, MAX_DB_STRING_LENGTH

Constructor Summary

Report()
Default constructor.

Report(java.lang.Boolean exit_status, java.lang.String exit_message, java.lang.String body, Series series)
Full constructor.

Method Summary

boolean	equals(java.lang.Object o) Compares another object to this Report for logical equality.
Report	fromBean(edu.sdsc.inca.dataModel.util.Report r) Copies information from an Inca schema XmlBean Report object so that this object contains equivalent information.
PersistentObject	fromBean(org.apache.xmlbeans.XmlObject o) Copies information from an Inca schema XmlBean Report object so that this object contains equivalent information.
java.lang.String	getBody() Retrieve the body of this report as an XML string.
java.lang.String	getBodypart1() Retrieve the first part of the body of this report.
java.lang.String	getBodypart2() Retrieve the second part of the body of this report.
java.lang.String	getBodypart3() Retrieve the third part of the body of this report.
java.lang.String	getExit_message() Retrieve the exit message of this report.
java.lang.Boolean	getExit_status() Retrieve the exit status of this report.
java.lang.Long	getId() Retrieve the id -- null if not yet connected to database.
RunInfo	getRunInfo() Get the RunInfo associated with this Report.
Series	getSeries() Get the Series that this report is part of.
java.lang.String	getStderr() Retrieve the contents of STDERR output by the reporter.
int	hashCode()
void	setBody(java.lang.String body) Set the body of this report.
void	setBodypart1(java.lang.String bodypart) Set the second part of the body of this report.
void	setBodypart2(java.lang.String bodypart) Set the second part of the body of this report.
void	setBodypart3(java.lang.String bodypart) Set the third part of the body of this report.
void	setExit_message(java.lang.String exit_message) Set the exit message of this report.
void	setExit_status(java.lang.Boolean exit_status) Set the exit status of this report.
void	setId(java.lang.Long id) Set the id.
void	setRunInfo(RunInfo runInfo) Set the RunInfo associated with this Report.
void	setSeries(Series series) set the report series that this report is part of.
void	setStderr(java.lang.String stderr) Set the contents of stderr -- can be used for querying or by Hibernate.
org.apache.xmlbeans.XmlObject	toBean() Returns a Inca schema XmlBean Report object that contains information equivalent to this object.

Methods inherited from class edu.sdsc.inca.depot.persistent.PersistentObject

toXml, truncate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Report

public Report()

Default constructor.

Report

public Report(java.lang.Boolean exit_status,
              java.lang.String exit_message,
              java.lang.String body,
              Series series)

Full constructor.

Parameters:

exit_status - the exist_status of the run

exit_message - the exit_message of the run

body - the body is the bulk of the results

series - which series does this report belong to?

Method Detail

fromBean

public PersistentObject fromBean(org.apache.xmlbeans.XmlObject o)

Copies information from an Inca schema XmlBean Report object so that this object contains equivalent information.

Specified by:

fromBean in class PersistentObject

Parameters:

o - the XmlBean Report object to copy

Returns:

this, for convenience

fromBean

public Report fromBean(edu.sdsc.inca.dataModel.util.Report r)

Copies information from an Inca schema XmlBean Report object so that this object contains equivalent information.

Parameters:

r - the XmlBean Report object to copy

Returns:

this, for convenience

getId

public java.lang.Long getId()

Retrieve the id -- null if not yet connected to database.

Returns:

The Long representation of the DB ID

setId

public void setId(java.lang.Long id)

Set the id. Hibernate use only.

Parameters:

id - The DB ID.

getExit_status

public java.lang.Boolean getExit_status()

Retrieve the exit status of this report.

Returns:

exit_status

setExit_status

public void setExit_status(java.lang.Boolean exit_status)

Set the exit status of this report.

Parameters:

exit_status - true for pass false for fail

getExit_message

public java.lang.String getExit_message()

Retrieve the exit message of this report.

Returns:

the exit message

setExit_message

public void setExit_message(java.lang.String exit_message)

Set the exit message of this report.

Parameters:

exit_message - the text of the exit message

getBody

public java.lang.String getBody()

Retrieve the body of this report as an XML string.

Returns:

XML string

setBody

public void setBody(java.lang.String body)

Set the body of this report.

Parameters:

body - xml body of report

getBodypart1

public java.lang.String getBodypart1()

Retrieve the first part of the body of this report.

setBodypart1

public void setBodypart1(java.lang.String bodypart)

Set the second part of the body of this report.

getBodypart2

public java.lang.String getBodypart2()

Retrieve the second part of the body of this report.

setBodypart2

public void setBodypart2(java.lang.String bodypart)

Set the second part of the body of this report.

getBodypart3

public java.lang.String getBodypart3()

Retrieve the third part of the body of this report.

setBodypart3

public void setBodypart3(java.lang.String bodypart)

Set the third part of the body of this report.

getSeries

public Series getSeries()

Get the Series that this report is part of.

Returns:

The Series this report belongs to.

setSeries

public void setSeries(Series series)

set the report series that this report is part of.

Parameters:

series - the Series this report belongs to

getRunInfo

public RunInfo getRunInfo()

Get the RunInfo associated with this Report.

Returns:

The RunInfo this report belongs to.

setRunInfo

public void setRunInfo(RunInfo runInfo)

Set the RunInfo associated with this Report.

Parameters:

runInfo - the RunInfo this report belongs to

getStderr

public java.lang.String getStderr()

Retrieve the contents of STDERR output by the reporter.

Returns:

what the reporter sent to STDERR

setStderr

public void setStderr(java.lang.String stderr)

Set the contents of stderr -- can be used for querying or by Hibernate.

Parameters:

stderr - contents of stderr

toBean

public org.apache.xmlbeans.XmlObject toBean()

Returns a Inca schema XmlBean Report object that contains information equivalent to this object.

Specified by:

toBean in class PersistentObject

Returns:

an XmlBean Report object that contains equivalent information

equals

public boolean equals(java.lang.Object o)

Compares another object to this Report for logical equality.

Overrides:

equals in class java.lang.Object

Parameters:

o - the object to compare

Returns:

true iff the comparison object represents the same Report

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object