Package org.opennms.netmgt.config.charts

Class BarChart

  • All Implemented Interfaces:
    java.io.Serializable
    public class BarChart
extends java.lang.Object
implements java.io.Serializable
    See Also:
    Serialized Form

    • Constructor Detail

      • BarChart

        public BarChart()

    • Method Detail

      • addSeriesDef

        public void addSeriesDef​(SeriesDef vSeriesDef)
                  throws java.lang.IndexOutOfBoundsException
        Parameters:
        vSeriesDef -
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

      • addSeriesDef

        public void addSeriesDef​(int index,
                         SeriesDef vSeriesDef)
                  throws java.lang.IndexOutOfBoundsException
        Parameters:
        index -
        vSeriesDef -
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

      • addSubTitle

        public void addSubTitle​(SubTitle vSubTitle)
                 throws java.lang.IndexOutOfBoundsException
        Parameters:
        vSubTitle -
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

      • addSubTitle

        public void addSubTitle​(int index,
                        SubTitle vSubTitle)
                 throws java.lang.IndexOutOfBoundsException
        Parameters:
        index -
        vSubTitle -
        Throws:
        java.lang.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 java.util.Enumeration<SeriesDef> enumerateSeriesDef()
        Method enumerateSeriesDef.
        Returns:
        an Enumeration over all possible elements of this collection

      • enumerateSubTitle

        public java.util.Enumeration<SubTitle> enumerateSubTitle()
        Method enumerateSubTitle.
        Returns:
        an Enumeration over all possible elements of this collection

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides the Object.equals method.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj -
        Returns:
        true if the objects are equal.

      • getChartBackgroundColor

        public java.util.Optional<ChartBackgroundColor> getChartBackgroundColor()
        Returns the value of field 'chartBackgroundColor'.
        Returns:
        the value of field 'ChartBackgroundColor'.

      • getDomainAxisLabel

        public java.lang.String getDomainAxisLabel()
        Returns the value of field 'domainAxisLabel'.
        Returns:
        the value of field 'DomainAxisLabel'.

      • getDrawBarOutline

        public java.lang.Boolean getDrawBarOutline()
        Returns the value of field 'drawBarOutline'.
        Returns:
        the value of field 'DrawBarOutline'.

      • getGridLines

        public java.util.Optional<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 java.lang.String getName()
        Returns the value of field 'name'.
        Returns:
        the value of field 'Name'.

      • getPlotBackgroundColor

        public java.util.Optional<PlotBackgroundColor> getPlotBackgroundColor()
        Returns the value of field 'plotBackgroundColor'.
        Returns:
        the value of field 'PlotBackgroundColor'.

      • getPlotOrientation

        public java.util.Optional<java.lang.String> getPlotOrientation()
        Returns the value of field 'plotOrientation'.
        Returns:
        the value of field 'PlotOrientation'.

      • getRangeAxisLabel

        public java.lang.String getRangeAxisLabel()
        Returns the value of field 'rangeAxisLabel'.
        Returns:
        the value of field 'RangeAxisLabel'.

      • getSeriesColorClass

        public java.util.Optional<java.lang.String> getSeriesColorClass()
        Returns the value of field 'seriesColorClass'.
        Returns:
        the value of field 'SeriesColorClass'.

      • getSeriesDef

        public SeriesDef getSeriesDef​(int index)
                       throws java.lang.IndexOutOfBoundsException
        Method getSeriesDef.
        Parameters:
        index -
        Returns:
        the value of the SeriesDef at the given index
        Throws:
        java.lang.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 java.util.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 java.lang.Boolean getShowLegend()
        Returns the value of field 'showLegend'.
        Returns:
        the value of field 'ShowLegend'.

      • getShowToolTips

        public java.lang.Boolean getShowToolTips()
        Returns the value of field 'showToolTips'.
        Returns:
        the value of field 'ShowToolTips'.

      • getShowUrls

        public java.lang.Boolean getShowUrls()
        Returns the value of field 'showUrls'.
        Returns:
        the value of field 'ShowUrls'.

      • getSubLabelClass

        public java.util.Optional<java.lang.String> getSubLabelClass()
        Returns the value of field 'subLabelClass'.
        Returns:
        the value of field 'SubLabelClass'.

      • getSubTitle

        public SubTitle getSubTitle​(int index)
                     throws java.lang.IndexOutOfBoundsException
        Method getSubTitle.
        Parameters:
        index -
        Returns:
        the value of the SubTitle at the given index
        Throws:
        java.lang.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 java.util.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 java.util.Optional<java.lang.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

      • hashCode

        public int hashCode()
        Method hashCode.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        a hash code value for the object.

      • isDrawBarOutline

        public java.lang.Boolean isDrawBarOutline()
        Returns the value of field 'drawBarOutline'.
        Returns:
        the value of field 'DrawBarOutline'.

      • isShowLegend

        public java.lang.Boolean isShowLegend()
        Returns the value of field 'showLegend'.
        Returns:
        the value of field 'ShowLegend'.

      • isShowToolTips

        public java.lang.Boolean isShowToolTips()
        Returns the value of field 'showToolTips'.
        Returns:
        the value of field 'ShowToolTips'.

      • isShowUrls

        public java.lang.Boolean isShowUrls()
        Returns the value of field 'showUrls'.
        Returns:
        the value of field 'ShowUrls'.

      • iterateSeriesDef

        public java.util.Iterator<SeriesDef> iterateSeriesDef()
        Method iterateSeriesDef.
        Returns:
        an Iterator over all possible elements in this collection

      • iterateSubTitle

        public java.util.Iterator<SubTitle> iterateSubTitle()
        Method iterateSubTitle.
        Returns:
        an Iterator over all possible elements in this collection

      • 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

      • setChartBackgroundColor

        public void setChartBackgroundColor​(ChartBackgroundColor chartBackgroundColor)
        Sets the value of field 'chartBackgroundColor'.
        Parameters:
        chartBackgroundColor - the value of field 'chartBackgroundColor'.

      • setDomainAxisLabel

        public void setDomainAxisLabel​(java.lang.String domainAxisLabel)
        Sets the value of field 'domainAxisLabel'.
        Parameters:
        domainAxisLabel - the value of field 'domainAxisLabel'.

      • setDrawBarOutline

        public void setDrawBarOutline​(java.lang.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​(java.lang.String name)
        Sets the value of field 'name'.
        Parameters:
        name - the value of field 'name'.

      • setPlotBackgroundColor

        public void setPlotBackgroundColor​(PlotBackgroundColor plotBackgroundColor)
        Sets the value of field 'plotBackgroundColor'.
        Parameters:
        plotBackgroundColor - the value of field 'plotBackgroundColor'.

      • setPlotOrientation

        public void setPlotOrientation​(java.lang.String plotOrientation)
        Sets the value of field 'plotOrientation'.
        Parameters:
        plotOrientation - the value of field 'plotOrientation'.

      • setRangeAxisLabel

        public void setRangeAxisLabel​(java.lang.String rangeAxisLabel)
        Sets the value of field 'rangeAxisLabel'.
        Parameters:
        rangeAxisLabel - the value of field 'rangeAxisLabel'.

      • setSeriesColorClass

        public void setSeriesColorClass​(java.lang.String seriesColorClass)
        Sets the value of field 'seriesColorClass'.
        Parameters:
        seriesColorClass - the value of field 'seriesColorClass'.

      • setSeriesDef

        public void setSeriesDef​(int index,
                         SeriesDef vSeriesDef)
                  throws java.lang.IndexOutOfBoundsException
        Parameters:
        index -
        vSeriesDef -
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

      • setSeriesDef

        public void setSeriesDef​(SeriesDef[] vSeriesDefArray)
        Parameters:
        vSeriesDefArray -

      • setSeriesDef

        public void setSeriesDef​(java.util.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​(java.util.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​(java.lang.Boolean showLegend)
        Sets the value of field 'showLegend'.
        Parameters:
        showLegend - the value of field 'showLegend'.

      • setShowToolTips

        public void setShowToolTips​(java.lang.Boolean showToolTips)
        Sets the value of field 'showToolTips'.
        Parameters:
        showToolTips - the value of field 'showToolTips'.

      • setShowUrls

        public void setShowUrls​(java.lang.Boolean showUrls)
        Sets the value of field 'showUrls'.
        Parameters:
        showUrls - the value of field 'showUrls'.

      • setSubLabelClass

        public void setSubLabelClass​(java.lang.String subLabelClass)
        Sets the value of field 'subLabelClass'.
        Parameters:
        subLabelClass - the value of field 'subLabelClass'.

      • setSubTitle

        public void setSubTitle​(int index,
                        SubTitle vSubTitle)
                 throws java.lang.IndexOutOfBoundsException
        Parameters:
        index -
        vSubTitle -
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

      • setSubTitle

        public void setSubTitle​(SubTitle[] vSubTitleArray)
        Parameters:
        vSubTitleArray -

      • setSubTitle

        public void setSubTitle​(java.util.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​(java.util.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​(java.lang.String variation)
        Sets the value of field 'variation'.
        Parameters:
        variation - the value of field 'variation'.