org.opennms.report.configuration
Class GroupXSet

java.lang.Object
  org.opennms.report.configuration.GroupXSet

All Implemented Interfaces:

Serializable

public class GroupXSet
extends Object
implements Serializable

Class GroupXSet.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

GroupXSet()

Method Summary

void	addNodeSet(int index, NodeSet vNodeSet)
void	addNodeSet(NodeSet vNodeSet)
void	deleteNodesMatching()
void	deleteNodesWithoutconfigurationAtAll()
void	deleteNodesWithoutconfigurationAtReportDate()
void	deleteTotalNodes()
Enumeration<NodeSet>	enumerateNodeSet() Method enumerateNodeSet.
String	getGroupXSetName() Returns the value of field 'groupXSetName'.
NodeSet[]	getNodeSet() Method getNodeSet.Returns the contents of the collection in an Array.
NodeSet	getNodeSet(int index) Method getNodeSet.
List<NodeSet>	getNodeSetCollection() Method getNodeSetCollection.Returns a reference to '_nodeSetList'.
int	getNodeSetCount() Method getNodeSetCount.
int	getNodesMatching() Returns the value of field 'nodesMatching'.
int	getNodesWithoutconfigurationAtAll() Returns the value of field 'nodesWithoutconfigurationAtAll'.
int	getNodesWithoutconfigurationAtReportDate() Returns the value of field 'nodesWithoutconfigurationAtReportDate'.
int	getTotalNodes() Returns the value of field 'totalNodes'.
boolean	hasNodesMatching() Method hasNodesMatching.
boolean	hasNodesWithoutconfigurationAtAll() Method hasNodesWithoutconfigurationAtAll.
boolean	hasNodesWithoutconfigurationAtReportDate() Method hasNodesWithoutconfigurationAtReportDate.
boolean	hasTotalNodes() Method hasTotalNodes.
boolean	isValid() Method isValid.
Iterator<NodeSet>	iterateNodeSet() Method iterateNodeSet.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllNodeSet()
boolean	removeNodeSet(NodeSet vNodeSet) Method removeNodeSet.
NodeSet	removeNodeSetAt(int index) Method removeNodeSetAt.
void	setGroupXSetName(String groupXSetName) Sets the value of field 'groupXSetName'.
void	setNodeSet(int index, NodeSet vNodeSet)
void	setNodeSet(List<NodeSet> vNodeSetList) Sets the value of '_nodeSetList' by copying the given Vector.
void	setNodeSet(NodeSet[] vNodeSetArray)
void	setNodeSetCollection(List<NodeSet> nodeSetList) Deprecated.
void	setNodesMatching(int nodesMatching) Sets the value of field 'nodesMatching'.
void	setNodesWithoutconfigurationAtAll(int nodesWithoutconfigurationAtAll) Sets the value of field 'nodesWithoutconfigurationAtAll'.
void	setNodesWithoutconfigurationAtReportDate(int nodesWithoutconfigurationAtReportDate) Sets the value of field 'nodesWithoutconfigurationAtReportDate'.
void	setTotalNodes(int totalNodes) Sets the value of field 'totalNodes'.
static GroupXSet	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

GroupXSet

public GroupXSet()

Method Detail

addNodeSet

public void addNodeSet(NodeSet vNodeSet)
                throws IndexOutOfBoundsException

Parameters:

vNodeSet -

Throws:

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

addNodeSet

public void addNodeSet(int index,
                       NodeSet vNodeSet)
                throws IndexOutOfBoundsException

Parameters:

index -

vNodeSet -

Throws:

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

deleteNodesMatching

public void deleteNodesMatching()

deleteNodesWithoutconfigurationAtAll

public void deleteNodesWithoutconfigurationAtAll()

deleteNodesWithoutconfigurationAtReportDate

public void deleteNodesWithoutconfigurationAtReportDate()

deleteTotalNodes

public void deleteTotalNodes()

enumerateNodeSet

public Enumeration<NodeSet> enumerateNodeSet()

Method enumerateNodeSet.

Returns:

an Enumeration over all possible elements of this collection

getGroupXSetName

public String getGroupXSetName()

Returns the value of field 'groupXSetName'.

Returns:

the value of field 'GroupXSetName'.

getNodeSet

public NodeSet getNodeSet(int index)
                   throws IndexOutOfBoundsException

Method getNodeSet.

Parameters:

index -

Returns:

the value of the org.opennms.report.configuration.NodeSet at the given index

Throws:

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

getNodeSet

public NodeSet[] getNodeSet()

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

getNodeSetCollection

public List<NodeSet> getNodeSetCollection()

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

Returns:

a reference to the Vector backing this class

getNodeSetCount

public int getNodeSetCount()

Method getNodeSetCount.

Returns:

the size of this collection

getNodesMatching

public int getNodesMatching()

Returns the value of field 'nodesMatching'.

Returns:

the value of field 'NodesMatching'.

getNodesWithoutconfigurationAtAll

public int getNodesWithoutconfigurationAtAll()

Returns the value of field 'nodesWithoutconfigurationAtAll'.

Returns:

the value of field 'NodesWithoutconfigurationAtAll'.

getNodesWithoutconfigurationAtReportDate

public int getNodesWithoutconfigurationAtReportDate()

Returns the value of field 'nodesWithoutconfigurationAtReportDate'.

Returns:

the value of field 'NodesWithoutconfigurationAtReportDate'.

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

hasNodesWithoutconfigurationAtAll

public boolean hasNodesWithoutconfigurationAtAll()

Method hasNodesWithoutconfigurationAtAll.

Returns:

true if at least one NodesWithoutconfigurationAtAll has been added

hasNodesWithoutconfigurationAtReportDate

public boolean hasNodesWithoutconfigurationAtReportDate()

Method hasNodesWithoutconfigurationAtReportDate.

Returns:

true if at least one NodesWithoutconfigurationAtReportDate 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

iterateNodeSet

public Iterator<NodeSet> iterateNodeSet()

Method iterateNodeSet.

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

removeAllNodeSet

public void removeAllNodeSet()

removeNodeSet

public boolean removeNodeSet(NodeSet vNodeSet)

Method removeNodeSet.

Parameters:

vNodeSet -

Returns:

true if the object was removed from the collection.

removeNodeSetAt

public NodeSet removeNodeSetAt(int index)

Method removeNodeSetAt.

Parameters:

index -

Returns:

the element removed from the collection

setGroupXSetName

public void setGroupXSetName(String groupXSetName)

Sets the value of field 'groupXSetName'.

Parameters:

groupXSetName - the value of field 'groupXSetName'.

setNodeSet

public void setNodeSet(int index,
                       NodeSet vNodeSet)
                throws IndexOutOfBoundsException

Parameters:

index -

vNodeSet -

Throws:

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

setNodeSet

public void setNodeSet(NodeSet[] vNodeSetArray)

Parameters:

vNodeSetArray -

setNodeSet

public void setNodeSet(List<NodeSet> vNodeSetList)

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

Parameters:

vNodeSetList - the Vector to copy.

setNodeSetCollection

public void setNodeSetCollection(List<NodeSet> nodeSetList)

Deprecated.

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

Parameters:

nodeSetList - the Vector to set.

setNodesMatching

public void setNodesMatching(int nodesMatching)

Sets the value of field 'nodesMatching'.

Parameters:

nodesMatching - the value of field 'nodesMatching'.

setNodesWithoutconfigurationAtAll

public void setNodesWithoutconfigurationAtAll(int nodesWithoutconfigurationAtAll)

Sets the value of field 'nodesWithoutconfigurationAtAll'.

Parameters:

nodesWithoutconfigurationAtAll - the value of field 'nodesWithoutconfigurationAtAll'.

setNodesWithoutconfigurationAtReportDate

public void setNodesWithoutconfigurationAtReportDate(int nodesWithoutconfigurationAtReportDate)

Sets the value of field 'nodesWithoutconfigurationAtReportDate'.

Parameters:

nodesWithoutconfigurationAtReportDate - the value of field 'nodesWithoutconfigurationAtReportDate'.

setTotalNodes

public void setTotalNodes(int totalNodes)

Sets the value of field 'totalNodes'.

Parameters:

totalNodes - the value of field 'totalNodes'.

unmarshal

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

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.opennms.report.configuration.GroupXSet

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