|
Style Intelligence v12.0 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectinetsoft.report.lens.AbstractTableLens
inetsoft.report.filter.AbstractGroupedTable
inetsoft.report.filter.SummaryFilter
public class SummaryFilter
SummaryFilter is a special GroupFilter where only summary rows are displayed. The details rows are omitted.
| Nested Class Summary | |
|---|---|
protected class |
SummaryFilter.GroupNode
Group node. |
protected class |
SummaryFilter.MergedGroupNode
Merged group node. |
| Nested classes/interfaces inherited from class inetsoft.report.filter.AbstractGroupedTable |
|---|
AbstractGroupedTable.BooleanObject |
| Field Summary |
|---|
| Fields inherited from class inetsoft.report.lens.AbstractTableLens |
|---|
descriptor, isLeftAlign |
| Fields inherited from interface inetsoft.report.TableLens |
|---|
BREAK_BORDER, NULL |
| Fields inherited from interface inetsoft.uql.XTable |
|---|
EOT |
| Fields inherited from interface inetsoft.report.filter.GroupedTable |
|---|
GROUP_HEADER_FULL, GROUP_HEADER_IN_PLACE, GROUP_HEADER_ROWS |
| Constructor Summary | |
|---|---|
SummaryFilter(SortedTable table,
int[] sums,
Formula[] calcs,
Formula[] grand)
Create a SummaryFilter. |
|
SummaryFilter(SortedTable table,
int[] sums,
Formula[] calcs,
Formula[] grand,
String[] headers)
Create a SummaryFilter. |
|
SummaryFilter(SortedTable table,
int[] sums,
Formula calc,
Formula grand)
Create a SummaryFilter. |
|
SummaryFilter(SortedTable table,
int sum,
Formula calc,
Formula grand)
Create a SummaryFilter. |
|
SummaryFilter(TableLens table,
int[] groupcols,
int[] sums,
Formula[] calcs,
Formula[] grand)
Create a SummaryFilter. |
|
SummaryFilter(TableLens table,
int[] groupcols,
int[] sums,
Formula[] calcs,
Formula[] grand,
boolean hierarchy)
Create a SummaryFilter. |
|
SummaryFilter(TableLens table,
int[] groupcols,
int[] sums,
Formula[] calcs,
Formula[] grand,
boolean hierarchy,
int pglvl)
Create a SummaryFilter. |
|
SummaryFilter(TableLens table,
int[] groupcols,
int[] sums,
Formula calc,
Formula grand)
Create a SummaryFilter. |
|
| Method Summary | |
|---|---|
void |
clearSortByVal()
|
boolean |
containsTopN(int col)
Check if contains topn info. |
void |
dispose()
Dispose the table to clear up temporary resources. |
protected boolean |
evaluate(SummaryFilter.GroupNode node)
Evaluate the detail node. |
int |
getAlignment(int r,
int c)
Return the per cell alignment. |
int |
getBaseColIndex(int col)
Get the base table column index corresponding to the filtered table. |
int |
getBaseRowIndex(int row)
Get the base table row index corresponding to the filtered table. |
int |
getColCount()
Return the number of columns in the table. |
String |
getColumnIdentifier(int col)
Get the column identifier of a column. |
Comparer |
getComparer(int col)
Get the comparer for a sorting column. |
TableDataDescriptor |
getDescriptor()
Get internal table data descriptor which contains table structural infos. |
Font |
getFont(int r,
int c)
Return the per cell font. |
Formula |
getGrandFormula(int col)
Get the grand total formula of the column. |
Formula[] |
getGrandFormulae()
Get grand formulae. |
String |
getGrandLabel()
Get the grand total row label. |
int |
getGroupColCount()
Return the number of grouping columns. |
int |
getGroupColumns(int level)
Get the number of columns used in the specified grouping level. |
Formula |
getGroupFormula(int col)
Get the group formula of the column. |
int |
getGroupHeaderStyle()
Get the group header style. |
int |
getGroupLevel(int r)
Get the grouping level of this group header. |
SortOrder |
getGroupOrder(int col)
Get the specific group order information. |
int |
getHeaderColCount()
Return the number of columns on the left of the table to be treated as header columns. |
int |
getHeaderRowCount()
Return the number of rows on the top of the table to be treated as header rows. |
Object |
getObject(int r,
int c)
Return the value at the specified cell. |
boolean[] |
getOrders()
Get the sorting order of the sorting columns. |
int |
getRowCount()
Return the number of rows in the table. |
int[] |
getSortCols()
Get the columns that the table is sorted on. |
String |
getSummaryLabel()
Get summary row label format. |
int |
getSummaryLevel(int row)
Get summary level of a row. |
TableLens |
getTable()
Get the original table of this filter. |
int |
getTrailerRowCount()
Return the number of rows on the bottom of the table to be treated as trailer rows. |
boolean |
hasGrandSummary()
Check if this table contains grand summary row. |
void |
invalidate()
Invalidate the table filter forcely, and the table filter will perform filtering calculation to validate itself. |
boolean |
isAddGroupHeader()
Check if group header is to be added to the grouped data. |
boolean |
isAggregateTopN()
Check if only aggregate topN rows. |
boolean |
isDefaultResult()
Get the default result option of this filter. |
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 |
isKeepHierarchy()
Check whether to keep group hierarchy. |
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. |
boolean |
moreRows(int row)
Check if there are more rows. |
void |
removeSortByVal(int col)
Remove sort by column value info. |
void |
removeTopN(int col)
Remove topn info. |
protected void |
resetOrder(List nodes0,
List nodes1,
int gidx)
Restore to original order if necessary. |
void |
setAddGroupHeader(boolean h)
Set whether group headers are added to the table. |
void |
setAggregateTopN(boolean aggTopN)
Set the option if only aggregate topN rows. |
void |
setComparer(int col,
Comparer comp)
Set the comparer for a sorting column. |
void |
setDefaultResult(boolean def)
Set the default result option of this filter. |
void |
setGrandLabel(String label)
Set the grand total label. |
void |
setGroupHeaderStyle(int headerS)
Set the group header style. |
void |
setGroupOrder(int col,
SortOrder order)
Set the specific group order information. |
void |
setMeasureNames(String[] names)
Set the measure names to table. |
void |
setObject(int r,
int c,
Object v)
Set the cell value. |
void |
setShowGroupColumns(boolean grp)
Set the show group column contents option. |
void |
setSortByValInfo(int col,
int scol,
boolean reverse)
Set sort by value column info. |
void |
setSummaryLabel(String fmt)
Set the summary row label. |
void |
setTable(TableLens table)
Set the base table of this filter. |
void |
setTopN(int col,
int scol,
int topn,
boolean reverse)
Set topn info. |
void |
setTopN(int col,
int scol,
int topn,
boolean reverse,
boolean kept,
boolean others)
Set topn info. |
void |
setTopNAggregateInfo(int dcol,
int n,
boolean topn)
Set the global topN. |
| Methods inherited from class inetsoft.report.filter.AbstractGroupedTable |
|---|
clearCache, clearPageBreaks, firstSummaryColumn, getAvailableLevels, getGroupColLevel, getGroupFirstRow, getGroupFirstRow, getGroupFirstRow0, getGroupLastRow, getGroupLastRow, getGroupLastRow0, getGroupLevel0, getHeader2, getMergedGroup, getOriginalPath, getPageBreakLevels, getRealGroupColCount, getSpan, isMergedGroup, isMergeGroupCells, setMergedGroup, setMergeGroupCells |
| Methods inherited from class inetsoft.report.lens.AbstractTableLens |
|---|
addChangeListener, clone, containsDrill, containsFormat, findColumnByIdentifier, fireChangeEvent, getBackground, getBoolean, getByte, getColBorder, getColBorderColor, getColType, getColWidth, getDefaultFormat, getDouble, getFloat, getForeground, getInsets, getInt, getLong, getRowBorder, getRowBorderColor, getRowHeight, getShort, getTrailerColCount, getXDrillInfo, isLineWrap, isNull, isPrimitive, removeChangeListener, setColumnIdentifier, setLeftAlign, setLocal |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface inetsoft.report.TableLens |
|---|
addChangeListener, containsDrill, containsFormat, getBackground, getColBorder, getColBorderColor, getColWidth, getDefaultFormat, getForeground, getInsets, getRowBorder, getRowBorderColor, getRowHeight, getSpan, getXDrillInfo, isLineWrap, removeChangeListener |
| Methods inherited from interface inetsoft.uql.XTable |
|---|
getBoolean, getByte, getColType, getDouble, getFloat, getInt, getLong, getShort, getTrailerColCount, isNull, isPrimitive, setColumnIdentifier |
| Constructor Detail |
|---|
public SummaryFilter(SortedTable table,
int sum,
Formula calc,
Formula grand)
table - sorted table.sum - summary column.calc - summary formula.grand - grand total formula.
public SummaryFilter(SortedTable table,
int[] sums,
Formula calc,
Formula grand)
table - sorted table.sums - summary columns.calc - summary formula.grand - grand total formula.
public SummaryFilter(TableLens table,
int[] groupcols,
int[] sums,
Formula calc,
Formula grand)
table - base table.sums - summary columns.calc - summary formula.grand - grand total formula.
public SummaryFilter(TableLens table,
int[] groupcols,
int[] sums,
Formula[] calcs,
Formula[] grand)
table - base table.sums - summary columns.calcs - summary formula.grand - grand total formula.
public SummaryFilter(TableLens table,
int[] groupcols,
int[] sums,
Formula[] calcs,
Formula[] grand,
boolean hierarchy)
table - base table.sums - summary columns.calcs - summary formula.grand - grand total formula.hierarchy - true if keep the group hierarchy, default is false.
public SummaryFilter(TableLens table,
int[] groupcols,
int[] sums,
Formula[] calcs,
Formula[] grand,
boolean hierarchy,
int pglvl)
table - base table.sums - summary columns.calcs - summary formula.grand - grand total formula.hierarchy - true if keep the group hierarchy, default is false.pglvl - percent by group level.
public SummaryFilter(SortedTable table,
int[] sums,
Formula[] calcs,
Formula[] grand,
String[] headers)
table - sorted table.sums - summary columns.calcs - summary formulas.grand - grand total formulas.headers - the column headers for the summary columns. If not
specified, the column header of the summarized column is used.
public SummaryFilter(SortedTable table,
int[] sums,
Formula[] calcs,
Formula[] grand)
table - sorted table.sums - summary columns.calcs - summary formulas.grand - grand total formulas.| Method Detail |
|---|
public int getGroupColCount()
getGroupColCount in interface GroupedTablegetGroupColCount in class AbstractGroupedTablepublic boolean isGroupHeaderRow(int r)
isGroupHeaderRow in interface GroupedTableisGroupHeaderRow in class AbstractGroupedTabler - row number.
public boolean isGroupHeaderCell(int r,
int c)
isGroupHeaderCell in interface GroupedTableisGroupHeaderCell in interface RegionTableisGroupHeaderCell in class AbstractGroupedTabler - row number.c - column number.
public int getGroupColumns(int level)
getGroupColumns in interface GroupedTablegetGroupColumns in class AbstractGroupedTablepublic int getGroupLevel(int r)
getGroupLevel in interface GroupedTablegetGroupLevel in interface RegionTablegetGroupLevel in class AbstractGroupedTablepublic boolean isShowGroupColumns()
isShowGroupColumns in interface GroupedTableisShowGroupColumns in class AbstractGroupedTablepublic void setShowGroupColumns(boolean grp)
setShowGroupColumns in interface GroupedTablesetShowGroupColumns in class AbstractGroupedTablegrp - show group column contents.public boolean isAddGroupHeader()
isAddGroupHeader in interface GroupedTableisAddGroupHeader in class AbstractGroupedTablepublic void setAddGroupHeader(boolean h)
setAddGroupHeader in interface GroupedTablesetAddGroupHeader in class AbstractGroupedTablepublic int getGroupHeaderStyle()
getGroupHeaderStyle in interface GroupedTablegetGroupHeaderStyle in class AbstractGroupedTablepublic void setGroupHeaderStyle(int headerS)
setGroupHeaderStyle in interface GroupedTablesetGroupHeaderStyle in class AbstractGroupedTableheaderS - one of GROUP_HEADER_IN_PLACE, GROUP_HEADER_ROWS (default).public boolean isSummaryRow(int row)
isSummaryRow in interface GroupedTableisSummaryRow in interface RegionTableisSummaryRow in class AbstractGroupedTablerow - the row number.
public boolean isSummaryCol(int col)
isSummaryCol in interface GroupedTableisSummaryCol in class AbstractGroupedTablecol - the column number.
public int getSummaryLevel(int row)
getSummaryLevel in interface GroupedTablegetSummaryLevel in interface RegionTablegetSummaryLevel in class AbstractGroupedTablerow - the specified row.
public boolean hasGrandSummary()
hasGrandSummary in interface GroupedTablehasGrandSummary in class AbstractGroupedTablepublic Formula getGroupFormula(int col)
getGroupFormula in interface GroupedTablegetGroupFormula in class AbstractGroupedTablecol - column index in the grouped table.
public Formula getGrandFormula(int col)
getGrandFormula in interface GroupedTablegetGrandFormula in class AbstractGroupedTablecol - column index in the grouped table.
public int[] getSortCols()
getSortCols in interface SortedTablepublic boolean[] getOrders()
getOrders in interface SortedTable
public void setComparer(int col,
Comparer comp)
setComparer in interface SortedTablecol - table column index.comp - comparer.public Comparer getComparer(int col)
getComparer in interface SortedTablecol - the specified table column index.public void invalidate()
invalidate in interface TableFilterpublic void setDefaultResult(boolean def)
def - true to use the default value of a formula if no
result, false to just return null.public boolean isDefaultResult()
public void setMeasureNames(String[] names)
setMeasureNames in interface CalcFilterpublic Formula[] getGrandFormulae()
protected void resetOrder(List nodes0,
List nodes1,
int gidx)
protected boolean evaluate(SummaryFilter.GroupNode node)
public void setGrandLabel(String label)
label - grand total label.public String getGrandLabel()
public void setSummaryLabel(String fmt)
public String getSummaryLabel()
public void setAggregateTopN(boolean aggTopN)
aggTopN - true to aggregate only topN rows.public boolean isAggregateTopN()
public void setGroupOrder(int col,
SortOrder order)
col - group columns.order - group order.public SortOrder getGroupOrder(int col)
col - group columns.
public void setTopN(int col,
int scol,
int topn,
boolean reverse)
col - group colscol - summary coltopn - topn valuereverse - true if should reverse
public void setTopN(int col,
int scol,
int topn,
boolean reverse,
boolean kept,
boolean others)
col - group colscol - summary coltopn - topn valuereverse - true if should reversekept - true if keep the equal rows, false to discard them
public void setSortByValInfo(int col,
int scol,
boolean reverse)
col - the index of column in the "cols" variable.scol - the index of summary column in "sums" variable.reverse - true if should reverse
public void setTopNAggregateInfo(int dcol,
int n,
boolean topn)
dcol - the aggregate column to compare values.n - the top N.topn - true to get top and false to get bottom values.public void removeTopN(int col)
col - the specified group colpublic boolean containsTopN(int col)
col - the group column, or -1 to check if any topN is defined.
public void removeSortByVal(int col)
col - the specified group colpublic void clearSortByVal()
public TableLens getTable()
getTable in interface TableFilterpublic void setTable(TableLens table)
setTable in interface TableFilterpublic TableDataDescriptor getDescriptor()
getDescriptor in interface TableLensgetDescriptor in interface XTablegetDescriptor in class AbstractTableLenspublic int getTrailerRowCount()
getTrailerRowCount in interface XTablegetTrailerRowCount in class AbstractTableLenspublic int getBaseRowIndex(int row)
getBaseRowIndex in interface GroupedTablegetBaseRowIndex in interface TableFiltergetBaseRowIndex in class AbstractGroupedTablerow - row index in the filtered table.
public int getBaseColIndex(int col)
getBaseColIndex in interface TableFiltercol - column index in the filtered table.
public boolean moreRows(int row)
moreRows in interface XTablemoreRows in class AbstractTableLensrow - row number.
public int getRowCount()
getRowCount in interface XTablepublic int getColCount()
getColCount in interface XTablepublic int getHeaderRowCount()
getHeaderRowCount in interface XTablegetHeaderRowCount in class AbstractTableLenspublic int getHeaderColCount()
getHeaderColCount in interface XTablegetHeaderColCount in class AbstractTableLens
public int getAlignment(int r,
int c)
getAlignment in interface TableLensgetAlignment in class AbstractTableLensr - row number.c - column number.
public Font getFont(int r,
int c)
getFont in interface TableLensgetFont in class AbstractTableLensr - row number.c - column number.
public Object getObject(int r,
int c)
getObject in interface XTabler - row number.c - column number.
public void setObject(int r,
int c,
Object v)
setObject in interface XTablesetObject in class AbstractTableLensr - row number.c - column number.v - cell value.public boolean isKeepHierarchy()
public void dispose()
dispose in interface XTabledispose in class AbstractTableLenspublic String getColumnIdentifier(int col)
getColumnIdentifier in interface XTablegetColumnIdentifier in class AbstractGroupedTablecol - the specified column index.
|
Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved. | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||