|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jrobin.core.FetchRequest
public class FetchRequest
Class to represent fetch request. For the complete explanation of all
fetch parameters consult RRDTool's
rrdfetch man page.
You cannot create FetchRequest
directly (no public constructor
is provided). Use createFetchRequest()
method of your RrdDb
object.
Method Summary | |
---|---|
java.lang.String |
dump()
Dumps the content of fetch request using the syntax of RRDTool's fetch command. |
FetchPoint[] |
fetch()
Deprecated. As of version 1.2.0 replaced with fetchData() . |
FetchData |
fetchData()
Returns data from the underlying RRD and puts it in a single FetchData object. |
java.lang.String |
getConsolFun()
Returns consolitation function to be used during the fetch process. |
long |
getFetchEnd()
Returns ending timestamp to be used for the fetch request. |
long |
getFetchStart()
Returns starting timestamp to be used for the fetch request. |
java.lang.String[] |
getFilter()
Returns request filter. |
RrdDb |
getParentDb()
Returns the underlying RrdDb object. |
long |
getResolution()
Returns fetch resolution to be used for the fetch request. |
void |
setFilter(java.lang.String filter)
Sets request filter in order to fetch data only for a single datasource (datasource name). |
void |
setFilter(java.lang.String[] filter)
Sets request filter in order to fetch data only for the specified array of datasources (datasource names). |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public void setFilter(java.lang.String[] filter)
filter
- Array of datsources (datsource names) to fetch data from.public void setFilter(java.lang.String filter)
filter
- Array of datsources (datsource names) to fetch data from.public java.lang.String[] getFilter()
setFilter()
for
complete explanation.
public java.lang.String getConsolFun()
public long getFetchStart()
public long getFetchEnd()
public long getResolution()
public java.lang.String dump()
public FetchPoint[] fetch() throws RrdException, java.io.IOException
fetchData()
.
FetchPoint
objects. Each fetch point object represents
RRD datasource values for the specific timestamp. Timestamp difference between
consecutive fecth points is guaranteed to be constant.
RrdException
- Thrown in case of JRobin specific error.
java.io.IOException
- Thrown in case of I/O error.public FetchData fetchData() throws RrdException, java.io.IOException
FetchData
object. Use this method instead of
deprecated fetch()
method.
RrdException
- Thrown in case of JRobin specific error.
java.io.IOException
- Thrown in case of I/O error.public RrdDb getParentDb()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |