|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IGroupDefinition
Provides information about a grouping level within a query or subquery. A group definition contains group break definition (key column etc.) and a set of transforms defined for the group
Field Summary | |
---|---|
static int |
DAY_INTERVAL
Grouping interval unit is Day. |
static int |
HOUR_INTERVAL
Grouping interval unit is Hour. |
static int |
MINUTE_INTERVAL
Grouping interval unit is Minute. |
static int |
MONTH_INTERVAL
Grouping interval unit is Month. |
static int |
NO_INTERVAL
No grouping interval unit specified. |
static int |
NO_SORT
|
static int |
NUMERIC_INTERVAL
Grouping interval unit is the numerical value. |
static int |
QUARTER_INTERVAL
Grouping interval unit is Quarter. |
static int |
SECOND_INTERVAL
Grouping interval unit is Second. |
static int |
SORT_ASC
|
static int |
SORT_DESC
|
static int |
STRING_PREFIX_INTERVAL
Grouping interval unit is the length of the string prefix. |
static int |
WEEK_INTERVAL
Grouping interval unit is Week. |
static int |
YEAR_INTERVAL
Grouping interval unit is Year. |
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()
Returns a start value for grouping by range. |
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. |
Methods inherited from interface org.eclipse.birt.data.engine.api.IBaseTransform |
---|
getFilters, getSorts, getSubqueries |
Field Detail |
---|
static final int NO_INTERVAL
static final int YEAR_INTERVAL
static final int MONTH_INTERVAL
static final int QUARTER_INTERVAL
static final int WEEK_INTERVAL
static final int DAY_INTERVAL
static final int HOUR_INTERVAL
static final int MINUTE_INTERVAL
static final int SECOND_INTERVAL
static final int NUMERIC_INTERVAL
static final int STRING_PREFIX_INTERVAL
static final int NO_SORT
static final int SORT_ASC
static final int SORT_DESC
Method Detail |
---|
java.lang.String getName()
int getInterval()
int getSortDirection()
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.double getIntervalRange()
MONTH_INTERVAL
, and IntervalRange
is 6, each group is defined to contain a span of 6 months.
java.lang.Object getIntervalStart()
A start value defines the boundary of range based grouping. For numeric values, the default start value is 0. For date range based grouping, the default start value is Jan. 1, 2000. It has no meaning for grouping based on string prefix or distinct values
java.lang.String getKeyColumn()
java.lang.String getKeyExpression()
row.column_name
, or row["column_name"]
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |