com.tibco.rta.query
Interface QueryDef

All Superinterfaces:

BaseQueryDef, java.io.Serializable

All Known Subinterfaces:

QueryByFilterDef, QueryByKeyDef

public interface QueryDef
extends BaseQueryDef

An interface that allows to build a query.

Method Summary

void	addMetricName(java.lang.String measurementName, java.lang.String metricName) The result details.
void	addOrderByTuple(FilterKeyQualifier qualifier, java.lang.String value) Add an order by clause to the query
void	addOrderByTuple(MetricQualifier qualifier) Add an order by clause to the query.
java.lang.String	getCubeName() Get the cube name.
java.lang.String	getHierarchyName() Get the hierarchy name.
java.util.List<MetricFieldTuple>	getOrderByTuples() Get the order by clause.

Methods inherited from interface com.tibco.rta.query.BaseQueryDef

getBatchSize, getCreatedDate, getModifiedDate, getName, getQueryType, getSchemaName, getSortOrder, getUserName, getVersion, setBatchSize, setCreatedDate, setModifiedDate, setName, setQueryType, setSortOrder, setUserName, setVersion

Method Detail

getCubeName

java.lang.String getCubeName()

Get the cube name.

Returns:

getHierarchyName

java.lang.String getHierarchyName()

Get the hierarchy name.

Returns:

getOrderByTuples

java.util.List<MetricFieldTuple> getOrderByTuples()

Get the order by clause.

Returns:

an ordered list representing the sort order.

addOrderByTuple

void addOrderByTuple(MetricQualifier qualifier)

Add an order by clause to the query.

Parameters:

qualifier - the qualifier indicating sort order.

addOrderByTuple

void addOrderByTuple(FilterKeyQualifier qualifier,
                     java.lang.String value)

Add an order by clause to the query

Parameters:

qualifier - the qualifier to use.

value - the value of the qualifier.

addMetricName

void addMetricName(java.lang.String measurementName,
                   java.lang.String metricName)

The result details.

Parameters:

measurementName - measurement to return.

metricName - the metric to return.