org.opennms.netmgt.config.reporting.opennms
Class Report

java.lang.Object
  org.opennms.netmgt.config.reporting.opennms.Report

All Implemented Interfaces:

Serializable

public class Report
extends Object
implements Serializable

Class Report.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Report()

Method Summary

boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getHtmlTemplate() Returns the value of field 'htmlTemplate'.
String	getId() Returns the value of field 'id'.
String	getLogo() Returns the value of field 'logo'.
Parameters	getParameters() Returns the value of field 'parameters'.
String	getPdfTemplate() Returns the value of field 'pdfTemplate'.
String	getSvgTemplate() Returns the value of field 'svgTemplate'.
String	getType() Returns the value of field 'type'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setHtmlTemplate(String htmlTemplate) Sets the value of field 'htmlTemplate'.
void	setId(String id) Sets the value of field 'id'.
void	setLogo(String logo) Sets the value of field 'logo'.
void	setParameters(Parameters parameters) Sets the value of field 'parameters'.
void	setPdfTemplate(String pdfTemplate) Sets the value of field 'pdfTemplate'.
void	setSvgTemplate(String svgTemplate) Sets the value of field 'svgTemplate'.
void	setType(String type) Sets the value of field 'type'.
static Report	unmarshal(Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

Report

public Report()

Method Detail

equals

public boolean equals(Object obj)

Overrides the java.lang.Object.equals method.

Overrides:

equals in class Object

Parameters:

obj -

Returns:

true if the objects are equal.

getHtmlTemplate

public String getHtmlTemplate()

Returns the value of field 'htmlTemplate'. The field 'htmlTemplate' has the following description: template to convert to display the report in HTML format

Returns:

the value of field 'HtmlTemplate'.

getId

public String getId()

Returns the value of field 'id'. The field 'id' has the following description: the name of this report

Returns:

the value of field 'Id'.

getLogo

public String getLogo()

Returns the value of field 'logo'. The field 'logo' has the following description: path to the logo file

Returns:

the value of field 'Logo'.

getParameters

public Parameters getParameters()

Returns the value of field 'parameters'.

Returns:

the value of field 'Parameters'.

getPdfTemplate

public String getPdfTemplate()

Returns the value of field 'pdfTemplate'. The field 'pdfTemplate' has the following description: template to convert to display the report in PDF format

Returns:

the value of field 'PdfTemplate'.

getSvgTemplate

public String getSvgTemplate()

Returns the value of field 'svgTemplate'. The field 'svgTemplate' has the following description: template to convert to display the report in PDF format with embedded SVG

Returns:

the value of field 'SvgTemplate'.

getType

public String getType()

Returns the value of field 'type'. The field 'type' has the following description: type of this report (calendar/classic)

Returns:

the value of field 'Type'.

hashCode

public int hashCode()

Overrides the java.lang.Object.hashCode method.

The following steps came from Effective Java Programming Language Guide by Joshua Bloch, Chapter 3

Overrides:

hashCode in class Object

Returns:

a hash code value for the object.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

marshal

public void marshal(Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

marshal

public void marshal(ContentHandler handler)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

handler -

Throws:

IOException - if an IOException occurs during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

setHtmlTemplate

public void setHtmlTemplate(String htmlTemplate)

Sets the value of field 'htmlTemplate'. The field 'htmlTemplate' has the following description: template to convert to display the report in HTML format

Parameters:

htmlTemplate - the value of field 'htmlTemplate'.

setId

public void setId(String id)

Sets the value of field 'id'. The field 'id' has the following description: the name of this report

Parameters:

id - the value of field 'id'.

setLogo

public void setLogo(String logo)

Sets the value of field 'logo'. The field 'logo' has the following description: path to the logo file

Parameters:

logo - the value of field 'logo'.

setParameters

public void setParameters(Parameters parameters)

Sets the value of field 'parameters'.

Parameters:

parameters - the value of field 'parameters'.

setPdfTemplate

public void setPdfTemplate(String pdfTemplate)

Sets the value of field 'pdfTemplate'. The field 'pdfTemplate' has the following description: template to convert to display the report in PDF format

Parameters:

pdfTemplate - the value of field 'pdfTemplate'.

setSvgTemplate

public void setSvgTemplate(String svgTemplate)

Sets the value of field 'svgTemplate'. The field 'svgTemplate' has the following description: template to convert to display the report in PDF format with embedded SVG

Parameters:

svgTemplate - the value of field 'svgTemplate'.

setType

public void setType(String type)

Sets the value of field 'type'. The field 'type' has the following description: type of this report (calendar/classic)

Parameters:

type - the value of field 'type'.

unmarshal

public static Report unmarshal(Reader reader)
                        throws org.exolab.castor.xml.MarshalException,
                               org.exolab.castor.xml.ValidationException

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.opennms.netmgt.config.reporting.opennms.Report

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Throws:

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema