public class

Datasource

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

Class Overview

Class to represent single datasource within RRD. Each datasource object holds the following information: datasource definition (once set, never changed) and datasource state variables (changed whenever RRD gets updated).

Normally, you don't need to manipulate Datasource objects directly, it's up to Rrd4j framework to do it for you.

Summary

Public Methods
void copyStateTo(RrdUpdater other)
Copies object's internal state to another Datasource object.
double getAccumValue()
Returns value this datasource accumulated so far.
int getDsIndex()
Returns index of this Datasource object in the RRD.
String getDsName()
Returns datasource name.
DsType getDsType()
Returns datasource type (GAUGE, COUNTER, DERIVE, ABSOLUTE).
long getHeartbeat()
Returns datasource heartbeat
double getLastValue()
Returns last known value of the datasource.
double getMaxValue()
Returns maximal allowed value for this datasource.
double getMinValue()
Returns mimimal allowed value for this datasource.
long getNanSeconds()
Returns the number of accumulated NaN seconds.
RrdAllocator getRrdAllocator()
Required to implement RrdUpdater interface.
RrdBackend getRrdBackend()
Returns the underlying storage (backend) object which actually performs all I/O operations.
void setDsName(String newDsName)
Sets datasource name to a new value
void setDsType(DsType newDsType)
void setHeartbeat(long heartbeat)
Sets datasource heartbeat to a new value.
void setMaxValue(double maxValue, boolean filterArchivedValues)
Sets maximum allowed value for this datasource.
void setMinMaxValue(double minValue, double maxValue, boolean filterArchivedValues)
Sets min/max values allowed for this datasource.
void setMinValue(double minValue, boolean filterArchivedValues)
Sets minimum allowed value for this datasource.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public void copyStateTo (RrdUpdater other)

Copies object's internal state to another Datasource object.

Parameters
other New Datasource object to copy state to
Throws
IOException Thrown in case of I/O error

public double getAccumValue ()

Returns value this datasource accumulated so far.

Returns
  • Accumulated datasource value.
Throws
IOException Thrown in case of I/O error

public int getDsIndex ()

Returns index of this Datasource object in the RRD.

Returns
  • Datasource index in the RRD.
Throws
IOException Thrown in case of I/O error

public String getDsName ()

Returns datasource name.

Returns
  • Datasource name
Throws
IOException Thrown in case of I/O error

public DsType getDsType ()

Returns datasource type (GAUGE, COUNTER, DERIVE, ABSOLUTE).

Returns
  • Datasource type.
Throws
IOException Thrown in case of I/O error

public long getHeartbeat ()

Returns datasource heartbeat

Returns
  • Datasource heartbeat
Throws
IOException Thrown in case of I/O error

public double getLastValue ()

Returns last known value of the datasource.

Returns
  • Last datasource value.
Throws
IOException Thrown in case of I/O error

public double getMaxValue ()

Returns maximal allowed value for this datasource.

Returns
  • Maximal value allowed.
Throws
IOException Thrown in case of I/O error

public double getMinValue ()

Returns mimimal allowed value for this datasource.

Returns
  • Minimal value allowed.
Throws
IOException Thrown in case of I/O error

public long getNanSeconds ()

Returns the number of accumulated NaN seconds.

Returns
  • Accumulated NaN seconds.
Throws
IOException Thrown in case of I/O error

public RrdAllocator getRrdAllocator ()

Required to implement RrdUpdater interface. You should never call this method directly.

Returns
  • Allocator object

public RrdBackend getRrdBackend ()

Returns the underlying storage (backend) object which actually performs all I/O operations.

Returns
  • I/O backend object

public void setDsName (String newDsName)

Sets datasource name to a new value

Parameters
newDsName New datasource name
Throws
IOException Thrown in case of I/O error

public void setDsType (DsType newDsType)

Throws
IOException

public void setHeartbeat (long heartbeat)

Sets datasource heartbeat to a new value.

Parameters
heartbeat New heartbeat value
Throws
IOException Thrown in case of I/O error
IllegalArgumentException Thrown if invalid (non-positive) heartbeat value is specified.

public void setMaxValue (double maxValue, boolean filterArchivedValues)

Sets maximum allowed value for this datasource. If filterArchivedValues argment is set to true, all archived values greater then maxValue will be fixed to NaN.

Parameters
maxValue New maximal value. Specify Double.NaN if no max value should be set.
filterArchivedValues true, if archived datasource values should be fixed; false, otherwise.
Throws
IOException Thrown in case of I/O error
IllegalArgumentException Thrown if invalid maxValue was supplied (not greater then minValue)

public void setMinMaxValue (double minValue, double maxValue, boolean filterArchivedValues)

Sets min/max values allowed for this datasource. If filterArchivedValues argment is set to true, all archived values less then minValue or greater then maxValue will be fixed to NaN.

Parameters
minValue New minimal value. Specify Double.NaN if no min value should be set.
maxValue New maximal value. Specify Double.NaN if no max value should be set.
filterArchivedValues true, if archived datasource values should be fixed; false, otherwise.
Throws
IOException Thrown in case of I/O error
IllegalArgumentException Thrown if invalid min/max values were supplied

public void setMinValue (double minValue, boolean filterArchivedValues)

Sets minimum allowed value for this datasource. If filterArchivedValues argment is set to true, all archived values less then minValue will be fixed to NaN.

Parameters
minValue New minimal value. Specify Double.NaN if no minimal value should be set
filterArchivedValues true, if archived datasource values should be fixed; false, otherwise.
Throws
IOException Thrown in case of I/O error
IllegalArgumentException Thrown if invalid minValue was supplied (not less then maxValue)