org.opennms.netmgt.config.statsd

Class PackageReport

java.lang.Object

org.opennms.netmgt.config.statsd.PackageReport

All Implemented Interfaces:

Serializable

public class PackageReport
extends Object
implements Serializable

Report to be generated for nodes matching this package

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PackageReport()

Method Summary

Methods

Modifier and Type	Method and Description
void	addParameter(int index, Parameter vParameter)
void	addParameter(Parameter vParameter)
Enumeration<Parameter>	enumerateParameter() Method enumerateParameter.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getDescription() Returns the value of field 'description'.
String	getName() Returns the value of field 'name'.
Parameter[]	getParameter() Method getParameter.Returns the contents of the collection in an Array.
Parameter	getParameter(int index) Method getParameter.
List<Parameter>	getParameterCollection() Method getParameterCollection.Returns a reference to '_parameterList'.
int	getParameterCount() Method getParameterCount.
String	getRetainInterval() Returns the value of field 'retainInterval'.
String	getSchedule() Returns the value of field 'schedule'.
PackageReportStatusType	getStatus() Returns the value of field 'status'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<Parameter>	iterateParameter() Method iterateParameter.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllParameter()
boolean	removeParameter(Parameter vParameter) Method removeParameter.
Parameter	removeParameterAt(int index) Method removeParameterAt.
void	setDescription(String description) Sets the value of field 'description'.
void	setName(String name) Sets the value of field 'name'.
void	setParameter(int index, Parameter vParameter)
void	setParameter(List<Parameter> vParameterList) Sets the value of '_parameterList' by copying the given Vector.
void	setParameter(Parameter[] vParameterArray)
void	setParameterCollection(List<Parameter> parameterList) Deprecated.
void	setRetainInterval(String retainInterval) Sets the value of field 'retainInterval'.
void	setSchedule(String schedule) Sets the value of field 'schedule'.
void	setStatus(PackageReportStatusType status) Sets the value of field 'status'.
static PackageReport	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

PackageReport

public PackageReport()

Method Detail

addParameter

public void addParameter(Parameter vParameter)
                  throws IndexOutOfBoundsException

Parameters:

vParameter -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addParameter

public void addParameter(int index,
                Parameter vParameter)
                  throws IndexOutOfBoundsException

Parameters:

index -

vParameter -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

enumerateParameter

public Enumeration<Parameter> enumerateParameter()

Method enumerateParameter.

Returns:

an Enumeration over all possible elements of this collection

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.

getDescription

public String getDescription()

Returns the value of field 'description'. The field 'description' has the following description: The report description. This is shown in the web UI.

Returns:

the value of field 'Description'.

getName

public String getName()

Returns the value of field 'name'. The field 'name' has the following description: The report name. This is used internally to reference a configured report class.

Returns:

the value of field 'Name'.

getParameter

public Parameter getParameter(int index)
                       throws IndexOutOfBoundsException

Method getParameter.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.statsd.Parameter at the given index

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getParameter

public Parameter[] getParameter()

Method getParameter.Returns the contents of the collection in an Array.

Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.

Returns:

this collection as an Array

getParameterCollection

public List<Parameter> getParameterCollection()

Method getParameterCollection.Returns a reference to '_parameterList'. No type checking is performed on any modifications to the Vector.

Returns:

a reference to the Vector backing this class

getParameterCount

public int getParameterCount()

Method getParameterCount.

Returns:

the size of this collection

getRetainInterval

public String getRetainInterval()

Returns the value of field 'retainInterval'. The field 'retainInterval' has the following description: the amount of time after which this report has been created that it can be purged.

Returns:

the value of field 'RetainInterval'.

getSchedule

public String getSchedule()

Returns the value of field 'schedule'. The field 'schedule' has the following description: the schedule at which the report is to be generated

Returns:

the value of field 'Schedule'.

getStatus

public PackageReportStatusType getStatus()

Returns the value of field 'status'. The field 'status' has the following description: status of the report; report is generated only if on

Returns:

the value of field 'Status'.

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

iterateParameter

public Iterator<Parameter> iterateParameter()

Method iterateParameter.

Returns:

an Iterator over all possible elements in this collection

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

removeAllParameter

public void removeAllParameter()

removeParameter

public boolean removeParameter(Parameter vParameter)

Method removeParameter.

Parameters:

vParameter -

Returns:

true if the object was removed from the collection.

removeParameterAt

public Parameter removeParameterAt(int index)

Method removeParameterAt.

Parameters:

index -

Returns:

the element removed from the collection

setDescription

public void setDescription(String description)

Sets the value of field 'description'. The field 'description' has the following description: The report description. This is shown in the web UI.

Parameters:

description - the value of field 'description'.

setName

public void setName(String name)

Sets the value of field 'name'. The field 'name' has the following description: The report name. This is used internally to reference a configured report class.

Parameters:

name - the value of field 'name'.

setParameter

public void setParameter(int index,
                Parameter vParameter)
                  throws IndexOutOfBoundsException

Parameters:

index -

vParameter -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setParameter

public void setParameter(Parameter[] vParameterArray)

Parameters:

vParameterArray -

setParameter

public void setParameter(List<Parameter> vParameterList)

Sets the value of '_parameterList' by copying the given Vector. All elements will be checked for type safety.

Parameters:

vParameterList - the Vector to copy.

setParameterCollection

public void setParameterCollection(List<Parameter> parameterList)

Deprecated.

Sets the value of '_parameterList' by setting it to the given Vector. No type checking is performed.

Parameters:

parameterList - the Vector to set.

setRetainInterval

public void setRetainInterval(String retainInterval)

Sets the value of field 'retainInterval'. The field 'retainInterval' has the following description: the amount of time after which this report has been created that it can be purged.

Parameters:

retainInterval - the value of field 'retainInterval'.

setSchedule

public void setSchedule(String schedule)

Sets the value of field 'schedule'. The field 'schedule' has the following description: the schedule at which the report is to be generated

Parameters:

schedule - the value of field 'schedule'.

setStatus

public void setStatus(PackageReportStatusType status)

Sets the value of field 'status'. The field 'status' has the following description: status of the report; report is generated only if on

Parameters:

status - the value of field 'status'.

unmarshal

public static PackageReport 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.statsd.PackageReport

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