|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.data.engine.api.querydefn.BaseTransform
org.eclipse.birt.data.engine.api.querydefn.BaseQueryDefinition
public abstract class BaseQueryDefinition
Default implementation of the IBaseQueryDefinition
interface.
Field Summary | |
---|---|
protected boolean |
distinctValue
|
protected java.util.List |
groups
|
protected boolean |
hasDetail
|
protected int |
maxRowCount
|
protected IBaseQueryDefinition |
parentQuery
|
protected int |
startingRow
|
Fields inherited from class org.eclipse.birt.data.engine.api.querydefn.BaseTransform |
---|
AFTER_LAST_ROW, afterExpressions, BEFORE_FIRST_ROW, beforeExpressions, filters, ON_EACH_ROW, rowExpressions, sorts, subqueries |
Method Summary | |
---|---|
void |
addBinding(IBinding binding)
Add a column binding instance to query definition. |
void |
addGroup(GroupDefinition group)
Appends a group definition to the group list. |
void |
addResultSetExpression(java.lang.String name,
IBaseExpression expression)
Deprecated. |
boolean |
cacheQueryResults()
Indicates if the query need cache the result rows . |
java.util.Map |
getBindings()
Get all column binding instance from query definition. |
boolean |
getDistinctValue()
If the flag is true this query will return the rows with distinct or unique column values. |
java.util.List |
getGroups()
Returns the group definitions as an ordered collection of GroupDefinition
objects. |
int |
getMaxRows()
Gets the maximum number of detail rows that can be retrieved by this report query |
java.lang.String |
getName()
get the name of current object. |
IBaseQueryDefinition |
getParentQuery()
Returns the parent query. |
IQueryExecutionHints |
getQueryExecutionHints()
Return the Query Execution Hints information. |
java.util.Map |
getResultSetExpressions()
Gets the expressions that needs to be available at the group/list, as an Map of bound colum name to IBaseExpression objects. |
int |
getStartingRow()
Gets the starting row that will be retrieved by this query |
void |
setCacheQueryResults(boolean cacheQueryResults)
|
void |
setDistinctValue(boolean distinctValue)
Sets the distinct value flag. |
void |
setMaxRows(int maxRows)
Sets the maximum number of detail rows that can be retrieved by this report query |
void |
setName(java.lang.String name)
set the name of current object. |
void |
setQueryExecutionHints(IQueryExecutionHints hints)
Set the query execution hints. |
void |
setStartingRow(int startingRow)
Sets the starting row that will be retrieved by this query |
void |
setUsesDetails(boolean usesDetails)
|
boolean |
usesDetails()
Indicates if the report will use the detail rows. |
Methods inherited from class org.eclipse.birt.data.engine.api.querydefn.BaseTransform |
---|
addFilter, addSort, addSubquery, getFilters, getSorts, getSubqueries |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.eclipse.birt.data.engine.api.IBaseTransform |
---|
getFilters, getSorts, getSubqueries |
Field Detail |
---|
protected java.util.List groups
protected boolean hasDetail
protected IBaseQueryDefinition parentQuery
protected int maxRowCount
protected int startingRow
protected boolean distinctValue
Method Detail |
---|
public java.util.List getGroups()
GroupDefinition
objects. Groups are organizations within the data that support
aggregation, filtering and sorting. Reports use groups to trigger
level breaks.
getGroups
in interface IBaseQueryDefinition
public void addGroup(GroupDefinition group)
group
- Group definition to addpublic boolean usesDetails()
usesDetails
in interface IBaseQueryDefinition
public void setUsesDetails(boolean usesDetails)
usesDetails
- Whether detail rows are used in this querypublic IBaseQueryDefinition getParentQuery()
getParentQuery
in interface IBaseQueryDefinition
public int getMaxRows()
getMaxRows
in interface IBaseQueryDefinition
public void setMaxRows(int maxRows)
setMaxRows
in interface IBaseQueryDefinition
public void setStartingRow(int startingRow)
startingRow
- public int getStartingRow()
IBaseQueryDefinition
getStartingRow
in interface IBaseQueryDefinition
public void setDistinctValue(boolean distinctValue)
public boolean getDistinctValue()
IBaseQueryDefinition
getDistinctValue
in interface IBaseQueryDefinition
public void addResultSetExpression(java.lang.String name, IBaseExpression expression)
name
- expression
- public void addBinding(IBinding binding) throws org.eclipse.birt.data.engine.core.DataException
IBaseQueryDefinition
addBinding
in interface IBaseQueryDefinition
org.eclipse.birt.data.engine.core.DataException
public java.util.Map getBindings()
IBaseQueryDefinition
getBindings
in interface IBaseQueryDefinition
public java.util.Map getResultSetExpressions()
IBaseQueryDefinition
IBaseExpression
objects.
getResultSetExpressions
in interface IBaseQueryDefinition
public boolean cacheQueryResults()
IBaseQueryDefinition
cacheQueryResults
in interface IBaseQueryDefinition
public void setCacheQueryResults(boolean cacheQueryResults)
public void setQueryExecutionHints(IQueryExecutionHints hints)
hints
- public IQueryExecutionHints getQueryExecutionHints()
IBaseQueryDefinition
getQueryExecutionHints
in interface IBaseQueryDefinition
public java.lang.String getName()
INamedObject
getName
in interface INamedObject
public void setName(java.lang.String name)
INamedObject
setName
in interface INamedObject
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |