org.eclipse.birt.data.engine.api
Interface IQueryDefinition

All Superinterfaces:
IBaseQueryDefinition, IBaseTransform
All Known Implementing Classes:
QueryDefinition

public interface IQueryDefinition
extends IBaseQueryDefinition

Defines a data engine query: a set of data transforms that provides data for a list-like element in the report. The data engine query encapsulates three types of information:
1. A data set, including computed columns together with the parameter bindings.
2. Data transforms that are defined on report items, i.e., sorting, filtering, grouping, aggregation functions, and so on.
3. Subqueries that are contained in the current report query.


Method Summary
 java.lang.String[] getColumnProjection()
          Provides a column projection hint to the data engine.
 java.lang.String getDataSetName()
          Gets the name of the data set used by this query
 java.util.Collection getInputParamBindings()
          Returns the set of input parameter bindings as an unordered collection of IInputParameterBinding objects.
 
Methods inherited from interface org.eclipse.birt.data.engine.api.IBaseQueryDefinition
getGroups, getMaxRows, getParentQuery, usesDetails
 
Methods inherited from interface org.eclipse.birt.data.engine.api.IBaseTransform
getAfterExpressions, getBeforeExpressions, getFilters, getRowExpressions, getSorts, getSubqueries
 

Method Detail

getDataSetName

public java.lang.String getDataSetName()
Gets the name of the data set used by this query


getInputParamBindings

public java.util.Collection getInputParamBindings()
Returns the set of input parameter bindings as an unordered collection of IInputParameterBinding objects.

Returns:
the input parameter bindings. If no binding is defined, null is returned.

getColumnProjection

public java.lang.String[] getColumnProjection()
Provides a column projection hint to the data engine. The caller informs the data engine that only a selected list of columns defined by the data set are used by this report query. The names of those columns (the "projected columns") are passed in as an array of string.
If a column projection is set, runtime error may occur if the report query uses columns that are not defined in the projected column list.



Copyright © 2005 Actuate Corp. All rights reserved.