|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jrobin.core.DsDef
public class DsDef
Class to represent single data source definition within the RRD. Datasource definition consists of the following five elements:
For the complete explanation of all source definition parameters, see RRDTool's rrdcreate man page.
Field Summary | |
---|---|
static java.lang.String[] |
DS_TYPES
array of valid source types |
Fields inherited from interface org.jrobin.core.DsTypes |
---|
DT_ABSOLUTE, DT_COUNTER, DT_DERIVE, DT_GAUGE |
Constructor Summary | |
---|---|
DsDef(java.lang.String dsName,
java.lang.String dsType,
long heartbeat,
double minValue,
double maxValue)
Creates new data source definition object. |
Method Summary | |
---|---|
java.lang.String |
dump()
Returns string representing source definition (RRDTool format). |
boolean |
equals(java.lang.Object obj)
Checks if two datasource definitions are equal. |
java.lang.String |
getDsName()
Returns data source name. |
java.lang.String |
getDsType()
Returns source type. |
long |
getHeartbeat()
Returns source heartbeat. |
double |
getMaxValue()
Returns maximal calculated source value. |
double |
getMinValue()
Returns minimal calculated source value. |
static boolean |
isValidDsType(java.lang.String dsType)
Checks if function argument represents valid source type. |
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[] DS_TYPES
Constructor Detail |
---|
public DsDef(java.lang.String dsName, java.lang.String dsType, long heartbeat, double minValue, double maxValue) throws RrdException
Creates new data source definition object. This object should be passed as argument
to addDatasource()
method of RrdDb
object.
For the complete explanation of all source definition parameters, see RRDTool's rrdcreate man page
IMPORTANT NOTE: If datasource name ends with '!', corresponding archives will never store NaNs as datasource values. In that case, NaN datasource values will be silently replaced with zeros by the framework.
dsName
- Data source name.dsType
- Data source type. Valid values are "COUNTER", "GAUGE", "DERIVE"
and "ABSOLUTE" (these string constants are conveniently defined in the
DsTypes
class).heartbeat
- HearbeatminValue
- Minimal value. Use Double.NaN
if unknown.maxValue
- Maximal value. Use Double.NaN
if unknown.
RrdException
- Thrown if any parameter has illegal value.Method Detail |
---|
public java.lang.String getDsName()
public java.lang.String getDsType()
public long getHeartbeat()
public double getMinValue()
public double getMaxValue()
public static boolean isValidDsType(java.lang.String dsType)
dsType
- Source type to be checked.
true
if dsType
is valid type,
false
otherwise.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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |