|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jrobin.core.Datasource
public class 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 manipluate Datasource objects directly, it's up to JRobin framework to do it for you.
Method Summary | |
---|---|
void |
copyStateTo(org.jrobin.core.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. |
java.lang.String |
getDsName()
Returns datasource name. |
java.lang.String |
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. |
org.jrobin.core.RrdAllocator |
getRrdAllocator()
Required to implement RrdUpdater interface. |
RrdBackend |
getRrdBackend()
Returns the underlying storage (backend) object which actually performs all I/O operations. |
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public java.lang.String getDsName() throws java.io.IOException
java.io.IOException
- Thrown in case of I/O errorpublic java.lang.String getDsType() throws java.io.IOException
java.io.IOException
- Thrown in case of I/O errorpublic long getHeartbeat() throws java.io.IOException
java.io.IOException
- Thrown in case of I/O errorpublic double getMinValue() throws java.io.IOException
java.io.IOException
- Thrown in case of I/O errorpublic double getMaxValue() throws java.io.IOException
java.io.IOException
- Thrown in case of I/O errorpublic double getLastValue() throws java.io.IOException
java.io.IOException
- Thrown in case of I/O errorpublic double getAccumValue() throws java.io.IOException
java.io.IOException
- Thrown in case of I/O errorpublic long getNanSeconds() throws java.io.IOException
java.io.IOException
- Thrown in case of I/O errorpublic void copyStateTo(org.jrobin.core.RrdUpdater other) throws java.io.IOException, RrdException
other
- New Datasource object to copy state to
java.io.IOException
- Thrown in case of I/O error
RrdException
- Thrown if supplied argument is not a Datasource objectpublic int getDsIndex() throws java.io.IOException
java.io.IOException
- Thrown in case of I/O errorpublic void setHeartbeat(long heartbeat) throws RrdException, java.io.IOException
heartbeat
- New heartbeat value
java.io.IOException
- Thrown in case of I/O error
RrdException
- Thrown if invalid (non-positive) heartbeat value is specified.public void setMinValue(double minValue, boolean filterArchivedValues) throws java.io.IOException, RrdException
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 setfilterArchivedValues
- true, if archived datasource values should be fixed;
false, otherwise.
java.io.IOException
- Thrown in case of I/O error
RrdException
- Thrown if invalid minValue was supplied (not less then maxValue)public void setMaxValue(double maxValue, boolean filterArchivedValues) throws java.io.IOException, RrdException
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.
java.io.IOException
- Thrown in case of I/O error
RrdException
- Thrown if invalid maxValue was supplied (not greater then minValue)public void setMinMaxValue(double minValue, double maxValue, boolean filterArchivedValues) throws java.io.IOException, RrdException
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.
java.io.IOException
- Thrown in case of I/O error
RrdException
- Thrown if invalid min/max values were suppliedpublic RrdBackend getRrdBackend()
public org.jrobin.core.RrdAllocator getRrdAllocator()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |