org.opennms.report.inventory
Class GroupSet

java.lang.Object
  org.opennms.report.inventory.GroupSet

All Implemented Interfaces:

Serializable

public class GroupSet
extends Object
implements Serializable

Class GroupSet.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

GroupSet()

Method Summary

void	addNbisinglenode(int index, Nbisinglenode vNbisinglenode)
void	addNbisinglenode(Nbisinglenode vNbisinglenode)
void	deleteNodesMatching()
void	deleteNodesWithoutinventoryAtAll()
void	deleteNodesWithoutinventoryAtReportDate()
void	deleteTotalNodes()
Enumeration<Nbisinglenode>	enumerateNbisinglenode() Method enumerateNbisinglenode.
String	getGroupSetName() Returns the value of field 'groupSetName'.
Nbisinglenode[]	getNbisinglenode() Method getNbisinglenode.Returns the contents of the collection in an Array.
Nbisinglenode	getNbisinglenode(int index) Method getNbisinglenode.
List<Nbisinglenode>	getNbisinglenodeCollection() Method getNbisinglenodeCollection.Returns a reference to '_nbisinglenodeList'.
int	getNbisinglenodeCount() Method getNbisinglenodeCount.
int	getNodesMatching() Returns the value of field 'nodesMatching'.
int	getNodesWithoutinventoryAtAll() Returns the value of field 'nodesWithoutinventoryAtAll'.
int	getNodesWithoutinventoryAtReportDate() Returns the value of field 'nodesWithoutinventoryAtReportDate'.
int	getTotalNodes() Returns the value of field 'totalNodes'.
boolean	hasNodesMatching() Method hasNodesMatching.
boolean	hasNodesWithoutinventoryAtAll() Method hasNodesWithoutinventoryAtAll.
boolean	hasNodesWithoutinventoryAtReportDate() Method hasNodesWithoutinventoryAtReportDate.
boolean	hasTotalNodes() Method hasTotalNodes.
boolean	isValid() Method isValid.
Iterator<Nbisinglenode>	iterateNbisinglenode() Method iterateNbisinglenode.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllNbisinglenode()
boolean	removeNbisinglenode(Nbisinglenode vNbisinglenode) Method removeNbisinglenode.
Nbisinglenode	removeNbisinglenodeAt(int index) Method removeNbisinglenodeAt.
void	setGroupSetName(String groupSetName) Sets the value of field 'groupSetName'.
void	setNbisinglenode(int index, Nbisinglenode vNbisinglenode)
void	setNbisinglenode(List<Nbisinglenode> vNbisinglenodeList) Sets the value of '_nbisinglenodeList' by copying the given Vector.
void	setNbisinglenode(Nbisinglenode[] vNbisinglenodeArray)
void	setNbisinglenodeCollection(List<Nbisinglenode> nbisinglenodeList) Deprecated.
void	setNodesMatching(int nodesMatching) Sets the value of field 'nodesMatching'.
void	setNodesWithoutinventoryAtAll(int nodesWithoutinventoryAtAll) Sets the value of field 'nodesWithoutinventoryAtAll'.
void	setNodesWithoutinventoryAtReportDate(int nodesWithoutinventoryAtReportDate) Sets the value of field 'nodesWithoutinventoryAtReportDate'.
void	setTotalNodes(int totalNodes) Sets the value of field 'totalNodes'.
static GroupSet	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

GroupSet

public GroupSet()

Method Detail

addNbisinglenode

public void addNbisinglenode(Nbisinglenode vNbisinglenode)
                      throws IndexOutOfBoundsException

Parameters:

vNbisinglenode -

Throws:

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

addNbisinglenode

public void addNbisinglenode(int index,
                             Nbisinglenode vNbisinglenode)
                      throws IndexOutOfBoundsException

Parameters:

index -

vNbisinglenode -

Throws:

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

deleteNodesMatching

public void deleteNodesMatching()

deleteNodesWithoutinventoryAtAll

public void deleteNodesWithoutinventoryAtAll()

deleteNodesWithoutinventoryAtReportDate

public void deleteNodesWithoutinventoryAtReportDate()

deleteTotalNodes

public void deleteTotalNodes()

enumerateNbisinglenode

public Enumeration<Nbisinglenode> enumerateNbisinglenode()

Method enumerateNbisinglenode.

Returns:

an Enumeration over all possible elements of this collection

getGroupSetName

public String getGroupSetName()

Returns the value of field 'groupSetName'.

Returns:

the value of field 'GroupSetName'.

getNbisinglenode

public Nbisinglenode getNbisinglenode(int index)
                               throws IndexOutOfBoundsException

Method getNbisinglenode.

Parameters:

