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

All Superinterfaces:
IBaseTransform, IDataQueryDefinition
All Known Subinterfaces:
IQueryDefinition, ISubqueryDefinition
All Known Implementing Classes:
BaseQueryDefinition, QueryDefinition, SubqueryDefinition

public interface IBaseQueryDefinition
extends IBaseTransform, IDataQueryDefinition

/** Represents attributes common to a data engine query and a subquery.


Method Summary
 void addBinding(IBinding binding)
          Add a column binding instance to query definition.
 boolean cacheQueryResults()
          Indicates if the query need cache the result rows .
 java.util.Map getBindings()
          Get all column binding instance from query definition.
 java.util.List getGroups()
          Returns the group definitions as an ordered collection of IGroupDefinition objects.
 int getMaxRows()
          Gets the maximum number of detail rows that can be retrieved by this query
 IBaseQueryDefinition getParentQuery()
          Returns the parent query.
 java.util.Map getResultSetExpressions()
          Deprecated.  
 boolean usesDetails()
          Indicates if the report will use the detail rows.
 
Methods inherited from interface org.eclipse.birt.data.engine.api.IBaseTransform
getFilters, getSorts, getSubqueries
 

Method Detail

getGroups

public java.util.List getGroups()
Returns the group definitions as an ordered collection of IGroupDefinition objects. Groups are organizations within the data that support aggregation, filtering and sorting. Reports use groups to trigger level breaks.

Returns:
the list of groups. If no group is defined, null is returned.

usesDetails

public boolean usesDetails()
Indicates if the report will use the detail rows. Allows the data engine to optimize the query if the details are not used.

Returns:
true if the detail rows are used, false if not used

cacheQueryResults

public boolean cacheQueryResults()
Indicates if the query need cache the result rows . The query result can be reload form the cache if the cache is used.

Returns:
true if cache is needed.

getParentQuery

public IBaseQueryDefinition getParentQuery()
Returns the parent query. The parent query is the outer query which encloses this query.


getMaxRows

public int getMaxRows()
Gets the maximum number of detail rows that can be retrieved by this query

Returns:
Maximum number of rows. If 0, there is no limit on how many rows this query can retrieve.

getResultSetExpressions

public java.util.Map getResultSetExpressions()
Deprecated.  

Gets the expressions that needs to be available at the group/list, as an Map of bound colum name to IBaseExpression objects.

Returns:

addBinding

public void addBinding(IBinding binding)
                throws org.eclipse.birt.data.engine.core.DataException
Add a column binding instance to query definition.

Parameters:
binding -
Throws:
org.eclipse.birt.data.engine.core.DataException
org.eclipse.birt.data.engine.core.DataException

getBindings

public java.util.Map getBindings()
Get all column binding instance from query definition.

Returns:
Throws:
org.eclipse.birt.data.engine.core.DataException


Copyright © 2005 Actuate Corp. All rights reserved.