|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jrobin.core.FetchData
public class FetchData
Class used to represent data fetched from the RRD.
Object of this class is created when the method
fetchData()
is
called on a FetchRequest
object.
Data returned from the RRD is, simply, just one big table filled with
timestamps and corresponding datasource values.
Use getRowCount()
method to count the number
of returned timestamps (table rows).
The first table column is filled with timestamps. Time intervals
between consecutive timestamps are guaranteed to be equal. Use
getTimestamps()
method to get an array of
timestamps returned.
Remaining columns are filled with datasource values for the whole timestamp range,
on a column-per-datasource basis. Use getColumnCount()
to find
the number of datasources and getValues(i)
method to obtain
all values for the i-th datasource. Returned datasource values correspond to
the values returned with getTimestamps()
method.
Method Summary | |
---|---|
void |
dump()
Dumps the content of the whole FetchData object to stdout. |
java.lang.String |
exportXml()
Dumps fetch data in XML format. |
void |
exportXml(java.io.OutputStream outputStream)
Dumps fetch data to output stream in XML format. |
void |
exportXml(java.lang.String filepath)
Dumps fetch data to file in XML format. |
double |
getAggregate(java.lang.String dsName,
java.lang.String consolFun)
Returns aggregated value from the fetched data for a single datasource. |
double |
getAggregate(java.lang.String dsName,
java.lang.String consolFun,
java.lang.String rpnExpression)
Returns aggregated value from the fetched data for a single datasource. |
int |
getColumnCount()
Returns the number of columns fetched from the corresponding RRD. |
int |
getDsIndex(java.lang.String dsName)
Retrieve the table index number of a datasource by name. |
java.lang.String[] |
getDsNames()
Returns array of datasource names found in the corresponding RRD. |
long |
getFirstTimestamp()
Returns the first timestamp in this FetchData object. |
long |
getLastTimestamp()
Returns the last timestamp in this FecthData object. |
Archive |
getMatchingArchive()
Returns Archive object which is determined to be the best match for the timestamps specified in the fetch request. |
FetchRequest |
getRequest()
Returns FetchRequest object used to create this FetchData object. |
FetchPoint |
getRow(int rowIndex)
Returns the number of rows fetched from the corresponding RRD. |
int |
getRowCount()
Returns the number of rows fetched from the corresponding RRD. |
long |
getStep()
Returns the step with which this data was fetched. |
long[] |
getTimestamps()
Returns an array of timestamps covering the whole range specified in the FetchReguest object. |
double[][] |
getValues()
Returns all archived values for all datasources. |
double[] |
getValues(int dsIndex)
Returns all archived values for a single datasource. |
double[] |
getValues(java.lang.String dsName)
Returns all archived values for a single datasource. |
java.lang.String |
toString()
Returns string representing fetched data in a RRDTool-like form. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public int getRowCount()
getRowCount
in interface RrdDataSet
public int getColumnCount()
getColumnCount
in interface RrdDataSet
public FetchPoint getRow(int rowIndex)
rowIndex
- Row index.
public long[] getTimestamps()
FetchReguest
object.
getTimestamps
in interface RrdDataSet
public long getStep()
getStep
in interface RrdDataSet
public double[] getValues(int dsIndex)
getTimestamps()
method.
getValues
in interface RrdDataSet
dsIndex
- Datasource index.
public double[][] getValues()
getTimestamps()
method.
getValues
in interface RrdDataSet
public double[] getValues(java.lang.String dsName) throws RrdException
getTimestamps()
method.
getValues
in interface RrdDataSet
dsName
- Datasource name.
RrdException
- Thrown if no matching datasource name is found.public FetchRequest getRequest()
FetchRequest
object used to create this FetchData object.
public long getFirstTimestamp()
getFirstTimestamp
in interface RrdDataSet
public long getLastTimestamp()
getLastTimestamp
in interface RrdDataSet
public Archive getMatchingArchive()
public java.lang.String[] getDsNames()
getDsNames
in interface RrdDataSet
public int getDsIndex(java.lang.String dsName)
getDsIndex
in interface RrdDataSet
dsName
- Name of the datasource for which to find the index.
public void dump()
public java.lang.String toString()
toString
in class java.lang.Object
public double getAggregate(java.lang.String dsName, java.lang.String consolFun) throws RrdException
getAggregate
in interface RrdDataSet
dsName
- Datasource nameconsolFun
- Consolidation function to be applied to fetched datasource values.
Valid consolidation functions are MIN, MAX, LAST and AVERAGE
RrdException
- Thrown if the given datasource name cannot be found in fetched data.public double getAggregate(java.lang.String dsName, java.lang.String consolFun, java.lang.String rpnExpression) throws RrdException
getAggregate("foots", "MAX", "value,0.3048,*");
Note that 'value' in the RPN expression is a reserved word and stands for the
original value (value fetched from RRD)
dsName
- Datasource nameconsolFun
- Consolidation function to be applied to fetched datasource values.
Valid consolidation functions are MIN, MAX, LAST and AVERAGE
RrdException
- Thrown if the given datasource name cannot be found in fetched data.public void exportXml(java.io.OutputStream outputStream) throws java.io.IOException
exportXml
in interface RrdDataSet
outputStream
- Output stream to dump fetch data to
java.io.IOException
- Thrown in case of I/O errorpublic void exportXml(java.lang.String filepath) throws java.io.IOException
exportXml
in interface RrdDataSet
filepath
- Path to destination file
java.io.IOException
- Thrown in case of I/O errorpublic java.lang.String exportXml() throws java.io.IOException
exportXml
in interface RrdDataSet
java.io.IOException
- Thrown in case of I/O error
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |