Package org.opennms.netmgt.rrd.model.v1

Class RRA

  • public class RRA
extends AbstractRRA
    The Class RRA (Round Robin Archives).

    Warning: This representation doesn't support Aberrant Behavior Detection with Holt-Winters Forecasting

    Author:
    Alejandro Galue

    • Constructor Detail

      • RRA

        public RRA()

    • Method Detail

      • getConsolidationFunction

        public CFType getConsolidationFunction()
        Gets the consolidation function.
        Returns:
        the consolidation function

      • setConsolidationFunction

        public void setConsolidationFunction​(CFType consolidationFunction)
        Sets the consolidation function.
        Parameters:
        consolidationFunction - the new consolidation function

      • setConsolidationFunction

        public void setConsolidationFunction​(java.lang.String consolidationFunction)
        Sets the consolidation function.
        Parameters:
        consolidationFunction - the new consolidation function

      • getDataSources

        public java.util.List<RRADS> getDataSources()
        Gets the data sources.
        Returns:
        the data sources

      • setDataSources

        public void setDataSources​(java.util.List<RRADS> dataSources)
        Sets the data sources.
        Parameters:
        dataSources - the new data sources

      • getXff

        public java.lang.Double getXff()
        Gets the XFF.

        XFF The xfiles factor defines what part of a consolidation interval may be made up from *UNKNOWN* data while the consolidated value is still regarded as known. It is given as the ratio of allowed *UNKNOWN* PDPs to the number of PDPs in the interval. Thus, it ranges from 0 to 1 (exclusive).

        Returns:
        the XFF

      • setXff

        public void setXff​(java.lang.Double xff)
        Sets the XFF.
        Parameters:
        xff - the new XFF

      • formatEquals

        public boolean formatEquals​(RRA rra)
        Format equals.
        Parameters:
        rra - the RRA object
        Returns:
        true, if successful

      • createSingleRRA

        protected AbstractRRA createSingleRRA​(int dsIndex)
                               throws java.lang.IllegalArgumentException
        Description copied from class: AbstractRRA
        Creates a RRA with a single data source.
        Specified by:
        createSingleRRA in class AbstractRRA
        Parameters:
        dsIndex - the RRA-DS index
        Returns:
        the abstract RRA
        Throws:
        java.lang.IllegalArgumentException - the illegal argument exception

      • formatMergeable

        public boolean formatMergeable​(AbstractRRA sourceRra)
        Description copied from class: AbstractRRA
        Format mergeable.

        Two RRA can be merged if and only if the Consolidation Function and the PDP per row are the same.

        The amount of rows is not strict for a merge operation.

        • If the sourceRra has more rows than the current RRA, the result will be truncated by the number of rows on the current RRA.
        • If the sourceRra has less rows than the current RRA, the result will have a NaN window as big as the different between the number of rows.
        Specified by:
        formatMergeable in class AbstractRRA
        Parameters:
        sourceRra - the source RRA object
        Returns:
        true, if the format is mergeable

      • hasAverageAsCF

        public boolean hasAverageAsCF()
        Description copied from class: AbstractRRA
        Checks for average as consolidation function.
        Specified by:
        hasAverageAsCF in class AbstractRRA
        Returns:
        true, if the consolidation function is AVERAGE