|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.jrobin.core.Archive
Class to represent single RRD archive in a RRD with its internal state. Normally, you don't need methods to manipulate archive objects directly because JRobin framework does it automatically for you.
Each archive object consists of three parts: archive definition, archive state objects (one state object for each datasource) and round robin archives (one round robin for each datasource). API (read-only) is provided to access each of theese parts.
| Method Summary | |
void |
copyStateTo(org.jrobin.core.RrdUpdater other)
Copies object's internal state to another Archive object. |
ArcState |
getArcState(int dsIndex)
Returns the underlying archive state object. |
long |
getArcStep()
Returns archive time step in seconds. |
java.lang.String |
getConsolFun()
Returns archive consolidation function (AVERAGE, MIN, MAX or LAST). |
long |
getEndTime()
Returns current ending timestamp. |
Robin |
getRobin(int dsIndex)
Returns the underlying round robin archive. |
int |
getRows()
Returns the number of archive rows. |
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. |
long |
getStartTime()
Returns current starting timestamp. |
int |
getSteps()
Returns the number of archive steps. |
double |
getXff()
Returns archive X-files factor. |
void |
setXff(double xff)
Sets X-files factor to a new value. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Method Detail |
public long getArcStep()
throws java.io.IOException
java.io.IOException - Thrown in case of I/O error.
public java.lang.String getConsolFun()
throws java.io.IOException
java.io.IOException - Thrown in case of I/O error.
public double getXff()
throws java.io.IOException
java.io.IOException - Thrown in case of I/O error.
public int getSteps()
throws java.io.IOException
java.io.IOException - Thrown in case of I/O error.
public int getRows()
throws java.io.IOException
java.io.IOException - Thrown in case of I/O error.
public long getStartTime()
throws java.io.IOException
java.io.IOException - Thrown in case of I/O error.
public long getEndTime()
throws java.io.IOException
java.io.IOException - Thrown in case of I/O error.public ArcState getArcState(int dsIndex)
dsIndex - Datasource index
public Robin getRobin(int dsIndex)
dsIndex - Index of the datasource in the RRD.
public void copyStateTo(org.jrobin.core.RrdUpdater other)
throws java.io.IOException,
RrdException
copyStateTo in interface org.jrobin.core.RrdUpdaterother - New Archive object to copy state to
java.io.IOException - Thrown in case of I/O error
RrdException - Thrown if supplied argument is not an Archive object
public void setXff(double xff)
throws RrdException,
java.io.IOException
xff - New X-files factor value. Must be >= 0 and < 1.
RrdException - Thrown if invalid value is supplied
java.io.IOException - Thrown in case of I/O errorpublic RrdBackend getRrdBackend()
getRrdBackend in interface org.jrobin.core.RrdUpdaterpublic org.jrobin.core.RrdAllocator getRrdAllocator()
getRrdAllocator in interface org.jrobin.core.RrdUpdater
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||