org.opennms.netmgt.config.charts

Class ChartConfiguration

java.lang.Object

org.opennms.netmgt.config.charts.ChartConfiguration

All Implemented Interfaces:

Serializable

public class ChartConfiguration
extends Object
implements Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ChartConfiguration()

Method Summary

Modifier and Type	Method and Description
void	addBarChart(BarChart vBarChart)
void	addBarChart(int index, BarChart vBarChart)
Enumeration<BarChart>	enumerateBarChart() Method enumerateBarChart.
boolean	equals(Object obj) Overrides the Object.equals method.
BarChart[]	getBarChart() Method getBarChart.Returns the contents of the collection in an Array.
BarChart	getBarChart(int index) Method getBarChart.
List<BarChart>	getBarChartCollection() Method getBarChartCollection.Returns a reference to 'barChartList'.
int	getBarChartCount() Method getBarChartCount.
int	hashCode() Method hashCode.
Iterator<BarChart>	iterateBarChart() Method iterateBarChart.
void	removeAllBarChart()
boolean	removeBarChart(BarChart vBarChart) Method removeBarChart.
BarChart	removeBarChartAt(int index) Method removeBarChartAt.
void	setBarChart(BarChart[] vBarChartArray)
void	setBarChart(int index, BarChart vBarChart)
void	setBarChart(List<BarChart> vBarChartList) Sets the value of 'barChartList' by copying the given Vector.
void	setBarChartCollection(List<BarChart> barChartList) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChartConfiguration

public ChartConfiguration()

Method Detail

addBarChart

public void addBarChart(BarChart vBarChart)
                 throws IndexOutOfBoundsException

Parameters:

vBarChart -

Throws:

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

addBarChart

public void addBarChart(int index,
                        BarChart vBarChart)
                 throws IndexOutOfBoundsException

Parameters:

index -

vBarChart -

Throws:

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

enumerateBarChart

public Enumeration<BarChart> enumerateBarChart()

Method enumerateBarChart.

Returns:

an Enumeration over all possible elements of this collection

equals

public boolean equals(Object obj)

Overrides the Object.equals method.

Overrides:

equals in class Object

Parameters:

obj -

Returns:

true if the objects are equal.

getBarChart

public BarChart getBarChart(int index)
                     throws IndexOutOfBoundsException

Method getBarChart.

Parameters:

index -

Returns:

the value of the BarChart at the given index

Throws:

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

getBarChart

public BarChart[] getBarChart()

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

getBarChartCollection

public List<BarChart> getBarChartCollection()

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

Returns:

a reference to the Vector backing this class

getBarChartCount

public int getBarChartCount()

Method getBarChartCount.

Returns:

the size of this collection

hashCode

public int hashCode()

Method hashCode.

Overrides:

hashCode in class Object

Returns:

a hash code value for the object.

iterateBarChart

public Iterator<BarChart> iterateBarChart()

Method iterateBarChart.

Returns:

an Iterator over all possible elements in this collection

removeAllBarChart

public void removeAllBarChart()

removeBarChart

public boolean removeBarChart(BarChart vBarChart)

Method removeBarChart.

Parameters:

vBarChart -

Returns:

true if the object was removed from the collection.

removeBarChartAt

public BarChart removeBarChartAt(int index)

Method removeBarChartAt.

Parameters:

index -

Returns:

the element removed from the collection

setBarChart

public void setBarChart(int index,
                        BarChart vBarChart)
                 throws IndexOutOfBoundsException

Parameters:

index -

vBarChart -

Throws:

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

setBarChart

public void setBarChart(BarChart[] vBarChartArray)

Parameters:

vBarChartArray -

setBarChart

public void setBarChart(List<BarChart> vBarChartList)

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

Parameters:

vBarChartList - the Vector to copy.

setBarChartCollection

public void setBarChartCollection(List<BarChart> barChartList)

Deprecated.

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

Parameters:

barChartList - the Vector to set.