index -

Returns:

the value of the org.opennms.report.inventory.Nbisinglenode at the given index

Throws:

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

getNbisinglenode

public Nbisinglenode[] getNbisinglenode()

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

getNbisinglenodeCollection

public List<Nbisinglenode> getNbisinglenodeCollection()

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

Returns:

a reference to the Vector backing this class

getNbisinglenodeCount

public int getNbisinglenodeCount()

Method getNbisinglenodeCount.

Returns:

the size of this collection

getNodesMatching

public int getNodesMatching()

Returns the value of field 'nodesMatching'.

Returns:

the value of field 'NodesMatching'.

getNodesWithoutinventoryAtAll

public int getNodesWithoutinventoryAtAll()

Returns the value of field 'nodesWithoutinventoryAtAll'.

Returns:

the value of field 'NodesWithoutinventoryAtAll'.

getNodesWithoutinventoryAtReportDate

public int getNodesWithoutinventoryAtReportDate()

Returns the value of field 'nodesWithoutinventoryAtReportDate'.

Returns:

the value of field 'NodesWithoutinventoryAtReportDate'.

getTotalNodes

public int getTotalNodes()

Returns the value of field 'totalNodes'.

Returns:

the value of field 'TotalNodes'.

hasNodesMatching

public boolean hasNodesMatching()

Method hasNodesMatching.

Returns:

true if at least one NodesMatching has been added

hasNodesWithoutinventoryAtAll

public boolean hasNodesWithoutinventoryAtAll()

Method hasNodesWithoutinventoryAtAll.

Returns:

true if at least one NodesWithoutinventoryAtAll has been added

hasNodesWithoutinventoryAtReportDate

public boolean hasNodesWithoutinventoryAtReportDate()

Method hasNodesWithoutinventoryAtReportDate.

Returns:

true if at least one NodesWithoutinventoryAtReportDate has been added

hasTotalNodes

public boolean hasTotalNodes()

Method hasTotalNodes.

Returns:

true if at least one TotalNodes has been added

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateNbisinglenode

public Iterator<Nbisinglenode> iterateNbisinglenode()

Method iterateNbisinglenode.

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

removeAllNbisinglenode

public void removeAllNbisinglenode()

removeNbisinglenode

public boolean removeNbisinglenode(Nbisinglenode vNbisinglenode)

Method removeNbisinglenode.

Parameters:

vNbisinglenode -

Returns:

true if the object was removed from the collection.

removeNbisinglenodeAt

public Nbisinglenode removeNbisinglenodeAt(int index)

Method removeNbisinglenodeAt.

Parameters:

index -

Returns:

the element removed from the collection

setGroupSetName

public void setGroupSetName(String groupSetName)

Sets the value of field 'groupSetName'.

Parameters:

groupSetName - the value of field 'groupSetName'.

setNbisinglenode

public void setNbisinglenode(int index,
                             Nbisinglenode vNbisinglenode)
                      throws IndexOutOfBoundsException

Parameters:

index -

vNbisinglenode -

Throws:

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

setNbisinglenode

public void setNbisinglenode(Nbisinglenode[] vNbisinglenodeArray)

Parameters:

vNbisinglenodeArray -

setNbisinglenode

public void setNbisinglenode(List<Nbisinglenode> vNbisinglenodeList)

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

Parameters:

vNbisinglenodeList - the Vector to copy.

setNbisinglenodeCollection

public void setNbisinglenodeCollection(List<Nbisinglenode> nbisinglenodeList)

Deprecated.

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

Parameters:

nbisinglenodeList - the Vector to set.

setNodesMatching

public void setNodesMatching(int nodesMatching)

Sets the value of field 'nodesMatching'.

Parameters:

nodesMatching - the value of field 'nodesMatching'.

setNodesWithoutinventoryAtAll

public void setNodesWithoutinventoryAtAll(int nodesWithoutinventoryAtAll)

Sets the value of field 'nodesWithoutinventoryAtAll'.

Parameters:

nodesWithoutinventoryAtAll - the value of field 'nodesWithoutinventoryAtAll'.

setNodesWithoutinventoryAtReportDate

public void setNodesWithoutinventoryAtReportDate(int nodesWithoutinventoryAtReportDate)

Sets the value of field 'nodesWithoutinventoryAtReportDate'.

Parameters:

nodesWithoutinventoryAtReportDate - the value of field 'nodesWithoutinventoryAtReportDate'.

setTotalNodes

public void setTotalNodes(int totalNodes)

Sets the value of field 'totalNodes'.

Parameters:

totalNodes - the value of field 'totalNodes'.

unmarshal

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

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.opennms.report.inventory.GroupSet

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