org.opennms.netmgt.xml.rtc
Class Category

java.lang.Object
  org.opennms.netmgt.xml.rtc.Category

All Implemented Interfaces:

Serializable

public class Category
extends Object
implements Serializable

A category

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Category()

Method Summary

void	addNode(int index, Node vNode)
void	addNode(Node vNode)
void	deleteCatvalue()
Enumeration<Node>	enumerateNode() Method enumerateNode.
String	getCatlabel() Returns the value of field 'catlabel'.
double	getCatvalue() Returns the value of field 'catvalue'.
Node[]	getNode() Method getNode.Returns the contents of the collection in an Array.
Node	getNode(int index) Method getNode.
List<Node>	getNodeCollection() Method getNodeCollection.Returns a reference to '_nodeList'.
int	getNodeCount() Method getNodeCount.
boolean	hasCatvalue() Method hasCatvalue.
boolean	isValid() Method isValid.
Iterator<Node>	iterateNode() Method iterateNode.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllNode()
boolean	removeNode(Node vNode) Method removeNode.
Node	removeNodeAt(int index) Method removeNodeAt.
void	setCatlabel(String catlabel) Sets the value of field 'catlabel'.
void	setCatvalue(double catvalue) Sets the value of field 'catvalue'.
void	setNode(int index, Node vNode)
void	setNode(List<Node> vNodeList) Sets the value of '_nodeList' by copying the given Vector.
void	setNode(Node[] vNodeArray)
void	setNodeCollection(List<Node> nodeList) Deprecated.
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

addNode

public void addNode(Node vNode)
             throws IndexOutOfBoundsException

Parameters:

vNode -

Throws:

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

addNode

public void addNode(int index,
                    Node vNode)
             throws IndexOutOfBoundsException

Parameters:

index -

vNode -

Throws:

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

deleteCatvalue

public void deleteCatvalue()

enumerateNode

public Enumeration<Node> enumerateNode()

Method enumerateNode.

Returns:

an Enumeration over all possible elements of this collection

getCatlabel

public String getCatlabel()

Returns the value of field 'catlabel'. The field 'catlabel' has the following description: The category label

Returns:

the value of field 'Catlabel'.

getCatvalue

public double getCatvalue()

Returns the value of field 'catvalue'. The field 'catvalue' has the following description: The category availability value

Returns:

the value of field 'Catvalue'.

getNode

public Node getNode(int index)
             throws IndexOutOfBoundsException

Method getNode.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.xml.rtc.Node at the given index

Throws:

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

getNode

public Node[] getNode()

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

getNodeCollection

public List<Node> getNodeCollection()

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

Returns:

a reference to the Vector backing this class

getNodeCount

public int getNodeCount()

Method getNodeCount.

Returns:

the size of this collection

hasCatvalue

public boolean hasCatvalue()

Method hasCatvalue.

Returns:

true if at least one Catvalue has been added

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateNode

public Iterator<Node> iterateNode()

Method iterateNode.

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

removeAllNode

public void removeAllNode()

removeNode

public boolean removeNode(Node vNode)

Method removeNode.

Parameters:

vNode -

Returns:

true if the object was removed from the collection.

removeNodeAt

public Node removeNodeAt(int index)

Method removeNodeAt.

Parameters:

index -

Returns:

the element removed from the collection

setCatlabel

public void setCatlabel(String catlabel)

Sets the value of field 'catlabel'. The field 'catlabel' has the following description: The category label

Parameters:

catlabel - the value of field 'catlabel'.

setCatvalue

public void setCatvalue(double catvalue)

Sets the value of field 'catvalue'. The field 'catvalue' has the following description: The category availability value

Parameters:

catvalue - the value of field 'catvalue'.

setNode

public void setNode(int index,
                    Node vNode)
             throws IndexOutOfBoundsException

Parameters:

index -

vNode -

Throws:

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

setNode

public void setNode(Node[] vNodeArray)

Parameters:

vNodeArray -

setNode

public void setNode(List<Node> vNodeList)

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

Parameters:

vNodeList - the Vector to copy.

setNodeCollection

public void setNodeCollection(List<Node> nodeList)

Deprecated.

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

Parameters:

nodeList - the Vector to set.

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.netmgt.xml.rtc.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