|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IQueryDefinition
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. |
java.lang.String |
getQueryResultsID()
When this value is not null, the data set name will not be used, since it indicates query is running on the data of report document or local caching of QueryResults. |
IBaseQueryDefinition |
getSourceQuery()
Return the source query of current query. |
boolean |
needAutoBinding()
When user knows which columns are in data set and user likes to get the column value without explicitly binding a name to a data set row expression, this flag can be set as true to indicate it. |
Methods inherited from interface org.eclipse.birt.data.engine.api.IBaseQueryDefinition |
---|
addBinding, cacheQueryResults, getBindings, getDistinctValue, getGroups, getMaxRows, getParentQuery, getQueryExecutionHints, getResultSetExpressions, getStartingRow, setMaxRows, usesDetails |
Methods inherited from interface org.eclipse.birt.data.engine.api.IBaseTransform |
---|
getFilters, getSorts, getSubqueries |
Methods inherited from interface org.eclipse.birt.data.engine.api.INamedObject |
---|
getName, setName |
Method Detail |
---|
java.lang.String getDataSetName()
java.lang.String getQueryResultsID()
boolean needAutoBinding()
java.util.Collection getInputParamBindings()
IInputParameterBinding
objects.
java.lang.String[] getColumnProjection()
IBaseQueryDefinition getSourceQuery()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |