org.jrobin.core

Class FetchRequest

public class FetchRequest extends Object

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
Stringdump()
Dumps the content of fetch request using the syntax of RRDTool's fetch command.
FetchDatafetchData()
Returns data from the underlying RRD and puts it in a single FetchData object.
StringgetConsolFun()
Returns consolitation function to be used during the fetch process.
longgetFetchEnd()
Returns ending timestamp to be used for the fetch request.
longgetFetchStart()
Returns starting timestamp to be used for the fetch request.
String[]getFilter()
Returns request filter.
RrdDbgetParentDb()
Returns the underlying RrdDb object.
longgetResolution()
Returns fetch resolution to be used for the fetch request.
voidsetFilter(String[] filter)
Sets request filter in order to fetch data only for the specified array of datasources (datasource names).
voidsetFilter(Set<String> filter)
Sets request filter in order to fetch data only for the specified set of datasources (datasource names).
voidsetFilter(String filter)
Sets request filter in order to fetch data only for a single datasource (datasource name).

Method Detail

dump

public String dump()
Dumps the content of fetch request using the syntax of RRDTool's fetch command.

Returns: Fetch request dump.

fetchData

public FetchData fetchData()
Returns data from the underlying RRD and puts it in a single FetchData object.

Returns: FetchData object filled with timestamps and datasource values.

Throws: RrdException Thrown in case of JRobin specific error. IOException Thrown in case of I/O error.

getConsolFun

public String getConsolFun()
Returns consolitation function to be used during the fetch process.

Returns: Consolidation function.

getFetchEnd

public long getFetchEnd()
Returns ending timestamp to be used for the fetch request.

Returns: Ending timestamp in seconds.

getFetchStart

public long getFetchStart()
Returns starting timestamp to be used for the fetch request.

Returns: Starting timstamp in seconds.

getFilter

public String[] getFilter()
Returns request filter. See (String[]) setFilter() for complete explanation.

Returns: Request filter (array of datasource names), null if not set.

getParentDb

public RrdDb getParentDb()
Returns the underlying RrdDb object.

Returns: RrdDb object used to create this FetchRequest object.

getResolution

public long getResolution()
Returns fetch resolution to be used for the fetch request.

Returns: Fetch resolution in seconds.

setFilter

public void setFilter(String[] filter)
Sets request filter in order to fetch data only for the specified array of datasources (datasource names). If not set (or set to null), fetched data will containt values of all datasources defined in the corresponding RRD. To fetch data only from selected datasources, specify an array of datasource names as method argument.

Parameters: filter Array of datsources (datsource names) to fetch data from.

setFilter

public void setFilter(Set<String> filter)
Sets request filter in order to fetch data only for the specified set of datasources (datasource names). If the filter is not set (or set to null), fetched data will containt values of all datasources defined in the corresponding RRD. To fetch data only from selected datasources, specify a set of datasource names as method argument.

Parameters: filter Set of datsource names to fetch data for.

setFilter

public void setFilter(String filter)
Sets request filter in order to fetch data only for a single datasource (datasource name). If not set (or set to null), fetched data will containt values of all datasources defined in the corresponding RRD. To fetch data for a single datasource only, specify an array of datasource names as method argument.

Parameters: filter Array of datsources (datsource names) to fetch data from.