java.lang.Object | |
↳ | org.rrd4j.core.Datasource |
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.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Copies object's internal state to another Datasource object.
| |||||||||||
Returns value this datasource accumulated so far.
| |||||||||||
Returns index of this Datasource object in the RRD.
| |||||||||||
Returns datasource name.
| |||||||||||
Returns datasource type (GAUGE, COUNTER, DERIVE, ABSOLUTE).
| |||||||||||
Returns datasource heartbeat
| |||||||||||
Returns last known value of the datasource.
| |||||||||||
Returns maximal allowed value for this datasource.
| |||||||||||
Returns mimimal allowed value for this datasource.
| |||||||||||
Returns the number of accumulated NaN seconds.
| |||||||||||
Required to implement RrdUpdater interface.
| |||||||||||
Returns the underlying storage (backend) object which actually performs all
I/O operations.
| |||||||||||
Sets datasource name to a new value
| |||||||||||
Sets datasource heartbeat to a new value.
| |||||||||||
Sets maximum allowed value for this datasource.
| |||||||||||
Sets min/max values allowed for this datasource.
| |||||||||||
Sets minimum allowed value for this datasource.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Copies object's internal state to another Datasource object.
other | New Datasource object to copy state to |
---|
IOException | Thrown in case of I/O error |
---|
Returns value this datasource accumulated so far.
IOException | Thrown in case of I/O error |
---|
Returns index of this Datasource object in the RRD.
IOException | Thrown in case of I/O error |
---|
Returns datasource type (GAUGE, COUNTER, DERIVE, ABSOLUTE).
IOException | Thrown in case of I/O error |
---|
Returns datasource heartbeat
IOException | Thrown in case of I/O error |
---|
Returns last known value of the datasource.
IOException | Thrown in case of I/O error |
---|
Returns maximal allowed value for this datasource.
IOException | Thrown in case of I/O error |
---|
Returns mimimal allowed value for this datasource.
IOException | Thrown in case of I/O error |
---|
Returns the number of accumulated NaN seconds.
IOException | Thrown in case of I/O error |
---|
Required to implement RrdUpdater interface. You should never call this method directly.
Returns the underlying storage (backend) object which actually performs all I/O operations.
Sets datasource name to a new value
newDsName | New datasource name |
---|
IOException | Thrown in case of I/O error |
---|
Sets datasource heartbeat to a new value.
heartbeat | New heartbeat value |
---|
IOException | Thrown in case of I/O error |
---|---|
IllegalArgumentException | Thrown if invalid (non-positive) heartbeat value is specified. |
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.
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. |
IOException | Thrown in case of I/O error |
---|---|
IllegalArgumentException | Thrown if invalid maxValue was supplied (not greater then minValue) |
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.
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. |
IOException | Thrown in case of I/O error |
---|---|
IllegalArgumentException | Thrown if invalid min/max values were supplied |
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.
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. |
IOException | Thrown in case of I/O error |
---|---|
IllegalArgumentException | Thrown if invalid minValue was supplied (not less then maxValue) |