org.opennms.reporting.availability
Class Category

java.lang.Object
  org.opennms.reporting.availability.Category

All Implemented Interfaces:

Serializable

public class Category
extends Object
implements Serializable

Class Category.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Category()

Method Summary

void	addCatSections(CatSections vCatSections)
void	addCatSections(int index, CatSections vCatSections)
void	deleteCatIndex()
void	deleteIpaddrCount()
void	deleteNodeCount()
void	deleteNormal()
void	deleteServiceCount()
void	deleteWarning()
Enumeration<CatSections>	enumerateCatSections() Method enumerateCatSections.
String	getCatComments() Returns the value of field 'catComments'.
int	getCatIndex() Returns the value of field 'catIndex'.
String	getCatName() Returns the value of field 'catName'.
CatSections[]	getCatSections() Method getCatSections.Returns the contents of the collection in an Array.
CatSections	getCatSections(int index) Method getCatSections.
List<CatSections>	getCatSectionsCollection() Method getCatSectionsCollection.Returns a reference to '_catSectionsList'.
int	getCatSectionsCount() Method getCatSectionsCount.
int	getIpaddrCount() Returns the value of field 'ipaddrCount'.
int	getNodeCount() Returns the value of field 'nodeCount'.
double	getNormal() Returns the value of field 'normal'.
int	getServiceCount() Returns the value of field 'serviceCount'.
double	getWarning() Returns the value of field 'warning'.
boolean	hasCatIndex() Method hasCatIndex.
boolean	hasIpaddrCount() Method hasIpaddrCount.
boolean	hasNodeCount() Method hasNodeCount.
boolean	hasNormal() Method hasNormal.
boolean	hasServiceCount() Method hasServiceCount.
boolean	hasWarning() Method hasWarning.
boolean	isValid() Method isValid.
Iterator<CatSections>	iterateCatSections() Method iterateCatSections.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllCatSections()
boolean	removeCatSections(CatSections vCatSections) Method removeCatSections.
CatSections	removeCatSectionsAt(int index) Method removeCatSectionsAt.
void	setCatComments(String catComments) Sets the value of field 'catComments'.
void	setCatIndex(int catIndex) Sets the value of field 'catIndex'.
void	setCatName(String catName) Sets the value of field 'catName'.
void	setCatSections(CatSections[] vCatSectionsArray)
void	setCatSections(int index, CatSections vCatSections)
void	setCatSections(List<CatSections> vCatSectionsList) Sets the value of '_catSectionsList' by copying the given Vector.
void	setCatSectionsCollection(List<CatSections> catSectionsList) Deprecated.
void	setIpaddrCount(int ipaddrCount) Sets the value of field 'ipaddrCount'.
void	setNodeCount(int nodeCount) Sets the value of field 'nodeCount'.
void	setNormal(double normal) Sets the value of field 'normal'.
void	setServiceCount(int serviceCount) Sets the value of field 'serviceCount'.
void	setWarning(double warning) Sets the value of field 'warning'.
static Category	unmarshal(Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

Category

public Category()

Method Detail

addCatSections

public void addCatSections(CatSections vCatSections)
                    throws IndexOutOfBoundsException

Parameters:

vCatSections -

Throws:

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

addCatSections

public void addCatSections(int index,
                           CatSections vCatSections)
                    throws IndexOutOfBoundsException

Parameters:

index -

vCatSections -

Throws:

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

deleteCatIndex

public void deleteCatIndex()

deleteIpaddrCount

public void deleteIpaddrCount()

deleteNodeCount

public void deleteNodeCount()

deleteNormal

public void deleteNormal()

deleteServiceCount

public void deleteServiceCount()

deleteWarning

public void deleteWarning()

enumerateCatSections

public Enumeration<CatSections> enumerateCatSections()

Method enumerateCatSections.

Returns:

an Enumeration over all possible elements of this collection

getCatComments

public String getCatComments()

Returns the value of field 'catComments'.

Returns:

the value of field 'CatComments'.

getCatIndex

public int getCatIndex()

Returns the value of field 'catIndex'.

Returns:

the value of field 'CatIndex'.

getCatName

public String getCatName()

Returns the value of field 'catName'.

Returns:

the value of field 'CatName'.

getCatSections

public CatSections getCatSections(int index)
                           throws IndexOutOfBoundsException

Method getCatSections.

Parameters:

index -

Returns:

the value of the org.opennms.reporting.availability.CatSections at the given index

Throws:

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

getCatSections

public CatSections[] getCatSections()

Method getCatSections.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

getCatSectionsCollection

public List<CatSections> getCatSectionsCollection()

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

Returns:

a reference to the Vector backing this class

getCatSectionsCount

public int getCatSectionsCount()

Method getCatSectionsCount.

Returns:

the size of this collection

getIpaddrCount

public int getIpaddrCount()

Returns the value of field 'ipaddrCount'.

Returns:

the value of field 'IpaddrCount'.

getNodeCount

public int getNodeCount()

Returns the value of field 'nodeCount'.

Returns:

the value of field 'NodeCount'.

getNormal

public double getNormal()

Returns the value of field 'normal'.

Returns:

the value of field 'Normal'.

getServiceCount

public int getServiceCount()

Returns the value of field 'serviceCount'.

Returns:

the value of field 'ServiceCount'.

getWarning

public double getWarning()

Returns the value of field 'warning'.

Returns:

the value of field 'Warning'.

hasCatIndex

public boolean hasCatIndex()

Method hasCatIndex.

Returns:

true if at least one CatIndex has been added

hasIpaddrCount

public boolean hasIpaddrCount()

Method hasIpaddrCount.

Returns:

true if at least one IpaddrCount has been added

hasNodeCount

public boolean hasNodeCount()

Method hasNodeCount.

Returns:

true if at least one NodeCount has been added

hasNormal

public boolean hasNormal()

Method hasNormal.

Returns:

true if at least one Normal has been added

hasServiceCount

public boolean hasServiceCount()

Method hasServiceCount.

Returns:

true if at least one ServiceCount has been added

hasWarning

public boolean hasWarning()

Method hasWarning.

Returns:

true if at least one Warning has been added

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateCatSections

public Iterator<CatSections> iterateCatSections()

Method iterateCatSections.

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

removeAllCatSections

public void removeAllCatSections()

removeCatSections

public boolean removeCatSections(CatSections vCatSections)

Method removeCatSections.

Parameters:

vCatSections -

Returns:

true if the object was removed from the collection.

removeCatSectionsAt

public CatSections removeCatSectionsAt(int index)

Method removeCatSectionsAt.

Parameters:

index -

Returns:

the element removed from the collection

setCatComments

public void setCatComments(String catComments)

Sets the value of field 'catComments'.

Parameters:

catComments - the value of field 'catComments'.

setCatIndex

public void setCatIndex(int catIndex)

Sets the value of field 'catIndex'.

Parameters:

catIndex - the value of field 'catIndex'.

setCatName

public void setCatName(String catName)

Sets the value of field 'catName'.

Parameters:

catName - the value of field 'catName'.

setCatSections

public void setCatSections(int index,
                           CatSections vCatSections)
                    throws IndexOutOfBoundsException

Parameters:

index -

vCatSections -

Throws:

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

setCatSections

public void setCatSections(CatSections[] vCatSectionsArray)

Parameters:

vCatSectionsArray -

setCatSections

public void setCatSections(List<CatSections> vCatSectionsList)

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

Parameters:

vCatSectionsList - the Vector to copy.

setCatSectionsCollection

public void setCatSectionsCollection(List<CatSections> catSectionsList)

Deprecated.

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

Parameters:

catSectionsList - the Vector to set.

setIpaddrCount

public void setIpaddrCount(int ipaddrCount)

Sets the value of field 'ipaddrCount'.

Parameters:

ipaddrCount - the value of field 'ipaddrCount'.

setNodeCount

public void setNodeCount(int nodeCount)

Sets the value of field 'nodeCount'.

Parameters:

nodeCount - the value of field 'nodeCount'.

setNormal

public void setNormal(double normal)

Sets the value of field 'normal'.

Parameters:

normal - the value of field 'normal'.

setServiceCount

public void setServiceCount(int serviceCount)

Sets the value of field 'serviceCount'.

Parameters:

serviceCount - the value of field 'serviceCount'.

setWarning

public void setWarning(double warning)

Sets the value of field 'warning'.

Parameters:

warning - the value of field 'warning'.

unmarshal

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

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.opennms.reporting.availability.Category

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