org.jrobin.core
public class ArcDef extends Object implements ConsolFuns
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.
|
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" (these string constants are conveniently defined in the ConsolFuns class). 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.
Returns: String containing all archive definition parameters.
Parameters: obj Archive definition to compare with.
Returns: true
if archive definitions are equal,
false
otherwise.
Returns: Consolidation function.
Returns: Number of rows.
Returns: Number of steps.
Returns: X-files factor value.
Parameters: consolFun Consolidation function to be checked
Returns: true
if consolFun
is valid consolidation function,
false
otherwise.