|
||||||||||
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.GroupDefinition
public class GroupDefinition
Default implementation of IGroupDefinition
.
Field Summary | |
---|---|
protected int |
interval
|
protected double |
intervalRange
|
protected java.lang.Object |
intervalStart
|
protected java.lang.String |
keyColumn
|
protected java.lang.String |
keyExpr
|
protected java.lang.String |
name
|
protected int |
sortDirection
|
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 |
Fields inherited from interface org.eclipse.birt.data.engine.api.IGroupDefinition |
---|
DAY_INTERVAL, HOUR_INTERVAL, MINUTE_INTERVAL, MONTH_INTERVAL, NO_INTERVAL, NO_SORT, NUMERIC_INTERVAL, QUARTER_INTERVAL, SECOND_INTERVAL, SORT_ASC, SORT_DESC, STRING_PREFIX_INTERVAL, WEEK_INTERVAL, YEAR_INTERVAL |
Constructor Summary | |
---|---|
GroupDefinition()
Deprecated. |
|
GroupDefinition(java.lang.String name)
Constructs a group with the given name |
Method Summary | |
---|---|
int |
getInterval()
Returns the interval for grouping on a range of contiguous group key values. |
double |
getIntervalRange()
Returns the number of contiguous group intervals that form one single group, when Interval is used to define group break level. |
java.lang.Object |
getIntervalStart()
Gets the starting value for the first interval |
java.lang.String |
getKeyColumn()
Returns the name of the column that defines the group key. |
java.lang.String |
getKeyExpression()
Returns the JavaScript expression that defines the group key. |
java.lang.String |
getName()
Returns the name of the group |
int |
getSortDirection()
Returns the sort direction on the group key. |
void |
setInterval(int interval)
|
void |
setIntervalRange(double intervalRange)
|
void |
setIntervalStart(java.lang.Object start)
|
void |
setKeyColumn(java.lang.String keyColumn)
|
void |
setKeyExpression(java.lang.String keyExpr)
|
void |
setSortDirection(int sortDirection)
|
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.lang.String name
protected java.lang.String keyExpr
protected java.lang.String keyColumn
protected int interval
protected double intervalRange
protected int sortDirection
protected java.lang.Object intervalStart
Constructor Detail |
---|
public GroupDefinition(java.lang.String name)
public GroupDefinition()
Method Detail |
---|
public java.lang.String getName()
getName
in interface IGroupDefinition
public int getInterval()
getInterval
in interface IGroupDefinition
public int getSortDirection()
getSortDirection
in interface IGroupDefinition
NO_SORT
is returned. This means
that the data engine can choose any sort order, or no sort order at all, for this group level.public double getIntervalRange()
MONTH_INTERVAL
, and IntervalRange
is 6, each group is defined to contain a span of 6 months.
getIntervalRange
in interface IGroupDefinition
public java.lang.Object getIntervalStart()
getIntervalStart
in interface IGroupDefinition
public java.lang.String getKeyColumn()
getKeyColumn
in interface IGroupDefinition
public java.lang.String getKeyExpression()
getKeyExpression
in interface IGroupDefinition
public void setInterval(int interval)
interval
- The interval to set.public void setIntervalRange(double intervalRange)
intervalRange
- The intervalRange to set.public void setIntervalStart(java.lang.Object start)
start
- a start value for the first intervalpublic void setKeyColumn(java.lang.String keyColumn)
keyColumn
- Name of the column to group bypublic void setKeyExpression(java.lang.String keyExpr)
keyExpr
- Key expression to group bypublic void setSortDirection(int sortDirection)
sortDirection
- The sortDirection to set.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |