org.opennms.netmgt.config.surveillanceViews

Class ColumnDef

java.lang.Object

org.opennms.netmgt.config.surveillanceViews.ColumnDef

All Implemented Interfaces:

Serializable

public class ColumnDef
extends Object
implements Serializable

Class ColumnDef.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ColumnDef()

Method Summary

Methods

Modifier and Type	Method and Description
void	addCategory(Category vCategory)
void	addCategory(int index, Category vCategory)
Enumeration<Category>	enumerateCategory() Method enumerateCategory.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
Category[]	getCategory() Method getCategory.Returns the contents of the collection in an Array.
Category	getCategory(int index) Method getCategory.
List<Category>	getCategoryCollection() Method getCategoryCollection.Returns a reference to '_categoryList'.
int	getCategoryCount() Method getCategoryCount.
String	getLabel() Returns the value of field 'label'.
String	getReportCategory() Returns the value of field 'reportCategory'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<Category>	iterateCategory() Method iterateCategory.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllCategory()
boolean	removeCategory(Category vCategory) Method removeCategory.
Category	removeCategoryAt(int index) Method removeCategoryAt.
void	setCategory(Category[] vCategoryArray)
void	setCategory(int index, Category vCategory)
void	setCategory(List<Category> vCategoryList) Sets the value of '_categoryList' by copying the given Vector.
void	setCategoryCollection(List<Category> categoryList) Deprecated.
void	setLabel(String label) Sets the value of field 'label'.
void	setReportCategory(String reportCategory) Sets the value of field 'reportCategory'.
static ColumnDef	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

ColumnDef

public ColumnDef()

Method Detail

addCategory

public void addCategory(Category vCategory)
                 throws IndexOutOfBoundsException

Parameters:

vCategory -

Throws:

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

addCategory

public void addCategory(int index,
               Category vCategory)
                 throws IndexOutOfBoundsException

Parameters:

index -

vCategory -

Throws:

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

enumerateCategory

public Enumeration<Category> enumerateCategory()

Method enumerateCategory.

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.

getCategory

public Category getCategory(int index)
                     throws IndexOutOfBoundsException

Method getCategory.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.surveillanceViews.Category at the given index

Throws:

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

getCategory

public Category[] getCategory()

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

getCategoryCollection

public List<Category> getCategoryCollection()

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

Returns:

a reference to the Vector backing this class

getCategoryCount

public int getCategoryCount()

Method getCategoryCount.

Returns:

the size of this collection

getLabel

public String getLabel()

Returns the value of field 'label'.

Returns:

the value of field 'Label'.

getReportCategory

public String getReportCategory()

Returns the value of field 'reportCategory'.

Returns:

the value of field 'ReportCategory'.

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

iterateCategory

public Iterator<Category> iterateCategory()

Method iterateCategory.

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

removeAllCategory

public void removeAllCategory()

removeCategory

public boolean removeCategory(Category vCategory)

Method removeCategory.

Parameters:

vCategory -

Returns:

true if the object was removed from the collection.

removeCategoryAt

public Category removeCategoryAt(int index)

Method removeCategoryAt.

Parameters:

index -

Returns:

the element removed from the collection

setCategory

public void setCategory(int index,
               Category vCategory)
                 throws IndexOutOfBoundsException

Parameters:

index -

vCategory -

Throws:

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

setCategory

public void setCategory(Category[] vCategoryArray)

Parameters:

vCategoryArray -

setCategory

public void setCategory(List<Category> vCategoryList)

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

Parameters:

vCategoryList - the Vector to copy.

setCategoryCollection

public void setCategoryCollection(List<Category> categoryList)

Deprecated.

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

Parameters:

categoryList - the Vector to set.

setLabel

public void setLabel(String label)

Sets the value of field 'label'.

Parameters:

label - the value of field 'label'.

setReportCategory

public void setReportCategory(String reportCategory)

Sets the value of field 'reportCategory'.

Parameters:

reportCategory - the value of field 'reportCategory'.

unmarshal

public static ColumnDef 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.surveillanceViews.ColumnDef

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