Style Intelligence v12.0

inetsoft.report
Interface TableDataDescriptor

All Superinterfaces:
Serializable
All Known Implementing Classes:
CalcTableLens.CalcTableLensDataDescriptor, DefaultTableDataDescriptor

public interface TableDataDescriptor
extends Serializable

Normally, a table lens contains a table data descriptor for users to get table structural infos.


Field Summary
static int CALC_TABLE
          Calc table.
static int CROSSTAB_TABLE
          Crosstab table.
static int FREEHAND_TABLE
          Freehand table.
static int GROUPED_TABLE
          Grouped table.
static int NORMAL_TABLE
          Normal table.
static int SUMMARY_TABLE
          Summary table.
static int TABLE_SUMMARY_TABLE
          Table summary table.
static int UNKNOWN_TABLE
          Unknown table.
 
Method Summary
 boolean containsDrill()
          Check if contains drill.
 boolean containsFormat()
          Check if contains format.
 TableDataPath getCellDataPath(int row, int col)
          Get table data path of a specified table cell.
 TableDataPath getColDataPath(int col)
          Get table data path of a specified table column.
 TableDataPath getRowDataPath(int row)
          Get table data path of a specified table row.
 int getRowLevel(int row)
          Get level of a specified table row, which is required for nested table.
 int getType()
          Get table type which is one of the table types defined in table data descriptor like NORMAL_TABLE, CROSSTAB_TABLE, etc.
 XMetaInfo getXMetaInfo(TableDataPath path)
          Get meta info of a specified table data path.
 boolean isCellDataPath(int row, int col, TableDataPath path)
          Check if a cell belongs to a table data path.
 boolean isCellDataPathType(int row, int col, TableDataPath path)
          Check if a cell belongs to a table data path in a loose way.
 boolean isColDataPath(int col, TableDataPath path)
          Check if a column belongs to a table data path.
 boolean isRowDataPath(int row, TableDataPath path)
          Check if a row belongs to a table data path.
 

Field Detail

UNKNOWN_TABLE

static final int UNKNOWN_TABLE
Unknown table.

See Also:
Constant Field Values

NORMAL_TABLE

static final int NORMAL_TABLE
Normal table.

See Also:
Constant Field Values

TABLE_SUMMARY_TABLE

static final int TABLE_SUMMARY_TABLE
Table summary table.

See Also:
Constant Field Values

SUMMARY_TABLE

static final int SUMMARY_TABLE
Summary table.

See Also:
Constant Field Values

GROUPED_TABLE

static final int GROUPED_TABLE
Grouped table.

See Also:
Constant Field Values

CROSSTAB_TABLE

static final int CROSSTAB_TABLE
Crosstab table.

See Also:
Constant Field Values

FREEHAND_TABLE

static final int FREEHAND_TABLE
Freehand table. A table generated from FreehandLayout.

See Also:
Constant Field Values

CALC_TABLE

static final int CALC_TABLE
Calc table. A table generated from a CalcTable with possible dynamic cell expansions.

See Also:
Constant Field Values
Method Detail

getColDataPath

TableDataPath getColDataPath(int col)
Get table data path of a specified table column.

Parameters:
col - the specified table column
Returns:
table data path of the table column

getRowDataPath

TableDataPath getRowDataPath(int row)
Get table data path of a specified table row.

Parameters:
row - the specified table row
Returns:
table data path of the table row

getCellDataPath

TableDataPath getCellDataPath(int row,
                              int col)
Get table data path of a specified table cell.

Parameters:
row - the specified table cell row
col - the specified table cell col
Returns:
table data path of the table cell

isColDataPath

boolean isColDataPath(int col,
                      TableDataPath path)
Check if a column belongs to a table data path.

Parameters:
col - the specified table col
path - the specified table data path
Returns:
true if the col belongs to the table data path, false otherwise

isRowDataPath

boolean isRowDataPath(int row,
                      TableDataPath path)
Check if a row belongs to a table data path.

Parameters:
row - the specified table row
path - the specified table data path
Returns:
true if the row belongs to the table data path, false otherwise

isCellDataPathType

boolean isCellDataPathType(int row,
                           int col,
                           TableDataPath path)
Check if a cell belongs to a table data path in a loose way. Note: when checking, path in the table data path will be ignored.

Parameters:
row - the specified table cell row
col - the specified table cell col
path - the specified table data path
Returns:
true if the cell belongs to the table data path, false otherwise

isCellDataPath

boolean isCellDataPath(int row,
                       int col,
                       TableDataPath path)
Check if a cell belongs to a table data path.

Parameters:
row - the specified table cell row
col - the specified table cell col
path - the specified table data path
Returns:
true if the cell belongs to the table data path, false otherwise

getRowLevel

int getRowLevel(int row)
Get level of a specified table row, which is required for nested table. The default value is -1.

Parameters:
row - the specified table row
Returns:
level of the table row

getType

int getType()
Get table type which is one of the table types defined in table data descriptor like NORMAL_TABLE, CROSSTAB_TABLE, etc.

Returns:
table type

getXMetaInfo

XMetaInfo getXMetaInfo(TableDataPath path)
Get meta info of a specified table data path.

Parameters:
path - the specified table data path
Returns:
meta info of the table data path

containsFormat

boolean containsFormat()
Check if contains format.

Returns:
true if contains format

containsDrill

boolean containsDrill()
Check if contains drill.

Returns:
true if contains drill, false otherwise

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