rrdService.util
Class RoundRobinArchive

java.lang.Object
  |
  +--rrdService.util.RoundRobinArchive
All Implemented Interfaces:
java.io.Serializable

public class RoundRobinArchive
extends java.lang.Object
implements java.io.Serializable

The class RoundRobinArchive consists of a number of data values from all the defined data-sources and is defined with an RRA line.

Version:
1.0 date : 15/07/2001
key-word
RoundRobin
Author:
Damien Pellier
See Also:
RoundRobinArchive, LockRoundRobinDataBase LockRoundRobinLibrary, Serialized Form

Field Summary
private  CdpPrepContainer cdpPrepContainer
          CdpPrepContainer of this RRA
private  java.lang.String consolidationFunction
          The consolidation function of the archive.
private  int rows
          rows defines how many generations of data values are kept in an RRA.
private  int steps
          steps defines how many of these primary data points are used to build a consolidated data point which then goes into the archive.
private  double xFilesFactor
          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.
 
Constructor Summary
RoundRobinArchive()
          Default constructor of a RoundRobinArchive
RoundRobinArchive(java.lang.String consolidationFunction, double xFilesFactor, int steps, int rows)
          Constructor of a RoundRobinArchive
RoundRobinArchive(java.lang.String consolidationFunction, double xFilesFactor, int steps, int rows, CdpPrepContainer cdpPrepContainer)
          Constructor of a RoundRobinArchive
 
Method Summary
 CdpPrepContainer getCdpPrepContainer()
          Returns the CdpPrepContainer in this archive.
 java.lang.String getConsolidationFunction()
          Returns the consolidation function of this archive.
 int getRows()
          Returns the rows of this archive.
 int getSteps()
          Returns the steps of this archive.
 double getXFilesFactor()
          Returns the xfile factor of this archive.
 void setCdpPrepContainer(CdpPrepContainer cdpPrepContainer)
          Replaces the CdpPrepContainer in this archive.
 void setConsolidationFunction(java.lang.String consolidationFunction)
          Replaces the consolidation function in this archive.
 void setRows(int rows)
          Replaces the rows in this archive.
 void setSteps(int steps)
          Replaces the steps in this archive.
 void setXFilesFactor(double xFilesFactor)
          Replaces the xFilesFactor in this archive.
 java.lang.String toString()
          toString return a string representation of a archive
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait
 

Field Detail

cdpPrepContainer

private CdpPrepContainer cdpPrepContainer
CdpPrepContainer of this RRA

consolidationFunction

private java.lang.String consolidationFunction
The consolidation function of the archive. The following consolidation functions are defined: AVERAGE, MIN, MAX, LAST.

rows

private int rows
rows defines how many generations of data values are kept in an RRA.

steps

private int steps
steps defines how many of these primary data points are used to build a consolidated data point which then goes into the archive.

xFilesFactor

private double xFilesFactor
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.
Constructor Detail

RoundRobinArchive

public RoundRobinArchive()
                  throws java.lang.Exception
Default constructor of a RoundRobinArchive

RoundRobinArchive

public RoundRobinArchive(java.lang.String consolidationFunction,
                         double xFilesFactor,
                         int steps,
                         int rows)
                  throws java.lang.Exception
Constructor of a RoundRobinArchive
Parameters:
consolidationFunction - the consolidation function of the archive
xFilesFactor - the xFilesFactor of the archive
steps - the steps of the archive
rows - the rows of the archive

RoundRobinArchive

public RoundRobinArchive(java.lang.String consolidationFunction,
                         double xFilesFactor,
                         int steps,
                         int rows,
                         CdpPrepContainer cdpPrepContainer)
                  throws java.lang.Exception
Constructor of a RoundRobinArchive
Parameters:
consolidationFunction - the consolidation function of the archive
xFilesFactor - the xFilesFactor of the archive
steps - the steps of the archive
rows - the rows of the archive
cdpPrepContainer - the CdpPrepContainer of the archive
Method Detail

getCdpPrepContainer

public CdpPrepContainer getCdpPrepContainer()
Returns the CdpPrepContainer in this archive.

getConsolidationFunction

public java.lang.String getConsolidationFunction()
Returns the consolidation function of this archive.

getRows

public int getRows()
Returns the rows of this archive.

getSteps

public int getSteps()
Returns the steps of this archive.

getXFilesFactor

public double getXFilesFactor()
Returns the xfile factor of this archive.

setCdpPrepContainer

public void setCdpPrepContainer(CdpPrepContainer cdpPrepContainer)
Replaces the CdpPrepContainer in this archive.
Parameters:
cdpPrepContainer - the CdpPrepContainer of the archive to set

setConsolidationFunction

public void setConsolidationFunction(java.lang.String consolidationFunction)
                              throws java.lang.Exception
Replaces the consolidation function in this archive.
Parameters:
consolidationFunction - the consolidation function of the archive to set

setRows

public void setRows(int rows)
Replaces the rows in this archive.
Parameters:
rows - the rows of the archive to set

setSteps

public void setSteps(int steps)
Replaces the steps in this archive.
Parameters:
steps - the steps of the archive to set

setXFilesFactor

public void setXFilesFactor(double xFilesFactor)
Replaces the xFilesFactor in this archive.
Parameters:
xFilesFactor - the xFilesFactor of the archive to set

toString

public java.lang.String toString()
toString return a string representation of a archive
Overrides:
toString in class java.lang.Object

Copyright 1885-2001 FIRMENICH SA, Geneva

Submit a bug or feature
Copyright 1885-2001 FIRMENICH SA, Geneva,
All Rights Reserved.