com.tibco.rta.query
Interface Query

public interface Query

The base client interface used to define a query to be executed on the metric engine.

Method Summary

void	close() Closes the query thus stopping any updates from server.
<T extends MetricResultTuple> Browser<T>	execute() Return a browser over result set of a query.
java.lang.String	getName() Return name
QueryResultHandler	getResultHandler()
QueryByFilterDef	newQueryByFilterDef(java.lang.String schemaName, java.lang.String cubeName, java.lang.String hierarchyName, java.lang.String measurementName) Define a query using filters
QueryByKeyDef	newQueryByKeyDef() Define a query using partial or complete keys.
void	setResultHandler(QueryResultHandler resultHandler)

Method Detail

getName

java.lang.String getName()

Return name

Returns:

newQueryByKeyDef

QueryByKeyDef newQueryByKeyDef()

Define a query using partial or complete keys.

Returns:

the query definition

newQueryByFilterDef

QueryByFilterDef newQueryByFilterDef(java.lang.String schemaName,
                                     java.lang.String cubeName,
                                     java.lang.String hierarchyName,
                                     java.lang.String measurementName)

Define a query using filters

Returns:

the query definition

execute

<T extends MetricResultTuple> Browser<T> execute()
                                             throws RtaException

Return a browser over result set of a query.

For snapshot query, browser can be used to iterate over the results, whereas for streaming queries the browser will be equivalent to an empty iterator.

Returns:

Throws:

java.lang.Exception

RtaException

close

void close()
           throws RtaException

Closes the query thus stopping any updates from server.

Throws:

RtaException

getResultHandler

QueryResultHandler getResultHandler()

Returns:

setResultHandler

void setResultHandler(QueryResultHandler resultHandler)

Parameters:

resultHandler -