|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.rrd4j.core.Archive
public class 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 Rrd4j 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 these parts.
Field Summary | |
---|---|
protected org.rrd4j.core.RrdString |
consolFun
|
protected org.rrd4j.core.RrdInt |
rows
|
protected org.rrd4j.core.RrdInt |
steps
|
protected org.rrd4j.core.RrdDouble |
xff
|
Method Summary | |
---|---|
void |
copyStateTo(org.rrd4j.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. |
ConsolFun |
getConsolFun()
Returns archive consolidation function ("AVERAGE", "MIN", "MAX", "FIRST", "LAST" or "TOTAL"). |
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.rrd4j.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 |
Field Detail |
---|
protected final org.rrd4j.core.RrdString consolFun
protected final org.rrd4j.core.RrdDouble xff
protected final org.rrd4j.core.RrdInt steps
protected final org.rrd4j.core.RrdInt rows
Method Detail |
---|
public long getArcStep() throws IOException
IOException
- Thrown in case of I/O error.public ConsolFun getConsolFun() throws IOException
IOException
- Thrown in case of I/O error.public double getXff() throws IOException
IOException
- Thrown in case of I/O error.public int getSteps() throws IOException
IOException
- Thrown in case of I/O error.public int getRows() throws IOException
IOException
- Thrown in case of I/O error.public long getStartTime() throws IOException
IOException
- Thrown in case of I/O error.public long getEndTime() throws IOException
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.rrd4j.core.RrdUpdater other) throws IOException
other
- New Archive object to copy state to
IOException
- Thrown in case of I/O errorpublic void setXff(double xff) throws IOException
xff
- New X-files factor value. Must be >= 0 and < 1.
IOException
- Thrown in case of I/O errorpublic RrdBackend getRrdBackend()
public org.rrd4j.core.RrdAllocator getRrdAllocator()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |