Style Intelligence v12.0

inetsoft.report.filter
Interface GroupedTable

All Superinterfaces:
Cloneable, RegionTable, Serializable, StyleConstants, TableLens, XConstants, XTable
All Known Implementing Classes:
AbstractGroupedTable, GroupedColumnMapFilter, GroupedSortFilter, GroupFilter, SummaryFilter, TopNFilter, TransparentGroupFilter

public interface GroupedTable
extends TableLens, RegionTable

This interface is implemented by all grouped table to provide information on the grouping.


Field Summary
static int GROUP_HEADER_FULL
          Group headers are displayed as part of the grouped rows, and all columns are included in every header row.
static int GROUP_HEADER_IN_PLACE
          Group headers are displayed as part of the grouped rows.
static int GROUP_HEADER_ROWS
          Group headers are added as new rows on top of the grouped rows.
 
Fields inherited from interface inetsoft.report.TableLens
BREAK_BORDER, NULL
 
Fields inherited from interface inetsoft.uql.XTable
EOT
 
Fields inherited from interface inetsoft.report.StyleConstants
ARROW_LINE_1, ARROW_LINE_2, ARROW_LINE_3, BACKGROUND_CENTER, BACKGROUND_TILED, BOX_RECTANGLE, BOX_ROUNDED_RECTANGLE, CENTER, CHART_3D_BAR, CHART_3D_BAR_3D, CHART_3D_PIE, CHART_3D_STACK_BAR, CHART_AREA, CHART_BAR, CHART_BUBBLE, CHART_CANDLE, CHART_CURVE, CHART_FILL_RADAR, CHART_GANTT, CHART_INV_BAR, CHART_INV_CURVE, CHART_INV_LINE, CHART_INV_POINT, CHART_INV_STACK_BAR, CHART_LINE, CHART_MAX_USER, CHART_PARETO, CHART_PIE, CHART_PIE_EXPLODED_ALL, CHART_PIE_EXPLODED_FIRST, CHART_PIE_EXPLODED_NONE, CHART_POINT, CHART_RADAR, CHART_RIBBON, CHART_SCATTER, CHART_SPEEDOMETER, CHART_STACK_AREA, CHART_STACK_BAR, CHART_STICK, CHART_STOCK, CHART_SURFACE, CHART_USER, CHART_VOLUME, CHART_WATERFALL, CHART_XY_LINE, CIRCLE, CROSS, CURRENCY, DASH_LINE, DASH_MASK, DEFAULT_PAGE_SIZE, DIAMOND, DOT_LINE, DOUBLE_3D_LOWERED, DOUBLE_3D_RAISED, DOUBLE_LINE, DOUBLE_MASK, FILL, FILLED_CIRCLE, FILLED_DIAMOND, FILLED_SQUARE, FILLED_TRIANGLE, FRACTION_WIDTH_MASK, H_ALIGN_MASK, H_CENTER, H_CURRENCY, H_LEFT, H_LINE, H_RIGHT, LANDSCAPE, LARGE_DASH, LEFT, LINECAP_BUTT, LINECAP_ROUND, LINECAP_SQUARE, LINEJOIN_BEVEL, LINEJOIN_MITER, LINEJOIN_ROUND, LOWERED_3D, LOWERED_MASK, LT_ANGLE, MEDIUM_DASH, MEDIUM_LINE, NIL, NO_BORDER, NONE, PAPER_10X11, PAPER_10X14, PAPER_11X17, PAPER_15X11, PAPER_9X11, PAPER_A_PLUS, PAPER_A2, PAPER_A3, PAPER_A3_EXTRA, PAPER_A3_EXTRA_TRANSVERSE, PAPER_A3_TRANSVERSE, PAPER_A4, PAPER_A4_EXTRA, PAPER_A4_PLUS, PAPER_A4_TRANSVERSE, PAPER_A4SMALL, PAPER_A5, PAPER_A5_EXTRA, PAPER_A5_TRANSVERSE, PAPER_B_PLUS, PAPER_B4, PAPER_B5, PAPER_B5_EXTRA, PAPER_B5_TRANSVERSE, PAPER_CSHEET, PAPER_DSHEET, PAPER_ENV_10, PAPER_ENV_11, PAPER_ENV_12, PAPER_ENV_14, PAPER_ENV_9, PAPER_ENV_B4, PAPER_ENV_B5, PAPER_ENV_B6, PAPER_ENV_C3, PAPER_ENV_C4, PAPER_ENV_C5, PAPER_ENV_C6, PAPER_ENV_C65, PAPER_ENV_DL, PAPER_ENV_INVITE, PAPER_ENV_ITALY, PAPER_ENV_MONARCH, PAPER_ENV_PERSONAL, PAPER_ESHEET, PAPER_EXECUTIVE, PAPER_FANFOLD_LGL_GERMAN, PAPER_FANFOLD_STD_GERMAN, PAPER_FANFOLD_US, PAPER_FOLIO, PAPER_ISO_B4, PAPER_JAPANESE_POSTCARD, PAPER_LEDGER, PAPER_LEGAL, PAPER_LEGAL_EXTRA, PAPER_LETTER, PAPER_LETTER_EXTRA, PAPER_LETTER_EXTRA_TRANSVERSE, PAPER_LETTER_PLUS, PAPER_LETTER_TRANSVERSE, PAPER_LETTERSMALL, PAPER_NOTE, PAPER_QUARTO, PAPER_STATEMENT, PAPER_TABLOID, PAPER_TABLOID_EXTRA, PATTERN_0, PATTERN_1, PATTERN_10, PATTERN_11, PATTERN_12, PATTERN_13, PATTERN_14, PATTERN_15, PATTERN_16, PATTERN_17, PATTERN_18, PATTERN_19, PATTERN_2, PATTERN_3, PATTERN_4, PATTERN_5, PATTERN_6, PATTERN_7, PATTERN_8, PATTERN_9, PATTERN_NONE, PORTRAIT, RAISED_3D, RAISED_MASK, REMAINDER, RIGHT, RIGHT_ANGLE, SOLID_MASK, SQUARE, STAR, THICK_LINE, THIN_LINE, THIN_THIN_LINE, TRAY_AUTO, TRAY_CASSETTE, TRAY_ENVELOPE, TRAY_ENVMANUAL, TRAY_FORMSOURCE, TRAY_LARGECAPACITY, TRAY_LARGEFMT, TRAY_LOWER, TRAY_MANUAL, TRAY_MIDDLE, TRAY_ONLYONE, TRAY_SMALLFMT, TRAY_TRACTOR, TRAY_UPPER, TRIANGLE, ULTRA_THIN_LINE, V_ALIGN_MASK, V_ANGLE, V_BASELINE, V_BOTTOM, V_CENTER, V_LINE, V_TOP, WIDTH_MASK, X
 
Fields inherited from interface inetsoft.uql.XConstants
AM_PM_DATE_GROUP, AM_PM_OF_DAY_DATE_GROUP, AVERAGE_FORMULA, CALC_FORMULA, COLUMN, CONCAT_FORMULA, CONDITION_EMPTY_STRING, CONDITION_NULL_STRING, CONDITION_NULL_VALUE, CONDITION_REAL_NULL, CORRELATION_FORMULA, COUNT_FORMULA, COVARIANCE_FORMULA, CURRENCY_FORMAT, CURRENT_REP_CHANGED, CURRENT_REP_WILL_CHANGE, DATE_FORMAT, DAY_DATE_GROUP, DAY_OF_MONTH_DATE_GROUP, DAY_OF_WEEK_DATE_GROUP, DAY_OF_YEAR_DATE_GROUP, DECIMAL_FORMAT, DISTINCTCOUNT_FORMULA, FIRST_FORMULA, FULL_JOIN, GREATER_EQUAL_JOIN, GREATER_JOIN, GROUP_OTHERS, HOUR_DATE_GROUP, HOUR_OF_DAY_DATE_GROUP, INNER_JOIN, JOIN, LAST_FORMULA, LEAVE_OTHERS, LEFT_JOIN, LESS_EQUAL_JOIN, LESS_JOIN, MAX_FORMULA, MEDIAN_FORMULA, MESSAGE_FORMAT, MILLISECOND_DATE_GROUP, MIN_FORMULA, MINUTE_DATE_GROUP, MODE_FORMULA, MONTH_DATE_GROUP, MONTH_OF_YEAR_DATE_GROUP, NONE_DATE_GROUP, NONE_FORMULA, NOT_EQUAL_JOIN, NTHLARGEST_FORMULA, NTHMOSTFREQUENT_FORMULA, NTHSMALLEST_FORMULA, PARAM_PREFIX, PART_DATE_GROUP, PERCENT_FORMAT, PERCENTAGE_BY_COL, PERCENTAGE_BY_ROW, PERCENTAGE_NONE, PERCENTAGE_OF_COL_GRANDTOTAL, PERCENTAGE_OF_COL_GROUP, PERCENTAGE_OF_GRANDTOTAL, PERCENTAGE_OF_GROUP, PERCENTAGE_OF_ROW_GRANDTOTAL, PERCENTAGE_OF_ROW_GROUP, POPULATIONSTANDARDDEVIATION_FORMULA, POPULATIONVARIANCE_FORMULA, PRODUCT_FORMULA, PTHPERCENTILE_FORMULA, QUARTER_DATE_GROUP, QUARTER_OF_YEAR_DATE_GROUP, RIGHT_JOIN, SECOND_DATE_GROUP, SET_FORMULA, SORT_ASC, SORT_DESC, SORT_NONE, SORT_ORIGINAL, SORT_SPECIFIC, SORT_VALUE_ASC, SORT_VALUE_DESC, STANDARDDEVIATION_FORMULA, SUB_QUERY_PARAM, SUM_FORMULA, SUMSQ_FORMULA, SUMWT_FORMULA, VARIANCE_FORMULA, WEEK_DATE_GROUP, WEEK_OF_MONTH_DATE_GROUP, WEEK_OF_YEAR_DATE_GROUP, WEIGHTEDAVERAGE_FORMULA, YEAR_DATE_GROUP
 
Method Summary
 int[] getAvailableLevels(int row)
          Get available group levels of a row when get group first/last row.
 int getBaseRowIndex(int row)
          Get the base table row index corresponding to the grouped table.
 Formula getGrandFormula(int col)
          Get the grand total formula of the column.
 int getGroupColCount()
          Return the number of grouping columns.
 int getGroupColLevel(int col)
          Get a group col's group level.
 int getGroupColumns(int level)
          Get the number of columns used in the specified grouping level.
 int getGroupFirstRow(int row)
          Get the first row at the specified row.
 int getGroupFirstRow(int row, int level)
          Get the first row at specified row and group level.
 Formula getGroupFormula(int col)
          Get the group formula of the column.
 int getGroupHeaderStyle()
          Get the group header style.
 int getGroupLastRow(int row)
          Get the last row at the specified row.
 int getGroupLastRow(int row, int level)
          Get the last row at specified row and group level.
 int getGroupLevel(int r)
          Get the grouping level of this group header.
 int getSummaryLevel(int r)
          Get the grouping level of a summary row.
 boolean hasGrandSummary()
          Check if this table contains grand summary row.
 boolean isAddGroupHeader()
          Check if group header is to be added to the grouped data.
 boolean isGroupHeaderCell(int r, int c)
          Check if a cell is a group header cell.
 boolean isGroupHeaderRow(int r)
          Check if a row is displaying group header.
 boolean isMergeGroupCells()
          Check the merge group cell option.
 boolean isShowGroupColumns()
          Check if the group column contents are shown.
 boolean isSummaryCol(int col)
          Check if a column is a summary column.
 boolean isSummaryRow(int row)
          Check if a row is a summary row.
 void setAddGroupHeader(boolean h)
          Set whether group headers are added to the table.
 void setGroupHeaderStyle(int headerS)
          Set the group header style.
 void setMergeGroupCells(boolean merge)
          Set merging group cell option.
 void setShowGroupColumns(boolean grp)
          Set the show group column contents option.
 
Methods inherited from interface inetsoft.report.TableLens
addChangeListener, containsDrill, containsFormat, getAlignment, getBackground, getColBorder, getColBorderColor, getColWidth, getDefaultFormat, getDescriptor, getFont, getForeground, getInsets, getRowBorder, getRowBorderColor, getRowHeight, getSpan, getXDrillInfo, isLineWrap, removeChangeListener
 
Methods inherited from interface inetsoft.uql.XTable
dispose, getBoolean, getByte, getColCount, getColType, getColumnIdentifier, getDouble, getFloat, getHeaderColCount, getHeaderRowCount, getInt, getLong, getObject, getRowCount, getShort, getTrailerColCount, getTrailerRowCount, isNull, isPrimitive, moreRows, setColumnIdentifier, setObject
 

Field Detail

GROUP_HEADER_ROWS

static final int GROUP_HEADER_ROWS
Group headers are added as new rows on top of the grouped rows.

See Also:
Constant Field Values

GROUP_HEADER_IN_PLACE

static final int GROUP_HEADER_IN_PLACE
Group headers are displayed as part of the grouped rows.

See Also:
Constant Field Values

GROUP_HEADER_FULL

static final int GROUP_HEADER_FULL
Group headers are displayed as part of the grouped rows, and all columns are included in every header row.

See Also:
Constant Field Values
Method Detail

getGroupColCount

int getGroupColCount()
Return the number of grouping columns. Multiple column group is counted as one group column.


isGroupHeaderRow

boolean isGroupHeaderRow(int r)
Check if a row is displaying group header.

Parameters:
r - row number.

isGroupHeaderCell

boolean isGroupHeaderCell(int r,
                          int c)
Check if a cell is a group header cell. This is more accurate than the isGroupHeaderRow() because it takes into consideration of the in-place header rows (where it's partially a header and body).

Specified by:
isGroupHeaderCell in interface RegionTable
Parameters:
r - row number.
c - column number.
Returns:
true if the cell is a group header cell.

getGroupColumns

int getGroupColumns(int level)
Get the number of columns used in the specified grouping level. This is normally 1 unless multiple columns are combined into one group.


getGroupLevel

int getGroupLevel(int r)
Get the grouping level of this group header. The row number must refer to a header row.

Specified by:
getGroupLevel in interface RegionTable
Returns:
grouping level. The top-most group is level 0. Returns -1 if the row is not a header row.

getGroupColLevel

int getGroupColLevel(int col)
Get a group col's group level.

Parameters:
col - the group col.
Returns:
the group col's group level, -1 means not a group col.

isShowGroupColumns

boolean isShowGroupColumns()
Check if the group column contents are shown. This is true by default. If it's false, the group columns are hidden.

Returns:
true if group columns are shown.

setShowGroupColumns

void setShowGroupColumns(boolean grp)
Set the show group column contents option. If it's turned off, the grouped columns will have empty contents. If the ShowGroupColumns is set to false, the AddGroupHeader is automatically turned on.

Parameters:
grp - show group column contents.

isAddGroupHeader

boolean isAddGroupHeader()
Check if group header is to be added to the grouped data.

Returns:
true if group header is added. Default to false.

setAddGroupHeader

void setAddGroupHeader(boolean h)
Set whether group headers are added to the table. Group headers are separate rows containing only the group column value for the section.


getGroupHeaderStyle

int getGroupHeaderStyle()
Get the group header style.

Returns:
group header style.

setGroupHeaderStyle

void setGroupHeaderStyle(int headerS)
Set the group header style. This must be called before the refresh() is called.

Parameters:
headerS - one of GROUP_HEADER_IN_PLACE, GROUP_HEADER_ROWS (default).

isSummaryRow

boolean isSummaryRow(int row)
Check if a row is a summary row.

Specified by:
isSummaryRow in interface RegionTable
Parameters:
row - the row number.
Returns:
true if the row is a summary row.

isSummaryCol

boolean isSummaryCol(int col)
Check if a column is a summary column.

Parameters:
col - the column number.
Returns:
true if the column is a summary column.

getSummaryLevel

int getSummaryLevel(int r)
Get the grouping level of a summary row. The row number must refer to a summary row.

Specified by:
getSummaryLevel in interface RegionTable
Returns:
grouping level. The top-most group is level 0. Returns -1 if the row is not a summary row.

hasGrandSummary

boolean hasGrandSummary()
Check if this table contains grand summary row.

Returns:
true if grand summary row exists.

getGroupFirstRow

int getGroupFirstRow(int row,
                     int level)
Get the first row at specified row and group level.

Parameters:
row - the specified row
level - the specified group level
Returns:
the first row, -1 if not available

getGroupLastRow

int getGroupLastRow(int row,
                    int level)
Get the last row at specified row and group level.

Parameters:
row - the specified row
level - the specified group level
Returns:
the last row, -1 if not available

getGroupFirstRow

int getGroupFirstRow(int row)
Get the first row at the specified row. The default group level is the highest available group level at the specified row.

Parameters:
row - the specified row
Returns:
the first row, -1 if not available

getGroupLastRow

int getGroupLastRow(int row)
Get the last row at the specified row. The default group level is the highest available group level at the specified row.

Parameters:
row - the specified row
Returns:
the last row, -1 if not available

getAvailableLevels

int[] getAvailableLevels(int row)
Get available group levels of a row when get group first/last row.

Parameters:
row - the specified row
Returns:
the available group level array

getBaseRowIndex

int getBaseRowIndex(int row)
Get the base table row index corresponding to the grouped table. If the row does not exist in the base table, it returns -1.

Parameters:
row - row index in the grouped table.
Returns:
corresponding row index in the base table.

getGroupFormula

Formula getGroupFormula(int col)
Get the group formula of the column.

Parameters:
col - column index in the grouped table.
Returns:
the group formula of column

getGrandFormula

Formula getGrandFormula(int col)
Get the grand total formula of the column.

Parameters:
col - column index in the grouped table.
Returns:
the grand total formula of column

setMergeGroupCells

void setMergeGroupCells(boolean merge)
Set merging group cell option. If set, group cells of the same group are merged into one span cell.


isMergeGroupCells

boolean isMergeGroupCells()
Check the merge group cell option.


Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.