org.jrobin.core
Class ArcDef

java.lang.Object
  extended by org.jrobin.core.ArcDef

public class ArcDef
extends Object

Class to represent single archive definition within the RRD. Archive definition consists of the following four elements:

For the complete explanation of all archive definition parameters, see RRDTool's rrdcreate man page


Field Summary
static String[] CONSOL_FUNS
          array of valid consolidation function names
 
Constructor Summary
ArcDef(String consolFun, double xff, int steps, int rows)
          Creates new archive definition object.
 
Method Summary
 String dump()
          Returns string representing archive definition (RRDTool format).
 boolean equals(Object obj)
          Checks if two archive definitions are equal.
 String getConsolFun()
          Returns consolidation function.
 int getRows()
          Returns the number of rows (aggregated values) stored in the archive.
 int getSteps()
          Returns the number of primary RRD steps which complete a single archive step.
 double getXff()
          Returns the X-files factor.
static boolean isValidConsolFun(String consolFun)
          Checks if function argument represents valid consolidation function name.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CONSOL_FUNS

public static final String[] CONSOL_FUNS
array of valid consolidation function names

Constructor Detail

ArcDef

public ArcDef(String consolFun,
              double xff,
              int steps,
              int rows)
       throws RrdException

Creates new archive definition object. This object should be passed as argument to addArchive() method of RrdDb object.

For the complete explanation of all archive definition parameters, see RRDTool's rrdcreate man page

Parameters:
consolFun - Consolidation function. Allowed values are "AVERAGE", "MIN", "MAX" and "LAST".
xff - X-files factor, between 0 and 1.
steps - Number of archive steps.
rows - Number of archive rows.
Throws:
RrdException - Thrown if any parameter has illegal value.
Method Detail

getConsolFun

public String getConsolFun()
Returns consolidation function.

Returns:
Consolidation function.

getXff

public double getXff()
Returns the X-files factor.

Returns:
X-files factor value.

getSteps

public int getSteps()
Returns the number of primary RRD steps which complete a single archive step.

Returns:
Number of steps.

getRows

public int getRows()
Returns the number of rows (aggregated values) stored in the archive.

Returns:
Number of rows.

dump

public String dump()
Returns string representing archive definition (RRDTool format).

Returns:
String containing all archive definition parameters.

equals

public boolean equals(Object obj)
Checks if two archive definitions are equal. Archive definitions are considered equal if they have the same number of steps and the same consolidation function. It is not possible to create RRD with two equal archive definitions.

Overrides:
equals in class Object
Parameters:
obj - Archive definition to compare with.
Returns:
true if archive definitions are equal, false otherwise.

isValidConsolFun

public static boolean isValidConsolFun(String consolFun)
Checks if function argument represents valid consolidation function name.

Parameters:
consolFun - Consolidation function to be checked
Returns:
true if consolFun is valid consolidation function, false otherwise.