|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jrobin.core.ArcDef
public class ArcDef
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 java.lang.String[] |
CONSOL_FUNS
array of valid consolidation function names |
Constructor Summary | |
---|---|
ArcDef(java.lang.String consolFun,
double xff,
int steps,
int rows)
Creates new archive definition object. |
Method Summary | |
---|---|
java.lang.String |
dump()
Returns string representing archive definition (RRDTool format). |
boolean |
equals(java.lang.Object obj)
Checks if two archive definitions are equal. |
java.lang.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(java.lang.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 |
---|
public static final java.lang.String[] CONSOL_FUNS
Constructor Detail |
---|
public ArcDef(java.lang.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
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.
RrdException
- Thrown if any parameter has illegal value.Method Detail |
---|
public java.lang.String getConsolFun()
public double getXff()
public int getSteps()
public int getRows()
public java.lang.String dump()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
obj
- Archive definition to compare with.
true
if archive definitions are equal,
false
otherwise.public static boolean isValidConsolFun(java.lang.String consolFun)
consolFun
- Consolidation function to be checked
true
if consolFun
is valid consolidation function,
false
otherwise.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |