org.jrobin.core
public class Archive extends Object implements RrdUpdater, ConsolFuns
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(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. |
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.
|
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.
|
Parameters: other New Archive object to copy state to
Throws: IOException Thrown in case of I/O error RrdException Thrown if supplied argument is not an Archive object
Parameters: dsIndex Datasource index
Returns: Underlying archive state object
Returns: Archive time step in seconds
Throws: IOException Thrown in case of I/O error.
Returns: Archive consolidation function.
Throws: IOException Thrown in case of I/O error.
Returns: Timestamp corresponding to the last archive row
Throws: IOException Thrown in case of I/O error.
Parameters: dsIndex Index of the datasource in the RRD.
Returns: Underlying round robin archive for the given datasource.
Returns: Number of archive rows.
Throws: IOException Thrown in case of I/O error.
Returns: Allocator object
Returns: I/O backend object
Returns: Timestamp corresponding to the first archive row
Throws: IOException Thrown in case of I/O error.
Returns: Number of archive steps.
Throws: IOException Thrown in case of I/O error.
Returns: Archive X-files factor (between 0 and 1).
Throws: IOException Thrown in case of I/O error.
Parameters: xff New X-files factor value. Must be >= 0 and < 1.
Throws: RrdException Thrown if invalid value is supplied IOException Thrown in case of I/O error