org.opennms.netmgt.config.charts
Class BarChart

java.lang.Object
  org.opennms.netmgt.config.charts.BarChart

All Implemented Interfaces:

Serializable

public class BarChart
extends Object
implements Serializable

Class BarChart.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

BarChart()

Method Summary

void	addSeriesDef(int index, SeriesDef vSeriesDef)
void	addSeriesDef(SeriesDef vSeriesDef)
void	addSubTitle(int index, SubTitle vSubTitle)
void	addSubTitle(SubTitle vSubTitle)
void	deleteDrawBarOutline()
void	deleteShowLegend()
void	deleteShowToolTips()
void	deleteShowUrls()
Enumeration<SeriesDef>	enumerateSeriesDef() Method enumerateSeriesDef.
Enumeration<SubTitle>	enumerateSubTitle() Method enumerateSubTitle.
String	getDomainAxisLabel() Returns the value of field 'domainAxisLabel'.
boolean	getDrawBarOutline() Returns the value of field 'drawBarOutline'.
GridLines	getGridLines() Returns the value of field 'gridLines'.
ImageSize	getImageSize() Returns the value of field 'imageSize'.
String	getName() Returns the value of field 'name'.
String	getPlotOrientation() Returns the value of field 'plotOrientation'.
String	getRangeAxisLabel() Returns the value of field 'rangeAxisLabel'.
String	getSeriesColorClass() Returns the value of field 'seriesColorClass'.
SeriesDef[]	getSeriesDef() Method getSeriesDef.Returns the contents of the collection in an Array.
SeriesDef	getSeriesDef(int index) Method getSeriesDef.
List<SeriesDef>	getSeriesDefCollection() Method getSeriesDefCollection.Returns a reference to '_seriesDefList'.
int	getSeriesDefCount() Method getSeriesDefCount.
boolean	getShowLegend() Returns the value of field 'showLegend'.
boolean	getShowToolTips() Returns the value of field 'showToolTips'.
boolean	getShowUrls() Returns the value of field 'showUrls'.
String	getSubLabelClass() Returns the value of field 'subLabelClass'.
SubTitle[]	getSubTitle() Method getSubTitle.Returns the contents of the collection in an Array.
SubTitle	getSubTitle(int index) Method getSubTitle.
List<SubTitle>	getSubTitleCollection() Method getSubTitleCollection.Returns a reference to '_subTitleList'.
int	getSubTitleCount() Method getSubTitleCount.
Title	getTitle() Returns the value of field 'title'.
String	getVariation() Returns the value of field 'variation'.
boolean	hasDrawBarOutline() Method hasDrawBarOutline.
boolean	hasShowLegend() Method hasShowLegend.
boolean	hasShowToolTips() Method hasShowToolTips.
boolean	hasShowUrls() Method hasShowUrls.
boolean	isDrawBarOutline() Returns the value of field 'drawBarOutline'.
boolean	isShowLegend() Returns the value of field 'showLegend'.
boolean	isShowToolTips() Returns the value of field 'showToolTips'.
boolean	isShowUrls() Returns the value of field 'showUrls'.
boolean	isValid() Method isValid.
Iterator<SeriesDef>	iterateSeriesDef() Method iterateSeriesDef.
Iterator<SubTitle>	iterateSubTitle() Method iterateSubTitle.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllSeriesDef()
void	removeAllSubTitle()
boolean	removeSeriesDef(SeriesDef vSeriesDef) Method removeSeriesDef.
SeriesDef	removeSeriesDefAt(int index) Method removeSeriesDefAt.
boolean	removeSubTitle(SubTitle vSubTitle) Method removeSubTitle.
SubTitle	removeSubTitleAt(int index) Method removeSubTitleAt.
void	setDomainAxisLabel(String domainAxisLabel) Sets the value of field 'domainAxisLabel'.
void	setDrawBarOutline(boolean drawBarOutline) Sets the value of field 'drawBarOutline'.
void	setGridLines(GridLines gridLines) Sets the value of field 'gridLines'.
void	setImageSize(ImageSize imageSize) Sets the value of field 'imageSize'.
void	setName(String name) Sets the value of field 'name'.
void	setPlotOrientation(String plotOrientation) Sets the value of field 'plotOrientation'.
void	setRangeAxisLabel(String rangeAxisLabel) Sets the value of field 'rangeAxisLabel'.
void	setSeriesColorClass(String seriesColorClass) Sets the value of field 'seriesColorClass'.
void	setSeriesDef(int index, SeriesDef vSeriesDef)
void	setSeriesDef(List<SeriesDef> vSeriesDefList) Sets the value of '_seriesDefList' by copying the given Vector.
void	setSeriesDef(SeriesDef[] vSeriesDefArray)
void	setSeriesDefCollection(List<SeriesDef> seriesDefList) Deprecated.
void	setShowLegend(boolean showLegend) Sets the value of field 'showLegend'.
void	setShowToolTips(boolean showToolTips) Sets the value of field 'showToolTips'.
void	setShowUrls(boolean showUrls) Sets the value of field 'showUrls'.
void	setSubLabelClass(String subLabelClass) Sets the value of field 'subLabelClass'.
void	setSubTitle(int index, SubTitle vSubTitle)
void	setSubTitle(List<SubTitle> vSubTitleList) Sets the value of '_subTitleList' by copying the given Vector.
void	setSubTitle(SubTitle[] vSubTitleArray)
void	setSubTitleCollection(List<SubTitle> subTitleList) Deprecated.
void	setTitle(Title title) Sets the value of field 'title'.
void	setVariation(String variation) Sets the value of field 'variation'.
static BarChart	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

