org.kairosdb.client.builder

Class AbstractQueryBuilder<B extends AbstractQueryBuilder<B>>

java.lang.Object

org.kairosdb.client.builder.AbstractQueryBuilder<B>

Type Parameters:

B - the builder

Direct Known Subclasses:

QueryBuilder, QueryTagBuilder

public abstract class AbstractQueryBuilder<B extends AbstractQueryBuilder<B>>
extends Object

Abstract class for querying KairosDB.

Field Summary

Fields

Modifier and Type	Field and Description
protected Long	endAbsolute
protected RelativeTime	endRelative
protected com.google.gson.Gson	mapper
protected Long	startAbsolute
protected RelativeTime	startRelative

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractQueryBuilder()

Method Summary

Modifier and Type	Method and Description
String	build() Returns the JSON string built by the builder.
protected abstract com.google.gson.Gson	buildGson() Builds Gson used by this implementation
boolean	equals(Object o)
Date	getEndAbsolute() Returns the absolute range end time.
RelativeTime	getEndRelative() Returns the relative range end time.
Date	getStartAbsolute() Returns the absolute range start time.
RelativeTime	getStartRelative() Returns the relative range start time.
int	hashCode()
B	setEnd(Date end) The ending value of the time range.
B	setEnd(int duration, TimeUnit unit) The ending time of the time range relative to now.
B	setStart(Date start) The beginning time of the time range.
B	setStart(int duration, TimeUnit unit) The beginning time of the time range relative to now.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

startAbsolute

protected Long startAbsolute

endAbsolute

protected Long endAbsolute

startRelative

protected RelativeTime startRelative

endRelative

protected RelativeTime endRelative

mapper

protected transient com.google.gson.Gson mapper

Constructor Detail

AbstractQueryBuilder

protected AbstractQueryBuilder()

Method Detail

buildGson

protected abstract com.google.gson.Gson buildGson()

Builds Gson used by this implementation

getStartAbsolute

public Date getStartAbsolute()

Returns the absolute range start time.

Returns:

absolute range start time

getEndAbsolute

public Date getEndAbsolute()

Returns the absolute range end time.

Returns:

absolute range end time

getStartRelative

public RelativeTime getStartRelative()

Returns the relative range start time.

Returns:

relative range start time

getEndRelative

public RelativeTime getEndRelative()

Returns the relative range end time.

Returns:

relative range end time

setStart

public B setStart(Date start)

The beginning time of the time range.

Parameters:

start - start time

Returns:

the builder

setStart

public B setStart(int duration,
                  TimeUnit unit)

The beginning time of the time range relative to now. For example, return all data points that starting 2 days ago.

Parameters:

duration - relative time value

unit - unit of time

Returns:

the builder

setEnd

public B setEnd(Date end)

The ending value of the time range. Must be later in time than the start time. An end time is not required and default to now.

Parameters:

end - end time

Returns:

the builder

setEnd

public B setEnd(int duration,
                TimeUnit unit)

The ending time of the time range relative to now.

Parameters:

duration - relative time value

unit - unit of time

Returns:

the builder

build

public String build()
             throws IOException

Returns the JSON string built by the builder. This is the JSON that can be used by the client to query KairosDB

Returns:

JSON

Throws:

IOException - if the query is invalid and cannot be converted to JSON

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object