public class

DsDef

extends Object
java.lang.Object
   ↳ org.rrd4j.core.DsDef

Class Overview

Class to represent single data source definition within the RRD. Datasource definition consists of the following five elements:

  • data source name
  • data soruce type
  • heartbeat
  • minimal value
  • maximal value

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

Summary

Public Constructors
DsDef(String dsName, DsType dsType, long heartbeat, double minValue, double maxValue)

Creates new data source definition object.

Public Methods
String dump()
Returns string representing source definition (RRDTool format).
boolean equals(Object obj)
Checks if two datasource definitions are equal.
String getDsName()
Returns data source name.
DsType getDsType()
Returns source type.
long getHeartbeat()
Returns source heartbeat.
double getMaxValue()
Returns maximal calculated source value.
double getMinValue()
Returns minimal calculated source value.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public DsDef (String dsName, DsType dsType, long heartbeat, double minValue, double maxValue)

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.

Parameters
dsName Data source name.
dsType Data source type. Valid values are "COUNTER", "GAUGE", "DERIVE" and "ABSOLUTE" (these string constants are conveniently defined in the DsType class).
heartbeat Hearbeat
minValue Minimal value. Use Double.NaN if unknown.
maxValue Maximal value. Use Double.NaN if unknown.

Public Methods

public String dump ()

Returns string representing source definition (RRDTool format).

Returns
  • String containing all data source definition parameters.

public boolean equals (Object obj)

Checks if two datasource definitions are equal. Source definitions are treated as equal if they have the same source name. It is not possible to create RRD with two equal archive definitions.

Parameters
obj Archive definition to compare with.
Returns
  • true if archive definitions are equal, false otherwise.

public String getDsName ()

Returns data source name.

Returns
  • Data source name.

public DsType getDsType ()

Returns source type.

Returns
  • Source type ("COUNTER", "GAUGE", "DERIVE" or "ABSOLUTE").

public long getHeartbeat ()

Returns source heartbeat.

Returns
  • Source heartbeat.

public double getMaxValue ()

Returns maximal calculated source value.

Returns
  • Maximal value.

public double getMinValue ()

Returns minimal calculated source value.

Returns
  • Minimal value.