BarChart

public BarChart()

Method Detail

addSeriesDef

public void addSeriesDef(SeriesDef vSeriesDef)
                  throws IndexOutOfBoundsException

Parameters:

vSeriesDef -

Throws:

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

addSeriesDef

public void addSeriesDef(int index,
                         SeriesDef vSeriesDef)
                  throws IndexOutOfBoundsException

Parameters:

index -

vSeriesDef -

Throws:

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

addSubTitle

public void addSubTitle(SubTitle vSubTitle)
                 throws IndexOutOfBoundsException

Parameters:

vSubTitle -

Throws:

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

addSubTitle

public void addSubTitle(int index,
                        SubTitle vSubTitle)
                 throws IndexOutOfBoundsException

Parameters:

index -

vSubTitle -

Throws:

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

deleteDrawBarOutline

public void deleteDrawBarOutline()

deleteShowLegend

public void deleteShowLegend()

deleteShowToolTips

public void deleteShowToolTips()

deleteShowUrls

public void deleteShowUrls()

enumerateSeriesDef

public Enumeration<SeriesDef> enumerateSeriesDef()

Method enumerateSeriesDef.

Returns:

an Enumeration over all possible elements of this collection

enumerateSubTitle

public Enumeration<SubTitle> enumerateSubTitle()

Method enumerateSubTitle.

Returns:

an Enumeration over all possible elements of this collection

getDomainAxisLabel

public String getDomainAxisLabel()

Returns the value of field 'domainAxisLabel'.

Returns:

the value of field 'DomainAxisLabel'.

getDrawBarOutline

public boolean getDrawBarOutline()

Returns the value of field 'drawBarOutline'.

Returns:

the value of field 'DrawBarOutline'.

getGridLines

public GridLines getGridLines()

Returns the value of field 'gridLines'.

Returns:

the value of field 'GridLines'.

getImageSize

public ImageSize getImageSize()

Returns the value of field 'imageSize'.

Returns:

the value of field 'ImageSize'.

getName

public String getName()

Returns the value of field 'name'.

Returns:

the value of field 'Name'.

getPlotOrientation

public String getPlotOrientation()

Returns the value of field 'plotOrientation'.

Returns:

the value of field 'PlotOrientation'.

getRangeAxisLabel

public String getRangeAxisLabel()

Returns the value of field 'rangeAxisLabel'.

Returns:

the value of field 'RangeAxisLabel'.

getSeriesColorClass

public String getSeriesColorClass()

Returns the value of field 'seriesColorClass'.

Returns:

the value of field 'SeriesColorClass'.

getSeriesDef

public SeriesDef getSeriesDef(int index)
                       throws IndexOutOfBoundsException

Method getSeriesDef.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.charts.SeriesDef at the given index

Throws:

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

getSeriesDef

public SeriesDef[] getSeriesDef()

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

getSeriesDefCollection

public List<SeriesDef> getSeriesDefCollection()

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

Returns:

a reference to the Vector backing this class

getSeriesDefCount

public int getSeriesDefCount()

Method getSeriesDefCount.

Returns:

the size of this collection

getShowLegend

public boolean getShowLegend()

Returns the value of field 'showLegend'.

Returns:

the value of field 'ShowLegend'.

getShowToolTips

public boolean getShowToolTips()

Returns the value of field 'showToolTips'.

Returns:

the value of field 'ShowToolTips'.

getShowUrls

public boolean getShowUrls()

Returns the value of field 'showUrls'.

Returns:

the value of field 'ShowUrls'.

getSubLabelClass

public String getSubLabelClass()

Returns the value of field 'subLabelClass'.

Returns:

the value of field 'SubLabelClass'.

getSubTitle

public SubTitle getSubTitle(int index)
                     throws IndexOutOfBoundsException

Method getSubTitle.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.charts.SubTitle at the given index

Throws:

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

getSubTitle

public SubTitle[] getSubTitle()

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

getSubTitleCollection

public List<SubTitle> getSubTitleCollection()

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

Returns:

a reference to the Vector backing this class

getSubTitleCount

public int getSubTitleCount()

Method getSubTitleCount.

Returns:

the size of this collection

getTitle

public Title getTitle()

Returns the value of field 'title'.

Returns:

the value of field 'Title'.

getVariation

public String getVariation()

Returns the value of field 'variation'.

Returns:

the value of field 'Variation'.

hasDrawBarOutline

public boolean hasDrawBarOutline()

Method hasDrawBarOutline.

Returns:

true if at least one DrawBarOutline has been added

hasShowLegend

public boolean hasShowLegend()

Method hasShowLegend.

Returns:

true if at least one ShowLegend has been added

hasShowToolTips

public boolean hasShowToolTips()

Method hasShowToolTips.

Returns:

true if at least one ShowToolTips has been added

hasShowUrls

public boolean hasShowUrls()

Method hasShowUrls.

Returns:

true if at least one ShowUrls has been added

isDrawBarOutline

public boolean isDrawBarOutline()

Returns the value of field 'drawBarOutline'.

Returns:

the value of field 'DrawBarOutline'.

isShowLegend

public boolean isShowLegend()

Returns the value of field 'showLegend'.

Returns:

the value of field 'ShowLegend'.

isShowToolTips

public boolean isShowToolTips()

Returns the value of field 'showToolTips'.

Returns:

the value of field 'ShowToolTips'.

isShowUrls

public boolean isShowUrls()

Returns the value of field 'showUrls'.

Returns:

the value of field 'ShowUrls'.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateSeriesDef

public Iterator<SeriesDef> iterateSeriesDef()

Method iterateSeriesDef.

Returns:

an Iterator over all possible elements in this collection

iterateSubTitle

public Iterator<SubTitle> iterateSubTitle()

Method iterateSubTitle.

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

removeAllSeriesDef

public void removeAllSeriesDef()

removeAllSubTitle

public void removeAllSubTitle()

removeSeriesDef

public boolean removeSeriesDef(SeriesDef vSeriesDef)

Method removeSeriesDef.

Parameters:

vSeriesDef -

Returns:

true if the object was removed from the collection.

removeSeriesDefAt

public SeriesDef removeSeriesDefAt(int index)

Method removeSeriesDefAt.

Parameters:

index -

Returns:

the element removed from the collection

removeSubTitle

public boolean removeSubTitle(SubTitle vSubTitle)

Method removeSubTitle.

Parameters:

vSubTitle -

Returns:

true if the object was removed from the collection.

removeSubTitleAt

public SubTitle removeSubTitleAt(int index)

Method removeSubTitleAt.

Parameters:

index -

Returns:

the element removed from the collection

setDomainAxisLabel

public void setDomainAxisLabel(String domainAxisLabel)

Sets the value of field 'domainAxisLabel'.

Parameters:

domainAxisLabel - the value of field 'domainAxisLabel'.

setDrawBarOutline

public void setDrawBarOutline(boolean drawBarOutline)

Sets the value of field 'drawBarOutline'.

Parameters:

drawBarOutline - the value of field 'drawBarOutline'.

setGridLines

public void setGridLines(GridLines gridLines)

Sets the value of field 'gridLines'.

Parameters:

gridLines - the value of field 'gridLines'.

setImageSize

public void setImageSize(ImageSize imageSize)

Sets the value of field 'imageSize'.

Parameters:

imageSize - the value of field 'imageSize'.

setName

public void setName(String name)

Sets the value of field 'name'.

Parameters:

name - the value of field 'name'.

setPlotOrientation

public void setPlotOrientation(String plotOrientation)

Sets the value of field 'plotOrientation'.

Parameters:

plotOrientation - the value of field 'plotOrientation'.

setRangeAxisLabel

public void setRangeAxisLabel(String rangeAxisLabel)

Sets the value of field 'rangeAxisLabel'.

Parameters:

rangeAxisLabel - the value of field 'rangeAxisLabel'.

setSeriesColorClass

public void setSeriesColorClass(String seriesColorClass)

Sets the value of field 'seriesColorClass'.

Parameters:

seriesColorClass - the value of field 'seriesColorClass'

setSeriesDef

public void setSeriesDef(int index,
                         SeriesDef vSeriesDef)
                  throws IndexOutOfBoundsException

Parameters:

index -

vSeriesDef -

Throws:

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

setSeriesDef

public void setSeriesDef(SeriesDef[] vSeriesDefArray)

Parameters:

vSeriesDefArray -

setSeriesDef

public void setSeriesDef(List<SeriesDef> vSeriesDefList)

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

Parameters:

vSeriesDefList - the Vector to copy.

setSeriesDefCollection

public void setSeriesDefCollection(List<SeriesDef> seriesDefList)

Deprecated.

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

Parameters:

seriesDefList - the Vector to set.

setShowLegend

public void setShowLegend(boolean showLegend)

Sets the value of field 'showLegend'.

Parameters:

showLegend - the value of field 'showLegend'.

setShowToolTips

public void setShowToolTips(boolean showToolTips)

Sets the value of field 'showToolTips'.

Parameters:

showToolTips - the value of field 'showToolTips'.

setShowUrls

public void setShowUrls(boolean showUrls)

Sets the value of field 'showUrls'.

Parameters:

showUrls - the value of field 'showUrls'.

setSubLabelClass

public void setSubLabelClass(String subLabelClass)

Sets the value of field 'subLabelClass'.

Parameters:

subLabelClass - the value of field 'subLabelClass'.

setSubTitle

public void setSubTitle(int index,
                        SubTitle vSubTitle)
                 throws IndexOutOfBoundsException

Parameters:

index -

vSubTitle -

Throws:

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

setSubTitle

public void setSubTitle(SubTitle[] vSubTitleArray)

Parameters:

vSubTitleArray -

setSubTitle

public void setSubTitle(List<SubTitle> vSubTitleList)

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

Parameters:

vSubTitleList - the Vector to copy.

setSubTitleCollection

public void setSubTitleCollection(List<SubTitle> subTitleList)

Deprecated.

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

Parameters:

subTitleList - the Vector to set.

setTitle

public void setTitle(Title title)

Sets the value of field 'title'.

Parameters:

title - the value of field 'title'.

setVariation

public void setVariation(String variation)

Sets the value of field 'variation'.

Parameters:

variation - the value of field 'variation'.

unmarshal

public static BarChart 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.charts.BarChart

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